Extension::initCodeCoverage() - Code Metrics - Inspection of "Add a toggle to disable branch/path coverage for c..." - dvdoug/behat-code-coverage - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — php8_build ( 83c998...34cfcd )

by Doug
created 2020-08-04 11:41 UTC
Extension::initCodeCoverage() A

↳ Parent: Extension
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	4
CRAP Score	2.3149
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	4
c	1
b	0
f	0
nc	2
nop	4
dl	0
loc	8
ccs	4
cts	7
cp	0.5714
crap	2.3149
rs	10
<?php

declare(strict_types=1);
/**
 * Code Coverage Extension for Behat.
 *
 * @copyright 2013 Anthon Pang
 *
 * @license BSD-2-Clause
 */

namespace DVDoug\Behat\CodeCoverage;

use Behat\Testwork\ServiceContainer\Extension as ExtensionInterface;
use Behat\Testwork\ServiceContainer\ExtensionManager;
use DVDoug\Behat\CodeCoverage\Subscriber\EventSubscriber;
use SebastianBergmann\CodeCoverage\CodeCoverage;
use SebastianBergmann\CodeCoverage\Driver\Driver;
use SebastianBergmann\CodeCoverage\Filter;
use SebastianBergmann\CodeCoverage\NoCodeCoverageDriverAvailableException;
filter:
    dependency_paths: ["lib/*"]
use SebastianBergmann\CodeCoverage\NoCodeCoverageDriverWithPathCoverageSupportAvailableException;
filter:
    dependency_paths: ["lib/*"]
use SebastianBergmann\CodeCoverage\RuntimeException;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\DependencyInjection\Reference;

/**
 * Code coverage extension.
 *
 * @author Anthon Pang <[email protected]>
 */
class Extension implements ExtensionInterface
{
    /**
     * {@inheritdoc}
     */
    public function initialize(ExtensionManager $extensionManager): void
    {
    }

    /**
     * {@inheritdoc}
     */
    public function load(ContainerBuilder $container, array $config): void
    {
        $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/Resources/config'));

        $servicesFile = 'services.xml';
        $loader->load($servicesFile);

        $container->setParameter('behat.code_coverage.config.filter', $config['filter']);
        $container->setParameter('behat.code_coverage.config.branchAndPathCoverage', $config['branchAndPathCoverage']);
        $container->setParameter('behat.code_coverage.config.reports', $config['reports'] ?? []);
    }

    /**
     * {@inheritdoc}
     */
    public function configure(ArrayNodeDefinition $builder): void
    {
        $builder
            ->children()
                ->booleanNode('branchAndPathCoverage')
                  ->defaultNull() // use null to mean auto
                ->end()
                ->arrayNode('filter')
                ->/** @scrutinizer ignore-call */ arrayNode('filter')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('includeUncoveredFiles')
                            ->defaultTrue()
                        ->end()
                        ->scalarNode('processUncoveredFiles')
                            ->defaultFalse()
                        ->end()
                        ->arrayNode('include')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->arrayNode('directories')
                                   ->useAttributeAsKey('name')
                                   ->normalizeKeys(false)
                                   ->prototype('array')
                                       ->children()
                                           ->scalarNode('prefix')->defaultValue('')->end()
                                           ->scalarNode('suffix')->defaultValue('.php')->end()
                                       ->end()
                                   ->end()
                                ->end()
                                ->arrayNode('files')
                                   ->prototype('scalar')->end()
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('exclude')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->arrayNode('directories')
                                   ->useAttributeAsKey('name')
                                   ->normalizeKeys(false)
                                   ->prototype('array')
                                       ->children()
                                           ->scalarNode('prefix')->defaultValue('')->end()
                                           ->scalarNode('suffix')->defaultValue('.php')->end()
                                       ->end()
                                   ->end()
                                ->end()
                                ->arrayNode('files')
                                   ->prototype('scalar')->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('reports')
                    ->children()
                        ->arrayNode('clover')
                            ->children()
                                ->scalarNode('name')->defaultNull()->end()
                                ->scalarNode('target')->isRequired()->cannotBeEmpty()->end()
                            ->end()
                        ->end()
                        ->arrayNode('crap4j')
                            ->children()
                                ->scalarNode('name')->defaultNull()->end()
                                ->scalarNode('target')->isRequired()->cannotBeEmpty()->end()
                            ->end()
                        ->end()
                        ->arrayNode('html')
                            ->children()
                                ->scalarNode('target')->isRequired()->cannotBeEmpty()->end()
                                ->scalarNode('lowUpperBound')->defaultValue(50)->end()
                                ->scalarNode('highLowerBound')->defaultValue(90)->end()
                            ->end()
                        ->end()
                        ->arrayNode('php')
                            ->children()
                                ->scalarNode('target')->isRequired()->cannotBeEmpty()->end()
                            ->end()
                        ->end()
                        ->arrayNode('text')
                            ->children()
                                ->booleanNode('showColors')->defaultValue(false)->end()
                                ->scalarNode('lowUpperBound')->defaultValue(50)->end()
                                ->scalarNode('highLowerBound')->defaultValue(90)->end()
                                ->booleanNode('showOnlySummary')->defaultValue(false)->end()
                                ->booleanNode('showUncoveredFiles')->defaultValue(false)->end()
                            ->end()
                        ->end()
                        ->arrayNode('xml')
                            ->children()
                                ->scalarNode('target')->isRequired()->cannotBeEmpty()->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end()
        ->end();
    }

    /**
     * {@inheritdoc}
     */
    public function getConfigKey()
    {
        return 'code_coverage';
    }

    /**
     * {@inheritdoc}
     */
    public function process(ContainerBuilder $container): void
    {
        /** @var InputInterface $input */
        $input = $container->get('cli.input');

        /** @var OutputInterface $output */
        $output = $container->get('cli.output');

        $filterConfig = $container->getParameter('behat.code_coverage.config.filter');
        $branchPathConfig = $container->getParameter('behat.code_coverage.config.branchAndPathCoverage');

        $canCollectCodeCoverage = true;
        try {
            $this->initCodeCoverage(new Filter(), $filterConfig, null, $output);

            $codeCoverageDefinition = $container->getDefinition(CodeCoverage::class);
            $filterDefinition = $container->getDefinition(Filter::class);
            $codeCoverageDefinition->setFactory([new Reference(self::class), 'initCodeCoverage']);
            $codeCoverageDefinition->setArguments([$filterDefinition, $filterConfig, $branchPathConfig, $output]);
        } catch (NoCodeCoverageDriverAvailableException | RuntimeException $e) {
            $output->writeln('<comment>No code coverage driver is available</comment>');
            $canCollectCodeCoverage = false;
        }

        if (!$canCollectCodeCoverage || $input->hasParameterOption('--no-coverage')) {
            $container->getDefinition(EventSubscriber::class)->setArgument('$coverage', null);
        }
    }

    public function initCodeCoverage(Filter $filter, array $filterConfig, ?bool $branchPathConfig, OutputInterface $output): CodeCoverage
    {
        $driverClassReflection = new \ReflectionClass(Driver::class);
        if ($driverClassReflection->isInterface()) {
            return $this->initCodeCoverageV678($filter, $filterConfig, $branchPathConfig, $output);
        }

        return $this->initCodeCoverageV9($filter, $filterConfig, $branchPathConfig, $output);
    }

    public function initCodeCoverageV9(Filter $filter, array $filterConfig, ?bool $branchPathConfig, OutputInterface $output): CodeCoverage
    {
        // set up filter
        array_walk($filterConfig['include']['directories'], static function (array $dir, string $path, Filter $filter): void {
            $filter->includeDirectory($path, $dir['suffix'], $dir['prefix']);
                     includeDirectory($path, $dir['suffix'], $dir['prefix']);
        }, $filter);

        array_walk($filterConfig['include']['files'], static function (string $file, string $key, Filter $filter): void {
            $filter->includeFile($file);
                     includeFile($file);
        }, $filter);

        array_walk($filterConfig['exclude']['directories'], static function (array $dir, string $path, Filter $filter): void {
            $filter->excludeDirectory($path, $dir['suffix'], $dir['prefix']);
                     excludeDirectory($path, $dir['suffix'], $dir['prefix']);
        }, $filter);

        array_walk($filterConfig['exclude']['files'], static function (string $file, string $key, Filter $filter): void {
            $filter->excludeFile($file);
                     excludeFile($file);
        }, $filter);

        // see if we can get a driver
        $driver = Driver::forLineCoverage($filter);
        $driver = Driver::forLineCoverage($filter);
        if ($branchPathConfig !== false) {
            try {
                $driver = Driver::forLineAndPathCoverage($filter);
                $driver = Driver::forLineAndPathCoverage($filter);
            } catch (NoCodeCoverageDriverWithPathCoverageSupportAvailableException $e) {
                // fallback driver is already set
                if ($branchPathConfig === true) { //only warn if explicitly enabled

                    $output->writeln('<info>Your coverage driver does not support collecting branch and path data</info>');
                }
            }
        }

        // and init coverage
        $codeCoverage = new CodeCoverage($driver, $filter);

        if ($filterConfig['includeUncoveredFiles']) {
            $codeCoverage->includeUncoveredFiles();
                           includeUncoveredFiles();
        } else {
            $codeCoverage->excludeUncoveredFiles();
                           excludeUncoveredFiles();
        }

        if ($filterConfig['processUncoveredFiles']) {
            $codeCoverage->processUncoveredFiles();
                           processUncoveredFiles();
        } else {
            $codeCoverage->doNotProcessUncoveredFiles();
                           doNotProcessUncoveredFiles();
        }

        return $codeCoverage;
    }

    public function initCodeCoverageV678(Filter $filter, array $config, ?bool $branchPathConfig, OutputInterface $output): CodeCoverage
    {
        if ($branchPathConfig === true) { //only warn if explicitly enabled
            $output->writeln('<info>php-code-coverage v9+ is needed to support collecting branch and path data</info>');
        }

        // set up filter
        array_walk($config['include']['directories'], static function (array $dir, string $path, Filter $filter): void {
            $filter->addDirectoryToWhitelist($path, $dir['suffix'], $dir['prefix']);
        }, $filter);

        array_walk($config['include']['files'], static function (string $file, string $key, Filter $filter): void {
            $filter->addFileToWhitelist($file);
        }, $filter);

        array_walk($config['exclude']['directories'], static function (array $dir, string $path, Filter $filter): void {
            $filter->removeDirectoryFromWhitelist($path, $dir['suffix'], $dir['prefix']);
        }, $filter);

        array_walk($config['exclude']['files'], static function (string $file, string $key, Filter $filter): void {
            $filter->removeFileFromWhitelist($file);
        }, $filter);

        // and init coverage
        $codeCoverage = new CodeCoverage(null, $filter);

        $codeCoverage->setAddUncoveredFilesFromWhitelist($config['includeUncoveredFiles']);
        $codeCoverage->setProcessUncoveredFilesFromWhitelist($config['processUncoveredFiles']);

        return $codeCoverage;
    }
}

dvdoug / behat-code-coverage

Push — php8_build ( 83c998...34cfcd )

Extension::initCodeCoverage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
