Running Symfony Tests

Warning: You are browsing the documentation for Symfony 4.x, which is no longer maintained.

Read the updated version of this page for Symfony 7.2 (the current stable version).

The Symfony project uses a third-party service which automatically runs tests for any submitted patch. If the new code breaks any test, the pull request will show an error message with a link to the full error details.

In any case, it's a good practice to run tests locally before submitting a patch for inclusion, to check that you have not broken anything.

Before Running the Tests

To run the Symfony test suite, install the external dependencies used during the tests, such as Doctrine, Twig and Monolog. To do so, install Composer and execute the following:

        1
        $ composer update
    

Tip

Dependencies might fail to update and in this case Composer might need you to tell it what Symfony version you are working on. To do so set COMPOSER_ROOT_VERSION variable, e.g.:

        1
        $ COMPOSER_ROOT_VERSION=4.4.x-dev composer update
    

Running the Tests

Then, run the test suite from the Symfony root directory with the following command:

        1
        $ php ./phpunit symfony
    

The output should display OK. If not, read the reported errors to figure out what's going on and if the tests are broken because of the new code.

Tip

The entire Symfony suite can take up to several minutes to complete. If you want to test a single component, type its path after the phpunit command, e.g.:

        1
        $ php ./phpunit src/Symfony/Component/Finder/
    

Tip

On Windows, install the Cmder, ConEmu, ANSICON or Mintty free applications to see colored test results.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

TOC

Version