PhpStorm 2017.1 Help

Codeception

File | Settings | Languages and Frameworks | PHP | Codeception for Windows and Linux
PhpStorm | Preferences | Languages and Frameworks | PHP | Codeception for macOS
Ctrl+Alt+S

/help/img/idea/2017.1/settings.png

This page is available only when the PHP and Codeception plugins are installed and enabled. The plugins are bundled with PhpStorm and activated by default. If the plugins are not activated, enable them on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.

Before you start, make sure the PHP interpreter is configured in PhpStorm on the PHP page, as described in Configuring Local PHP Interpreters and Configuring Remote PHP Interpreters.

On this page, configure installations of the Codeception framework available through configured local and remote PHP interpreters and thus enable behaviour-driven development in PhpStorm. The page consists of two panes:

PHP interpreters

The central pane of the page shows a list of configured PHP interpreters that are associated with Codeception installations. The list contains at least one item (Local) which cannot be removed. The contents of the right-hand pane depend on the type of the selected interpreter.

  • To add a remote interpreter to the list, click /help/img/idea/2017.1/new.png on the toolbar of the pane and choose the relevant interpreter in the Codeception by remote interpreter dialog that opens. Then specify the details of the Codeception installation to use with this interpreter.
  • To remove a remote interpreter from the list, select the relevant interpreter and click /help/img/idea/2017.1/delete.png. The Codeception configuration associated with the interpreter is also removed.

See Configuring Remote PHP Interpreters for details.

Codeception configuration

ItemDescription
CLI Interpreter This area shows:
  • The remote PHP CLI Interpreter to use Codeception with. The field is read-only, to update the chosen interpreter configuration or create a new one, click the /help/img/idea/2017.1/browseButton.png whereupon PhpStorm brings you to the Interpreters dialog box.
  • The Path Mappings between your local sources and the sources inside the Vagrant instance, or the Docker container, or on the remote host.
  • The Docker container settings that will be used to start the container from an image. These settings may include the volume configuration, the exposed port, the network, etc.
In most cases, PhpStorm detects the path mappings and the container settings and fills in all the fields automatically. Alternatively, click the /help/img/idea/2017.1/browseButton.png next to the field in question and specify the settings manually. See Configuring Remote PHP Interpreters for details.
Codeception Library In this area, specify the Codeception installation to use.
  • Path to Codeception executable: in this text box, specify the location of the codeception.phar archive or the folder with the Codeception executable file.
  • Codeception releases: click this link to navigate to the Codeception repository on github where you can choose the relevant version of codeception.phar archive.
  • Codeception version: this read-only field shows the version of the specified Codeception installation. PhpStorm detects the version when you click the Refresh icon /help/img/idea/2017.1/refresh.png. The default value is Not installed.
Test Runner In this 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.

  • Default configuration file: select this check box to specify your own .yml configuration file. This file will be later used as default in all Codeception run/debug configurations.

    In the text box, specify the location of the configuration file to use. Type the path manually or click the /help/img/idea/2017.1/browseButton.png button and choose the file in the dialog box that opens.

    Clear the check box 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.

See Also

Last modified: 19 July 2017