Skip to content

Commit a8062b1

Browse files
dvdougsebastianbergmann
dvdoug
authored and
sebastianbergmann
committed
Don't crash when a new/amended function is present in a previously seen file
1 parent ceceec7 commit a8062b1

File tree

3 files changed

+165
-13
lines changed

3 files changed

+165
-13
lines changed

‎src/CodeCoverage.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ public function append(RawCodeCoverageData $rawData, $id = null, bool $append =
291291
$this->applyWhitelistFilter($rawData);
292292
$this->applyIgnoredLinesFilter($rawData);
293293

294-
$this->data->initializeFilesThatAreSeenTheFirstTime($rawData);
294+
$this->data->initializeUnseenData($rawData);
295295

296296
if (!$append) {
297297
return;

‎src/ProcessedCodeCoverageData.php‎

Lines changed: 55 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ final class ProcessedCodeCoverageData
3333
*/
3434
private $functionCoverage = [];
3535

36-
public function initializeFilesThatAreSeenTheFirstTime(RawCodeCoverageData $rawData): void
36+
public function initializeUnseenData(RawCodeCoverageData $rawData): void
3737
{
3838
foreach ($rawData->lineCoverage() as $file => $lines) {
3939
if (!isset($this->lineCoverage[$file])) {
@@ -46,17 +46,11 @@ public function initializeFilesThatAreSeenTheFirstTime(RawCodeCoverageData $rawD
4646
}
4747

4848
foreach ($rawData->functionCoverage() as $file => $functions) {
49-
if (!isset($this->functionCoverage[$file])) {
50-
$this->functionCoverage[$file] = $functions;
51-
52-
foreach ($this->functionCoverage[$file] as $functionName => $functionData) {
53-
foreach (\array_keys($this->functionCoverage[$file][$functionName]['branches']) as $branchId) {
54-
$this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'] = [];
55-
}
56-
57-
foreach (\array_keys($this->functionCoverage[$file][$functionName]['paths']) as $pathId) {
58-
$this->functionCoverage[$file][$functionName]['paths'][$pathId]['hit'] = [];
59-
}
49+
foreach ($functions as $functionName => $functionData) {
50+
if (isset($this->functionCoverage[$file][$functionName])) {
51+
$this->initPreviouslySeenFunction($file, $functionName, $functionData);
52+
} else {
53+
$this->initPreviouslyUnseenFunction($file, $functionName, $functionData);
6054
}
6155
}
6256
}
@@ -107,6 +101,11 @@ public function lineCoverage(): array
107101
return $this->lineCoverage;
108102
}
109103

104+
public function setFunctionCoverage(array $functionCoverage): void
105+
{
106+
$this->functionCoverage = $functionCoverage;
107+
}
108+
110109
public function functionCoverage(): array
111110
{
112111
\ksort($this->functionCoverage);
@@ -169,6 +168,12 @@ public function merge(self $newData): void
169168
}
170169

171170
foreach ($functions as $functionName => $functionData) {
171+
if (isset($this->functionCoverage[$file][$functionName])) {
172+
$this->initPreviouslySeenFunction($file, $functionName, $functionData);
173+
} else {
174+
$this->initPreviouslyUnseenFunction($file, $functionName, $functionData);
175+
}
176+
172177
foreach ($functionData['branches'] as $branchId => $branchData) {
173178
$this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'] = \array_unique(\array_merge($this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'], $branchData['hit']));
174179
}
@@ -206,4 +211,42 @@ private function priorityForLine(array $data, int $line): int
206211

207212
return 4;
208213
}
214+
215+
/**
216+
* For a function we have never seen before, copy all data over and simply init the 'hit' array
217+
*/
218+
private function initPreviouslyUnseenFunction(string $file, string $functionName, array $functionData): void
219+
{
220+
$this->functionCoverage[$file][$functionName] = $functionData;
221+
222+
foreach (\array_keys($functionData['branches']) as $branchId) {
223+
$this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'] = [];
224+
}
225+
226+
foreach (\array_keys($functionData['paths']) as $pathId) {
227+
$this->functionCoverage[$file][$functionName]['paths'][$pathId]['hit'] = [];
228+
}
229+
}
230+
231+
/**
232+
* For a function we have seen before, only copy over and init the 'hit' array for any unseen branches and paths.
233+
* Techniques such as mocking and where the contents of a file are different vary during tests (e.g. compiling
234+
* containers) mean that the functions inside a file cannot be relied upon to be static.
235+
*/
236+
private function initPreviouslySeenFunction(string $file, string $functionName, array $functionData): void
237+
{
238+
foreach ($functionData['branches'] as $branchId => $branchData) {
239+
if (!isset($this->functionCoverage[$file][$functionName]['branches'][$branchId])) {
240+
$this->functionCoverage[$file][$functionName]['branches'][$branchId] = $branchData;
241+
$this->functionCoverage[$file][$functionName]['branches'][$branchId]['hit'] = [];
242+
}
243+
}
244+
245+
foreach ($functionData['paths'] as $pathId => $pathData) {
246+
if (!isset($this->functionCoverage[$file][$functionName]['paths'][$pathId])) {
247+
$this->functionCoverage[$file][$functionName]['paths'][$pathId] = $pathData;
248+
$this->functionCoverage[$file][$functionName]['paths'][$pathId]['hit'] = [];
249+
}
250+
}
251+
}
209252
}

‎tests/tests/ProcessedCodeCoverageDataTest.php‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,113 @@ public function testMergeOfAPreviouslyUnseenLine(): void
6666

6767
$this->assertArrayHasKey(12, $existingCoverage->lineCoverage()['/some/path/SomeClass.php']);
6868
}
69+
70+
public function testMergeDoesNotCrashWhenFileContentsHaveChanged(): void
71+
{
72+
$coverage = new ProcessedCodeCoverageData;
73+
$coverage->setFunctionCoverage(
74+
[
75+
'/some/path/SomeClass.php' => [
76+
'SomeClass->firstFunction' => [
77+
'branches' => [
78+
0 => [
79+
'op_start' => 0,
80+
'op_end' => 14,
81+
'line_start' => 20,
82+
'line_end' => 25,
83+
'hit' => [],
84+
'out' => [
85+
],
86+
'out_hit' => [
87+
],
88+
],
89+
],
90+
'paths' => [
91+
0 => [
92+
'path' => [
93+
0 => 0,
94+
],
95+
'hit' => [],
96+
],
97+
],
98+
],
99+
],
100+
]
101+
);
102+
103+
$newCoverage = new ProcessedCodeCoverageData;
104+
$newCoverage->setFunctionCoverage(
105+
[
106+
'/some/path/SomeClass.php' => [
107+
'SomeClass->firstFunction' => [
108+
'branches' => [
109+
0 => [
110+
'op_start' => 0,
111+
'op_end' => 14,
112+
'line_start' => 20,
113+
'line_end' => 25,
114+
'hit' => [],
115+
'out' => [
116+
],
117+
'out_hit' => [
118+
],
119+
],
120+
1 => [
121+
'op_start' => 15,
122+
'op_end' => 16,
123+
'line_start' => 26,
124+
'line_end' => 27,
125+
'hit' => [],
126+
'out' => [
127+
],
128+
'out_hit' => [
129+
],
130+
],
131+
],
132+
'paths' => [
133+
0 => [
134+
'path' => [
135+
0 => 0,
136+
],
137+
'hit' => [],
138+
],
139+
1 => [
140+
'path' => [
141+
0 => 1,
142+
],
143+
'hit' => [],
144+
],
145+
],
146+
],
147+
'SomeClass->secondFunction' => [
148+
'branches' => [
149+
0 => [
150+
'op_start' => 0,
151+
'op_end' => 24,
152+
'line_start' => 30,
153+
'line_end' => 35,
154+
'hit' => [],
155+
'out' => [
156+
],
157+
'out_hit' => [
158+
],
159+
],
160+
],
161+
'paths' => [
162+
0 => [
163+
'path' => [
164+
0 => 0,
165+
],
166+
'hit' => [],
167+
],
168+
],
169+
],
170+
],
171+
]
172+
);
173+
174+
$coverage->merge($newCoverage);
175+
176+
$this->assertArrayHasKey('SomeClass->secondFunction', $newCoverage->functionCoverage()['/some/path/SomeClass.php']);
177+
}
69178
}

0 commit comments

Comments
 (0)