PHPUnit

• Download phpunit.phar from the PHPUnit Official website and save it on your computer:

  • If you need full coding assistance in addition to the ability of running PHPUnit tests, store phpunit.phar under the root of the project where PHPUnit will be later used.

  • If you only need to run PHPUnit tests and you do not need any coding assistance, you can save phpunit.phar outside the project.

1. Inside composer.json, add the phpunit/phpunit dependency record to the require or require-dev key. Press to get code completion for the package name and version.

2. Do one of the following:

   • Click the Install shortcut link on top of the editor panel.

   • If the Non-installed Composer packages inspection is enabled, PhpStorm will highlight the declared dependencies that are not currently installed. Press and select whether you want to install a specific dependency or all dependencies at once.

Click next to the package record in the composer.json editor gutter to jump to the corresponding Settings page and configure PHPUnit manually.

1. Store the phpunit.xml or phpunit.xml.dist configuration file under the project root.

2. Install PHPUnit with Composer.

PhpStorm detects the installed PHPUnit executable (or executables, if the project has Composer-managed subprojects with a specified PHPUnit dependency) and creates a test framework configuration per each installed PHPUnit executable on the Test Frameworks page.

tip

You can manually configure the used local or remote PHP interpreter separately for each of the Composer-managed test framework configurations.

If the phpunit.xml or phpunit.xml.dist configuration file is detected under the project (or subproject) root automatically or specified explicitly during manual configuration, PhpStorm also creates a respective PHPUnit run/debug configuration.

1. In the Settings dialog (), go to PHP | Test Frameworks.

   On the Test Frameworks page that opens, click in the central pane and choose the configuration type from the list:

   

   • In local configurations, the default project PHP interpreter is used. For more information, refer to Default project CLI interpreters.

   • To use PHPUnit with a remote PHP interpreter, choose one of the configurations in the dialog that opens:

     

2. In the right-hand pane, choose the PHPUnit library installation type:

   • To use Composer autoloader, specify the path to the autoload.php file in the vendor folder. For more information, refer to Composer.

   • To run PHPUnit from phpunit.phar, download phpunit.phar, save the archive in the project root folder, and specify the path to it. For local configurations, you can download the archive by clicking the provided download link. To use it in the current project, make sure a default PHP interpreter is defined.

     When you click , PhpStorm detects and displays the PHPUnit version.

3. In the Test Runner area, appoint the configuration XML file to use for launching and executing scenarios.

   By default, PHPUnit looks for a phpunit.xml or phpunit.xml.dist configuration file in the project root folder. You can appoint a custom configuration file.

   You can also type the path to a bootstrap file to have a PHP script always executed before launching tests. In the field, specify the location of the script. Type the path manually or click and select the desired folder in the dialog that opens.

   Note that you can also provide an alternative configuration and bootstrap file when editing a PHPUnit run/debug configuration.

1. Open the Create New PHP Test dialog by doing any of the following:

   • Go to File | New. Then, choose PHP Test | PHPUnit Test from the context menu.

   • In the Project tool window, press or right-click the PHP class to be tested and choose New | PHP Test | PHPUnit Test.

   • In the editor of the PHP class to be tested, place the caret at the definition of the class. Then, press and select Create New Test from the popup menu. This way, you can generate a test for a PHP class defined among several classes within a single PHP file.

     To create a test for a certain method, place the caret within the method declaration. The chosen method will be automatically selected in the methods list of the Create New PHP Test dialog.

2. The Create New PHP Test dialog opens.

   

   Provide the parameters of the generated test:

   • The test file template, that is, the template based on which PhpStorm will generate the test class. Make sure that PHPUnit<6 is selected in the Test file template list.

   • The name of the test class. PhpStorm automatically composes the name from the production class name as <production class>Test.php.

   • The folder for the test class file, which is automatically suggested based on the containing directory and namespace of the production class, the configured test sources root and its psr-4 package prefix, or the directory value specified in the phpunit.xml configuration file.

     To specify a different folder, click next to the Directory field and choose the relevant folder.

   • The namespace the test class will belong to, which is automatically suggested based on the containing directory and namespace of the production class, the configured test sources root and its psr-4 package prefix.

   • The production class methods to generate test method stubs for. Select the checkboxes next to the required production class methods. To include inherited methods from parent classes, select the Show inherited methods checkbox.

     PhpStorm will automatically compose the test methods' names as test<production method>. You can customize the code templates used for generating test method stubs on the Code tab of the File and Code Templates settings page.

After the test is created, you can navigate back to the production class by choosing Navigate | Go to Test Subject. For more information, refer to Navigate between a test and its test subject.

note

If you are relying on the PHPUnit configuration file for providing the containing folder and namespace for the test class, make sure that it is selected on the Test Frameworks page as described in Integrating PHPUnit with a PhpStorm project.

• In the Project tool window, select the file or folder to run your tests from and choose Run '<file or folder>' or Debug '<file or folder>' from the context menu of the selection:

  

  PhpStorm generates a default run configuration and starts a run or debug test session with it.

You can run or debug a single test for a specific test class or test method from the file editor window.

• Open the test file in the editor, click the gutter icon next to the test and choose Run '<test_name>' or Debug '<test_name>' from the context menu. Alternatively, place the caret at the corresponding line and press .

If the PHPUnit test uses a data provider, you can run single tests for some types of data sets. Data sets that can be run separately are marked with the gutter icon in the editor.

• In the file editor, click in the gutter next to the data set (or right-click the corresponding code line) and select Run '<test_name>'.

  

1. Open the target file in the editor, right-click the desired test target, that is, a class or a method being tested, and either choose Go To | Test or press .

2. From the popup menu, select the tests to be executed. For multiple selection use and .

   

3. Press to run the tests selection.

After a test session is over, PhpStorm automatically creates a run/debug configuration with its Test scope set to Composite. For more information, refer to PHPUnit.

• After a test session is over, choose Save <default_test_configuration_name> from the context menu of the file or folder.

• Choose the required PHPUnit configuration from the list on the toolbar and click or .

1. In the Project tool window, select the file or folder with the tests to run and choose Create run configuration from the context menu. Alternatively, choose Run | Edit Configurations from the main menu, then click and choose PHPUnit from the list.

2. In the PHPUnit dialog that opens, specify the scenarios to run, choose the PHP interpreter to use, and customize its behavior by specifying the options and arguments to be passed to the PHP executable.

1. Set the path to the ParaTest binary file for PhpStorm in the Test Runner settings by either of the following ways:

   • In the Settings dialog (), go to PHP | Test Frameworks and set the Default ParaTest binary field.

     

   • For existing run configurations, open the Run Configuration dialog, select the Use ParaTest checkbox and set the path to the file in the field.

     

   note

   If you have ParaTest configured and installed together with PHPUnit in the compose.json file, the path to the ParaTest binary will be set automatically in the run configurations and settings. However, you still need to select the Use ParaTest checkbox to enable the parallel test run configuration.

2. In the Project tool window, right-click the folder to run the tests from and select the Run <test_name> (PHPUnit) with ParaTest option from the context menu.

   

   Alternatively, right-click the phpunit.xml config file and select the Run `phpunit.xml (PHPUnit)` with ParaTest option from the context menu.

1. Run the tests.

2. On the Test Runner tab, press the toggle button on the toolbar:

   

3. Optionally, click the button and set the time delay for launching the tests upon the changes in the code: