From 57f8118f754bbb34bec0a5b47eaef0cd096c6481 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Thu, 24 Jul 2014 01:03:16 +0400 Subject: [PATCH] Adjusted docs to use global phpunit and codeception installation --- docs/internals/getting-started.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/docs/internals/getting-started.md b/docs/internals/getting-started.md index 5840aa0..078e18b 100644 --- a/docs/internals/getting-started.md +++ b/docs/internals/getting-started.md @@ -24,10 +24,10 @@ Unit tests To run the unit tests you have to install composer packages for the dev-repo. Run `composer update` in the repo root directory to get the latest packages. -You can now execute unit tests by running `./vendor/bin/phpunit`. +You can now execute unit tests by running `phpunit`. You may limit the tests to a group of tests you are working on e.g. to run only tests for the validators and redis -`./vendor/bin/phpunit --group=validators,redis`. +`phpunit --group=validators,redis`. Functional and acceptance tests ------------------------------- @@ -37,9 +37,6 @@ to test. Add the following four packages to your `composer.json` `require-dev` s ``` "yiisoft/yii2-codeception": "*", -"codeception/codeception": "2.0.*", -"codeception/specify": "*", -"codeception/verify": "*" ``` For advanced application you may need `yiisoft/yii2-faker: *` as well. @@ -51,16 +48,16 @@ After package installation is complete you can run the following for basic app: ``` cd apps/basic -vendor/bin/codecept build -vendor/bin/codecept run +codecept build +codecept run ``` For advanced application frontend it will be: ``` cd apps/advanced/frontend -../vendor/bin/codecept build -../vendor/bin/codecept run +codecept build +codecept run ``` Note that you need a running webserver in order to pass acceptance tests. That can be easily achieved with PHP's built-in @@ -71,6 +68,18 @@ cd apps/advanced/frontend/www php -S 127.0.0.1:8080 index-test.php ``` +Note that you should have Codeception and PHPUnit installed globally: + +``` +composer global require "phpunit/phpunit=4.1.*" +composer global require "codeception/codeception=2.0.*" +composer global require "codeception/specify=*" +composer global require "codeception/verify=*" +``` + +After running commands you'll see "Changed current directory to /your/global/composer/dir" message. If it's the +first time you're installing a package globally you need to add `/your/global/composer/dir/vendor/bin/` to your `PATH`. + Extensions ----------