Codeception

Download and install Codeception manually

• Download codeception.phar at the Codeception Installation page and save it under the root of the project where Codeception will be later used.

  You can also save codeception.phar in a different location and configure it as an include path. In either case, PhpStorm will include codeception.phar in indexing, so it will successfully resolve references to the Codeception classes and thus provide you with full coding assistance.

Download and install Codeception with Composer

1. Inside composer.json, add the codeception/codeception dependency record to the require or require-dev section. Press Ctrl+Space 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 Alt+Enter and select whether you want to install a specific dependency or all dependencies at once.

Learn more about installing Codeception from Codeception Official website.

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

Generate a codeception.yml configuration file

Having installed Codeception, you need to initialize it in your project by generating a codeception.yml configuration file.

• Open the built-in PhpStorm Terminal Alt+F12 and at the command prompt type one of the following commands depending on the installation mode and your current operating system:

  • If you installed codeception.phar in your project, type php codecept.phar bootstrap for Windows and macOS or codecept bootstrap for Linux.

  • If you installed Codeception globally through Composer, type codecept bootstrap for all platforms.

Configure Codeception automatically

1. Store the codeception.yml or codeception.yml.dist configuration file under the project root.

2. Install Codeception with Composer.

PhpStorm will create the local framework configuration on the Test Frameworks page and the Codeception run/debug configuration.

Configure Codeception manually

1. In the Settings/Preferences dialog (Ctrl+Alt+S), 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, see Default project CLI interpreters for details.

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

     

2. In the Codeception Library area, specify the location of the Codeception executable file or codeception.phar archive in the target environment. For example, if you installed Codeception through Composer, the executable file is stored in vendor/bin/codecept. Click next to the Path to Codeception directory or phar file field. PhpStorm detects the version of Codeception and displays it below the field.

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

   By default, Codeception looks for a codeception.yml configuration file in the project root folder. You can appoint a custom configuration file.

   • Clear the Default configuration file checkbox to have Codeception use the codeception.yml configuration file from the project root folder. If no such file is found, test execution fails, therefore it may be more reliable to specify the configuration file explicitly.

   • Select the Default configuration file checkbox to specify your own YML configuration file. This file will be later used as default in all Codeception run/debug configurations.

     In the field, specify the location of the configuration file to use. Type the path manually or click and choose the file in the dialog that opens.

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

   • From the main menu, choose File | New. Then, choose either PHP Test | Codeception Unit Test or PHP Test | Codeception Functional Test from the context menu.

   • In the Project tool window, press Alt+Insert or right-click the PHP class to be tested and choose either New | PHP Test | Codeception Unit Test or New| PHP Test | Codeception Functional Test.

   • In the editor of the PHP class to be tested, position the caret at the definition of the class. Then, press Alt+Enter 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 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 either Codeception Unit or Codeception Functional 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 (for Codeception Unit Test) or <production class>Cest.php (for Codeception Functional Test) .

   • 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 tests value specified in the codeception.yml 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, or the namespace value specified in the codeception.yml configuration file.

   • 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 details, see Navigate between a test and its test subject.

Run or debug Codeception tests

• 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/debug test session with it.

Save an automatically generated default configuration

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

Run or debug tests through a previously saved run/debug configuration

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

Create a custom run/debug configuration

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 Codeception from the list.

2. In the Codeception 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. 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: