|
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\PhpstanJsonResultsParser; |
|
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\AnalysisResultsBuilder; |
|
25
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\Identifier; |
|
26
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ResultsParser; |
|
27
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayParseException; |
|
28
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayUtils; |
|
29
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\FqcnRemover; |
|
30
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\JsonParseException; |
|
31
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\JsonUtils; |
|
32
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ParseAtLocationException; |
|
33
|
|
|
|
|
34
|
|
|
/** |
|
35
|
|
|
* Handles PHPStan's JSON output. |
|
36
|
|
|
* |
|
37
|
|
|
* NOTE: SARB only deals with errors that are attached to a particular line in a file. |
|
38
|
|
|
* PHPStan can report general errors (not specific to file). These are ignored by SARB. |
|
39
|
|
|
*/ |
|
40
|
|
|
class PhpstanJsonResultsParser implements ResultsParser |
|
41
|
|
|
{ |
|
42
|
|
|
private const LINE = 'line'; |
|
43
|
|
|
private const TYPE = 'message'; |
|
44
|
|
|
private const FILES = 'files'; |
|
45
|
|
|
private const MESSAGES = 'messages'; |
|
46
|
|
|
private const MESSAGE = 'message'; |
|
47
|
|
|
private const ABSOLUTE_FILE_PATH = 'absoluteFilePath'; |
|
48
|
|
|
|
|
49
|
|
|
/** |
|
50
|
|
|
* @var FqcnRemover |
|
51
|
|
|
*/ |
|
52
|
|
|
private $fqcnRemover; |
|
53
|
|
|
|
|
54
|
|
|
/** |
|
55
|
|
|
* PhpstanJsonResultsParser constructor. |
|
56
|
|
|
*/ |
|
57
|
|
|
public function __construct(FqcnRemover $fqcnRemover) |
|
58
|
|
|
{ |
|
59
|
|
|
$this->fqcnRemover = $fqcnRemover; |
|
60
|
|
|
} |
|
61
|
|
|
|
|
62
|
|
|
/** |
|
63
|
|
|
* {@inheritdoc} |
|
64
|
|
|
*/ |
|
65
|
|
|
public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults |
|
66
|
|
|
{ |
|
67
|
|
|
try { |
|
68
|
|
|
$asArray = JsonUtils::toArray($resultsAsString); |
|
69
|
|
|
} catch (JsonParseException $e) { |
|
70
|
|
|
throw new InvalidFileFormatException('Not a valid JSON format'); |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
|
|
return $this->convertFromArray($asArray, $projectRoot); |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* {@inheritdoc} |
|
78
|
|
|
*/ |
|
79
|
|
|
public function getIdentifier(): Identifier |
|
80
|
|
|
{ |
|
81
|
|
|
return new PhpstanJsonIdentifier(); |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
|
|
/** |
|
85
|
|
|
* {@inheritdoc} |
|
86
|
|
|
*/ |
|
87
|
|
|
public function showTypeGuessingWarning(): bool |
|
88
|
|
|
{ |
|
89
|
|
|
return true; |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
|
|
/** |
|
93
|
|
|
* Converts from an array. |
|
94
|
|
|
* |
|
95
|
|
|
* @phpstan-param array<mixed> $analysisResultsAsArray |
|
96
|
|
|
* |
|
97
|
|
|
* @throws ParseAtLocationException |
|
98
|
|
|
*/ |
|
99
|
|
|
private function convertFromArray(array $analysisResultsAsArray, ProjectRoot $projectRoot): AnalysisResults |
|
100
|
|
|
{ |
|
101
|
|
|
$analysisResultsBuilder = new AnalysisResultsBuilder(); |
|
102
|
|
|
|
|
103
|
|
|
try { |
|
104
|
|
|
$filesErrors = ArrayUtils::getArrayValue($analysisResultsAsArray, self::FILES); |
|
105
|
|
|
} catch (ArrayParseException $e) { |
|
106
|
|
|
throw ParseAtLocationException::issueParsing($e, 'Root node'); |
|
107
|
|
|
} |
|
108
|
|
|
|
|
109
|
|
|
/** @psalm-suppress MixedAssignment */ |
|
110
|
|
|
foreach ($filesErrors as $absoluteFilePath => $fileErrors) { |
|
111
|
|
|
try { |
|
112
|
|
|
if (!is_string($absoluteFilePath)) { |
|
113
|
|
|
throw new ArrayParseException('Expected filename to be of type string'); |
|
114
|
|
|
} |
|
115
|
|
|
|
|
116
|
|
|
ArrayUtils::assertArray($fileErrors); |
|
117
|
|
|
|
|
118
|
|
|
$fileNameAsString = $projectRoot->getPathRelativeToRootDirectory($absoluteFilePath); |
|
119
|
|
|
$fileName = new FileName($fileNameAsString); |
|
120
|
|
|
|
|
121
|
|
|
$messages = ArrayUtils::getArrayValue($fileErrors, self::MESSAGES); |
|
122
|
|
|
|
|
123
|
|
|
foreach ($messages as $message) { |
|
124
|
|
|
ArrayUtils::assertArray($message); |
|
125
|
|
|
$analysisResult = $this->convertAnalysisResultFromArray($message, $fileName, $absoluteFilePath); |
|
126
|
|
|
$analysisResultsBuilder->addAnalysisResult($analysisResult); |
|
127
|
|
|
} |
|
128
|
|
|
} catch (ArrayParseException | JsonParseException | InvalidPathException $e) { |
|
129
|
|
|
throw ParseAtLocationException::issueParsing($e, "Result [$absoluteFilePath]"); |
|
130
|
|
|
} |
|
131
|
|
|
} |
|
132
|
|
|
|
|
133
|
|
|
return $analysisResultsBuilder->build(); |
|
134
|
|
|
} |
|
135
|
|
|
|
|
136
|
|
|
/** |
|
137
|
|
|
* @phpstan-param array<mixed> $analysisResultAsArray |
|
138
|
|
|
* |
|
139
|
|
|
* @throws ArrayParseException |
|
140
|
|
|
* @throws JsonParseException |
|
141
|
|
|
*/ |
|
142
|
|
|
private function convertAnalysisResultFromArray( |
|
143
|
|
|
array $analysisResultAsArray, |
|
144
|
|
|
FileName $fileName, |
|
145
|
|
|
string $absoluteFilePath |
|
146
|
|
|
): AnalysisResult { |
|
147
|
|
|
$lineAsInt = ArrayUtils::getIntOrNullValue($analysisResultAsArray, self::LINE); |
|
148
|
|
|
|
|
149
|
|
|
// PHPStan sometimes reports errors not assigned to any line number. In this case give the line number as 0 |
|
150
|
|
|
if (null === $lineAsInt) { |
|
151
|
|
|
$lineAsInt = 0; |
|
152
|
|
|
} |
|
153
|
|
|
|
|
154
|
|
|
$rawType = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE); |
|
155
|
|
|
$type = $this->fqcnRemover->removeRqcn($rawType); |
|
156
|
|
|
|
|
157
|
|
|
$location = new Location( |
|
158
|
|
|
$fileName, |
|
159
|
|
|
new LineNumber($lineAsInt) |
|
160
|
|
|
); |
|
161
|
|
|
|
|
162
|
|
|
return new AnalysisResult( |
|
163
|
|
|
$location, |
|
164
|
|
|
new Type($type), |
|
165
|
|
|
$rawType, |
|
166
|
|
|
JsonUtils::toString([ |
|
167
|
|
|
self::ABSOLUTE_FILE_PATH => $absoluteFilePath, |
|
168
|
|
|
self::MESSAGE => $analysisResultAsArray, |
|
169
|
|
|
]) |
|
170
|
|
|
); |
|
171
|
|
|
} |
|
172
|
|
|
} |
|
173
|
|
|
|
DaveLiddament /
sarb
