Skip to end of metadata
Go to start of metadata

 

Behat is a BDD (behavior driven development) framework for PHP. With BDD, you write human-readable stories that describe the behavior of your application. These stories can then be auto-tested against your application. This tutorial describes how to install, configure and use Behat right from the PhpStorm IDE.

Behat support is currently available in PhpStorm 8 EAP.

Prerequisites

To make use of Behat, we first have to install it on our system. Read more about Behat installation in official documentation.

Please note that PHP interpreter should have mbstring extension installed (or just compiled with --enable-mbstring option) to execute Behat tests.

Installing Behat via Composer

A Composer package for Behat is available. A dependency can be added to composer.json using Composer Support in PhpStorm (recommended) or manually.

Use the Composer | Add dependency... context menu in your project and install behat/behat package:

Installing Behat via Phar package

You can either download behat.phar package from Behat GitHub repository manually, or automatically install it from Settings | PHP | Behat | Download behat.phar from...

Run Configuration for Behat

Behat run configurations can be set in the same way as PHPUnit’s. The usual testing workflow (running with run action, UI for running tests and displaying results) is supported.

Setting Behat run configuration via Edit Configurations... action

1. New Run Configuration for Behat can be created either in Run | Edit configurations... menu, or with the same action from the toolbar:

2. Add a new configuration with  button and select Behat

3. Provide the path to the directory that contains test scenarios (/Users/user/PhpStormProjects/Behat/features in our case). Test scope can be defined as a Directory, File, Scenario or Defined in configuration file. There are many additional options which can be configured in this dialog (such as alternative Behat configuration file, test runner options, command line options, or actions to be performed before launch).

4. If you haven't configured the path to Behat directory or behat.phar file before, PhpStorm will offer you to do so with the Fix button in the run configuration dialog. Provide the path to Behat and default configuration file (if needed).

Behat configuration can be always changed in Settings | PHP | Behat.

Alternatively, you can use Behat via Remote Interpreter. The configuration process is similar with the only difference that you should have remote PHP interpreter configured.

Setting Behat run configuration via file/folder context action

Depending on your workflow, in order to create run configuration on the fly you can just invoke the context action Create Run Configuration | Folder name (with Behat icon), or create and run it straight away with Run | Folder name (with Behat icon) for folders in Project Tool Window:

The same actions are available in the Run | Run menu (Alt + Shift + F10 / Ctrl + Alt + R):

It works the same way for context actions inside a *.feature file in the editor (creating run configuration or running all scenarios from file or single scenario from file):

Running Behat tests and evaluating results

As stated earlier, usual testing workflow (running with run action, UI for running tests and displaying results) is supported similar to the one for PHPUnit.

That means that as soon as run configuration is created (or you are running/creating test scenarios for folder/file from the context menu action), your tests will run and results will be displayed in the test runner tab:

!

From the test runner tab you can navigate to the source code of the test, sort or filter results of tests, and much more.

Behat Intellisense

Resolve from step in Gherkin file to Context file

Press and hold Ctrl / Cmd hotkey and hover over a step in Gherkin file: the relevant method from the Context file will be highlighted. Click on the displayed link to navigate to the declaration. You can also navigate to the method declaration in the Context file with Ctrl+B / Cmd-B when the editor caret is placed at the step in Gherkin file.

As soon as a navigation action is invoked, you are navigated to the very method in Context file (FeatureContext.php in our case):

Find Usages from Context file to usages in Gherkin files

From any Context file, you can find all the usages of a method in all *.feature files. Just place the caret at the method name and press Alt+F7 (or select Find Usages from the context menu). You will see all usages of the desired method in project files:

Keyword and step completion

Any keywords and steps are completed with the basic code completion action (Ctrl+Space) in *.feature files. All steps are indexed from the current project and always up-to-date.

Generation for undefined steps

If any of the steps in your *.feature file are undefined, PhpStorm will detect this, and will immediately highlight the step as undefined step reference:

Press Alt+Enter (or click the light bulb) to get a list of relevant quick-fixes, then select Create Step Definition. You will be prompted to choose the step definition file from your project or create a new one:

If you choose an existing step definition file, step definition will be immediately created there with a relevant PHPDoc:

If you would like to create a new file, this option should be selected from the list on the previous step:

In the Create New Step Definition File dialog, enter the file name, file type and file location:

After as you have set these options, a new step definition file will be created:

Your input is welcome

If you have any bugs to report and/or feature requests to add related to Behat functionality, please do so in our Issue Tracker.

  • No labels