Behat

Download Behat installation package manually

• Download behat.phar from the Behat Downloads page and save it on your computer:

  • If you need full coding assistance in addition to the ability of running Behat tests, store behat.phar under the root of the project where Behat will be later used.

  • If you only need to run Behat tests and you do not need any coding assistance, you can save behat.phar outside the project.

Download and install Behat with Composer

1. Inside composer.json, add the behat/behat 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.

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

Configure Behat automatically

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

2. Install Behat with Composer.

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

Configure Behat 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 Behat with a remote PHP interpreter, choose one of the configurations in the dialog that opens:

     

2. In the Behat Library area, specify the location of the Behat executable file or behat.phar archive.

   Click next to the Path to Behat directory or phar file field. PhpStorm detects the version of Behat 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, Behat looks for a behat.yml configuration file in the project root folder or in the config folder. You can appoint a custom configuration file.

   • Clear the Default configuration file checkbox to have Behat use the behat.yml configuration file from the project root folder or from the config 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 Behat 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.

Run or debug Behat tests

• In the Project tool window, select the feature file to run your tests from and choose Run '<feature file>' or Debug '<feature file>' 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.

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

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