Warning: You are browsing the documentation for Symfony 2.0, which is no longer maintained.
Read the updated version of this page for Symfony 5.3 (the current stable version).
Running Symfony2 Tests
Before submitting a patch for inclusion, you need to run the Symfony2 test suite to check that you have not broken anything.
PHPUnit
To run the Symfony2 test suite, install PHPUnit 3.5.11 or later first:
1 2
$ pear config-set auto_discover 1
$ pear install pear.phpunit.de/PHPUnitDependencies (optional)
To run the entire test suite, including tests that depend on external dependencies, Symfony2 needs to be able to autoload them. By default, they are autoloaded from `vendor/` under the main root directory (see `autoload.php.dist`).
The test suite needs the following third-party libraries:
- Doctrine
- Swiftmailer
- Twig
- Monolog
To install them all, run the `vendors` script:
1
$ php vendors.php installNote
Note that the script takes some time to finish.
After installation, you can update the vendors to their latest version with the follow command:
1
$ php vendors.php updateRunning
First, update the vendors (see above).
Then, run the test suite from the Symfony2 root directory with the following command:
1
$ phpunitThe output should display `OK`. If not, you need to figure out what's going on and if the tests are broken because of your modifications.
Tip
If you want to test a single component type its path after the `phpunit` command, e.g.:
1
$ phpunit src/Symfony/Component/Finder/Tip
Run the test suite before applying your modifications to check that they run fine on your configuration.
Code Coverage
If you add a new feature, you also need to check the code coverage by using the `coverage-html` option:
1
$ phpunit --coverage-html=cov/Check the code coverage by opening the generated `cov/index.html` page in a browser.
Tip
The code coverage only works if you have XDebug enabled and all dependencies installed.