pest/src/Console/Command.php

<?php

declare(strict_types=1);

namespace Pest\Console;

use Pest\Actions\AddsCoverage;
use Pest\Actions\AddsDefaults;
use Pest\Actions\AddsTests;
use Pest\Actions\LoadStructure;
use Pest\Actions\ValidatesConfiguration;
use Pest\Exceptions\CodeCoverageDriverNotAvailable;
use Pest\TestSuite;
use PHPUnit\Framework\TestSuite as BaseTestSuite;
use PHPUnit\TextUI\Command as BaseCommand;
use PHPUnit\TextUI\TestRunner;
use SebastianBergmann\FileIterator\Facade as FileIteratorFacade;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * @internal
 */
final class Command extends BaseCommand
{
    /**
     * Holds the current testing suite.
     *
     * @var TestSuite
     */
    private $testSuite;

    /**
     * Holds the current console output.
     *
     * @var OutputInterface
     */
    private $output;

    /**
     * Creates a new instance of the command class.
     */
    public function __construct(TestSuite $testSuite, OutputInterface $output)
    {
        $this->testSuite = $testSuite;
        $this->output    = $output;
    }

    /**
     * {@inheritdoc}
     *
     * @phpstan-ignore-next-line
     *
     * @param array<int, string> $argv
     */
    protected function handleArguments(array $argv): void
    {
        /*
         * First, let's handle pest is own `--coverage` param.
         */
        $argv = AddsCoverage::from($this->testSuite, $argv);

        /*
         * Next, as usual, let's send the console arguments to PHPUnit.
         */
        parent::handleArguments($argv);

        /*
         * Finally, let's validate the configuration. Making
         * sure all options are yet supported by Pest.
         */
        ValidatesConfiguration::in($this->arguments);
    }

    /**
     * Creates a new PHPUnit test runner.
     */
    protected function createRunner(): TestRunner
    {
        /*
         * First, let's add the defaults we use on `pest`. Those
         * are the printer class, and others that may be appear.
         */
        $this->arguments = AddsDefaults::to($this->arguments);

        $testRunner = new TestRunner($this->arguments['loader']);
        $testSuite  = $this->arguments['test'];

        if (is_string($testSuite)) {
            if (\is_dir($testSuite)) {
                /** @var string[] $files */
                $files = (new FileIteratorFacade())->getFilesAsArray(
                    $testSuite,
                    $this->arguments['testSuffixes']
                );
            } else {
                $files = [$testSuite];
            }

            $testSuite = new BaseTestSuite($testSuite);

            $testSuite->addTestFiles($files);

            $this->arguments['test'] = $testSuite;
        }

        LoadStructure::in($this->testSuite->rootPath);
        AddsTests::to($testSuite, $this->testSuite);

        return $testRunner;
    }

    /**
     * {@inheritdoc}
     *
     * @phpstan-ignore-next-line
     *
     * @param array<int, string> $argv
     */
    public function run(array $argv, bool $exit = true): int
    {
        $result = parent::run($argv, false);

        if ($result === 0 && $this->testSuite->coverage) {
            if (!Coverage::isAvailable()) {
                throw new CodeCoverageDriverNotAvailable();
            }

            $coverage = Coverage::report($this->output);

            $result = (int) ($coverage < $this->testSuite->coverageMin);

            if ($result === 1) {
                $this->output->writeln(sprintf(
                    "\n  <fg=white;bg=red;options=bold> FAIL </> Code coverage below expected:<fg=red;options=bold> %s %%</>. Minimum:<fg=white;options=bold> %s %%</>.",
                    number_format($coverage, 1),
                    number_format($this->testSuite->coverageMin, 1)
                ));
            }
        }

        exit($result);
    }
}