File: //usr/local/wp/vendor/behat/behat/src/Behat/Behat/Output/Node/EventListener/AST/OutlineListener.php
<?php
/*
* This file is part of the Behat.
* (c) Konstantin Kudryashov <ever.zet@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Behat\Behat\Output\Node\EventListener\AST;
use Behat\Behat\EventDispatcher\Event\AfterOutlineTested;
use Behat\Behat\EventDispatcher\Event\AfterScenarioSetup;
use Behat\Behat\EventDispatcher\Event\AfterScenarioTested;
use Behat\Behat\EventDispatcher\Event\AfterStepSetup;
use Behat\Behat\EventDispatcher\Event\AfterStepTested;
use Behat\Behat\EventDispatcher\Event\BeforeOutlineTested;
use Behat\Behat\EventDispatcher\Event\ExampleTested;
use Behat\Behat\Output\Node\Printer\ExamplePrinter;
use Behat\Behat\Output\Node\Printer\OutlinePrinter;
use Behat\Behat\Output\Node\Printer\SetupPrinter;
use Behat\Behat\Output\Node\Printer\StepPrinter;
use Behat\Gherkin\Node\ExampleNode;
use Behat\Testwork\Event\Event;
use Behat\Testwork\Output\Formatter;
use Behat\Testwork\Output\Node\EventListener\EventListener;
/**
* Listens to expanded outline events and calls appropriate printers.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
final class OutlineListener implements EventListener
{
/**
* @var OutlinePrinter
*/
private $outlinePrinter;
/**
* @var ExamplePrinter
*/
private $examplePrinter;
/**
* @var StepPrinter
*/
private $stepPrinter;
/**
* @var SetupPrinter
*/
private $stepSetupPrinter;
/**
* @var SetupPrinter
*/
private $exampleSetupPrinter;
/**
* @var ExampleNode
*/
private $example;
/**
* Initializes listener.
*
* @param OutlinePrinter $outlinePrinter
* @param ExamplePrinter $examplePrinter
* @param StepPrinter $stepPrinter
* @param SetupPrinter $exampleSetupPrinter
* @param SetupPrinter $stepSetupPrinter
*/
public function __construct(
OutlinePrinter $outlinePrinter,
ExamplePrinter $examplePrinter,
StepPrinter $stepPrinter,
SetupPrinter $exampleSetupPrinter,
SetupPrinter $stepSetupPrinter
) {
$this->outlinePrinter = $outlinePrinter;
$this->examplePrinter = $examplePrinter;
$this->stepPrinter = $stepPrinter;
$this->exampleSetupPrinter = $exampleSetupPrinter;
$this->stepSetupPrinter = $stepSetupPrinter;
}
/**
* {@inheritdoc}
*/
public function listenEvent(Formatter $formatter, Event $event, $eventName)
{
$this->printAndCaptureOutlineHeaderOnBeforeEvent($formatter, $event);
$this->printAndForgetOutlineFooterOnAfterEvent($formatter, $event);
$this->printExampleHeaderOnBeforeExampleEvent($formatter, $event);
$this->printExampleFooterOnAfterExampleEvent($formatter, $event, $eventName);
$this->printStepSetupOnBeforeStepEvent($formatter, $event);
$this->printStepOnAfterStepEvent($formatter, $event);
}
/**
* Prints outline header and captures outline into ivar on BEFORE event.
*
* @param Formatter $formatter
* @param Event $event
*/
private function printAndCaptureOutlineHeaderOnBeforeEvent(Formatter $formatter, Event $event)
{
if (!$event instanceof BeforeOutlineTested) {
return;
}
$this->outlinePrinter->printHeader($formatter, $event->getFeature(), $event->getOutline());
}
/**
* Prints outline footer and removes outline from ivar on AFTER event.
*
* @param Formatter $formatter
* @param Event $event
*/
private function printAndForgetOutlineFooterOnAfterEvent(Formatter $formatter, Event $event)
{
if (!$event instanceof AfterOutlineTested) {
return;
}
$this->outlinePrinter->printFooter($formatter, $event->getTestResult());
}
/**
* Prints example header on example BEFORE event.
*
* @param Formatter $formatter
* @param Event $event
*/
private function printExampleHeaderOnBeforeExampleEvent(Formatter $formatter, Event $event)
{
if (!$event instanceof AfterScenarioSetup) {
return;
}
$this->example = $event->getScenario();
$this->exampleSetupPrinter->printSetup($formatter, $event->getSetup());
$this->examplePrinter->printHeader($formatter, $event->getFeature(), $this->example);
}
/**
* Prints example footer on example AFTER event.
*
* @param Formatter $formatter
* @param Event $event
* @param string $eventName
*/
private function printExampleFooterOnAfterExampleEvent(Formatter $formatter, Event $event, $eventName)
{
if (!$event instanceof AfterScenarioTested || ExampleTested::AFTER !== $eventName) {
return;
}
$this->examplePrinter->printFooter($formatter, $event->getTestResult());
$this->exampleSetupPrinter->printTeardown($formatter, $event->getTeardown());
$this->example = null;
}
/**
* Prints step setup on step BEFORE event.
*
* @param Formatter $formatter
* @param Event $event
*/
private function printStepSetupOnBeforeStepEvent(Formatter $formatter, Event $event)
{
if (!$event instanceof AfterStepSetup) {
return;
}
$this->stepSetupPrinter->printSetup($formatter, $event->getSetup());
}
/**
* Prints example step on step AFTER event.
*
* @param Formatter $formatter
* @param Event $event
*/
private function printStepOnAfterStepEvent(Formatter $formatter, Event $event)
{
if (!$event instanceof AfterStepTested) {
return;
}
$this->stepPrinter->printStep($formatter, $this->example, $event->getStep(), $event->getTestResult());
$this->stepSetupPrinter->printTeardown($formatter, $event->getTeardown());
}
}