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 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
|
<?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\Advisory\Auditor;
use Composer\Config;
use Composer\Util\Platform;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
class ConfigTest extends TestCase
{
/**
* @param mixed[] $expected
* @param mixed[] $localConfig
* @param ?array<mixed> $systemConfig
*/
#[DataProvider('dataAddPackagistRepository')]
public function testAddPackagistRepository(array $expected, array $localConfig, ?array $systemConfig = null): void
{
$config = new Config(false);
if ($systemConfig) {
$config->merge(['repositories' => $systemConfig]);
}
$config->merge(['repositories' => $localConfig]);
self::assertEquals($expected, $config->getRepositories());
}
public static function dataAddPackagistRepository(): array
{
$data = [];
$data['local config inherits system defaults'] = [
[
'packagist.org' => ['type' => 'composer', 'url' => 'https://repo.packagist.org'],
],
[],
];
$data['local config can disable system config by name'] = [
[],
[
['packagist.org' => false],
],
];
$data['local config can disable system config by name bc'] = [
[],
[
['packagist' => false],
],
];
$data['local config adds above defaults'] = [
[
0 => ['type' => 'vcs', 'url' => 'git://github.com/composer/composer.git'],
1 => ['type' => 'pear', 'url' => 'http://pear.composer.org'],
'packagist.org' => ['type' => 'composer', 'url' => 'https://repo.packagist.org'],
],
[
['type' => 'vcs', 'url' => 'git://github.com/composer/composer.git'],
['type' => 'pear', 'url' => 'http://pear.composer.org'],
],
];
$data['system config adds above core defaults'] = [
[
'example.com' => ['type' => 'composer', 'url' => 'http://example.com'],
'packagist.org' => ['type' => 'composer', 'url' => 'https://repo.packagist.org'],
],
[],
[
'example.com' => ['type' => 'composer', 'url' => 'http://example.com'],
],
];
$data['local config can disable repos by name and re-add them anonymously to bring them above system config'] = [
[
1 => ['type' => 'composer', 'url' => 'http://packagist.org'],
'example.com' => ['type' => 'composer', 'url' => 'http://example.com'],
],
[
['packagist.org' => false],
['type' => 'composer', 'url' => 'http://packagist.org'],
],
[
'example.com' => ['type' => 'composer', 'url' => 'http://example.com'],
],
];
$data['local config can override by name to bring a repo above system config'] = [
[
'packagist.org' => ['type' => 'composer', 'url' => 'http://packagistnew.org'],
'example.com' => ['type' => 'composer', 'url' => 'http://example.com'],
],
[
'packagist.org' => ['type' => 'composer', 'url' => 'http://packagistnew.org'],
],
[
'example.com' => ['type' => 'composer', 'url' => 'http://example.com'],
],
];
$data['local config redefining packagist.org by URL override it if no named keys are used'] = [
[
['type' => 'composer', 'url' => 'https://repo.packagist.org'],
],
[
['type' => 'composer', 'url' => 'https://repo.packagist.org'],
],
];
$data['local config redefining packagist.org by URL override it also with named keys'] = [
[
'example' => ['type' => 'composer', 'url' => 'https://repo.packagist.org'],
],
[
'example' => ['type' => 'composer', 'url' => 'https://repo.packagist.org'],
],
];
$data['incorrect local config does not cause ErrorException'] = [
[
'packagist.org' => ['type' => 'composer', 'url' => 'https://repo.packagist.org'],
'type' => 'vcs',
'url' => 'http://example.com',
],
[
'type' => 'vcs',
'url' => 'http://example.com',
],
];
return $data;
}
public function testPreferredInstallAsString(): void
{
$config = new Config(false);
$config->merge(['config' => ['preferred-install' => 'source']]);
$config->merge(['config' => ['preferred-install' => 'dist']]);
self::assertEquals('dist', $config->get('preferred-install'));
}
public function testMergePreferredInstall(): void
{
$config = new Config(false);
$config->merge(['config' => ['preferred-install' => 'dist']]);
$config->merge(['config' => ['preferred-install' => ['foo/*' => 'source']]]);
// This assertion needs to make sure full wildcard preferences are placed last
// Handled by composer because we convert string preferences for BC, all other
// care for ordering and collision prevention is up to the user
self::assertEquals(['foo/*' => 'source', '*' => 'dist'], $config->get('preferred-install'));
}
public function testMergeGithubOauth(): void
{
$config = new Config(false);
$config->merge(['config' => ['github-oauth' => ['foo' => 'bar']]]);
$config->merge(['config' => ['github-oauth' => ['bar' => 'baz']]]);
self::assertEquals(['foo' => 'bar', 'bar' => 'baz'], $config->get('github-oauth'));
}
public function testVarReplacement(): void
{
$config = new Config(false);
$config->merge(['config' => ['a' => 'b', 'c' => '{$a}']]);
$config->merge(['config' => ['bin-dir' => '$HOME', 'cache-dir' => '~/foo/']]);
$home = rtrim(getenv('HOME') ?: getenv('USERPROFILE'), '\\/');
self::assertEquals('b', $config->get('c'));
self::assertEquals($home, $config->get('bin-dir'));
self::assertEquals($home.'/foo', $config->get('cache-dir'));
}
public function testRealpathReplacement(): void
{
$config = new Config(false, '/foo/bar');
$config->merge(['config' => [
'bin-dir' => '$HOME/foo',
'cache-dir' => '/baz/',
'vendor-dir' => 'vendor',
]]);
$home = rtrim(getenv('HOME') ?: getenv('USERPROFILE'), '\\/');
self::assertEquals('/foo/bar/vendor', $config->get('vendor-dir'));
self::assertEquals($home.'/foo', $config->get('bin-dir'));
self::assertEquals('/baz', $config->get('cache-dir'));
}
public function testStreamWrapperDirs(): void
{
$config = new Config(false, '/foo/bar');
$config->merge(['config' => [
'cache-dir' => 's3://baz/',
]]);
self::assertEquals('s3://baz', $config->get('cache-dir'));
}
public function testFetchingRelativePaths(): void
{
$config = new Config(false, '/foo/bar');
$config->merge(['config' => [
'bin-dir' => '{$vendor-dir}/foo',
'vendor-dir' => 'vendor',
]]);
self::assertEquals('/foo/bar/vendor', $config->get('vendor-dir'));
self::assertEquals('/foo/bar/vendor/foo', $config->get('bin-dir'));
self::assertEquals('vendor', $config->get('vendor-dir', Config::RELATIVE_PATHS));
self::assertEquals('vendor/foo', $config->get('bin-dir', Config::RELATIVE_PATHS));
}
public function testOverrideGithubProtocols(): void
{
$config = new Config(false);
$config->merge(['config' => ['github-protocols' => ['https', 'ssh']]]);
$config->merge(['config' => ['github-protocols' => ['https']]]);
self::assertEquals(['https'], $config->get('github-protocols'));
}
public function testGitDisabledByDefaultInGithubProtocols(): void
{
$config = new Config(false);
$config->merge(['config' => ['github-protocols' => ['https', 'git']]]);
self::assertEquals(['https'], $config->get('github-protocols'));
$config->merge(['config' => ['secure-http' => false]]);
self::assertEquals(['https', 'git'], $config->get('github-protocols'));
}
#[DataProvider('allowedUrlProvider')]
#[DoesNotPerformAssertions]
public function testAllowedUrlsPass(string $url): void
{
$config = new Config(false);
$config->prohibitUrlByConfig($url);
}
#[DataProvider('prohibitedUrlProvider')]
public function testProhibitedUrlsThrowException(string $url): void
{
self::expectException('Composer\Downloader\TransportException');
self::expectExceptionMessage('Your configuration does not allow connections to ' . $url);
$config = new Config(false);
$config->prohibitUrlByConfig($url);
}
/**
* @return string[][] List of test URLs that should pass strict security
*/
public static function allowedUrlProvider(): array
{
$urls = [
'https://packagist.org',
'git@github.com:composer/composer.git',
'hg://user:pass@my.satis/satis',
'\\myserver\myplace.git',
'file://myserver.localhost/mygit.git',
'file://example.org/mygit.git',
'git:Department/Repo.git',
'ssh://[user@]host.xz[:port]/path/to/repo.git/',
];
return array_combine($urls, array_map(static function ($e): array {
return [$e];
}, $urls));
}
/**
* @return string[][] List of test URLs that should not pass strict security
*/
public static function prohibitedUrlProvider(): array
{
$urls = [
'http://packagist.org',
'http://10.1.0.1/satis',
'http://127.0.0.1/satis',
'http://💛@example.org',
'svn://localhost/trunk',
'svn://will.not.resolve/trunk',
'svn://192.168.0.1/trunk',
'svn://1.2.3.4/trunk',
'git://5.6.7.8/git.git',
];
return array_combine($urls, array_map(static function ($e): array {
return [$e];
}, $urls));
}
public function testProhibitedUrlsWarningVerifyPeer(): void
{
$io = $this->getIOMock();
$io->expects([['text' => '<warning>Warning: Accessing example.org with verify_peer and verify_peer_name disabled.</warning>']], true);
$config = new Config(false);
$config->prohibitUrlByConfig('https://example.org', $io, [
'ssl' => [
'verify_peer' => false,
'verify_peer_name' => false,
],
]);
}
/**
* @group TLS
*/
public function testDisableTlsCanBeOverridden(): void
{
$config = new Config;
$config->merge(
['config' => ['disable-tls' => 'false']]
);
self::assertFalse($config->get('disable-tls'));
$config->merge(
['config' => ['disable-tls' => 'true']]
);
self::assertTrue($config->get('disable-tls'));
}
public function testProcessTimeout(): void
{
Platform::putEnv('COMPOSER_PROCESS_TIMEOUT', '0');
$config = new Config(true);
$result = $config->get('process-timeout');
Platform::clearEnv('COMPOSER_PROCESS_TIMEOUT');
self::assertEquals(0, $result);
}
public function testHtaccessProtect(): void
{
Platform::putEnv('COMPOSER_HTACCESS_PROTECT', '0');
$config = new Config(true);
$result = $config->get('htaccess-protect');
Platform::clearEnv('COMPOSER_HTACCESS_PROTECT');
self::assertEquals(0, $result);
}
public function testGetSourceOfValue(): void
{
Platform::clearEnv('COMPOSER_PROCESS_TIMEOUT');
$config = new Config;
self::assertSame(Config::SOURCE_DEFAULT, $config->getSourceOfValue('process-timeout'));
$config->merge(
['config' => ['process-timeout' => 1]],
'phpunit-test'
);
self::assertSame('phpunit-test', $config->getSourceOfValue('process-timeout'));
}
public function testGetSourceOfValueEnvVariables(): void
{
Platform::putEnv('COMPOSER_HTACCESS_PROTECT', '0');
$config = new Config;
$result = $config->getSourceOfValue('htaccess-protect');
Platform::clearEnv('COMPOSER_HTACCESS_PROTECT');
self::assertEquals('COMPOSER_HTACCESS_PROTECT', $result);
}
public function testAudit(): void
{
$config = new Config(true);
$result = $config->get('audit');
self::assertArrayHasKey('abandoned', $result);
self::assertArrayHasKey('ignore', $result);
self::assertSame(Auditor::ABANDONED_FAIL, $result['abandoned']);
self::assertSame([], $result['ignore']);
Platform::putEnv('COMPOSER_AUDIT_ABANDONED', Auditor::ABANDONED_IGNORE);
$result = $config->get('audit');
Platform::clearEnv('COMPOSER_AUDIT_ABANDONED');
self::assertArrayHasKey('abandoned', $result);
self::assertArrayHasKey('ignore', $result);
self::assertSame(Auditor::ABANDONED_IGNORE, $result['abandoned']);
self::assertSame([], $result['ignore']);
$config->merge(['config' => ['audit' => ['ignore' => ['A', 'B']]]]);
$config->merge(['config' => ['audit' => ['ignore' => ['A', 'C']]]]);
$result = $config->get('audit');
self::assertArrayHasKey('ignore', $result);
self::assertSame(['A', 'B', 'A', 'C'], $result['ignore']);
// Test COMPOSER_SECURITY_BLOCKING_ABANDONED env var
Platform::putEnv('COMPOSER_SECURITY_BLOCKING_ABANDONED', '1');
$result = $config->get('audit');
Platform::clearEnv('COMPOSER_SECURITY_BLOCKING_ABANDONED');
self::assertArrayHasKey('block-abandoned', $result);
self::assertSame(true, $result['block-abandoned']);
Platform::putEnv('COMPOSER_SECURITY_BLOCKING_ABANDONED', '0');
$result = $config->get('audit');
Platform::clearEnv('COMPOSER_SECURITY_BLOCKING_ABANDONED');
self::assertArrayHasKey('block-abandoned', $result);
self::assertSame(false, $result['block-abandoned']);
}
public function testGetDefaultsToAnEmptyArray(): void
{
$config = new Config;
$keys = [
'bitbucket-oauth',
'github-oauth',
'gitlab-oauth',
'gitlab-token',
'forgejo-token',
'http-basic',
'bearer',
];
foreach ($keys as $key) {
$value = $config->get($key);
self::assertIsArray($value);
self::assertCount(0, $value);
}
}
public function testMergesPluginConfig(): void
{
$config = new Config(false);
$config->merge(['config' => ['allow-plugins' => ['some/plugin' => true]]]);
self::assertEquals(['some/plugin' => true], $config->get('allow-plugins'));
$config->merge(['config' => ['allow-plugins' => ['another/plugin' => true]]]);
self::assertEquals(['some/plugin' => true, 'another/plugin' => true], $config->get('allow-plugins'));
}
public function testOverridesGlobalBooleanPluginsConfig(): void
{
$config = new Config(false);
$config->merge(['config' => ['allow-plugins' => true]]);
self::assertEquals(true, $config->get('allow-plugins'));
$config->merge(['config' => ['allow-plugins' => ['another/plugin' => true]]]);
self::assertEquals(['another/plugin' => true], $config->get('allow-plugins'));
}
public function testAllowsAllPluginsFromLocalBoolean(): void
{
$config = new Config(false);
$config->merge(['config' => ['allow-plugins' => ['some/plugin' => true]]]);
self::assertEquals(['some/plugin' => true], $config->get('allow-plugins'));
$config->merge(['config' => ['allow-plugins' => true]]);
self::assertEquals(true, $config->get('allow-plugins'));
}
}
|