Skip to content

Commit b3ad370

Browse files
sebastianbergmannsebastianbergmann
committed
Do not use rely on PHPUnit internals
1 parent 5fe7cbb commit b3ad370

File tree

16 files changed

+532
-118
lines changed

16 files changed

+532
-118
lines changed

‎.psalm/baseline.xml‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,6 @@
44
<ArgumentTypeCoercion occurrences="1">
55
<code>$unit[0]</code>
66
</ArgumentTypeCoercion>
7-
<InternalMethod occurrences="8">
8-
<code>asString</code>
9-
<code>getName</code>
10-
<code>isLarge</code>
11-
<code>isMedium</code>
12-
<code>nameWithDataSet</code>
13-
<code>size</code>
14-
<code>size</code>
15-
<code>size</code>
16-
</InternalMethod>
17-
<PropertyNotSetInConstructor occurrences="1">
18-
<code>$currentId</code>
19-
</PropertyNotSetInConstructor>
207
<RedundantCondition occurrences="1">
218
<code>is_array($linesToBeCovered)</code>
229
</RedundantCondition>

‎src/CodeCoverage.php‎

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,9 @@
1818
use function array_values;
1919
use function count;
2020
use function explode;
21-
use function get_class;
2221
use function is_array;
2322
use function is_file;
2423
use function sort;
25-
use PHPUnit\Framework\TestCase;
26-
use PHPUnit\Runner\PhptTestCase;
2724
use ReflectionClass;
2825
use SebastianBergmann\CodeCoverage\Data\ProcessedCodeCoverageData;
2926
use SebastianBergmann\CodeCoverage\Data\RawCodeCoverageData;
@@ -33,6 +30,8 @@
3330
use SebastianBergmann\CodeCoverage\StaticAnalysis\CachingFileAnalyser;
3431
use SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser;
3532
use SebastianBergmann\CodeCoverage\StaticAnalysis\ParsingFileAnalyser;
33+
use SebastianBergmann\CodeCoverage\Test\TestSize\TestSize;
34+
use SebastianBergmann\CodeCoverage\Test\TestStatus\TestStatus;
3635
use SebastianBergmann\CodeUnitReverseLookup\Wizard;
3736

3837
/**
@@ -54,7 +53,9 @@ final class CodeCoverage
5453

5554
private bool $ignoreDeprecatedCode = false;
5655

57-
private PhptTestCase|string|TestCase|null $currentId;
56+
private ?string $currentId = null;
57+
58+
private ?TestSize $currentSize = null;
5859

5960
private ProcessedCodeCoverageData $data;
6061

@@ -92,9 +93,10 @@ public function getReport(): Directory
9293
*/
9394
public function clear(): void
9495
{
95-
$this->currentId = null;
96-
$this->data = new ProcessedCodeCoverageData;
97-
$this->tests = [];
96+
$this->currentId = null;
97+
$this->currentSize = null;
98+
$this->data = new ProcessedCodeCoverageData;
99+
$this->tests = [];
98100
}
99101

100102
/**
@@ -143,23 +145,26 @@ public function setTests(array $tests): void
143145
$this->tests = $tests;
144146
}
145147

146-
public function start(PhptTestCase|string|TestCase $id, bool $clear = false): void
148+
public function start(string $id, TestSize $size = null, bool $clear = false): void
147149
{
148150
if ($clear) {
149151
$this->clear();
150152
}
151153

152-
$this->currentId = $id;
154+
$this->currentId = $id;
155+
$this->currentSize = $size;
153156

154157
$this->driver->start();
155158
}
156159

157-
public function stop(bool $append = true, array|false $linesToBeCovered = [], array $linesToBeUsed = []): RawCodeCoverageData
160+
public function stop(bool $append = true, TestStatus $status = null, array|false $linesToBeCovered = [], array $linesToBeUsed = []): RawCodeCoverageData
158161
{
159162
$data = $this->driver->stop();
160-
$this->append($data, null, $append, $linesToBeCovered, $linesToBeUsed);
161163

162-
$this->currentId = null;
164+
$this->append($data, null, $append, $status, $linesToBeCovered, $linesToBeUsed);
165+
166+
$this->currentId = null;
167+
$this->currentSize = null;
163168

164169
return $data;
165170
}
@@ -169,7 +174,7 @@ public function stop(bool $append = true, array|false $linesToBeCovered = [], ar
169174
* @throws TestIdMissingException
170175
* @throws UnintentionallyCoveredCodeException
171176
*/
172-
public function append(RawCodeCoverageData $rawData, PhptTestCase|string|TestCase|null $id = null, bool $append = true, array|false $linesToBeCovered = [], array $linesToBeUsed = []): void
177+
public function append(RawCodeCoverageData $rawData, string $id = null, bool $append = true, TestStatus $status = null, array|false $linesToBeCovered = [], array $linesToBeUsed = []): void
173178
{
174179
if ($id === null) {
175180
$id = $this->currentId;
@@ -179,6 +184,16 @@ public function append(RawCodeCoverageData $rawData, PhptTestCase|string|TestCas
179184
throw new TestIdMissingException;
180185
}
181186

187+
if ($status === null) {
188+
$status = TestStatus::unknown();
189+
}
190+
191+
$size = $this->currentSize;
192+
193+
if ($size === null) {
194+
$size = TestSize::unknown();
195+
}
196+
182197
$this->applyFilter($rawData);
183198

184199
$this->applyExecutableLinesFilter($rawData);
@@ -197,30 +212,18 @@ public function append(RawCodeCoverageData $rawData, PhptTestCase|string|TestCas
197212
$this->applyCoversAnnotationFilter(
198213
$rawData,
199214
$linesToBeCovered,
200-
$linesToBeUsed
215+
$linesToBeUsed,
216+
$size
201217
);
202218

203219
if (empty($rawData->lineCoverage())) {
204220
return;
205221
}
206222

207-
$size = 'unknown';
208-
$status = 'unknown';
209-
$fromTestcase = false;
210-
211-
if ($id instanceof TestCase) {
212-
$fromTestcase = true;
213-
214-
$size = $id->size()->asString();
215-
$status = $id->status()->asString();
216-
$id = get_class($id) . '::' . $id->nameWithDataSet();
217-
} elseif ($id instanceof PhptTestCase) {
218-
$fromTestcase = true;
219-
$size = 'large';
220-
$id = $id->getName();
221-
}
222-
223-
$this->tests[$id] = ['size' => $size, 'status' => $status, 'fromTestcase' => $fromTestcase];
223+
$this->tests[$id] = [
224+
'size' => $size->asString(),
225+
'status' => $status->asString(),
226+
];
224227

225228
$this->data->markCodeAsExecutedByTestCase($id, $rawData);
226229
}
@@ -344,7 +347,7 @@ public function detectsDeadCode(): bool
344347
* @throws ReflectionException
345348
* @throws UnintentionallyCoveredCodeException
346349
*/
347-
private function applyCoversAnnotationFilter(RawCodeCoverageData $rawData, array|false $linesToBeCovered, array $linesToBeUsed): void
350+
private function applyCoversAnnotationFilter(RawCodeCoverageData $rawData, array|false $linesToBeCovered, array $linesToBeUsed, TestSize $size): void
348351
{
349352
if ($linesToBeCovered === false) {
350353
$rawData->clear();
@@ -356,9 +359,7 @@ private function applyCoversAnnotationFilter(RawCodeCoverageData $rawData, array
356359
return;
357360
}
358361

359-
if ($this->checkForUnintentionallyCoveredCode &&
360-
(!$this->currentId instanceof TestCase ||
361-
(!$this->currentId->size()->isMedium() && !$this->currentId->size()->isLarge()))) {
362+
if ($this->checkForUnintentionallyCoveredCode && !$size->isMedium() && !$size->isLarge()) {
362363
$this->performUnintentionallyCoveredCodeCheck($rawData, $linesToBeCovered, $linesToBeUsed);
363364
}
364365

‎src/Report/Html/Renderer/File.php‎

Lines changed: 12 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -984,42 +984,21 @@ private function createPopoverContentForTest(string $test, array $testData): str
984984
{
985985
$testCSS = '';
986986

987-
if ($testData['fromTestcase']) {
988-
switch ($testData['status']) {
989-
case 'success':
990-
switch ($testData['size']) {
991-
case 'small':
992-
$testCSS = ' class="covered-by-small-tests"';
987+
switch ($testData['status']) {
988+
case 'success':
989+
$testCSS = match ($testData['size']) {
990+
'small' => ' class="covered-by-small-tests"',
991+
'medium' => ' class="covered-by-medium-tests"',
992+
// no break
993+
default => ' class="covered-by-large-tests"',
994+
};
993995

994-
break;
996+
break;
995997

996-
case 'medium':
997-
$testCSS = ' class="covered-by-medium-tests"';
998+
case 'failure':
999+
$testCSS = ' class="danger"';
9981000

999-
break;
1000-
1001-
default:
1002-
$testCSS = ' class="covered-by-large-tests"';
1003-
1004-
break;
1005-
}
1006-
1007-
break;
1008-
1009-
case 'skipped':
1010-
case 'incomplete':
1011-
case 'risky':
1012-
case 'warning':
1013-
$testCSS = ' class="warning"';
1014-
1015-
break;
1016-
1017-
case 'failure':
1018-
case 'error':
1019-
$testCSS = ' class="danger"';
1020-
1021-
break;
1022-
}
1001+
break;
10231002
}
10241003

10251004
return sprintf(

‎src/TestSize/Known.php‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php declare(strict_types=1);
2+
/*
3+
* This file is part of phpunit/php-code-coverage.
4+
*
5+
* (c) Sebastian Bergmann <[email protected]>
6+
*
7+
* For the full copyright and license information, please view the LICENSE
8+
* file that was distributed with this source code.
9+
*/
10+
namespace SebastianBergmann\CodeCoverage\Test\TestSize;
11+
12+
/**
13+
* @psalm-immutable
14+
*/
15+
abstract class Known extends TestSize
16+
{
17+
/**
18+
* @psalm-assert-if-true Known $this
19+
*/
20+
public function isKnown(): bool
21+
{
22+
return true;
23+
}
24+
25+
abstract public function isGreaterThan(self $other): bool;
26+
}

‎src/TestSize/Large.php‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php declare(strict_types=1);
2+
/*
3+
* This file is part of phpunit/php-code-coverage.
4+
*
5+
* (c) Sebastian Bergmann <[email protected]>
6+
*
7+
* For the full copyright and license information, please view the LICENSE
8+
* file that was distributed with this source code.
9+
*/
10+
namespace SebastianBergmann\CodeCoverage\Test\TestSize;
11+
12+
/**
13+
* @psalm-immutable
14+
*/
15+
final class Large extends Known
16+
{
17+
/**
18+
* @psalm-assert-if-true Large $this
19+
*/
20+
public function isLarge(): bool
21+
{
22+
return true;
23+
}
24+
25+
public function isGreaterThan(TestSize $other): bool
26+
{
27+
return !$other->isLarge();
28+
}
29+
30+
public function asString(): string
31+
{
32+
return 'large';
33+
}
34+
}

‎src/TestSize/Medium.php‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php declare(strict_types=1);
2+
/*
3+
* This file is part of phpunit/php-code-coverage.
4+
*
5+
* (c) Sebastian Bergmann <[email protected]>
6+
*
7+
* For the full copyright and license information, please view the LICENSE
8+
* file that was distributed with this source code.
9+
*/
10+
namespace SebastianBergmann\CodeCoverage\Test\TestSize;
11+
12+
/**
13+
* @psalm-immutable
14+
*/
15+
final class Medium extends Known
16+
{
17+
/**
18+
* @psalm-assert-if-true Medium $this
19+
*/
20+
public function isMedium(): bool
21+
{
22+
return true;
23+
}
24+
25+
public function isGreaterThan(TestSize $other): bool
26+
{
27+
return $other->isSmall();
28+
}
29+
30+
public function asString(): string
31+
{
32+
return 'medium';
33+
}
34+
}

‎src/TestSize/Small.php‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php declare(strict_types=1);
2+
/*
3+
* This file is part of phpunit/php-code-coverage.
4+
*
5+
* (c) Sebastian Bergmann <[email protected]>
6+
*
7+
* For the full copyright and license information, please view the LICENSE
8+
* file that was distributed with this source code.
9+
*/
10+
namespace SebastianBergmann\CodeCoverage\Test\TestSize;
11+
12+
/**
13+
* @psalm-immutable
14+
*/
15+
final class Small extends Known
16+
{
17+
/**
18+
* @psalm-assert-if-true Small $this
19+
*/
20+
public function isSmall(): bool
21+
{
22+
return true;
23+
}
24+
25+
public function isGreaterThan(TestSize $other): bool
26+
{
27+
return false;
28+
}
29+
30+
public function asString(): string
31+
{
32+
return 'small';
33+
}
34+
}

0 commit comments

Comments
 (0)