-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
TestCaseWrapper.php
221 lines (188 loc) · 6.69 KB
/
TestCaseWrapper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
<?php
declare(strict_types=1);
namespace Codeception\Test;
use Codeception\Exception\UselessTestException;
use Codeception\Scenario;
use Codeception\Test\Interfaces\Dependent;
use Codeception\Test\Interfaces\Descriptive;
use Codeception\Test\Interfaces\Reported;
use Codeception\Test\Interfaces\StrictCoverage;
use Codeception\TestInterface;
use Codeception\Util\Annotation;
use Codeception\Util\ReflectionHelper;
use PHPUnit\Framework\Assert;
use PHPUnit\Framework\TestCase;
use PHPUnit\Metadata\Api\CodeCoverage;
use PHPUnit\Runner\Version as PHPUnitVersion;
use PHPUnit\Util\Test as TestUtil;
use ReflectionClass;
/**
* Wrapper for TestCase tests behaving like native Codeception test format
*/
class TestCaseWrapper extends Test implements Reported, Dependent, StrictCoverage, TestInterface, Descriptive
{
private Metadata $metadata;
/**
* @var array<string, mixed>
*/
private static array $testResults = [];
/**
* @param string[] $beforeClassMethods
* @param string[] $afterClassMethods
*/
public function __construct(
private TestCase $testCase,
array $beforeClassMethods = [],
array $afterClassMethods = [],
) {
$this->metadata = new Metadata();
$metadata = $this->metadata;
if (PHPUnitVersion::series() < 10) {
$methodName = $testCase->getName(false);
} else {
$methodName = $testCase->name();
}
$metadata->setName($methodName);
$metadata->setFilename((new ReflectionClass($testCase))->getFileName());
if ($testCase->dataName() !== '') {
$metadata->setIndex($testCase->dataName());
}
$classAnnotations = Annotation::forClass($testCase);
$metadata->setParamsFromAnnotations($classAnnotations->raw());
$metadata->setParamsFromAttributes($classAnnotations->attributes());
$methodAnnotations = Annotation::forMethod($testCase, $methodName);
$metadata->setParamsFromAnnotations($methodAnnotations->raw());
$metadata->setParamsFromAttributes($methodAnnotations->attributes());
$metadata->setBeforeClassMethods($beforeClassMethods);
$metadata->setAfterClassMethods($afterClassMethods);
}
public function __clone(): void
{
$this->testCase = clone $this->testCase;
}
public function getTestCase(): TestCase
{
return $this->testCase;
}
public function getMetadata(): Metadata
{
return $this->metadata;
}
public function getScenario(): ?Scenario
{
if ($this->testCase instanceof Unit) {
return $this->testCase->getScenario();
}
return null;
}
public function fetchDependencies(): array
{
$names = [];
foreach ($this->metadata->getDependencies() as $required) {
if (!str_contains($required, ':') && method_exists($this->testCase::class, $required)) {
$required = $this->testCase::class . ':' . $required;
}
$names[] = $required;
}
return $names;
}
/**
* @return array<string, string>
*/
public function getReportFields(): array
{
return [
'name' => $this->getNameWithDataSet(),
'class' => $this->testCase::class,
'file' => $this->metadata->getFilename()
];
}
public function getLinesToBeCovered(): array|bool
{
$class = $this->testCase::class;
$method = $this->metadata->getName();
if (PHPUnitVersion::series() < 10) {
return TestUtil::getLinesToBeCovered($class, $method);
}
return (new CodeCoverage())->linesToBeCovered($class, $method);
}
public function getLinesToBeUsed(): array
{
$class = $this->testCase::class;
$method = $this->metadata->getName();
if (PHPUnitVersion::series() < 10) {
return TestUtil::getLinesToBeUsed($class, $method);
}
return (new CodeCoverage())->linesToBeUsed($class, $method);
}
public function test(): void
{
$dependencyInput = [];
foreach ($this->fetchDependencies() as $dependency) {
$dependencyInput[] = self::$testResults[$dependency] ?? null;
}
$this->testCase->setDependencyInput($dependencyInput);
$this->testCase->runBare();
$this->testCase->addToAssertionCount(Assert::getCount());
if (PHPUnitVersion::series() < 10) {
self::$testResults[$this->getSignature()] = $this->testCase->getResult();
} else {
self::$testResults[$this->getSignature()] = $this->testCase->result();
}
$numberOfAssertionsPerformed = $this->getNumAssertions();
if (
$this->reportUselessTests &&
$numberOfAssertionsPerformed > 0 &&
$this->testCase->doesNotPerformAssertions()
) {
throw new UselessTestException(
sprintf(
'This test indicates it does not perform assertions but %d assertions were performed',
$numberOfAssertionsPerformed
)
);
}
}
/**
* Is the test expected to not perform assertions with `expectNotToPerformAssertions`?
*/
protected function doesNotPerformAssertions(): bool
{
return $this->testCase->doesNotPerformAssertions();
}
public function toString(): string
{
$text = Descriptor::getTestCaseNameAsString($this->getNameWithDataSet());
return ReflectionHelper::getClassShortName($this->testCase) . ': ' . $text;
}
public function getFileName(): string
{
return $this->metadata->getFilename();
}
public function getSignature(): string
{
return $this->testCase::class . ':' . $this->metadata->getName();
}
private function getNameWithDataSet(): string
{
if (PHPUnitVersion::series() < 10) {
return $this->testCase->getName(true);
}
return $this->testCase->nameWithDataSet();
}
/**
* Override this method from the {@see \Codeception\Test\Feature\AssertionCounter} so that we use PHPUnit's
* assertion count instead of our own.
* This is needed because PHPUnit's {@see TestCase} has a {@see TestCase::addToAssertionCount()} method which is
* both internally and externally used to increase the assertion count. Externally it is called from tearDown
* methods, for example when using Mockery.
*/
public function getNumAssertions(): int
{
if (PHPUnitVersion::series() < 10) {
return $this->testCase->getNumAssertions();
} else {
return $this->testCase->numberOfAssertionsPerformed();
}
}
}