dvdoug / behat-code-coverage

src/Subscriber/EventSubscriber.php

<?php
/**
 * Behat Code Coverage
 */
declare(strict_types=1);

namespace DVDoug\Behat\CodeCoverage\Subscriber;

use Behat\Behat\EventDispatcher\Event\ExampleTested;
use Behat\Behat\EventDispatcher\Event\ScenarioTested;
use Behat\Testwork\EventDispatcher\Event\ExerciseCompleted;
use DVDoug\Behat\CodeCoverage\Service\ReportService;
use SebastianBergmann\CodeCoverage\CodeCoverage;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class EventSubscriber implements EventSubscriberInterface
{
    private ?CodeCoverage $coverage;

    private ReportService $reportService;

    public function __construct(ReportService $reportService, ?CodeCoverage $coverage)
    {
        $this->reportService = $reportService;
        $this->coverage = $coverage;
    }

    public static function getSubscribedEvents(): array
    {
        return [
            ScenarioTested::BEFORE => 'beforeScenario',
            ExampleTested::BEFORE => 'beforeScenario',
            ScenarioTested::AFTER => 'afterScenario',
            ExampleTested::AFTER => 'afterScenario',
            ExerciseCompleted::AFTER => 'afterExercise',
        ];
    }

    /**
     * Before Scenario/Outline Example hook.
     */
    public function beforeScenario(ScenarioTested $event): void
    {
        if (!$this->coverage) {
            return;
        }

        $node = $event->getScenario();
        $id = $event->getFeature()->getFile() . ':' . $node->getLine();

        $this->coverage->start($id);
    }

    /**
     * After Scenario/Outline Example hook.
     */
    public function afterScenario(ScenarioTested $event): void

The parameter $event is not used and could be removed.

    {
        if (!$this->coverage) {
            return;
        }

        $this->coverage->stop();
    }

    /**
     * After Exercise hook.
     */
    public function afterExercise(ExerciseCompleted $event): void

The parameter $event is not used and could be removed.

    {
        if (!$this->coverage) {
            return;
        }

        $this->reportService->generateReport($this->coverage);
    }
}