RemoveBaseLineCommandTest::testNoNewIssues() - Code Metrics - Inspection of "Feature/clean up" - DaveLiddament/sarb - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#117)

by Dave

created 2022-08-07 17:53 UTC

RemoveBaseLineCommandTest::testNoNewIssues() A

↳ Parent: RemoveBaseLineCommandTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
cc	1
eloc	10
c	2
b	0
f	1
nc	1
nop	0
dl	0
loc	16
rs	9.9332

<?php

declare(strict_types=1);

namespace DaveLiddament\StaticAnalysisResultsBaseliner\Tests\Unit\Framework\Command;

use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\AbsoluteFileName;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\BaseLine;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\LineNumber;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Location;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\ProjectRoot;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Type;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\OutputFormatter\OutputFormatter;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Pruner\PrunedResults;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResult;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResults;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResultsBuilder;
use DaveLiddament\StaticAnalysisResultsBaseliner\Framework\Command\RemoveBaseLineFromResultsCommand;
use DaveLiddament\StaticAnalysisResultsBaseliner\Framework\Container\OutputFormatterRegistry;
use DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\GitDiffHistoryAnalyser\GitCommit;
use DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\OutputFormatters\TableOutputFormatter;
use DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\ResultsParsers\SarbJsonResultsParser\SarbJsonResultsParser;
use DaveLiddament\StaticAnalysisResultsBaseliner\Tests\Helpers\BaseLineResultsBuilder;
use DaveLiddament\StaticAnalysisResultsBaseliner\Tests\TestDoubles\HistoryFactoryStub;
use DaveLiddament\StaticAnalysisResultsBaseliner\Tests\TestDoubles\MockResultsPruner;
use DaveLiddament\StaticAnalysisResultsBaseliner\Tests\TestDoubles\OutputFormatterStub;
use Exception;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Console\Tester\CommandTester;
use Throwable;

class RemoveBaseLineCommandTest extends TestCase
{
    private const INPUT_STRING_1 = <<<EOF
This is
a multiline
string
EOF;
    public const BASELINE_FILENAME = 'baseline1.sarb';
    public const BASELINE_FILE_ARGUMENT = 'baseline-file';
    public const OUTPUT_FORMAT_OPTION = '--output-format';
    public const PROJECT_ROOT = '--project-root';
    public const CLEAN_UP = '--clean-up';

    /**
     * @var ProjectRoot
     */
    private $projectRoot;

    /**
     * @var OutputFormatterRegistry
     */
    private $outputFormatterRegistry;
    /**
     * @var OutputFormatter
     */
    private $defaultOutputFormater;
    /**
     * @var OutputFormatter
     */
    private $stubOutputFormatter;

    protected function setUp(): void
    {
        $this->defaultOutputFormater = new TableOutputFormatter();
        $this->stubOutputFormatter = new OutputFormatterStub();

        $this->outputFormatterRegistry = new OutputFormatterRegistry([
            $this->defaultOutputFormater,
            $this->stubOutputFormatter,
        ]);

        $this->projectRoot = ProjectRoot::fromProjectRoot('/tmp', '/tmp/foo/bar');
    }

    public function testNoNewIssues(): void
    {
        $commandTester = $this->createCommandTester(
            $this->getAnalysisResultsWithXResults(0),
            null,
            null
        );

        $commandTester->execute([
            self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
        ]);

        $this->assertReturnCode(0, $commandTester);
        $this->assertResponseContains('Latest analysis issue count: 2', $commandTester);
        $this->assertResponseContains('Baseline issue count: 4', $commandTester);
        $this->assertResponseContains('Issue count with baseline removed: 0', $commandTester);
    }

    public function test1NewIssues(): void
    {
        $commandTester = $this->createCommandTester(
            $this->getAnalysisResultsWithXResults(1),
            null,
            null
        );

        $commandTester->execute([
            self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
        ]);

        $this->assertReturnCode(1, $commandTester);
        $this->assertResponseContains('Issue count with baseline removed: 1', $commandTester);
    }

    public function testPickNonDefaultOutputFormatter(): void
    {
        $commandTester = $this->createCommandTester(
            $this->getAnalysisResultsWithXResults(0),
            null,
            null
        );

        $commandTester->execute([
            self::OUTPUT_FORMAT_OPTION => OutputFormatterStub::CODE,
            self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
        ]);

        $this->assertReturnCode(0, $commandTester);
        $this->assertResponseContains(
            '[stub output formatter: Issues since baseline 0]',
            $commandTester
        );
    }

    public function testPickNonDefaultOutputFormatterWithIssues(): void
    {
        $commandTester = $this->createCommandTester(
            $this->getAnalysisResultsWithXResults(8),
            null,
            null
        );

        $commandTester->execute([
            self::OUTPUT_FORMAT_OPTION => OutputFormatterStub::CODE,
            self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
        ]);

        $this->assertReturnCode(1, $commandTester);
        $this->assertResponseContains(
            '[stub output formatter: Issues since baseline 8]',
            $commandTester
        );
    }

    public function testInvalidResultsParser(): void
    {
        $commandTester = $this->createCommandTester(
            $this->getAnalysisResultsWithXResults(0),
            null,
            null
        );

        $commandTester->execute([
            self::OUTPUT_FORMAT_OPTION => 'rubbish',
            self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
        ]);

        $this->assertReturnCode(11, $commandTester);
        $this->assertResponseContains(
            'Invalid value [rubbish] for option [output-format]. Pick one of: table|stub',
            $commandTester
        );
    }

    public function testSpecifyProjectRoot(): void
    {
        $commandTester = $this->createCommandTester(
            $this->getAnalysisResultsWithXResults(0),
            $this->projectRoot,
            null
        );

        $commandTester->execute([
            self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
            self::PROJECT_ROOT => '/tmp',
        ]);

        $this->assertReturnCode(0, $commandTester);
    }

    public function testException(): void
    {
        $commandTester = $this->createCommandTester(
            $this->getAnalysisResultsWithXResults(1),
            null,
            new Exception()
        );

        $commandTester->execute([
            self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
        ]);

        $this->assertReturnCode(100, $commandTester);
    }


    public function testCleanUpOptions(): void
    {
        $commandTester = $this->createCommandTester(
            $this->getAnalysisResultsWithXResults(0),
            $this->projectRoot,
            null
        );

        $commandTester->execute([
            self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
            self::CLEAN_UP => true,
        ]);

        var_dump($commandTester->getDisplay());


        $this->assertResponseContains(
            'Random 2 issues in the baseline to fix...',
            $commandTester
        );
    }

    private function createCommandTester(
        AnalysisResults $expectedAnalysisResults,
        ?ProjectRoot $projectRoot,
        ?Throwable $exception
    ): CommandTester {
        $baseLineResultsBuilder = new BaseLineResultsBuilder();
        $baseLineResultsBuilder->add('file1', 1, 'type1');
        $baseLineResultsBuilder->add('file2', 2, 'type2');
        $baseLineResultsBuilder->add('file3', 3, 'type3');
        $baseLineResultsBuilder->add('file4', 4, 'type4');

        $baseLine = new BaseLine(
            new HistoryFactoryStub(),
            $baseLineResultsBuilder->build(),
            new SarbJsonResultsParser(),
            new GitCommit('fae40b3d596780ffd746dbd2300d05dcfbd09033')
        );

        $prunedResults = new PrunedResults(
            $baseLine,
            $expectedAnalysisResults,
            $this->getAnalysisResultsWithXResults(2)
        );

        $mockResultsPruner = new MockResultsPruner(
            self::INPUT_STRING_1,
            $prunedResults,
            $projectRoot,
            $exception
        );

        $command = new RemoveBaseLineFromResultsCommand(
            $mockResultsPruner,
            $this->outputFormatterRegistry,
            new TableOutputFormatter(),
        );

        $commandTester = new CommandTester($command);
        $commandTester->setInputs([self::INPUT_STRING_1]);

        return $commandTester;
    }



    private function assertReturnCode(int $expectedReturnCode, CommandTester $commandTester): void
    {
        $this->assertSame($expectedReturnCode, $commandTester->getStatusCode(), $commandTester->getDisplay());
    }

    private function assertResponseContains(string $expectedMessage, CommandTester $commandTester): void
    {
        $output = $commandTester->getDisplay();
        $position = strpos($output, $expectedMessage);
        $this->assertNotFalse($position, "Can't find message [$expectedMessage] in [$output]");
    }

    private function getAnalysisResultsWithXResults(int $count): AnalysisResults
    {
        $projectRoot = ProjectRoot::fromCurrentWorkingDirectory('/');

        $analysisResultsBuilder = new AnalysisResultsBuilder();
        for ($i = 0; $i < $count; ++$i) {
            $analysisResult = new AnalysisResult(
                Location::fromAbsoluteFileName(
                    new AbsoluteFileName("/FILE_$count"),
                    $projectRoot,
                    new LineNumber($count)
                ),
                new Type("TYPE_$i"),
                "MESSAGE_$i",
                []
            );
            $analysisResultsBuilder->addAnalysisResult($analysisResult);
        }

        return $analysisResultsBuilder->build();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace DaveLiddament\StaticAnalysisResultsBaseliner\Tests\Unit\Framework\Command;
6
7			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\AbsoluteFileName;
8			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\BaseLine;
9			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\LineNumber;
10			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Location;
11			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\ProjectRoot;
12			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Type;
13			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\OutputFormatter\OutputFormatter;
14			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Pruner\PrunedResults;
15			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResult;
16			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResults;
17			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResultsBuilder;
18			use DaveLiddament\StaticAnalysisResultsBaseliner\Framework\Command\RemoveBaseLineFromResultsCommand;
19			use DaveLiddament\StaticAnalysisResultsBaseliner\Framework\Container\OutputFormatterRegistry;
20			use DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\GitDiffHistoryAnalyser\GitCommit;
21			use DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\OutputFormatters\TableOutputFormatter;
22			use DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\ResultsParsers\SarbJsonResultsParser\SarbJsonResultsParser;
23			use DaveLiddament\StaticAnalysisResultsBaseliner\Tests\Helpers\BaseLineResultsBuilder;
24			use DaveLiddament\StaticAnalysisResultsBaseliner\Tests\TestDoubles\HistoryFactoryStub;
25			use DaveLiddament\StaticAnalysisResultsBaseliner\Tests\TestDoubles\MockResultsPruner;
26			use DaveLiddament\StaticAnalysisResultsBaseliner\Tests\TestDoubles\OutputFormatterStub;
27			use Exception;
28			use PHPUnit\Framework\TestCase;
29			use Symfony\Component\Console\Tester\CommandTester;
30			use Throwable;
31
32			class RemoveBaseLineCommandTest extends TestCase
33			{
34			private const INPUT_STRING_1 = <<<EOF
35			This is
36			a multiline
37			string
38			EOF;
39			public const BASELINE_FILENAME = 'baseline1.sarb';
40			public const BASELINE_FILE_ARGUMENT = 'baseline-file';
41			public const OUTPUT_FORMAT_OPTION = '--output-format';
42			public const PROJECT_ROOT = '--project-root';
43			public const CLEAN_UP = '--clean-up';
44
45			/**
46			* @var ProjectRoot
47			*/
48			private $projectRoot;
49
50			/**
51			* @var OutputFormatterRegistry
52			*/
53			private $outputFormatterRegistry;
54			/**
55			* @var OutputFormatter
56			*/
57			private $defaultOutputFormater;
58			/**
59			* @var OutputFormatter
60			*/
61			private $stubOutputFormatter;
62
63			protected function setUp(): void
64			{
65			$this->defaultOutputFormater = new TableOutputFormatter();
66			$this->stubOutputFormatter = new OutputFormatterStub();
67
68			$this->outputFormatterRegistry = new OutputFormatterRegistry([
69			$this->defaultOutputFormater,
70			$this->stubOutputFormatter,
71			]);
72
73			$this->projectRoot = ProjectRoot::fromProjectRoot('/tmp', '/tmp/foo/bar');
74			}
75
76			public function testNoNewIssues(): void
77			{
78			$commandTester = $this->createCommandTester(
79			$this->getAnalysisResultsWithXResults(0),
80			null,
81			null
82			);
83
84			$commandTester->execute([
85			self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
86			]);
87
88			$this->assertReturnCode(0, $commandTester);
89			$this->assertResponseContains('Latest analysis issue count: 2', $commandTester);
90			$this->assertResponseContains('Baseline issue count: 4', $commandTester);
91			$this->assertResponseContains('Issue count with baseline removed: 0', $commandTester);
92			}
93
94			public function test1NewIssues(): void
95			{
96			$commandTester = $this->createCommandTester(
97			$this->getAnalysisResultsWithXResults(1),
98			null,
99			null
100			);
101
102			$commandTester->execute([
103			self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
104			]);
105
106			$this->assertReturnCode(1, $commandTester);
107			$this->assertResponseContains('Issue count with baseline removed: 1', $commandTester);
108			}
109
110			public function testPickNonDefaultOutputFormatter(): void
111			{
112			$commandTester = $this->createCommandTester(
113			$this->getAnalysisResultsWithXResults(0),
114			null,
115			null
116			);
117
118			$commandTester->execute([
119			self::OUTPUT_FORMAT_OPTION => OutputFormatterStub::CODE,
120			self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
121			]);
122
123			$this->assertReturnCode(0, $commandTester);
124			$this->assertResponseContains(
125			'[stub output formatter: Issues since baseline 0]',
126			$commandTester
127			);
128			}
129
130			public function testPickNonDefaultOutputFormatterWithIssues(): void
131			{
132			$commandTester = $this->createCommandTester(
133			$this->getAnalysisResultsWithXResults(8),
134			null,
135			null
136			);
137
138			$commandTester->execute([
139			self::OUTPUT_FORMAT_OPTION => OutputFormatterStub::CODE,
140			self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
141			]);
142
143			$this->assertReturnCode(1, $commandTester);
144			$this->assertResponseContains(
145			'[stub output formatter: Issues since baseline 8]',
146			$commandTester
147			);
148			}
149
150			public function testInvalidResultsParser(): void
151			{
152			$commandTester = $this->createCommandTester(
153			$this->getAnalysisResultsWithXResults(0),
154			null,
155			null
156			);
157
158			$commandTester->execute([
159			self::OUTPUT_FORMAT_OPTION => 'rubbish',
160			self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
161			]);
162
163			$this->assertReturnCode(11, $commandTester);
164			$this->assertResponseContains(
165			'Invalid value [rubbish] for option [output-format]. Pick one of: table\|stub',
166			$commandTester
167			);
168			}
169
170			public function testSpecifyProjectRoot(): void
171			{
172			$commandTester = $this->createCommandTester(
173			$this->getAnalysisResultsWithXResults(0),
174			$this->projectRoot,
175			null
176			);
177
178			$commandTester->execute([
179			self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
180			self::PROJECT_ROOT => '/tmp',
181			]);
182
183			$this->assertReturnCode(0, $commandTester);
184			}
185
186			public function testException(): void
187			{
188			$commandTester = $this->createCommandTester(
189			$this->getAnalysisResultsWithXResults(1),
190			null,
191			new Exception()
192			);
193
194			$commandTester->execute([
195			self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
196			]);
197
198			$this->assertReturnCode(100, $commandTester);
199			}
200
201
202			public function testCleanUpOptions(): void
203			{
204			$commandTester = $this->createCommandTester(
205			$this->getAnalysisResultsWithXResults(0),
206			$this->projectRoot,
207			null
208			);
209
210			$commandTester->execute([
211			self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
212			self::CLEAN_UP => true,
213			]);
214
215			var_dump($commandTester->getDisplay());
			0 ignored issues – show Security Debugging Code introduced 2022-08-07 17:56 UTC by Report Bug Copy Issue Report `var_dump($commandTester->getDisplay())` looks like debug code. Are you sure you do not want to remove it? Loading history...
216
217			$this->assertResponseContains(
218			'Random 2 issues in the baseline to fix...',
219			$commandTester
220			);
221			}
222
223			private function createCommandTester(
224			AnalysisResults $expectedAnalysisResults,
225			?ProjectRoot $projectRoot,
226			?Throwable $exception
227			): CommandTester {
228			$baseLineResultsBuilder = new BaseLineResultsBuilder();
229			$baseLineResultsBuilder->add('file1', 1, 'type1');
230			$baseLineResultsBuilder->add('file2', 2, 'type2');
231			$baseLineResultsBuilder->add('file3', 3, 'type3');
232			$baseLineResultsBuilder->add('file4', 4, 'type4');
233
234			$baseLine = new BaseLine(
235			new HistoryFactoryStub(),
236			$baseLineResultsBuilder->build(),
237			new SarbJsonResultsParser(),
238			new GitCommit('fae40b3d596780ffd746dbd2300d05dcfbd09033')
239			);
240
241			$prunedResults = new PrunedResults(
242			$baseLine,
243			$expectedAnalysisResults,
244			$this->getAnalysisResultsWithXResults(2)
245			);
246
247			$mockResultsPruner = new MockResultsPruner(
248			self::INPUT_STRING_1,
249			$prunedResults,
250			$projectRoot,
251			$exception
252			);
253
254			$command = new RemoveBaseLineFromResultsCommand(
255			$mockResultsPruner,
256			$this->outputFormatterRegistry,
257			new TableOutputFormatter(),
258			);
259
260			$commandTester = new CommandTester($command);
261			$commandTester->setInputs([self::INPUT_STRING_1]);
262
263			return $commandTester;
264			}
265
266
267
268			private function assertReturnCode(int $expectedReturnCode, CommandTester $commandTester): void
269			{
270			$this->assertSame($expectedReturnCode, $commandTester->getStatusCode(), $commandTester->getDisplay());
271			}
272
273			private function assertResponseContains(string $expectedMessage, CommandTester $commandTester): void
274			{
275			$output = $commandTester->getDisplay();
276			$position = strpos($output, $expectedMessage);
277			$this->assertNotFalse($position, "Can't find message [$expectedMessage] in [$output]");
278			}
279
280			private function getAnalysisResultsWithXResults(int $count): AnalysisResults
281			{
282			$projectRoot = ProjectRoot::fromCurrentWorkingDirectory('/');
283
284			$analysisResultsBuilder = new AnalysisResultsBuilder();
285			for ($i = 0; $i < $count; ++$i) {
286			$analysisResult = new AnalysisResult(
287			Location::fromAbsoluteFileName(
288			new AbsoluteFileName("/FILE_$count"),
289			$projectRoot,
290			new LineNumber($count)
291			),
292			new Type("TYPE_$i"),
293			"MESSAGE_$i",
294			[]
295			);
296			$analysisResultsBuilder->addAnalysisResult($analysisResult);
297			}
298
299			return $analysisResultsBuilder->build();
300			}
301			}
302

DaveLiddament / sarb

Pull Request — master (#117)

RemoveBaseLineCommandTest::testNoNewIssues() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like