forked from composer/composer
/
TestCase.php
338 lines (288 loc) · 9.91 KB
/
TestCase.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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<?php declare(strict_types=1);
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Composer\Test;
use Composer\Config;
use Composer\Console\Application;
use Composer\IO\IOInterface;
use Composer\Json\JsonFile;
use Composer\Pcre\Preg;
use Composer\Semver\VersionParser;
use Composer\Package\PackageInterface;
use Composer\Semver\Constraint\Constraint;
use Composer\Test\Mock\HttpDownloaderMock;
use Composer\Test\Mock\ProcessExecutorMock;
use Composer\Util\Filesystem;
use Composer\Util\Platform;
use Composer\Util\Silencer;
use Symfony\Component\Console\Tester\ApplicationTester;
use Symfony\Component\Process\ExecutableFinder;
use Composer\Package\Loader\ArrayLoader;
use Composer\Package\BasePackage;
use Composer\Package\RootPackage;
use Composer\Package\AliasPackage;
use Composer\Package\RootAliasPackage;
use Composer\Package\CompletePackage;
use Composer\Package\CompleteAliasPackage;
use Composer\Package\Package;
use Symfony\Component\Process\Process;
abstract class TestCase extends \PHPUnit\Framework\TestCase
{
/**
* @var ?VersionParser
*/
private static $parser;
/**
* @var array<string, bool>
*/
private static $executableCache = array();
/**
* @var list<HttpDownloaderMock>
*/
private $httpDownloaderMocks = [];
/**
* @var list<ProcessExecutorMock>
*/
private $processExecutorMocks = [];
/**
* @var list<string>
*/
private $tempComposerDirs = [];
/** @var string|null */
private $prevCwd = null;
protected function tearDown(): void
{
parent::tearDown();
foreach ($this->httpDownloaderMocks as $mock) {
$mock->assertComplete();
}
foreach ($this->processExecutorMocks as $mock) {
$mock->assertComplete();
}
if (null !== $this->prevCwd) {
chdir($this->prevCwd);
$this->prevCwd = null;
Platform::clearEnv('COMPOSER_HOME');
Platform::clearEnv('COMPOSER_DISABLE_XDEBUG_WARN');
}
$fs = new Filesystem();
foreach ($this->tempComposerDirs as $dir) {
$fs->removeDirectory($dir);
}
}
/**
* @return string
*/
public static function getUniqueTmpDirectory(): string
{
$attempts = 5;
$root = sys_get_temp_dir();
do {
$unique = $root . DIRECTORY_SEPARATOR . uniqid('composer-test-' . random_int(1000, 9000));
if (!file_exists($unique) && Silencer::call('mkdir', $unique, 0777)) {
return realpath($unique);
}
} while (--$attempts);
throw new \RuntimeException('Failed to create a unique temporary directory.');
}
/**
* Creates a composer.json / auth.json inside a temp dir and chdir() into it
*
* The directory will be cleaned up on tearDown automatically.
*
* @param mixed[] $composerJson
* @param mixed[] $authJson
* @return string the newly created temp dir
*/
public function initTempComposer(array $composerJson = [], array $authJson = []): string
{
$dir = self::getUniqueTmpDirectory();
$this->tempComposerDirs[] = $dir;
$this->prevCwd = Platform::getCwd();
Platform::putEnv('COMPOSER_HOME', $dir.'/composer-home');
Platform::putEnv('COMPOSER_DISABLE_XDEBUG_WARN', '1');
if ($composerJson === []) {
$composerJson = new \stdClass;
}
if ($authJson === []) {
$authJson = new \stdClass;
}
chdir($dir);
file_put_contents($dir.'/composer.json', JsonFile::encode($composerJson, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
file_put_contents($dir.'/auth.json', JsonFile::encode($authJson, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
return $dir;
}
public function getApplicationTester(): ApplicationTester
{
$application = new Application();
$application->setAutoExit(false);
$application->setCatchExceptions(false);
return new ApplicationTester($application);
}
/**
* @return VersionParser
*/
protected static function getVersionParser(): VersionParser
{
if (!self::$parser) {
self::$parser = new VersionParser();
}
return self::$parser;
}
/**
* @param Constraint::STR_OP_* $operator
* @param string $version
* @return Constraint
*/
protected function getVersionConstraint($operator, string $version): Constraint
{
$constraint = new Constraint(
$operator,
self::getVersionParser()->normalize($version)
);
$constraint->setPrettyString($operator.' '.$version);
return $constraint;
}
/**
* @template PackageClass of CompletePackage|CompleteAliasPackage
*
* @param string $class FQCN to be instantiated
* @param string $name
* @param string $version
*
* @return CompletePackage|CompleteAliasPackage|RootPackage|RootAliasPackage
*
* @phpstan-param class-string<PackageClass> $class
* @phpstan-return PackageClass
*/
protected function getPackage(string $name = 'dummy/pkg', string $version = '1.0.0', string $class = 'Composer\Package\CompletePackage'): BasePackage
{
$normVersion = self::getVersionParser()->normalize($version);
return new $class($name, $normVersion, $version);
}
protected function getRootPackage(string $name = '__root__', string $version = '1.0.0'): RootPackage
{
$normVersion = self::getVersionParser()->normalize($version);
return new RootPackage($name, $normVersion, $version);
}
/**
* @param string $version
* @return ($package is RootPackage ? RootAliasPackage : ($package is CompletePackage ? CompleteAliasPackage : AliasPackage))
*/
protected function getAliasPackage(Package $package, string $version): AliasPackage
{
$normVersion = self::getVersionParser()->normalize($version);
if ($package instanceof RootPackage) {
return new RootAliasPackage($package, $normVersion, $version);
}
if ($package instanceof CompletePackage) {
return new CompleteAliasPackage($package, $normVersion, $version);
}
return new AliasPackage($package, $normVersion, $version);
}
/**
* @param array<string, array<string, string>> $config
* @return void
*/
protected function configureLinks(PackageInterface $package, array $config): void
{
$arrayLoader = new ArrayLoader();
foreach (BasePackage::$supportedLinkTypes as $type => $opts) {
if (isset($config[$type])) {
$method = 'set'.ucfirst($opts['method']);
$package->{$method}(
$arrayLoader->parseLinks(
$package->getName(),
$package->getPrettyVersion(),
$opts['method'],
$config[$type]
)
);
}
}
}
/**
* @param array<mixed> $configOptions
*/
protected function getConfig(array $configOptions = [], bool $useEnvironment = false): Config
{
$config = new Config($useEnvironment);
$config->merge(['config' => $configOptions], 'test');
return $config;
}
/**
* @param string $directory
* @return void
*/
protected static function ensureDirectoryExistsAndClear(string $directory): void
{
$fs = new Filesystem();
if (is_dir($directory)) {
$fs->removeDirectory($directory);
}
mkdir($directory, 0777, true);
}
/**
* Check whether or not the given name is an available executable.
*
* @param string $executableName The name of the binary to test.
*
* @return void
*
* @throws \PHPUnit\Framework\SkippedTestError
*/
protected function skipIfNotExecutable(string $executableName): void
{
if (!isset(self::$executableCache[$executableName])) {
$finder = new ExecutableFinder();
self::$executableCache[$executableName] = (bool) $finder->find($executableName);
}
if (false === self::$executableCache[$executableName]) {
$this->markTestSkipped($executableName . ' is not found or not executable.');
}
}
/**
* Transforms an escaped non-Windows command to match Windows escaping.
*
* @param string $cmd
*
* @return string The transformed command
*/
protected function getCmd(string $cmd): string
{
if (Platform::isWindows()) {
$cmd = Preg::replaceCallback("/('[^']*')/", function ($m) {
// Double-quotes are used only when needed
$char = (strpbrk($m[1], " \t^&|<>()") !== false || $m[1] === "''") ? '"' : '';
return str_replace("'", $char, $m[1]);
}, $cmd);
}
return $cmd;
}
protected function getHttpDownloaderMock(IOInterface $io = null, Config $config = null): HttpDownloaderMock
{
$this->httpDownloaderMocks[] = $mock = new HttpDownloaderMock($io, $config);
return $mock;
}
protected function getProcessExecutorMock(): ProcessExecutorMock
{
$this->processExecutorMocks[] = $mock = new ProcessExecutorMock($this->getMockBuilder(Process::class));
return $mock;
}
protected function createTempFile(?string $dir = null): string
{
$dir = $dir ?? sys_get_temp_dir();
$name = tempnam($dir, 'c');
if ($name === false) {
throw new \UnexpectedValueException('tempnam failed to create a temporary file in '.$dir);
}
return $name;
}
}