Generate PHP tests

1. In the editor, place the caret at the PHP class or within the method declaration for which you want to create a test, press AltEnter, and select Create New PHP Test.

   tip

   Alternative ways of revoking the Create New PHP Test action are:

   • In the main menu, go to File | New | PHP Test | <Test framework> Test.

   • In the Project tool window, press AltInsert 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:

   

2. In the Create New PHP Test dialog, specify the following:

   • Test file template: the framework 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, Pest, Codeception, and PHPSpec.

   • Name: PhpStorm automatically creates the name from the production class name according to the naming conventions of the chosen test framework. For example, for a PHPUnit test file, it's <MyClass>Test.php.

     tip

     When editing the test class name, you can press the up or down arrow keys to quickly switch between the test frameworks.

   • Directory: 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 CtrlSpace and choose the path from the list.

   • Namespace: PhpStorm can complete the namespace automatically based on the configured PSR package prefixes and the values specified in the framework-specific configuration file. To invoke namespace completion, press CtrlSpace.

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

1. Open a test class or test subject class in the editor.

2. From the editor context menu, choose Go To | Test Subject or press CtrlShift0T.

   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() {}
}