SymfonyExtension for Behat

SymfonyExtension is a Behat extension that provides deep integration with Symfony (^6.0 and ^7.0) and the Mink driver for Symfony applications. It enables a more seamless testing experience by allowing you to:

• Define your Behat contexts as regular Symfony services.
• Leverage Symfony's autowiring and autoconfiguring capabilities for your contexts.
• Test your Symfony application directly without the need to set up a web server.

The extension provides an isolated driver for testing Symfony applications via Mink.

Installation

1. Install the required forks of Mink and the BrowserKit driver:

composer require --dev behat/mink friends-of-behat/mink-extension behat/mink-browserkit-driver

2. Enable the symfony session in your behat.yaml:

default:
    extensions:
        Behat\MinkExtension:
            sessions:
                symfony:
                    symfony: ~

Usage

Inject the Behat\Mink\Session into your context constructor.

Warning: Calling any method on Mink-related services directly inside the constructor is not permitted and will cause errors. You must use the injected session instance within your step definitions.

For legacy Symfony 3 projects:

1. Install via Composer:

composer require --dev friends-of-behat/symfony-extension:^2.0

2. Enable the extension in behat.yml or behat.yml.dist:

default:
    extensions:
        FriendsOfBehat\SymfonyExtension: ~

3. Register the bundle in app/AppKernel.php:

public function registerBundles()
{
    $bundles = array(/* ... */);
    
    if ('test' === $this->getEnvironment()) {
        $bundles[] = new \FriendsOfBehat\SymfonyExtension\Bundle\FriendsOfBehatSymfonyExtensionBundle();
    }
}

4. Create the Behat directory:

mkdir -p tests/Behat

5. Configure autowiring in app/config/config_test.yml:

services:
    _defaults:
        autowire: true
        autoconfigure: true

    Tests\Behat\:
        resource: '../../tests/Behat/*'

To use SymfonyExtension 2.0, you must update your Symfony kernel configuration:

1. Register the \FriendsOfBehat\SymfonyExtension\Bundle\FriendsOfBehatSymfonyExtensionBundle bundle in your kernel specifically for the test environment.
2. Ensure your context service definitions are loaded in the test environment.

If your composer.json contains friends-of-behat/mink-browserkit-driver or friends-of-behat/mink, you must replace them with the official Behat versions to ensure compatibility with SymfonyExtension 2.x.

Remove:

• friends-of-behat/mink-browserkit-driver
• friends-of-behat/mink

Add:

• behat/mink-browserkit-driver
• behat/mink

composer remove friends-of-behat/mink-browserkit-driver friends-of-behat/mink
composer require behat/mink-browserkit-driver behat/mink

Update your behat.yml configuration to align with the 2.0 API:

Remove obsolete extensions

Remove FriendsOfBehat\CrossContainerExtension and FriendsOfBehat\ContextServiceExtension from your extensions list.

Update SymfonyExtension configuration keys

• Rename kernel.env to kernel.environment.
• Move kernel.bootstrap to bootstrap.
• Note: The env_file setting has been removed. Use your original Symfony bootstrap file or a custom one to load environment variables.

You can inject specific Symfony parameters (like %kernel.environment%) into your Behat context constructors.

With autowiring enabled, simply type-hint the parameter in the constructor. If autowiring is disabled, register the context as a public service and pass the parameter using the %parameter.name% syntax in your services_test.yaml or config_test.yml.

final class DemoContext implements Context
{
    private $environment;
    
    public function __construct(string $environment) 
    {
        $this->environment = $environment;
    }

    /** @Then the application's kernel should use :expected environment */
    public function kernelEnvironmentShouldBe(string $expected): void
    {
        if ($this->environment !== $expected) {
            throw new \RuntimeException();
        }
    }
}