forked from infection/infection
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CoverageChecker.php
255 lines (224 loc) · 8.41 KB
/
CoverageChecker.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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<?php
/**
* This code is licensed under the BSD 3-Clause License.
*
* Copyright (c) 2017, Maks Rafalko
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
declare(strict_types=1);
namespace Infection\TestFramework\Coverage;
use Composer\XdebugHandler\XdebugHandler;
use function count;
use function extension_loaded;
use function implode;
use Infection\FileSystem\Locator\FileNotFound;
use Infection\TestFramework\Coverage\JUnit\JUnitReportLocator;
use Infection\TestFramework\Coverage\XmlReport\IndexXmlCoverageLocator;
use const PHP_EOL;
use const PHP_SAPI;
use function Safe\preg_match;
use function Safe\sprintf;
use function strtolower;
/**
* @internal
* @final
*/
class CoverageChecker
{
private const PHPUNIT = 'phpunit';
private const CODECEPTION = 'codeception';
private bool $skipCoverage;
private bool $skipInitialTests;
private string $initialTestPhpOptions;
private string $coveragePath;
private bool $jUnitReport;
private JUnitReportLocator $jUnitReportLocator;
private string $frameworkAdapterName;
private IndexXmlCoverageLocator $indexXmlCoverageLocator;
public function __construct(
bool $skipCoverage,
bool $skipInitialTests,
string $initialTestPhpOptions,
string $coveragePath,
bool $junitReport,
JUnitReportLocator $jUnitReportLocator,
string $testFrameworkAdapterName,
IndexXmlCoverageLocator $indexXmlCoverageLocator
) {
$this->skipCoverage = $skipCoverage;
$this->skipInitialTests = $skipInitialTests;
$this->initialTestPhpOptions = $initialTestPhpOptions;
$this->coveragePath = $coveragePath;
$this->jUnitReport = $junitReport;
$this->jUnitReportLocator = $jUnitReportLocator;
$this->frameworkAdapterName = strtolower($testFrameworkAdapterName);
$this->indexXmlCoverageLocator = $indexXmlCoverageLocator;
}
public function checkCoverageRequirements(): void
{
if ($this->skipInitialTests && !$this->skipCoverage) {
throw new CoverageNotFound(sprintf(
'The initial test suite run is being skipped. The XML %sreports need to be '
. 'provided with the "--coverage" option',
$this->jUnitReport
? 'and JUnit coverage '
: ''
));
}
if (!$this->skipCoverage && !$this->hasCoverageGeneratorEnabled()) {
throw new CoverageNotFound(<<<TXT
Coverage needs to be generated but no code coverage generator (pcov, phpdbg or xdebug) has been detected. Please either:
- Enable pcov and run Infection again
- Use phpdbg, e.g. `phpdbg -qrr infection`
- Enable Xdebug and run Infection again
- Use the "--coverage" option with path to the existing coverage report
- Enable the code generator tool for the initial test run only, e.g. with `--initial-tests-php-options -d zend_extension=xdebug.so`
TXT
);
}
}
public function checkCoverageExists(): void
{
$this->checkIndexCoverageReport();
$this->checkJUnitReport();
}
public function checkCoverageHasBeenGenerated(
string $initialTestSuiteCommandLine,
string $initialTestSuiteOutput
): void {
$errors = [];
try {
$this->indexXmlCoverageLocator->locate();
} catch (FileNotFound $exception) {
$errors[] = sprintf(
'- The file "index.xml" could not be found: %s',
$exception->getMessage()
);
}
if ($this->jUnitReport) {
try {
$this->jUnitReportLocator->locate();
} catch (FileNotFound $exception) {
$errors[] = sprintf(
'- The JUnit file could not be found: %s',
$exception->getMessage()
);
}
}
if (count($errors) === 0) {
return;
}
$message = sprintf(<<<TXT
The code coverage generated by the initial test run is invalid. Please report the issue on the
infection repository "%s".
```
$ %s
%s
```
Issue(s):
%s
TXT
,
'https://github.com/infection/infection',
$initialTestSuiteCommandLine,
$initialTestSuiteOutput,
implode(PHP_EOL, $errors)
);
throw new CoverageNotFound($message);
}
private function hasCoverageGeneratorEnabled(): bool
{
return PHP_SAPI === 'phpdbg'
|| XdebugHandler::isXdebugActive()
|| extension_loaded('pcov')
|| XdebugHandler::getSkippedVersion()
|| $this->isXdebugIncludedInInitialTestPhpOptions()
|| $this->isPcovIncludedInInitialTestPhpOptions();
}
private function isXdebugIncludedInInitialTestPhpOptions(): bool
{
return (bool) preg_match(
'/(zend_extension\s*=.*xdebug.*)/mi',
$this->initialTestPhpOptions
);
}
private function isPcovIncludedInInitialTestPhpOptions(): bool
{
return (bool) preg_match(
'/(extension\s*=.*pcov.*)/mi',
$this->initialTestPhpOptions
);
}
private function checkIndexCoverageReport(): void
{
try {
$this->indexXmlCoverageLocator->locate();
return;
} catch (FileNotFound $exception) {
// Continue
}
$message = 'Could not find the "index.xml" file. Please ensure that the XML coverage '
. 'report has been properly generated at the right place.'
;
if ($this->frameworkAdapterName === self::PHPUNIT) {
$message .= sprintf(
' The PHPUnit option for the path given is "--coverage-xml=%s"',
$this->coveragePath . '/coverage-xml'
);
} elseif ($this->frameworkAdapterName === self::CODECEPTION) {
$message .= sprintf(
' The Codeception option for the path given is "--coverage-phpunit=%s"',
$this->coveragePath . '/coverage-xml'
);
}
throw new CoverageNotFound($message, 0, $exception);
}
private function checkJUnitReport(): void
{
if (!$this->jUnitReport) {
return;
}
try {
$this->jUnitReportLocator->locate();
return;
} catch (FileNotFound $exception) {
// Continue
}
$message = 'Could not find the JUnit file report. Please ensure that the JUnit coverage'
. ' report has been properly generated at the right place.';
if ($this->frameworkAdapterName === self::PHPUNIT) {
$message .= sprintf(
' The PHPUnit option for the path given is "--log-junit=%s/junit.xml"',
$this->coveragePath
);
} elseif ($this->frameworkAdapterName === self::CODECEPTION) {
$message .= ' The Codeception option for the path given is "--xml"';
}
throw new CoverageNotFound($message, 0, $exception);
}
}