Extension::initCodeCoverageV9() - Code Metrics - Inspection of "Restore BC with older php-code-coverage versions" - dvdoug/behat-code-coverage - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 7925f4...acac31 )

by Doug
created 2020-07-03 02:56 UTC
Extension::initCodeCoverageV9() A

↳ Parent: Extension
Complexity

Conditions	4
Paths	8
Size

Total Lines	42
Code Lines	26
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	18
CRAP Score	4
Importance

Changes
Metric	Value
cc	4
eloc	26
nc	8
nop	2
dl	0
loc	42
ccs	18
cts	18
cp	1
crap	4
rs	9.504
c	0
b	0
f	0
<?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.reports', $config['reports'] ?? []);
    }

    /**
     * {@inheritdoc}
     */
    public function configure(ArrayNodeDefinition $builder): void
    {
        $builder
            ->children()
                ->arrayNode('filter')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('includeUncoveredFiles')
                            ->defaultTrue()
                        ->end()
                        ->scalarNode('processUncoveredFiles')
                        ->/** @scrutinizer ignore-call */ 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');

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

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

            $codeCoverage = $container->getDefinition(CodeCoverage::class);
            $filter = $container->getDefinition(Filter::class);
            $codeCoverage->setFactory([new Reference(self::class), 'initCodeCoverage']);
            $codeCoverage->setArguments([$filter, $config]);
        } 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 $config): CodeCoverage
    {
        $driverClassReflection = new \ReflectionClass(Driver::class);
        if ($driverClassReflection->isInterface()) {
            return $this->initCodeCoverageV678($filter, $config);
        }

        return $this->initCodeCoverageV9($filter, $config);
    }

    public function initCodeCoverageV9(Filter $filter, array $config): CodeCoverage
    {
        // set up filter
        array_walk($config['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($config['include']['files'], static function (string $file, string $key, Filter $filter): void {
            $filter->includeFile($file);
                     includeFile($file);
        }, $filter);

        array_walk($config['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($config['exclude']['files'], static function (string $file, string $key, Filter $filter): void {
            $filter->excludeFile($file);
                     excludeFile($file);
        }, $filter);

        // see if we can get a driver
        try {
            $driver = Driver::forLineAndPathCoverage($filter);
            $driver = Driver::forLineAndPathCoverage($filter);
        } catch (NoCodeCoverageDriverWithPathCoverageSupportAvailableException $e) {
            $driver = Driver::forLineCoverage($filter);
            $driver = Driver::forLineCoverage($filter);
        }

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

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

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

        return $codeCoverage;
    }

    public function initCodeCoverageV678(Filter $filter, array $config): CodeCoverage
    {
        // 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 — master ( 7925f4...acac31 )

Extension::initCodeCoverageV9() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
