yoanm/behat-utils-extension

A set of utility for Behat3

BehatUtilsExtension

, _(*1)

, _(*2)

, _(*3)

BehatUtilsExtension provide a set of utility for Behat 3.0+, _(*4)

• How to use
  • Installation
  • Configuration
• In the box
  • Logger
  • Behat event subscription
  • Step logger
• Default configuration reference
• Tests

Install

composer require --dev yoanm/behat-utils-extension

How to use

BehatUtilsExtension require behat/behat and monolog/monolog, _(*5)

Configuration

Add the following in your behat configuration file (usually behat.yml) :, _(*6)

default:
    extensions:
        Yoanm\BehatUtilsExtension: ~

In the box

Logger

See LoggerAwareInterface, _(*7)

Implements this interface and your context will have a logger injected, _(*8)

Example

<?php
namespace Functional\Yoanm\BehatUtilsExtension\Context;

use Behat\Behat\Context\Context;
use Psr\Log\LoggerInterface;
use Yoanm\BehatUtilsExtension\Context\LoggerAwareInterface;

class FeatureContext implements Context, LoggerAwareInterface
{
    /** @var LoggerInterface */
    private $logger;

    /**
     * {@inheritdoc}
     */
    public function setBehatLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    /**
     * @When my step
     */
    public function myStep()
    {
        $this->logger->info('Executing my step');
    }
}

Behat event subscription

See BehatContextSubscriberInterface, _(*9)

Enable initializer and implements BehatContextSubscriberInterface, then your context will be passed to Behat dispatcher in order to receive behat events, _(*10)

Enable context initializer

default:
    extensions:
        Yoanm\BehatUtilsExtension:
            event_subscriber: true

Example

<?php
namespace Functional\Yoanm\BehatUtilsExtension\Context;

use Behat\Behat\Context\Context;
use Behat\Behat\EventDispatcher\Event\ExampleTested;
use Behat\Behat\EventDispatcher\Event\GherkinNodeTested;
use Behat\Behat\EventDispatcher\Event\ScenarioTested;
use Yoanm\BehatUtilsExtension\Context\BehatContextSubscriberInterface;

class FeatureContext implements Context, BehatContextSubscriberInterface
{
    /**
     * @param GherkinNodeTested $event
     */
    public function reset(GherkinNodeTested $event)
    {
        /**
         * Reset here your data before a scenario or example is started
         */
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return [
            ScenarioTested::BEFORE => ['reset'],
            ExampleTested::BEFORE => ['reset'],
            //Or
            // ScenarioTested::BEFORE => ['reset', ListenerPriority::HIGH_PRIORITY],
        ];
    }
}

Step logger

See BehatStepLoggerSubscriber, _(*11)

If enabled, will log each behat feature/background/outline/example/step start and end. Usefull to understand what happens behing the scene if you have a non understandable error in you features., _(*12)

Could be use with Logger to easily spot an issue in context custom steps., _(*13)

Enable step listener

default:
    extensions:
        Yoanm\BehatUtilsExtension:
            step_logger: true

Output example

The following will be appended in the configured log file (see default configuration reference below)., _(*14)

behatUtils.DEBUG: [BehatStepLoggerSubscriber] [FEATURE][IN] {"title":"FEATURE TITLE","file":"FEATURE FILE PATH"} []
behatUtils.DEBUG: [BehatStepLoggerSubscriber] [FEATURE][OUT] {"title":"FEATURE TITLE","file":"FEATURE FILE PATH"} []

behatUtils.DEBUG: [BehatStepLoggerSubscriber] [BACKGROUND][IN] {"title":"BACKGROUND TITLE","line":"BACKGROUND START LINE"} []
behatUtils.DEBUG: [BehatStepLoggerSubscriber] [BACKGROUND][OUT] {"title":"BACKGROUND TITLE","line":"BACKGROUND END LINE"} []

behatUtils.DEBUG: [BehatStepLoggerSubscriber] [OUTLINE][IN] {"title":"OUTLINE TITLE","line": "OUTLINE START LINE"} []
behatUtils.DEBUG: [BehatStepLoggerSubscriber] [OUTLINE][OUT] {"title":"OUTLINE TITLE","line": "OUTLINE END LINE"} []

behatUtils.DEBUG: [BehatStepLoggerSubscriber] [EXAMPLE][IN] {"tokens":{"EXAMPLE_TOKENS_NAME":"EXAMPLE_TOKENS_VALUE"},"title":"| EXAMPLE_TOKENS_VALUE|","line":"EXAMPLE START LINE"} []
behatUtils.DEBUG: [BehatStepLoggerSubscriber] [EXAMPLE][OUT] {"tokens":{"EXAMPLE_TOKENS_NAME":"EXAMPLE_TOKENS_VALUE"},"title":"| EXAMPLE_TOKENS_VALUE|","line":"EXAMPLE END LINE"} []

behatUtils.DEBUG: [BehatStepLoggerSubscriber] [STEP][IN] {"text":"STEP TEXT","line":"STEP LINE"} []
behatUtils.DEBUG: [BehatStepLoggerSubscriber] [STEP][OUT] {"text":"STEP TEXT","line":"STEP LINE"} []

Configuration reference

default:
    extensions:
        Yoanm\BehatUtilsExtension:
            logger:
                path: behat.log
                level: INFO
            event_subscriber: false
            step_logger: false

Tests

This repository follow a custom test strategy, _(*15)

Contributing

See contributing note, _(*16)