1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* Static Analysis Results Baseliner (sarb). |
5
|
|
|
* |
6
|
|
|
* (c) Dave Liddament |
7
|
|
|
* |
8
|
|
|
* For the full copyright and licence information please view the LICENSE file distributed with this source code. |
9
|
|
|
*/ |
10
|
|
|
|
11
|
|
|
declare(strict_types=1); |
12
|
|
|
|
13
|
|
|
namespace DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\ResultsParsers\PsalmJsonResultsParser; |
14
|
|
|
|
15
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\FileName; |
16
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\InvalidPathException; |
17
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\LineNumber; |
18
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Location; |
19
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\ProjectRoot; |
20
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Type; |
21
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\File\InvalidFileFormatException; |
22
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResult; |
23
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResults; |
24
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\Identifier; |
25
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ResultsParser; |
26
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayParseException; |
27
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayUtils; |
28
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\JsonParseException; |
29
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\JsonUtils; |
30
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ParseAtLocationException; |
31
|
|
|
|
32
|
|
|
class PsalmJsonResultsParser implements ResultsParser |
33
|
|
|
{ |
34
|
|
|
const LINE_FROM = 'line_from'; |
35
|
|
|
const TYPE = 'type'; |
36
|
|
|
const FILE = 'file_path'; |
37
|
|
|
const SEVERITY = 'severity'; |
38
|
|
|
const ERROR_SEVERITY_LEVEL = 'error'; |
39
|
|
|
const MESSAGE = 'message'; |
40
|
|
|
|
41
|
|
|
/** |
42
|
|
|
* {@inheritdoc} |
43
|
|
|
*/ |
44
|
|
|
public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults |
45
|
|
|
{ |
46
|
|
|
try { |
47
|
|
|
$asArray = JsonUtils::toArray($resultsAsString); |
48
|
|
|
} catch (JsonParseException $e) { |
49
|
|
|
throw new InvalidFileFormatException('Not a valid JSON format'); |
50
|
|
|
} |
51
|
|
|
|
52
|
|
|
return $this->convertFromArray($asArray, $projectRoot); |
53
|
|
|
} |
54
|
|
|
|
55
|
|
|
/** |
56
|
|
|
* {@inheritdoc} |
57
|
|
|
*/ |
58
|
|
|
public function getIdentifier(): Identifier |
59
|
|
|
{ |
60
|
|
|
return new PsalmJsonIdentifier(); |
61
|
|
|
} |
62
|
|
|
|
63
|
|
|
/** |
64
|
|
|
* {@inheritdoc} |
65
|
|
|
*/ |
66
|
|
|
public function showTypeGuessingWarning(): bool |
67
|
|
|
{ |
68
|
|
|
return false; |
69
|
|
|
} |
70
|
|
|
|
71
|
|
|
/** |
72
|
|
|
* Converts from an array. |
73
|
|
|
* |
74
|
|
|
* @phpstan-param array<mixed> $analysisResultsAsArray |
75
|
|
|
* |
76
|
|
|
* @throws ParseAtLocationException |
77
|
|
|
*/ |
78
|
|
|
private function convertFromArray(array $analysisResultsAsArray, ProjectRoot $projectRoot): AnalysisResults |
79
|
|
|
{ |
80
|
|
|
$analysisResults = new AnalysisResults(); |
81
|
|
|
|
82
|
|
|
$resultsCount = 0; |
83
|
|
|
|
84
|
|
|
/** @psalm-suppress MixedAssignment */ |
85
|
|
|
foreach ($analysisResultsAsArray as $analysisResultAsArray) { |
86
|
|
|
++$resultsCount; |
87
|
|
|
try { |
88
|
|
|
ArrayUtils::assertArray($analysisResultAsArray); |
89
|
|
|
$severity = ArrayUtils::getStringValue($analysisResultAsArray, self::SEVERITY); |
90
|
|
|
if (self::ERROR_SEVERITY_LEVEL === $severity) { |
91
|
|
|
$analysisResult = $this->convertAnalysisResultFromArray($analysisResultAsArray, $projectRoot); |
92
|
|
|
$analysisResults->addAnalysisResult($analysisResult); |
93
|
|
|
} |
94
|
|
|
} catch (ArrayParseException | JsonParseException | InvalidPathException $e) { |
95
|
|
|
throw new ParseAtLocationException("Result [$resultsCount]", $e); |
96
|
|
|
} |
97
|
|
|
} |
98
|
|
|
|
99
|
|
|
return $analysisResults; |
100
|
|
|
} |
101
|
|
|
|
102
|
|
|
/** |
103
|
|
|
* @phpstan-param array<mixed> $analysisResultAsArray |
104
|
|
|
* |
105
|
|
|
* @throws ArrayParseException |
106
|
|
|
* @throws JsonParseException |
107
|
|
|
* @throws InvalidPathException |
108
|
|
|
*/ |
109
|
|
|
private function convertAnalysisResultFromArray( |
110
|
|
|
array $analysisResultAsArray, |
111
|
|
|
ProjectRoot $projectRoot |
112
|
|
|
): AnalysisResult { |
113
|
|
|
$absoluteFileNameAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::FILE); |
114
|
|
|
$lineAsInt = ArrayUtils::getIntValue($analysisResultAsArray, self::LINE_FROM); |
115
|
|
|
$typeAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE); |
116
|
|
|
$relativeFileNameAsString = $projectRoot->getPathRelativeToRootDirectory($absoluteFileNameAsString); |
117
|
|
|
|
118
|
|
|
$location = new Location( |
119
|
|
|
new FileName($relativeFileNameAsString), |
120
|
|
|
new LineNumber($lineAsInt) |
121
|
|
|
); |
122
|
|
|
|
123
|
|
|
return new AnalysisResult( |
124
|
|
|
$location, |
125
|
|
|
new Type($typeAsString), |
126
|
|
|
ArrayUtils::getStringValue($analysisResultAsArray, self::MESSAGE), |
127
|
|
|
JsonUtils::toString($analysisResultAsArray) |
128
|
|
|
); |
129
|
|
|
} |
130
|
|
|
} |
131
|
|
|
|