Generate 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.

After creating the test, you can quickly navigate between the test and its subject.

Add a new test

Do any of the following:
- In the editor of the PHP class to be tested, place the caret at the class definition. Then, press Alt+Enter and select Create New PHP 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 method list of the Create New PHP Test dialog.
- Go to File | New | PHP Test | <Test framework> Test.
- In the Project tool window, press Alt+Insert or right-click the PHP class to be tested and choose New | PHP Test | <Test framework> Test from the selection context menu.
The Create New PHP Test dialog opens:
In the Create New PHP Test dialog, specify the following:
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.
  When editing the test class name, you can press the up or down arrow keys to quickly switch between the test frameworks.
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. 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.

Navigate between a test and its test subject

Open a test class or test subject class in the editor.
From the editor context menu, choose Go To | Test Subject or press Ctrl+Shift+T.
If there's only one test for this class, the IDE will navigate you to it right away. Otherwise, you will be prompted to select the necessary test from a popup or create a new test.

In the PHP context, when working with PHPUnit and Codeception tests, you can use the @covers annotation to maintain the link between the test class or method and their test subjects.

This way, it will be possible to navigate between the test and test subject even if their names do not follow the PHPUnit naming convention:

            class Person {
                    public function getAge() {}
            }

            /** @covers Person */
            class TestForPersonClass extends TestCase {

                /** @covers Person::getAge */
                public function testCorrectAgeIsReturned() {}
            }
        

Last modified: 17 June 2024