PhpStorm 2023.3 Help

Codeception

PhpStorm provides support for running unit, functional, and acceptance tests with the Codeception test framework, versions 2.2.0 and later.

Before you start

Make sure the PHP interpreter is configured in PhpStorm on the PHP page, as described in Configure local PHP interpreters and Configure remote PHP interpreters.

Download and install Codeception

Before you start, make sure Composer is installed on your machine and initialized in the current project as described in Composer dependency manager.

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 key. To get code completion for the package name and version, press Ctrl+Space.

  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.

Clicking the Settings button next to the package record in the composer.json editor gutter will take you to the corresponding Settings page where you can configure Codeception manually.

Gutter icon for codeception settings in composer.json

Integrate Codeception with PhpStorm in a project

If you use a local PHP interpreter, PhpStorm performs initial Codeception configuration automatically. In the case of remote PHP interpreters, manual Codeception configuration is required.

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.dist.yml configuration file under the project root.

  2. Install Codeception with Composer.

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

Codeception configurations

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

Codeception run/debug configurations

Configure Codeception manually

  1. In the Settings dialog (Ctrl+Alt+S) , go to PHP | Test Frameworks.

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

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

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

      ps_settings_php_test_frameworks_codeception_choose_php_interpreter.png
  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 the Reload button 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 or codeception.dist.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 or codeception.dist.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 the Browse button and choose the file in the dialog that opens.

Generate a Codeception test for a class

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

    • Go to 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, place 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, place the caret within the method declaration. The chosen method will be automatically selected from the list of methods in the Create New PHP Test dialog.

  2. The Create New PHP Test dialog opens.

    the Create new codeception test dialog

    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 the Browse button 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 more information, refer to Navigate between a test and its test subject.

Run and debug Codeception tests

For more information about writing Codeception tests, refer to Unit Tests, Acceptance Tests, and Functional Tests.

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:

    ps_test_frameworks_codeception_launch_tests.png

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

Save an automatically generated default configuration

  • After a test session is over, choose Save Configuration from the context menu of the respective run/debug configuration in the run widget.

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

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

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, go to Run | Edit Configurations in the main menu, then click Add icon 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.

Monitor test results

PhpStorm shows the tests execution results in the Test Runner tab of the Run tool window.

ps_test_result_codeception.png

The tab is divided into 2 main areas:

  • The left-hand area lets you drill down through all unit tests to see the succeeded and failed ones. You can filter tests, export results, and use the context menu commands to run specific tests or navigate to the source code.

  • The right-hand area displays the raw Codeception output.

Run Codeception tests automatically

You can have PhpStorm re-run tests automatically when the affected code is changed. This option is configured per run/debug configuration and can be applied to a test, a test file, a folder, or a composite selection of tests, depending on the test scope specified in this run/debug configuration.

  1. Run the tests.

  2. On the Run toolbar, click Rerun Automatically.

    ps_phpunit_enable-auto-test.png
  3. Optionally, set a time delay for launching the tests upon the changes in the code. To do so, on the Run toolbar, click and select Test Runner Settings | Set AutoTest Delay.

    ps_phpunit_set-auto-test-delay.png
Last modified: 20 February 2024