BehatBundle for Symfony2¶

Behat Installation¶

In order to be able to use BehatBundle, you need to install Behat first.

$ pear channel-discover pear.behat.org
$ pear install behat/behat

<?php # app/AppKernel.php

//...

if ('test' === $this->getEnvironment()) {
    // don't autoload Symfony2 classes, as they are
    // already loaded by the Symfony2 itself
    if (!defined('BEHAT_AUTOLOAD_SF2')) define('BEHAT_AUTOLOAD_SF2', false);
    require_once 'behat/autoload.php';
}

//...

[gherkin]
    git=https://github.com/Behat/Gherkin.git
    target=/behat/gherkin

[behat]
    git=https://github.com/Behat/Behat.git
    target=/behat/behat

$ bin/vendors install

$loader->registerNamespaces(array(
//...
    'Behat\Gherkin' => __DIR__.'/../vendor/behat/gherkin/src',
    'Behat\Behat'   => __DIR__.'/../vendor/behat/behat/src',
//...
));

Bundle Installation & Setup¶

Now it’s time to install and setup BehatBundle itself.

1. Add BehatBundle repository address to your deps file:

   [BehatBundle]
       git=https://github.com/Behat/BehatBundle.git
       target=/bundles/Behat/BehatBundle
   

2. Add it to app/autoload.php:

   $loader->registerNamespaces(array(
   //...
       'Behat\BehatBundle' => __DIR__.'/../vendor/bundles',
   //...
   ));
   

3. And enable it in your app kernel (app/AppKernel.php):

   if ('test' === $this->getEnvironment()) {
       $bundles[] = new Behat\BehatBundle\BehatBundle();
   }
   

4. Run bin/vendors install once again:

$ bin/vendors install

Prepare Your Bundle for Behat¶

In order for Behat to be able to test your bundle, you need to do two things:

1. Create Features folder in your bundle directory
2. Create custom FeatureContext class in your bundle’s Features folder

BehatBundle can do this for you with one simple command:

$ app/console -e=test behat --init @AcmeDemoBundle

It will init features suite structure in your bundle and create basic FeatureContext for you.

In contrast with Behat itself, which runs suite in context of whole application, BehatBundle runs bundle-oriented suites. Everything in Symfony2 is a bundle and every bundle in your application could have feature suite. BehatBundle makes it extremely easy to test them with Behat.

Bundle’s FeatureContext Class¶

Every bundle in your application could have its own feature suite. And every feature suite has its own independent context class (FeatureContext).

For example, created in previous chapter context class would look like this:

<?php # src/Acme/DemoBundle/Features/Context/FeatureContext.php

namespace Acme\DemoBundle\Features\Context;

use Behat\BehatBundle\Context\BehatContext,
    Behat\BehatBundle\Context\MinkContext;
use Behat\Behat\Context\ClosuredContextInterface,
    Behat\Behat\Context\TranslatedContextInterface,
    Behat\Behat\Exception\PendingException;
use Behat\Gherkin\Node\PyStringNode,
    Behat\Gherkin\Node\TableNode;

//
// Require 3rd-party libraries here:
//
//   require_once 'PHPUnit/Autoload.php';
//   require_once 'PHPUnit/Framework/Assert/Functions.php';
//

/**
 * Feature context.
 */
class FeatureContext extends BehatContext //MinkContext if you want to test web
{
//
// Place your definition and hook methods here:
//
//    /**
//     * @Given /^I have done something with "([^"]*)"$/
//     */
//    public function iHaveDoneSomethingWith($argument)
//    {
//        $container = $this->getContainer();
//        $container->get('some_service')->doSomethingWith($argument);
//    }
//
}

It’s your own class from now on. You can require other libraries, describe bundle step definitions and hooks here. Feel like home ;-)

As this doc intro states: “BehatBundle teaches Behat everything about your Symfony2 app”. But how you can use all these knowledge in your contexts? Behat\BehatBundle\Context\BehatContext and Behat\BehatBundle\Context\MinkContext from which ones you should inherit your own contexts, provide set of useful methods, that you could use in your suite definitions or hooks:

/**
 * @Given /^I have done something with "([^"]*)"$/
 */
public function iHaveDoneSomethingWith($argument)
{
    // get your app service container:
    $container = $this->getContainer();
    $container->get('some_service')->doSomethingWith($argument);

    // get your app kernel:
    $kernel = $this->getKernel();
    $bundles = $kernel->getBundles();
}

<?php

namespace Acme\DemoBundle\Features\Context;

use Behat\BehatBundle\Context\BehatContext;
use Symfony\Component\HttpKernel\KernelInterface;

class FeatureContext extends BehatContext
{
    public function __construct(KernelInterface $kernel)
    {
        // ...
    }
}

Mink Integration: MinkContext¶

By default, BehatBundle creates FeatureContext, that inherit from simplest Behat\BehatBundle\Context\BehatContext class. But if you want to test your app with Mink web acceptance testing framework - you should extend Behat\BehatBundle\Context\MinkContext instead.

After changing base class for your bundle context from Behat\BehatBundle\Context\BehatContext to Behat\BehatBundle\Context\MinkContext you’ll be able to use out-of-the box Mink steps in your bundle features. To check all available steps, run:

$ app/console -e=test behat @AcmeDemoBundle --definitions

or even for specific language:

$ app/console -e=test behat @AcmeDemoBundle --definitions --lang=ru

All your mink steps will be executed against default Mink session (symfony by default).

# app/config/config_test.yml

mink:
  default_session:  goutte
  goutte:           ~

If you need to run javascript or UI related steps, you’ll need to tag your UI/JS scenario with @javascript tag:

...

@javascript
Scenario: Drag'n'Drop scenario
  ...

Default session for such scenario will become sahi, giving you access to all js-specific functionality of the Mink.

# app/config/config_test.yml

mink:
  browser_name:  chrome
  sahi:          ~

# app/config/config_test.yml

mink:
  javascript_session:  zombie
  zombie:              ~

Also, you can switch all scenarios inside single feature to @javascript session by tagging feature instead:

@javascript
Feature: My web feature
  In order to ...
  As a ...
  I need to ...

  Scenario: Scenario 1
    ...

  Scenario: Scenario 2
    ...

If you want to switch to specific Mink session instead, you can do it with @mink:... tag:

...

@mink:zombie
Scenario: Drag'n'Drop in Zombie.js
  ...

Running Features¶

The simplest possible way to run all features in your project is to call behat command without arguments:

$ app/console -e=test behat

This way, BehatBundle will run features suite from every registered bundle, that has one.

More proper way is to run specific bundle feature suite. You can do it with either full path to bundle:

$ app/console -e=test behat src/Acme/DemoBundle

or with full bundle name, prefixed with @:

$ app/console -e=test behat @AcmeDemoBundle

And of course, BehatBundle supports specific feature call:

$ app/console -e=test behat src/Acme/DemoBundle/Features/my.feature

Or even specific scenario call:

$ app/console -e=test behat src/Acme/DemoBundle/Features/my.feature:5

$ app/console -e=test behat @AcmeDemoBundle/my.feature:5

Also, BehatBundle supports almost all configuration options, that Behat does.

Read More About Behat & Mink¶

If you don’t know what Behat is and how it could help your development become more successfull, read: Behat Quick Intro.

If you wan to describe your web application with Mink steps, you should read about Mink on its official site.