PhpStorm 2016.3 Help

Behat

File | Settings | Languages and Frameworks | PHP | Behat for Windows and Linux
PhpStorm | Preferences | Languages and Frameworks | PHP | Behat for OS X
Ctrl+Alt+S

/help/img/idea/2016.3/settings.png

This page is available only when the PHP and Behat 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 Enabling PHP Support.

On this page, configure installations of the Behat 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 Behat installations. The list contains at least one item (Local) which cannot be removed.

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

See Configuring Remote PHP Interpreters for details.

Behat configuration

ItemDescription
CLI Interpreter In this area, PhpStorm displays the remote PHP interpreter to use Behat with and the path mappings configured for this interpreter. If the selected remote PHP interpreter is running on a Docker container or in a Vagrant instance, PhpStorm also displays the path to this container or the Vagrant instance folder which points at the environment you are going to use. See Configuring Remote PHP Interpreters for details.

The field is read-only, to update the chosen interpreter configuration or create a new one, click the /help/img/idea/2016.3/browseButton.png whereupon PhpStorm brings you to the Interpreters dialog box.

Behat Library In this area, specify the Behat installation to use.
  • Path to Behat executable: in this text box, specify the location of the behat.phar archive or the folder with the Behat executable file. Behat does not necessarily have to be installed under the current project root. You can type the path manually or click the /help/img/idea/2016.3/browseButton.png button and choose the relevant location in the dialog box that opens.
  • Download behat.phar from: click this link to have PhpStorm download the behat.phar archive from GitHub. This approach works only if you have already an account on GitHub and you have configured access to this account in PhpStorm, see Registering GitHub Account in PhpStorm.
  • Behat version: this read-only field shows the version of the specified Behat installation. PhpStorm detects the version when you click the Refresh icon /help/img/idea/2016.3/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, 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.

  • Default configuration file: select this check box to specify your own .yml configuration file. This file will be later used as default in all Behat 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/2016.3/browseButton.png button and choose the file in the dialog box that opens.

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

See Also

Last modified: 1 December 2016