Task: #53687 Refactor CLI input validation into option validators, add validator coverage, and refactor cfg CLI tests
This commit is contained in:
parent
480d97c804
commit
1c851632c3
2 changed files with 380 additions and 287 deletions
|
|
@ -8,6 +8,7 @@ class CfgTest extends TestCase
|
|||
{
|
||||
private string $tmpDir;
|
||||
|
||||
/* Lifecycle {{{ */
|
||||
protected function setUp(): void
|
||||
{
|
||||
$this->tmpDir = rtrim(sys_get_temp_dir(), '/').'/util-settings-cfg-'.bin2hex(random_bytes(8));
|
||||
|
|
@ -24,18 +25,16 @@ class CfgTest extends TestCase
|
|||
{
|
||||
$this->removeDir($this->tmpDir);
|
||||
}
|
||||
/* }}} */
|
||||
|
||||
/* Write Flow {{{ */
|
||||
public function testWriteWithoutDirectoryNameUsesLocalConfigFile(): void
|
||||
{
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="X100"',
|
||||
]);
|
||||
$result = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $result['code'], $result['output']);
|
||||
$this->assertCfgSuccess($result);
|
||||
|
||||
$localFile = $this->tmpDir.'/config/Extension.conf.php';
|
||||
$this->assertFileExists($localFile);
|
||||
|
|
@ -51,46 +50,34 @@ class CfgTest extends TestCase
|
|||
"<?php return [\n\t'module' => [\n\t\t'code' => '',\n\t],\n];\n"
|
||||
);
|
||||
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="X100"',
|
||||
]);
|
||||
$result = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $result['code'], $result['output']);
|
||||
$this->assertCfgSuccess($result);
|
||||
$this->assertFileExists($this->tmpDir.'/config/Extension.conf.php');
|
||||
}
|
||||
|
||||
public function testWriteWithInputFileWritesMultipleSettings(): void
|
||||
{
|
||||
$inFile = $this->tmpDir.'/extension-in.json';
|
||||
file_put_contents(
|
||||
$inFile,
|
||||
json_encode([
|
||||
'module' => [
|
||||
'code' => 'X100',
|
||||
'label' => 'demo-module',
|
||||
],
|
||||
'feature' => [
|
||||
'endpoint' => 'https://example.invalid/v1/resource',
|
||||
],
|
||||
], JSON_PRETTY_PRINT)
|
||||
);
|
||||
$inFile = $this->createJsonInputFile([
|
||||
'module' => [
|
||||
'code' => 'X100',
|
||||
'label' => 'demo-module',
|
||||
],
|
||||
'feature' => [
|
||||
'endpoint' => 'https://example.invalid/v1/resource',
|
||||
],
|
||||
]);
|
||||
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
$result = $this->runWrite([
|
||||
'--siteDir=owner_xyz',
|
||||
'-i',
|
||||
$inFile,
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $result['code'], $result['output']);
|
||||
$cfg = require $this->tmpDir.'/config/owner_xyz/Extension.conf.php';
|
||||
$this->assertCfgSuccess($result);
|
||||
$cfg = $this->loadWrittenConfig('owner_xyz');
|
||||
$this->assertSame('X100', $cfg['module']['code']);
|
||||
$this->assertSame('demo-module', $cfg['module']['label']);
|
||||
$this->assertSame('https://example.invalid/v1/resource', $cfg['feature']['endpoint']);
|
||||
|
|
@ -98,68 +85,59 @@ class CfgTest extends TestCase
|
|||
|
||||
public function testWriteAcceptsJsonStringValueInSetting(): void
|
||||
{
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module={"code":"X100","label":"demo-module"}',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$result = $this->runWrite([
|
||||
'module={"code":"X100","label":"demo-module"}',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $result['code'], $result['output']);
|
||||
$cfg = require $this->tmpDir.'/config/owner_xyz/Extension.conf.php';
|
||||
$this->assertCfgSuccess($result);
|
||||
$cfg = $this->loadWrittenConfig('owner_xyz');
|
||||
$this->assertSame('X100', $cfg['module']['code']);
|
||||
$this->assertSame('demo-module', $cfg['module']['label']);
|
||||
}
|
||||
|
||||
public function testWriteSupportsNestedPathWithColonNotation(): void
|
||||
{
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
$result = $this->runWrite([
|
||||
'module:flags:enabled=true',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $result['code'], $result['output']);
|
||||
$cfg = require $this->tmpDir.'/config/owner_xyz/Extension.conf.php';
|
||||
$this->assertCfgSuccess($result);
|
||||
$cfg = $this->loadWrittenConfig('owner_xyz');
|
||||
$this->assertTrue($cfg['module']['flags']['enabled']);
|
||||
}
|
||||
|
||||
public function testWriteWithInputFileAndSettingReturnsError(): void
|
||||
public function testWriteCoercesSimpleStringValueToJsonString(): void
|
||||
{
|
||||
$inFile = $this->tmpDir.'/extension-in.json';
|
||||
file_put_contents($inFile, json_encode(['module' => ['code' => 'X100']]));
|
||||
$result = $this->runWrite([
|
||||
'module:code=X100',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="x"',
|
||||
'-i',
|
||||
$inFile,
|
||||
]);
|
||||
$this->assertCfgSuccess($result);
|
||||
$cfg = $this->loadWrittenConfig('owner_xyz');
|
||||
$this->assertSame('X100', $cfg['module']['code']);
|
||||
}
|
||||
|
||||
$this->assertSame(1, $result['code']);
|
||||
$this->assertStringContainsString('Please use either SETTING or --in, not both.', $result['output']);
|
||||
public function testWriteRejectsInvalidJsonStringValue(): void
|
||||
{
|
||||
$result = $this->runWrite([
|
||||
'module={"code":',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
|
||||
$this->assertCfgFailure($result, 'The value does not appear to be a valid JSON string.');
|
||||
}
|
||||
|
||||
public function testWriteWithSiteDirCreatesAndWritesSiteConfig(): void
|
||||
{
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
$result = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $result['code'], $result['output']);
|
||||
$this->assertCfgSuccess($result);
|
||||
|
||||
$siteFile = $this->tmpDir.'/config/owner_xyz/Extension.conf.php';
|
||||
$this->assertFileExists($siteFile);
|
||||
|
|
@ -171,28 +149,19 @@ class CfgTest extends TestCase
|
|||
|
||||
public function testWriteWithSiteDirMergesIntoExistingSiteConfig(): void
|
||||
{
|
||||
$firstWrite = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
$firstWrite = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$this->assertSame(0, $firstWrite['code'], $firstWrite['output']);
|
||||
$this->assertCfgSuccess($firstWrite);
|
||||
|
||||
$secondWrite = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
$secondWrite = $this->runWrite([
|
||||
'module:label="demo-module"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$this->assertSame(0, $secondWrite['code'], $secondWrite['output']);
|
||||
$this->assertCfgSuccess($secondWrite);
|
||||
|
||||
$siteFile = $this->tmpDir.'/config/owner_xyz/Extension.conf.php';
|
||||
$cfg = require $siteFile;
|
||||
$cfg = $this->loadWrittenConfig('owner_xyz');
|
||||
|
||||
$this->assertSame('X100', $cfg['module']['code']);
|
||||
$this->assertSame('demo-module', $cfg['module']['label']);
|
||||
|
|
@ -200,56 +169,62 @@ class CfgTest extends TestCase
|
|||
|
||||
public function testWriteWithSiteDirUsingConfigPrefixIsNormalized(): void
|
||||
{
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="X100"',
|
||||
'--siteDir=config/owner_xyz',
|
||||
]);
|
||||
$result = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
'--siteDir=config/owner_xyz',
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $result['code'], $result['output']);
|
||||
$this->assertCfgSuccess($result);
|
||||
$this->assertFileExists($this->tmpDir.'/config/owner_xyz/Extension.conf.php');
|
||||
$this->assertFileDoesNotExist($this->tmpDir.'/config/config/owner_xyz/Extension.conf.php');
|
||||
}
|
||||
|
||||
public function testWriteWithSiteDirUsingAbsoluteConfigPrefixIsNormalized(): void
|
||||
{
|
||||
$result = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
'--siteDir='.$this->tmpDir.'/config/owner_xyz',
|
||||
]);
|
||||
|
||||
$this->assertCfgSuccess($result);
|
||||
$this->assertFileExists($this->tmpDir.'/config/owner_xyz/Extension.conf.php');
|
||||
}
|
||||
|
||||
public function testWriteWithNestedSiteDirWritesToNestedSiteConfig(): void
|
||||
{
|
||||
$result = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
'--siteDir=owner_xyz/sub_a',
|
||||
]);
|
||||
|
||||
$this->assertCfgSuccess($result);
|
||||
$this->assertFileExists($this->tmpDir.'/config/owner_xyz/sub_a/Extension.conf.php');
|
||||
}
|
||||
|
||||
public function testWriteWithSiteDirWritesToSiteConfig(): void
|
||||
{
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="X100"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$result = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $result['code'], $result['output']);
|
||||
$this->assertCfgSuccess($result);
|
||||
$this->assertFileExists($this->tmpDir.'/config/owner_xyz/Extension.conf.php');
|
||||
}
|
||||
|
||||
public function testWriteToExistingSiteConfigCreatesBackup(): void
|
||||
{
|
||||
$firstWrite = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="first"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$this->assertSame(0, $firstWrite['code'], $firstWrite['output']);
|
||||
$firstWrite = $this->runWrite([
|
||||
'module:code="first"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$this->assertCfgSuccess($firstWrite);
|
||||
|
||||
$secondWrite = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="second"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$this->assertSame(0, $secondWrite['code'], $secondWrite['output']);
|
||||
$secondWrite = $this->runWrite([
|
||||
'module:code="second"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$this->assertCfgSuccess($secondWrite);
|
||||
|
||||
$siteFile = $this->tmpDir.'/config/owner_xyz/Extension.conf.php';
|
||||
$backupFile = $siteFile.'.bak';
|
||||
|
|
@ -260,74 +235,180 @@ class CfgTest extends TestCase
|
|||
$this->assertSame('second', $current['module']['code']);
|
||||
$this->assertSame('first', $backup['module']['code']);
|
||||
}
|
||||
/* }}} */
|
||||
|
||||
/* Show Flow {{{ */
|
||||
public function testShowWithSiteReturnsSiteSpecificValue(): void
|
||||
{
|
||||
$this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="X100"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$this->runWrite([
|
||||
'module:code="X100"',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
|
||||
$show = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'show',
|
||||
'Extension',
|
||||
'module:code',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
$show = $this->runShow([
|
||||
'module:code',
|
||||
'--siteDir=owner_xyz',
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $show['code'], $show['output']);
|
||||
$this->assertCfgSuccess($show);
|
||||
$this->assertStringContainsString('X100', $show['output']);
|
||||
}
|
||||
/* }}} */
|
||||
|
||||
public function testSiteDirRejectsTraversal(): void
|
||||
/* Validation {{{ */
|
||||
public function testInvalidActionReturnsError(): void
|
||||
{
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="X100"',
|
||||
'--siteDir=../owner_xyz',
|
||||
]);
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'delete',
|
||||
'Extension',
|
||||
]);
|
||||
|
||||
$this->assertSame(1, $result['code']);
|
||||
$this->assertStringContainsString('Invalid directory in --siteDir', $result['output']);
|
||||
}
|
||||
|
||||
public function testSiteDirRejectsInvalidSegment(): void
|
||||
{
|
||||
$result = $this->runCfg([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="X100"',
|
||||
'--siteDir=owner xyz',
|
||||
]);
|
||||
|
||||
$this->assertSame(1, $result['code']);
|
||||
$this->assertStringContainsString("Invalid directory name segment 'owner xyz' in --siteDir.", $result['output']);
|
||||
$this->assertCfgFailure($result, "'delete' not found");
|
||||
}
|
||||
|
||||
public function testSiteDirRejectsEmptyValue(): void
|
||||
{
|
||||
$result = $this->runCfg([
|
||||
$result = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
'--siteDir=',
|
||||
]);
|
||||
|
||||
$this->assertCfgFailure($result, 'a value is required for --siteDir');
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider siteDirValidationDataProvider
|
||||
*/
|
||||
public function testSiteDirValidation(string $siteDir, string $expectedMessage): void
|
||||
{
|
||||
$result = $this->runWrite([
|
||||
'module:code="X100"',
|
||||
'--siteDir='.$siteDir,
|
||||
]);
|
||||
|
||||
$this->assertCfgFailure($result, $expectedMessage);
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider inputFileValidationDataProvider
|
||||
*/
|
||||
public function testInputFileValidation(?string $fileContents, string $pathSuffix, string $expectedMessage): void
|
||||
{
|
||||
$inFile = $this->tmpDir.'/'.$pathSuffix;
|
||||
if ($fileContents !== null) {
|
||||
file_put_contents($inFile, $fileContents);
|
||||
}
|
||||
|
||||
$result = $this->runWrite([
|
||||
'-i',
|
||||
$inFile,
|
||||
]);
|
||||
|
||||
$this->assertCfgFailure($result, $expectedMessage);
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider writePayloadSourceValidationDataProvider
|
||||
*/
|
||||
public function testWritePayloadSourceValidation(array $extraArgs, string $expectedMessage): void
|
||||
{
|
||||
$inFile = $this->createJsonInputFile(['module' => ['code' => 'X100']]);
|
||||
|
||||
$args = array_merge(
|
||||
[
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
'module:code="X100"',
|
||||
'--siteDir=',
|
||||
]);
|
||||
],
|
||||
array_map(
|
||||
fn (string $arg): string => $arg === '__INPUT_FILE__' ? $inFile : $arg,
|
||||
$extraArgs
|
||||
)
|
||||
);
|
||||
|
||||
$this->assertSame(1, $result['code']);
|
||||
$this->assertStringContainsString('a value is required for --siteDir', $result['output']);
|
||||
$result = $this->runCfg($args);
|
||||
|
||||
$this->assertCfgFailure($result, $expectedMessage);
|
||||
}
|
||||
|
||||
public function siteDirValidationDataProvider(): array
|
||||
{
|
||||
return [
|
||||
'traversal' => ['../owner_xyz', 'Invalid directory in --siteDir'],
|
||||
'invalid segment' => ['owner xyz', "Invalid directory name segment 'owner xyz' in --siteDir."],
|
||||
'hidden dot segment' => ['owner_xyz/./secret', "Invalid directory in --siteDir: 'owner_xyz/./secret'."],
|
||||
'config root only' => ['config/', 'Option --siteDir is empty.'],
|
||||
];
|
||||
}
|
||||
|
||||
public function inputFileValidationDataProvider(): array
|
||||
{
|
||||
return [
|
||||
'missing file' => [null, 'missing.json', 'Input file is not readable'],
|
||||
'invalid json' => ['{"module":', 'invalid.json', 'Input JSON is invalid'],
|
||||
'scalar json' => ['true', 'scalar.json', 'Input JSON must decode to an object/array'],
|
||||
];
|
||||
}
|
||||
|
||||
public function writePayloadSourceValidationDataProvider(): array
|
||||
{
|
||||
return [
|
||||
'missing payload source' => [[], 'Nothing to write: provide SETTING or --in.'],
|
||||
'both payload sources' => [['module:code="x"', '-i', '__INPUT_FILE__'], 'Please use either SETTING or --in, not both.'],
|
||||
];
|
||||
}
|
||||
/* }}} */
|
||||
|
||||
/* Helpers {{{ */
|
||||
private function runWrite(array $args): array
|
||||
{
|
||||
return $this->runCfg(array_merge([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'write',
|
||||
'Extension',
|
||||
], $args));
|
||||
}
|
||||
|
||||
private function runShow(array $args): array
|
||||
{
|
||||
return $this->runCfg(array_merge([
|
||||
'-a',
|
||||
$this->tmpDir,
|
||||
'show',
|
||||
'Extension',
|
||||
], $args));
|
||||
}
|
||||
|
||||
private function createJsonInputFile(array $contents, string $name = 'extension-in.json'): string
|
||||
{
|
||||
$path = $this->tmpDir.'/'.$name;
|
||||
file_put_contents($path, json_encode($contents, JSON_PRETTY_PRINT));
|
||||
|
||||
return $path;
|
||||
}
|
||||
|
||||
private function loadWrittenConfig(?string $siteDir = null): array
|
||||
{
|
||||
$path = $siteDir === null
|
||||
? $this->tmpDir.'/config/Extension.conf.php'
|
||||
: $this->tmpDir.'/config/'.$siteDir.'/Extension.conf.php';
|
||||
|
||||
return require $path;
|
||||
}
|
||||
|
||||
private function assertCfgSuccess(array $result): void
|
||||
{
|
||||
$this->assertSame(0, $result['code'], $result['output']);
|
||||
}
|
||||
|
||||
private function assertCfgFailure(array $result, string $message): void
|
||||
{
|
||||
$this->assertSame(1, $result['code'], $result['output']);
|
||||
$this->assertStringContainsString($message, $result['output']);
|
||||
}
|
||||
|
||||
private function runCfg(array $args): array
|
||||
|
|
@ -372,4 +453,5 @@ class CfgTest extends TestCase
|
|||
|
||||
rmdir($dir);
|
||||
}
|
||||
/* }}} */
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue