Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

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.

Error rendering macro 'toc' : [com.ctc.wstx.exc.WstxLazyException] com.ctc.wstx.exc.WstxParsingException: Undeclared namespace prefix "fb" at [row,col {unknown-source}]: [3,372]

Prerequisites

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

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 on 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. 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 path to the directory which 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, actions to be performed before launch).

4. If you haven't configured path to Behat directory or behat.phar file before, PhpStorm will offer you to do so with a Fix button in the run configuration dialog. Provide 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, configuration is similar with the only difference that you should have remote PHP interpreter configured.

Setting Behat run configuration via file/folder context action

Apart from standard workflow which involves providing paths to test scenarios manually, you can invoke 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:

Same actions are available in Run | Run menu (Alt + Shift + F10 / Ctrl - Alt - R):

It works in the same way for context action inside *.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 the run configuration is created (or you are running 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 source of the test, sort or filter results of tests, and much more.

Behat Intellisense

Resolve from step in Gherkin file to Context file

Hover step in Gherkin file with Ctrl / Cmd hotkey pressed and get relevant method from the Context file highlighted. Clicking on appeared link immediately navigates you to the declaration. You can also navigate to the method declaration in the Context file with Ctrl+B / Cmd-B with an editor caret placed at the step in Gherkin file.

As soon as 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 the method in all *.feature files. Just place a caret at the method name and invoke Alt-F7 (or context menu action Find Usages). You will see all the usages of desired method in project files:

Keyword and step completion

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

Generation for undefined steps

If any of steps in your *.feature file are undefined, the PhpStorm will spot that in a moment highlighting step in question with undefined step reference inspection result:

Press Alt+Enter (or click on the light bulb) to get list of relevant quick fixes, and select the one named Create Step Definition.

You will be immediately offered to choose step definition file from your project or create a new one.

In case of choosing already existing step definition file, step definition will be immediately created there with relevant PHPDoc:

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

Create New Step Definition File dialog will appear providing you an opportunity to set a file name, file type and file location:

As soon as you are done with these options, a new step definition file will be created:

Make sure to report any bugs and feature requests related to Behat functionality to the Issue Tracker.

  • No labels