PhpStorm 2019.3 Help

Generating PHP Tests

You can have the test class stubs generated automatically based on the PHP classes that are subject for testing. PhpStorm provides this ability for the PHPUnit, Codeception, and PHPSpec test frameworks. If you are using Behat framework, you have to create tests manually.

A Test class is a PHP class with its name derived from the production class name. For example, if the class to test is MyClass.php, PhpStorm will automatically compose the name for the corresponding PHPUnit test class as <MyClass>Test.php.

PhpStorm can generate tests for the classes that are defined in separate files as well as for the classes that are defined within a single PHP file. In the latter case, for each generated test class PhpStorm will create a separate file.

  1. Do any of the following:

    • From the main menu, select File | New. Then, choose PHP Test | Test or PHP Test | <Test framework> Test from the popup menu.

    • In the Project tool window, press Alt+Insert or right-click the PHP class to be tested and choose New | PHP Test | Test or PHP Test | <Test framework> Test from the selection context menu.

    • In the editor of the PHP class to be tested, position the caret inside the definition of the class. Then, choose Go To | Test from the context menu or press Ctrl+Shift+T 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, position the caret within the method declaration. The chosen method will be automatically selected in the Generate test methods for area of the Create New PHP Test dialog.

    The Create New PHP Test dialog opens:

    create new php test phpunit dialog
  2. In the Create New PHP Test dialog, specify the following data:

    1. The test file template based on which the test class will be generated. PhpStorm provides the built-in file templates for generating test classes with the following supported test frameworks: PHPUnit, Codeception, and PHPSpec.

    2. The name of the test class. PhpStorm automatically composes the name from the production class name according to the naming conventions of the chosen test framework. For example, if the class to test is MyClass.php, PhpStorm will automatically compose the name for a PHPUnit test class as <MyClass>Test.php.

    3. The folder for the test class, 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 value provided in the configuration file of the corresponding test framework. To use path completion, press Ctrl+Space and choose the path from the list.

    4. The namespace the test class will belong to. PhpStorm can complete the namespace automatically based on the configured PSR package prefixes and the values specified in the framework-specific configuration file. To use namespace completion, press Ctrl+Space and choose the relevant namespace from the list.

    5. In the Generate test methods for area, select the checkboxes next to the production class methods you want to generate test method stubs for. 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.

When the test is ready, you can navigate back to the production class by choosing Navigate | Go to Test Subject. For details, see Navigating between test and test subject.

Last modified: 20 February 2020