CoverageCheckCommand::execute() - Code Metrics - Inspection of "Update main.yml" - ericsizemore/phpunit-coverage-check - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 92d243...5a69a1 )

by Eric

created 2024-04-21 06:33 UTC

CoverageCheckCommand::execute() A

↳ Parent: CoverageCheckCommand

Complexity

Conditions	5
Paths	8

Size

Total Lines	43
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	20
nc	8
nop	2
dl	0
loc	43
rs	9.2888
c	1
b	0
f	0
ccs	19
cts	19
cp	1
crap	5

<?php

declare(strict_types=1);

/**
 * This file is part of PHPUnit Coverage Check.
 *
 * (c) Eric Sizemore <[email protected]>
 * (c) Richard Regeer <[email protected]>
 *
 * This source file is subject to the MIT license. For the full copyright,
 * license information, and credits/acknowledgements, please view the LICENSE
 * and README files that were distributed with this source code.
 */

namespace Esi\CoverageCheck\Command;

use Esi\CoverageCheck\Application;
use Esi\CoverageCheck\CoverageCheck;
use Esi\CoverageCheck\Style\CoverageCheckStyle;
use Esi\CoverageCheck\Utils;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\TableCell;
use Symfony\Component\Console\Helper\TableCellStyle;
use Symfony\Component\Console\Helper\TableSeparator;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Throwable;

use function sprintf;

/**
 * @see \Esi\CoverageCheck\Tests\Command\CoverageCheckCommandTest
 */
#[AsCommand(name: Application::COMMAND_NAME, description: Application::APPLICATION_DESCRIPTION)]
class CoverageCheckCommand extends Command
{
    private CoverageCheckStyle $coverageCheckStyle;

    public function __construct(private readonly CoverageCheck $coverageCheck)
    {
        parent::__construct();
    }

    /**
     * @see Command
     */
    #[\Override]
    protected function configure(): void
    {
        $this
            ->setDefinition([
                new InputArgument('cloverfile', InputArgument::REQUIRED, 'The location of the clover xml file that is generated by PHPUnit.'),
                new InputArgument('threshold', InputArgument::REQUIRED, 'The coverage threshold that is acceptable. Min = 1, Max = 100'),
                new InputOption('--only-percentage', '-O', InputOption::VALUE_NONE, 'Only return the resulting coverage percentage'),
                new InputOption('--show-files', '-F', InputOption::VALUE_NONE, 'Show a breakdown of coverage by file'),
            ])
            ->setHelp(
                <<<'EOF'
                    The <info>%command.name%</info> command calculates coverage score for the provided clover xml report.

                    You must also pass a coverage threshold that is acceptable. <info>Min = 1, Max = 100</info>:

                    <info>php %command.full_name% /path/to/clover.xml 100</info>

                    You may also choose to only return the resulting coverage percentage by using the <info>--only-percentage</info> option:

                    <info>php %command.full_name% /path/to/clover.xml 100 --only-percentage</info>

                    You may also choose to show a breakdown of coverage by file by using the <info>--show-files</info> option:

                    <info>php %command.full_name% /path/to/clover.xml 100 --show-files</info>
                    EOF
            )
        ;
    }

    /**
     * @see Command
     * @see CoverageCheck
     * @see CoverageCheckStyle
     */
    #[\Override]
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->coverageCheckStyle = new CoverageCheckStyle($input, $output);

        /** @var string $cloverFile */
        $cloverFile = $input->getArgument('cloverfile');

        /** @var string $threshold */
        $threshold = $input->getArgument('threshold');

        /** @var bool $onlyPercentage */
        $onlyPercentage = $input->getOption('only-percentage');

        /** @var bool $showFiles */
        $showFiles = $input->getOption('show-files');

        $this->coverageCheck->setCloverFile($cloverFile)
            ->setThreshold((int) $threshold)
            ->setOnlyPercentage($onlyPercentage);

        try {
            $result = $showFiles ? $this->coverageCheck->processByFile() : $this->coverageCheck->process();
        } catch (Throwable $throwable) {
            $this->coverageCheckStyle->error($throwable->getMessage());

            return Command::INVALID;
        }

        // No metrics
        if ($result === false) {
            $this->coverageCheckStyle->error('Insufficient data for calculation. Please add more code.');

            return Command::FAILURE;
        }

        // --show-files
        if (\is_array($result)) {

            return $this->getFileTable($result);
        }

        // Standard output
        return $this->getResultOutput($result);
    }

    /**
     * @param array{
     *     fileMetrics: array<string, array{coveredMetrics: int, totalMetrics: int, percentage: float|int}>,
     *     totalCoverage: float|int
     * } $result
     */
    private function getFileTable(array $result): int
    {
        $threshold     = $this->coverageCheck->getThreshold();
        $tableRows     = [];
        $totalElements = ['coveredMetrics' => 0, 'totalMetrics' => 0];
        $metrics       = $result['fileMetrics'];
        $totalCoverage = $result['totalCoverage'];

        unset($result);

        foreach ($metrics as $name => $file) {
            $tableRows[] = [
                $name,
                sprintf('%d/%d', $file['coveredMetrics'], $file['totalMetrics']),
                new TableCell(
                    Utils::formatCoverage($file['percentage']),
                    [
                        'style' => new TableCellStyle(
                            [
                                'cellFormat' => ($file['percentage'] < $threshold) ? '<error>%s</error>' : '<info>%s</info>',
                            ]
                        ),
                    ]
                ),
            ];

            $totalElements['coveredMetrics'] += $file['coveredMetrics'];
            $totalElements['totalMetrics']   += $file['totalMetrics'];
        }

        unset($metrics);

        $tableRows[] = new TableSeparator();
        $tableRows[] = [
            'Overall Totals',
            sprintf('%d/%d', $totalElements['coveredMetrics'], $totalElements['totalMetrics']),
            new TableCell(
                Utils::formatCoverage($totalCoverage),
                ['style' => new TableCellStyle(['cellFormat' => ($totalCoverage < $threshold) ? '<error>%s</error>' : '<info>%s</info>',])]
            ),
        ];

        $this->coverageCheckStyle->table(
            ['File', 'Elements (Covered/Total)', 'Coverage'],
            $tableRows
        );

        unset($tableRows);

        if ($totalCoverage < $threshold) {
            return Command::FAILURE;
        }

        return Command::SUCCESS;
    }

    private function getResultOutput(float $result): int
    {
        $threshold         = $this->coverageCheck->getThreshold();
        $onlyPercentage    = $this->coverageCheck->getOnlyPercentage();
        $formattedCoverage = Utils::formatCoverage($result);
        $belowThreshold    = $result < $threshold;

        // Only display the percentage?
        if ($onlyPercentage) {
            // ... below the accepted threshold
            if ($belowThreshold) {
                $this->coverageCheckStyle->error($formattedCoverage, true);

                return Command::FAILURE;
            }

            // all good, we meet or exceed the threshold
            $this->coverageCheckStyle->success($formattedCoverage, true);

            return Command::SUCCESS;
        }

        // We want the full message…
        if ($belowThreshold) {
            // ... below the accepted threshold
            $this->coverageCheckStyle->error(
                sprintf('Total code coverage is %s which is below the accepted %d%%', $formattedCoverage, $threshold)
            );

            return Command::FAILURE;
        }

        // all good, we meet or exceed the threshold
        $this->coverageCheckStyle->success(sprintf('Total code coverage is %s', $formattedCoverage));

        return Command::SUCCESS;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/**
6		* This file is part of PHPUnit Coverage Check.
7		*
8		* (c) Eric Sizemore <[email protected]>
9		* (c) Richard Regeer <[email protected]>
10		*
11		* This source file is subject to the MIT license. For the full copyright,
12		* license information, and credits/acknowledgements, please view the LICENSE
13		* and README files that were distributed with this source code.
14		*/
15
16		namespace Esi\CoverageCheck\Command;
17
18		use Esi\CoverageCheck\Application;
19		use Esi\CoverageCheck\CoverageCheck;
20		use Esi\CoverageCheck\Style\CoverageCheckStyle;
21		use Esi\CoverageCheck\Utils;
22		use Symfony\Component\Console\Attribute\AsCommand;
23		use Symfony\Component\Console\Command\Command;
24		use Symfony\Component\Console\Helper\TableCell;
25		use Symfony\Component\Console\Helper\TableCellStyle;
26		use Symfony\Component\Console\Helper\TableSeparator;
27		use Symfony\Component\Console\Input\InputArgument;
28		use Symfony\Component\Console\Input\InputInterface;
29		use Symfony\Component\Console\Input\InputOption;
30		use Symfony\Component\Console\Output\OutputInterface;
31		use Throwable;
32
33		use function sprintf;
34
35		/**
36		* @see \Esi\CoverageCheck\Tests\Command\CoverageCheckCommandTest
37		*/
38		#[AsCommand(name: Application::COMMAND_NAME, description: Application::APPLICATION_DESCRIPTION)]
39		class CoverageCheckCommand extends Command
40		{
41		private CoverageCheckStyle $coverageCheckStyle;
42
43	15	public function __construct(private readonly CoverageCheck $coverageCheck)
44		{
45	15	parent::__construct();
46		}
47
48		/**
49		* @see Command
50		*/
51	15	#[\Override]
52		protected function configure(): void
53		{
54	15	$this
55	15	->setDefinition([
56	15	new InputArgument('cloverfile', InputArgument::REQUIRED, 'The location of the clover xml file that is generated by PHPUnit.'),
57	15	new InputArgument('threshold', InputArgument::REQUIRED, 'The coverage threshold that is acceptable. Min = 1, Max = 100'),
58	15	new InputOption('--only-percentage', '-O', InputOption::VALUE_NONE, 'Only return the resulting coverage percentage'),
59	15	new InputOption('--show-files', '-F', InputOption::VALUE_NONE, 'Show a breakdown of coverage by file'),
60	15	])
61	15	->setHelp(
62	15	<<<'EOF'
63		The <info>%command.name%</info> command calculates coverage score for the provided clover xml report.
64
65		You must also pass a coverage threshold that is acceptable. <info>Min = 1, Max = 100</info>:
66
67		<info>php %command.full_name% /path/to/clover.xml 100</info>
68
69		You may also choose to only return the resulting coverage percentage by using the <info>--only-percentage</info> option:
70
71		<info>php %command.full_name% /path/to/clover.xml 100 --only-percentage</info>
72
73		You may also choose to show a breakdown of coverage by file by using the <info>--show-files</info> option:
74
75		<info>php %command.full_name% /path/to/clover.xml 100 --show-files</info>
76	15	EOF
77	15	)
78	15	;
79		}
80
81		/**
82		* @see Command
83		* @see CoverageCheck
84		* @see CoverageCheckStyle
85		*/
86	15	#[\Override]
87		protected function execute(InputInterface $input, OutputInterface $output): int
88		{
89	15	$this->coverageCheckStyle = new CoverageCheckStyle($input, $output);
90
91		/** @var string $cloverFile */
92	15	$cloverFile = $input->getArgument('cloverfile');
93
94		/** @var string $threshold */
95	15	$threshold = $input->getArgument('threshold');
96
97		/** @var bool $onlyPercentage */
98	15	$onlyPercentage = $input->getOption('only-percentage');
99
100		/** @var bool $showFiles */
101	15	$showFiles = $input->getOption('show-files');
102
103	15	$this->coverageCheck->setCloverFile($cloverFile)
104	15	->setThreshold((int) $threshold)
105	15	->setOnlyPercentage($onlyPercentage);
106
107		try {
108	12	$result = $showFiles ? $this->coverageCheck->processByFile() : $this->coverageCheck->process();
109	3	} catch (Throwable $throwable) {
110	3	$this->coverageCheckStyle->error($throwable->getMessage());
111
112	3	return Command::INVALID;
113		}
114
115		// No metrics
116	9	if ($result === false) {
117	3	$this->coverageCheckStyle->error('Insufficient data for calculation. Please add more code.');
118
119	3	return Command::FAILURE;
120		}
121
122		// --show-files
123	6	if (\is_array($result)) {
		1 ignored issue – show introduced 2024-04-21 06:45 UTC by Report Bug Copy Issue Report The condition `is_array($result)` is always `true`. Loading history...
124	2	return $this->getFileTable($result);
125		}
126
127		// Standard output
128	4	return $this->getResultOutput($result);
129		}
130
131		/**
132		* @param array{
133		* fileMetrics: array<string, array{coveredMetrics: int, totalMetrics: int, percentage: float\|int}>,
134		* totalCoverage: float\|int
135		* } $result
136		*/
137	2	private function getFileTable(array $result): int
138		{
139	2	$threshold = $this->coverageCheck->getThreshold();
140	2	$tableRows = [];
141	2	$totalElements = ['coveredMetrics' => 0, 'totalMetrics' => 0];
142	2	$metrics = $result['fileMetrics'];
143	2	$totalCoverage = $result['totalCoverage'];
144
145	2	unset($result);
146
147	2	foreach ($metrics as $name => $file) {
148	2	$tableRows[] = [
149	2	$name,
150	2	sprintf('%d/%d', $file['coveredMetrics'], $file['totalMetrics']),
151	2	new TableCell(
152	2	Utils::formatCoverage($file['percentage']),
153	2	[
154	2	'style' => new TableCellStyle(
155	2	[
156	2	'cellFormat' => ($file['percentage'] < $threshold) ? '<error>%s</error>' : '<info>%s</info>',
157	2	]
158	2	),
159	2	]
160	2	),
161	2	];
162
163	2	$totalElements['coveredMetrics'] += $file['coveredMetrics'];
164	2	$totalElements['totalMetrics'] += $file['totalMetrics'];
165		}
166
167	2	unset($metrics);
168
169	2	$tableRows[] = new TableSeparator();
170	2	$tableRows[] = [
171	2	'Overall Totals',
172	2	sprintf('%d/%d', $totalElements['coveredMetrics'], $totalElements['totalMetrics']),
173	2	new TableCell(
174	2	Utils::formatCoverage($totalCoverage),
175	2	['style' => new TableCellStyle(['cellFormat' => ($totalCoverage < $threshold) ? '<error>%s</error>' : '<info>%s</info>',])]
176	2	),
177	2	];
178
179	2	$this->coverageCheckStyle->table(
180	2	['File', 'Elements (Covered/Total)', 'Coverage'],
181	2	$tableRows
182	2	);
183
184	2	unset($tableRows);
185
186	2	if ($totalCoverage < $threshold) {
187	1	return Command::FAILURE;
188		}
189
190	1	return Command::SUCCESS;
191		}
192
193	4	private function getResultOutput(float $result): int
194		{
195	4	$threshold = $this->coverageCheck->getThreshold();
196	4	$onlyPercentage = $this->coverageCheck->getOnlyPercentage();
197	4	$formattedCoverage = Utils::formatCoverage($result);
198	4	$belowThreshold = $result < $threshold;
199
200		// Only display the percentage?
201	4	if ($onlyPercentage) {
202		// ... below the accepted threshold
203	2	if ($belowThreshold) {
204	1	$this->coverageCheckStyle->error($formattedCoverage, true);
205
206	1	return Command::FAILURE;
207		}
208
209		// all good, we meet or exceed the threshold
210	1	$this->coverageCheckStyle->success($formattedCoverage, true);
211
212	1	return Command::SUCCESS;
213		}
214
215		// We want the full message…
216	2	if ($belowThreshold) {
217		// ... below the accepted threshold
218	1	$this->coverageCheckStyle->error(
219	1	sprintf('Total code coverage is %s which is below the accepted %d%%', $formattedCoverage, $threshold)
220	1	);
221
222	1	return Command::FAILURE;
223		}
224
225		// all good, we meet or exceed the threshold
226	1	$this->coverageCheckStyle->success(sprintf('Total code coverage is %s', $formattedCoverage));
227
228	1	return Command::SUCCESS;
229		}
230		}
231

ericsizemore / phpunit-coverage-check

Push — master ( 92d243...5a69a1 )

CoverageCheckCommand::execute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like