Chekote\BehatRetryExtension\Context\BehatRetryContext

Complexity

Total Complexity

7

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	restoreConfig()	0	5	2
A	setInterval()	0	3	1
A	setTimeout()	0	3	1
A	enableStrictKeywords()	0	3	1
A	recordConfig()	0	5	1
A	disableStrictKeywords()	0	3	1

<?php namespace Chekote\BehatRetryExtension\Context;

use Behat\Behat\Context\Context;
use Chekote\BehatRetryExtension\Tester\RuntimeStepTester;

/**
 * Context for working with auto-retrying assertions (Then steps).
 */
class BehatRetryContext implements Context
{
    /** @var float the timeout setting for RuntimeStepTester before a Scenario is ran */
    protected $originalTimeout;

    /** @var int the interval setting for RuntimeStepTester before a Scenario is ran */
    protected $originalInterval;

    /** @var bool the strict keywords setting for RuntimeStepTester before a Scenario is ran */
    protected $originalStrictKeywords;

    /**
     * Sets the number of seconds that an assertion (Then step) should retry before failing.
     *
     * @Given assertions will retry for :timeout seconds before failing
     * @param float $timeout the number of seconds
     */
    public function setTimeout($timeout)
    {
        RuntimeStepTester::$timeout = $timeout;
    }

    /**
     * Sets the number of nanoseconds that should pass between each retry of an assertion (Then step).
     *
     * @Given assertions will retry every :interval nanoseconds
     * @param int $interval the number of nanoseconds
     */
    public function setInterval($interval)
    {
        RuntimeStepTester::$interval = $interval;
    }

    /**
     * Requires that steps should only match when the correct keyword is used.
     *
     * @Given strict keywords are required
     */
    public function enableStrictKeywords()
    {
        RuntimeStepTester::$strictKeywords = true;
    }

    /**
     * Allows steps to match if if the correct keyword is not used.
     *
     * @Given strict keywords are not required
     */
    public function disableStrictKeywords()
    {
        RuntimeStepTester::$strictKeywords = false;
    }

    /**
     * Records the configuration of the RuntimeStepTester.
     *
     * The config is recorded so that it can be modified after the Scenario has ran, thus ensuring that config settings
     * changed during the Scenario are reset back to their original settings.
     *
     * @BeforeScenario
     */
    public function recordConfig()
    {
        $this->originalTimeout = RuntimeStepTester::$timeout;
        $this->originalInterval = RuntimeStepTester::$interval;
        $this->originalStrictKeywords = RuntimeStepTester::$strictKeywords;
    }

    /**
     * Restores the RuntimeStepTester config to it's original state.
     *
     * The config is restored to it's state before the Scenario was ran.
     *
     * @AfterScenario
     */
    public function restoreConfig()
    {
        $this->setTimeout($this->originalTimeout);
        $this->setInterval($this->originalInterval);
        $this->originalStrictKeywords ? $this->enableStrictKeywords() : $this->disableStrictKeywords();
    }
}