doyolabs / behat-code-coverage

src/Controller/Cli/CoverageController.php

<?php

/*
 * This file is part of the doyo/behat-coverage-extension project.
 *
 * (c) Anthonius Munthi <me@itstoni.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Doyo\Behat\Coverage\Controller\Cli;

use Behat\Testwork\Cli\Controller;
use Doyo\Behat\Coverage\Bridge\Symfony\Event;
use Doyo\Behat\Coverage\Event\CoverageEvent;
use Doyo\Behat\Coverage\Event\ReportEvent;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\StyleInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Code Coverage Cli Controller.
 *
 * @author Anthonius Munthi <me@itstoni.com>
 */
class CoverageController implements Controller, EventSubscriberInterface
{
    /**
     * @var StyleInterface|null
     */
    private $style;

    /**
     * @var bool
     */
    private $coverageEnabled = false;

    /**
     * CoverageController constructor.
     *
     * @param StyleInterface|null $style
     */
    public function __construct(StyleInterface $style)
    {
        $this->style = $style;
    }

    /**
     * {@inheritdoc}
     */
    public function configure(Command $command)
    {
        $command->addOption('coverage', null, InputOption::VALUE_NONE, 'Collecting code coverage');
    }

    public static function getSubscribedEvents()
    {
        return [
            ReportEvent::BEFORE_PROCESS => [
                ['validateEvent', 1000],
                ['onBeforeReportProcess', 100],
            ],
            ReportEvent::AFTER_PROCESS    => 'onAfterReportProcess',
            CoverageEvent::BEFORE_REFRESH => ['validateEvent', 1000],
            CoverageEvent::BEFORE_START   => ['validateEvent', 1000],
            CoverageEvent::BEFORE_STOP    => ['validateEvent', 1000],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function execute(InputInterface $input, OutputInterface $output)
    {
        if ($input->hasParameterOption(['--coverage'])) {
            $this->coverageEnabled = true;
        }
    }

    public function validateEvent(Event $event)
    {
        if (!$this->coverageEnabled) {
            $event->stopPropagation();

The function Symfony\Component\EventDispatcher\Event::stopPropagation() has been deprecated: since Symfony 4.3, use "Symfony\Contracts\EventDispatcher\Event" instead

        }
    }

    public function onBeforeReportProcess(ReportEvent $event)
    {
        $io = $this->style;
        $io->section('behat coverage reports process started');

The method section() does not exist on null.

        $event->setIO($io);

It seems like $io can also be of type null; however, parameter $io of Doyo\Behat\Coverage\Event\ReportEvent::setIO() does only seem to accept Symfony\Component\Console\Style\StyleInterface, maybe add an additional type check?

    }

    public function onAfterReportProcess(ReportEvent $event)
    {
        $exceptions = $event->getExceptions();
        $io         = $event->getIO();
        if (0 === \count($exceptions)) {
            $this->style->success('behat coverage reports process completed');

The method success() does not exist on null.

            return;
        }

        $io->newLine(2);
        $io->section('behat coverage reports process failed');
        foreach ($exceptions as $exception) {
            $io->error($exception->getMessage());
        }
    }
}