MinkBundle for Symfony2¶

MinkBundle is Symfony2 bundle (plugin) created in order to give ability to write functional tests for Symfony2 applications.

Mink Installation¶

In order to be able to use MinkBundle, you need to install Mink first.

Method #1 (PEAR)¶

The simplest way to install Mink is through PEAR:

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

Now you should include Mink’s autoloader in your AppKernel::registerBundles() method (for test environment only):

<?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 'mink/autoload.php';
}

//...

Method #2 (Git)¶

Add next lines to your deps file:

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

By default, MinkBundle will use custom SymfonyDriver. But if you want to use GoutteDriver, you’ll need to also add:

[goutte]
    git=https://github.com/fabpot/Goutte.git
    target=/goutte
[zend]
    git=https://github.com/zendframework/zf2.git
    target=/zend

And if you want to use SahiDriver, you’ll need to add another 2 lines:

[buzz]
    git=https://github.com/kriswallsmith/Buzz.git
    target=/buzz
[SahiClient]
    git=https://github.com/Behat/SahiClient
    target=/behat/sahi

Now run:

bin/vendors install

in order to install all missing parts.

It’s time to setup your app/autoload.php:

$loader->registerNamespaces(array(
//...
    'Behat\Mink'       => __DIR__.'/../vendor/behat/mink/src',

    // if you want to use GoutteDriver
    'Goutte'           => __DIR__.'/../vendor/goutte/src',
    'Zend'             => __DIR__.'/../vendor/zend/library',

    // if you want to use SahiDriver
    'Behat\SahiClient' => __DIR__.'/../vendor/behat/sahi/src',
    'Buzz'             => __DIR__.'/../vendor/buzz/lib',
//...
));

Bundle Installation & Setup¶

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

Add MinkBundle repository address to your deps file:

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

Add it to app/autoload.php:

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

And to app/AppKernel.php:

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

Run bin/vendors install

Bundle Configuration¶

Now, as you’ve setted up the bundle, you should configure it:

# app/config/config_test.yml
mink:
    base_url:   http://your_app.dev/app_test.php

By default, MinkBundle uses only SymfonyDriver session. If you want to use GoutteDriver, SahiDriver or ZombieDriver sessions - you should specify them in config explicitly:

# app/config/config_test.yml
mink:
    base_url:   http://your_app.dev/app_test.php
    goutte:     ~
    sahi:       ~
    zombie:     ~

Out of the box, Mink will use SymfonyDriver session as default one. This means that any session call without argument:

$this->getMink()->getSession()->...;

will be done against default Symfony2 test.client library. If you want to change this, use default_session configuration option:

# app/config/config_test.yml
mink:
    base_url:           http://your_app.dev/app_test.php
    default_session:    goutte
    goutte:             ~

Note

Note, that we do our configuration in config_test.yml. It’s convenient way to configure MinkBundle, because test environment has all the needed requirements for Mink and default SymfonyDriver enabled out of the box.

Available Options¶

MinkBundle provides bunch of useful options for you to configure Mink’s behavior. You can use them to make your testing experience even more smooth:

base_url - most important one. Defines base url for your application. Used heavily inside BehatBundle and can be used inside your test cases to be able to use relative paths in your web test cases.
default_session - defines session name, which will be used by default. It’s symfony out of the box.
javascript_session - defines session name, which will be used for @javascript tagged Behat scenarios.
browser_name - specifies browser to be used with sahi session.
show_cmd - specified console command to run on “show” step in BehatBundle. For Mac OS, it could be something like open %s.

Writing your first test¶

Now, as you’ve configured MinkBundle, you can use the special MinkTestCase, provided with it as a base class for your tests:

<?php

namespace Acme\AcmeBundle\Tests;

use Behat\MinkBundle\Test\MinkTestCase;

class AcmeWebTestCase extends MinkTestCase
{
    protected $base;

    protected function setUp()
    {
        $this->base = $this->getKernel()
            ->getContainer()
            ->getParameter('behat.mink.base_url');
    }

    // write functional tests
}

Base Behat\MinkBundle\Test\MinkTestCase class provides an easy way to get $mink and specific session instances in your tests:

symfony session will be used by default, so getSession() without parameters will return test.client enabled session for you:

$session = $this->getSession();
// or you can use the more verbose call:
$session = $this->getSession('symfony');

If you want to test your application with real HTTP requests, you should use goutte session instead (should be enabled in config_test.yml first):
```
$session = $this->getSession('goutte');
```
If you want to test your app running in real browser - use sahi session (should be enabled in config_test.yml first):
```
$session = $this->getSession('sahi');
```

If you want to test your app running in zombie.js browser - use zombie session (should be enabled in config_test.yml first):
```
$session = $this->getSession('zombie');
```

After you’ve choosen needed session - use it to perform actions on your Symfony2 app:

$session
    ->visit($this->base.'/_behat/tests/page/page1');
$this->assertTrue(
    $session->getPage()->hasContent('Page N1')
);

$session->getPage()->clickLink('p10');

For example, form specification with symfony session will look like that:

public function testForms()
{
    $session = $this->getSession();

    $session->visit($this->base.'/_behat/tests/form');
    $page = $session->getPage();

    // 3. FILL FORMS:

    $page->fillField('name', 'ever');
    $page->fillField('age', '23');
    $page->selectFieldOption('speciality', 'programmer');
    $page->pressButton('Send spec info');

    // 4. ASSERT RESPONSE:

    $this->assertTrue(
        $page->hasContent('POST recieved')
    );
    $this->assertTrue(
        $page->hasContent('ever is 23 years old programmer')
    );
}