/
InitialConfigBuilder.php
158 lines (131 loc) · 5.81 KB
/
InitialConfigBuilder.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
<?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\PhpUnit\Config\Builder;
use DOMDocument;
use Infection\TestFramework\Config\InitialConfigBuilder as ConfigBuilder;
use Infection\TestFramework\PhpUnit\Config\XmlConfigurationManipulator;
use Infection\TestFramework\PhpUnit\Config\XmlConfigurationVersionProvider;
use Infection\TestFramework\SafeDOMXPath;
use function Safe\file_put_contents;
use function Safe\sprintf;
use function version_compare;
use Webmozart\Assert\Assert;
/**
* @internal
*/
class InitialConfigBuilder implements ConfigBuilder
{
private string $originalXmlConfigContent;
/**
* @param string[] $srcDirs
* @param list<string> $filteredSourceFilesToMutate
*/
public function __construct(
private string $tmpDir,
string $originalXmlConfigContent,
private XmlConfigurationManipulator $configManipulator,
private XmlConfigurationVersionProvider $versionProvider,
private array $srcDirs,
private array $filteredSourceFilesToMutate
) {
Assert::notEmpty(
$originalXmlConfigContent,
'The original XML config content cannot be an empty string'
);
$this->originalXmlConfigContent = $originalXmlConfigContent;
}
public function build(string $version): string
{
$path = $this->buildPath();
$dom = new DOMDocument();
$dom->preserveWhiteSpace = false;
$dom->formatOutput = true;
$success = @$dom->loadXML($this->originalXmlConfigContent);
Assert::true($success);
$xPath = new SafeDOMXPath($dom);
$this->configManipulator->validate($path, $xPath);
$this->addCoverageNodes($version, $xPath);
$this->addRandomTestsOrderAttributesIfNotSet($version, $xPath);
$this->configManipulator->addFailOnAttributesIfNotSet($version, $xPath);
$this->configManipulator->replaceWithAbsolutePaths($xPath);
$this->configManipulator->setStopOnFailure($xPath);
$this->configManipulator->deactivateColours($xPath);
$this->configManipulator->deactivateResultCaching($xPath);
$this->configManipulator->deactivateStderrRedirection($xPath);
$this->configManipulator->removeExistingLoggers($xPath);
$this->configManipulator->removeExistingPrinters($xPath);
file_put_contents($path, $dom->saveXML());
return $path;
}
private function buildPath(): string
{
return $this->tmpDir . '/phpunitConfiguration.initial.infection.xml';
}
private function addCoverageNodes(string $version, SafeDOMXPath $xPath): void
{
if (version_compare($version, '10', '>=')) {
$this->configManipulator->addOrUpdateCoverageIncludeNodes($xPath, $this->srcDirs, $this->filteredSourceFilesToMutate);
return;
}
if (version_compare($version, '9.3', '<')) {
$this->configManipulator->addOrUpdateLegacyCoverageWhitelistNodes($xPath, $this->srcDirs, $this->filteredSourceFilesToMutate);
return;
}
// For versions between 9.3 and 10.0, fallback to version provider
if (version_compare($this->versionProvider->provide($xPath), '9.3', '>=')) {
$this->configManipulator->addOrUpdateCoverageIncludeNodes($xPath, $this->srcDirs, $this->filteredSourceFilesToMutate);
return;
}
$this->configManipulator->addOrUpdateLegacyCoverageWhitelistNodes($xPath, $this->srcDirs, $this->filteredSourceFilesToMutate);
}
private function addRandomTestsOrderAttributesIfNotSet(string $version, SafeDOMXPath $xPath): void
{
if (version_compare($version, '7.2', '<')) {
return;
}
if ($this->addAttributeIfNotSet('executionOrder', 'random', $xPath)) {
$this->addAttributeIfNotSet('resolveDependencies', 'true', $xPath);
}
}
private function addAttributeIfNotSet(string $attribute, string $value, SafeDOMXPath $xPath): bool
{
$nodeList = $xPath->query(sprintf('/phpunit/@%s', $attribute));
if ($nodeList->length === 0) {
$node = $xPath->query('/phpunit')[0];
$node->setAttribute($attribute, $value);
return true;
}
return false;
}
}