hanneskod / readme-tester

src/Application.php

<?php

declare(strict_types=1);

namespace hanneskod\readmetester;

use hanneskod\readmetester\Config\Configs;
use hanneskod\readmetester\Exception\InvalidInputException;
use Crell\Tukio\OrderedProviderInterface;
use Psr\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

final class Application
{
    private const CONFIG_FILE_OPTION = 'config';
    private const NO_CONFIG_OPTION = 'no-config';
    private const STDIN_OPTION = 'stdin';
    private const SUITE_OPTION = 'suite';
    private const PATHS_ARGUMENT = 'path';
    private const INPUT_OPTION = 'input';
    private const OUTPUT_OPTION = 'output';
    private const DEBUG_OPTION = 'debug';
    private const RUNNER_OPTION = 'runner';
    private const FILE_EXTENSIONS_OPTION = 'file-extension';
    private const IGNORE_PATHS_OPTION = 'exclude';
    private const BOOTSTRAP_OPTION = 'bootstrap';
    private const NO_BOOTSTRAP_OPTION = 'no-bootstrap';
    private const STOP_ON_FAILURE_OPTION = 'stop-on-failure';
    private const FILTER_OPTION = 'filter';

    public function __construct(
        private Config\ConfigManager $configManager,

A parse error occurred: Syntax error, unexpected T_PRIVATE, expecting T_VARIABLE on line 36 at column 8

        private Event\ExitStatusListener $exitStatusListener,
        private ExampleProviderInterface $exampleProvider,
        private Runner\RunnerFactory $runnerFactory,
        private TestMarshal $testMarshal,
        private EventDispatcherInterface $dispatcher,
        private OrderedProviderInterface $listenerProvider,
    ) {}

    public function configure(Command $command): void
    {
        $command
            ->addArgument(
                self::PATHS_ARGUMENT,
                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
                'One or more paths to scan for test files'
            )
            ->addOption(
                self::CONFIG_FILE_OPTION,
                'c',
                InputOption::VALUE_REQUIRED,
                'Read configurations from file'
            )
            ->addOption(
                self::NO_CONFIG_OPTION,
                null,
                InputOption::VALUE_NONE,
                'Do not load a configuration file'
            )
            ->addOption(
                self::SUITE_OPTION,
                null,
                InputOption::VALUE_REQUIRED,
                'Execute named suite'
            )
            ->addOption(
                self::FILE_EXTENSIONS_OPTION,
                null,
                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
                'File extension to use while scanning for test files'
            )
            ->addOption(
                self::IGNORE_PATHS_OPTION,
                null,
                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
                'Path to ignore while scanning for test files'
            )
            ->addOption(
                self::STDIN_OPTION,
                null,
                InputOption::VALUE_NONE,
                'Read from stdin instead of scaning the filesystem'
            )
            ->addOption(
                self::OUTPUT_OPTION,
                null,
                InputOption::VALUE_REQUIRED,
                'Set output format (' . Configs::describe(Configs::OUTPUT_ID) . ')'
            )
            ->addOption(
                self::DEBUG_OPTION,
                null,
                InputOption::VALUE_NONE,
                'View debug info on generated examples (shorthand for --output debug)'
            )
            ->addOption(
                self::INPUT_OPTION,
                null,
                InputOption::VALUE_REQUIRED,
                'Set input format (' . Configs::describe(Configs::INPUT_ID) . ')'
            )
            ->addOption(
                self::RUNNER_OPTION,
                null,
                InputOption::VALUE_REQUIRED,
                'Set example runner (' . Configs::describe(Configs::RUNNER_ID) . ')'
            )
            ->addOption(
                self::BOOTSTRAP_OPTION,
                null,
                InputOption::VALUE_REQUIRED,
                'A "bootstrap" PHP file that is included before testing'
            )
            ->addOption(
                self::NO_BOOTSTRAP_OPTION,
                null,
                InputOption::VALUE_NONE,
                "Ignore bootstrapping"
            )
            ->addOption(
                self::STOP_ON_FAILURE_OPTION,
                's',
                InputOption::VALUE_NONE,
                "Stop processing on first failed test"
            )
            ->addOption(
                self::FILTER_OPTION,
                null,
                InputOption::VALUE_REQUIRED,
                "Filter which examples to test"
            )
        ;
    }

    public function __invoke(InputInterface $input, OutputInterface $output): int
    {
        // Setup configuration from config file

        if (!$input->getOption(self::NO_CONFIG_OPTION)) {
            if ($input->getOption(self::CONFIG_FILE_OPTION)) {
                $this->configManager->loadRepository(
                    // @phpstan-ignore-next-line
                    new Config\YamlRepository((string)$input->getOption(self::CONFIG_FILE_OPTION))
                );
            } else {
                $this->configManager->loadRepository(new Config\UserConfigRepository());
            }
        }

        // Setup configuration from command line

        $this->configManager->loadRepository(
            new Config\ArrayRepository([Configs::CLI => array_filter([
                Configs::INCLUDE_PATHS => (array)$input->getArgument(self::PATHS_ARGUMENT),
                Configs::FILE_EXTENSIONS => (array)$input->getOption(self::FILE_EXTENSIONS_OPTION),
                Configs::EXCLUDE_PATHS => (array)$input->getOption(self::IGNORE_PATHS_OPTION),
                Configs::BOOTSTRAP => (string)$input->getOption(self::BOOTSTRAP_OPTION), // @phpstan-ignore-line
                Configs::OUTPUT => $input->getOption(self::DEBUG_OPTION)
                    ? 'debug'
                    : (string)$input->getOption(self::OUTPUT_OPTION), // @phpstan-ignore-line
                Configs::INPUT_LANGUAGE => (string)$input->getOption(self::INPUT_OPTION), // @phpstan-ignore-line
                Configs::RUNNER => (string)$input->getOption(self::RUNNER_OPTION), // @phpstan-ignore-line
                Configs::STOP_ON_FAILURE => (bool)$input->getOption(self::STOP_ON_FAILURE_OPTION),
                Configs::FILTER => (string)$input->getOption(self::FILTER_OPTION), // @phpstan-ignore-line
                Configs::STDIN => (bool)$input->getOption(self::STDIN_OPTION),
            ])])
        );

        // Create bootstrap

        $bootstrap = '';

        if (!$input->getOption(self::NO_BOOTSTRAP_OPTION)) {
            $bootstrap = $this->configManager->getBootstrap();

            if ($bootstrap) {
                require_once $bootstrap;
            }
        }

        // Setup event subscribers

        foreach ($this->configManager->getSubscribers() as $subscriber) {
            if (!$subscriber) {
                continue;
            }

            if (!class_exists($subscriber)) {
                throw new \RuntimeException("Unknown subscriber '$subscriber', class does not exist");
            }

            $this->listenerProvider->addSubscriber($subscriber, $subscriber);
        }

        // From here convert RuntimeExceptions to ErrorEvents (after subscribers have been loaded)

        try {
            return $this->execute($input, $output, $bootstrap);
        } catch (\RuntimeException $exception) {
            $this->dispatcher->dispatch(new Event\ErrorEvent($exception));
        }

        return 1;
    }

    private function execute(InputInterface $input, OutputInterface $output, string $bootstrap): int
    {
        // Dispatch events

        $this->dispatcher->dispatch(new Event\ExecutionStarted($output));

        if ($bootstrap) {
            $this->dispatcher->dispatch(new Event\BootstrapIncluded($bootstrap));
        }

        foreach ($this->configManager->getLoadedRepositoryNames() as $name) {
            $this->dispatcher->dispatch(new Event\ConfigurationIncluded($name));
        }

        // Execute suites

        if ($input->getOption(self::SUITE_OPTION)) {
            $this->executeSuite(
                // @phpstan-ignore-next-line
                $this->configManager->getSuite((string)$input->getOption(self::SUITE_OPTION)),
                $bootstrap
            );
        } else {
            foreach ($this->configManager->getAllSuites() as $suite) {
                $this->executeSuite($suite, $bootstrap);
            }
        }

        // Done

        $this->dispatcher->dispatch(new Event\ExecutionStopped());

        return $this->exitStatusListener->getStatusCode();
    }

    private function executeSuite(Config\Suite $suite, string $bootstrap): void
    {
        $this->dispatcher->dispatch(new Event\SuiteStarted($suite));

        // Create runner

        $runner = $this->runnerFactory->createRunner($suite->getRunner());

        $runner->setBootstrap($bootstrap);

        $this->dispatcher->dispatch(
            new Event\DebugEvent("Using runner {$suite->getRunner()}")
        );

        // Execute tests

        try {
            $this->testMarshal->test(
                $this->exampleProvider->getExamplesForSuite($suite),
                $runner,
                $suite->stopOnFailure()
            );
        } catch (InvalidInputException $exception) {
            $this->dispatcher->dispatch(new Event\InvalidInput($exception));
        }

        $this->dispatcher->dispatch(new Event\SuiteDone($suite));
    }
}