diff options
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/cli/CliOptionsParserTest.php | 242 | ||||
| -rwxr-xr-x | tests/cli/cli-parser-test.php | 24 |
2 files changed, 266 insertions, 0 deletions
diff --git a/tests/cli/CliOptionsParserTest.php b/tests/cli/CliOptionsParserTest.php new file mode 100644 index 000000000..facb5dbc5 --- /dev/null +++ b/tests/cli/CliOptionsParserTest.php @@ -0,0 +1,242 @@ +<?php +declare(strict_types=1); + +use PHPUnit\Framework\TestCase; +require_once __DIR__ . '/../../cli/CliOption.php'; +require_once __DIR__ . '/../../cli/CliOptionsParser.php'; + +final class CliOptionsOptionalTest extends CliOptionsParser { + public string $string = ''; + public int $int = 0; + public bool $bool = false; + /** @var array<int,string> $arrayOfString */ + public array $arrayOfString = []; + public string $defaultInput = ''; + public string $optionalValue = ''; + public bool $optionalValueWithDefault = false; + public string $defaultInputAndOptionalValueWithDefault = ''; + + public function __construct() { + $this->addOption('string', (new CliOption('string', 's'))->deprecatedAs('deprecated-string')); + $this->addOption('int', (new CliOption('int', 'i'))->typeOfInt()); + $this->addOption('bool', (new CliOption('bool', 'b'))->typeOfBool()); + $this->addOption('arrayOfString', (new CliOption('array-of-string', 'a'))->typeOfArrayOfString()); + $this->addOption('defaultInput', (new CliOption('default-input', 'i')), 'default'); + $this->addOption('optionalValue', (new CliOption('optional-value', 'o'))->withValueOptional()); + $this->addOption('optionalValueWithDefault', (new CliOption('optional-value-with-default', 'd'))->withValueOptional('true')->typeOfBool()); + $this->addOption('defaultInputAndOptionalValueWithDefault', + (new CliOption('default-input-and-optional-value-with-default', 'e'))->withValueOptional('optional'), + 'default' + ); + $this->addOption('flag', (new CliOption('flag', 'f'))->withValueNone()); + parent::__construct(); + } +} + +final class CliOptionsOptionalAndRequiredTest extends CliOptionsParser { + public string $required = ''; + public string $string = ''; + public int $int = 0; + public bool $bool = false; + public string $flag = ''; + + public function __construct() { + $this->addRequiredOption('required', new CliOption('required')); + $this->addOption('string', new CliOption('string', 's')); + $this->addOption('int', (new CliOption('int', 'i'))->typeOfInt()); + $this->addOption('bool', (new CliOption('bool', 'b'))->typeOfBool()); + $this->addOption('flag', (new CliOption('flag', 'f'))->withValueNone()); + parent::__construct(); + } +} + +class CliOptionsParserTest extends TestCase { + + public function testInvalidOptionSetWithValueReturnsError(): void { + $result = $this->runOptionalOptions('--invalid=invalid'); + + self::assertEquals(['invalid' => 'unknown option: invalid'], $result->errors); + } + + public function testInvalidOptionSetWithoutValueReturnsError(): void { + $result = $this->runOptionalOptions('--invalid'); + + self::assertEquals(['invalid' => 'unknown option: invalid'], $result->errors); + } + + public function testValidOptionSetWithValidValueAndInvalidOptionSetWithValueReturnsValueForValidOptionAndErrorForInvalidOption(): void { + $result = $this->runOptionalOptions('--string=string --invalid=invalid'); + + self::assertEquals('string', $result->string); + self::assertEquals(['invalid' => 'unknown option: invalid'], $result->errors); + } + + public function testOptionWithValueTypeOfStringSetOnceWithValidValueReturnsValueAsString(): void { + $result = $this->runOptionalOptions('--string=string'); + + self::assertEquals('string', $result->string); + } + + public function testOptionWithRequiredValueTypeOfIntSetOnceWithValidValueReturnsValueAsInt(): void { + $result = $this->runOptionalOptions('--int=111'); + + self::assertEquals(111, $result->int); + } + + public function testOptionWithRequiredValueTypeOfBoolSetOnceWithValidValueReturnsValueAsBool(): void { + $result = $this->runOptionalOptions('--bool=on'); + + self::assertEquals(true, $result->bool); + } + + public function testOptionWithValueTypeOfArrayOfStringSetOnceWithValidValueReturnsValueAsArrayOfString(): void { + $result = $this->runOptionalOptions('--array-of-string=string'); + + self::assertEquals(['string'], $result->arrayOfString); + } + + public function testOptionWithValueTypeOfStringSetMultipleTimesWithValidValueReturnsLastValueSetAsString(): void { + $result = $this->runOptionalOptions('--string=first --string=second'); + + self::assertEquals('second', $result->string); + } + + public function testOptionWithValueTypeOfIntSetMultipleTimesWithValidValueReturnsLastValueSetAsInt(): void { + $result = $this->runOptionalOptions('--int=111 --int=222'); + + self::assertEquals(222, $result->int); + } + + public function testOptionWithValueTypeOfBoolSetMultipleTimesWithValidValueReturnsLastValueSetAsBool(): void { + $result = $this->runOptionalOptions('--bool=on --bool=off'); + + self::assertEquals(false, $result->bool); + } + + public function testOptionWithValueTypeOfArrayOfStringSetMultipleTimesWithValidValueReturnsAllSetValuesAsArrayOfString(): void { + $result = $this->runOptionalOptions('--array-of-string=first --array-of-string=second'); + + self::assertEquals(['first', 'second'], $result->arrayOfString); + } + + public function testOptionWithValueTypeOfIntSetWithInvalidValueReturnsAnError(): void { + $result = $this->runOptionalOptions('--int=one'); + + self::assertEquals(['int' => 'invalid input: int must be an integer'], $result->errors); + } + + public function testOptionWithValueTypeOfBoolSetWithInvalidValuesReturnsAnError(): void { + $result = $this->runOptionalOptions('--bool=bad'); + + self::assertEquals(['bool' => 'invalid input: bool must be a boolean'], $result->errors); + } + + public function testOptionWithValueTypeOfIntSetMultipleTimesWithValidAndInvalidValuesReturnsLastValidValueSetAsIntAndError(): void { + $result = $this->runOptionalOptions('--int=111 --int=one --int=222 --int=two'); + + self::assertEquals(222, $result->int); + self::assertEquals(['int' => 'invalid input: int must be an integer'], $result->errors); + } + + public function testOptionWithValueTypeOfBoolSetMultipleTimesWithWithValidAndInvalidValuesReturnsLastValidValueSetAsBoolAndError(): void { + $result = $this->runOptionalOptions('--bool=on --bool=good --bool=off --bool=bad'); + + self::assertEquals(false, $result->bool); + self::assertEquals(['bool' => 'invalid input: bool must be a boolean'], $result->errors); + } + + public function testNotSetOptionWithDefaultInputReturnsDefaultInput(): void { + $result = $this->runOptionalOptions(''); + + self::assertEquals('default', $result->defaultInput); + } + + public function testOptionWithDefaultInputSetWithValidValueReturnsCorrectlyTypedValue(): void { + $result = $this->runOptionalOptions('--default-input=input'); + + self::assertEquals('input', $result->defaultInput); + } + + public function testOptionWithOptionalValueSetWithoutValueReturnsEmptyString(): void { + $result = $this->runOptionalOptions('--optional-value'); + + self::assertEquals('', $result->optionalValue); + } + + public function testOptionWithOptionalValueDefaultSetWithoutValueReturnsOptionalValueDefault(): void { + $result = $this->runOptionalOptions('--optional-value-with-default'); + + self::assertEquals(true, $result->optionalValueWithDefault); + } + + public function testNotSetOptionWithOptionalValueDefaultAndDefaultInputReturnsDefaultInput(): void { + $result = $this->runOptionalOptions(''); + + self::assertEquals('default', $result->defaultInputAndOptionalValueWithDefault); + } + + public function testOptionWithOptionalValueDefaultAndDefaultInputSetWithoutValueReturnsOptionalValueDefault(): void { + $result = $this->runOptionalOptions('--default-input-and-optional-value-with-default'); + + self::assertEquals('optional', $result->defaultInputAndOptionalValueWithDefault); + } + + public function testRequiredOptionNotSetReturnsError(): void { + $result = $this->runOptionalAndRequiredOptions(''); + + self::assertEquals(['required' => 'invalid input: required cannot be empty'], $result->errors); + } + + public function testOptionSetWithDeprecatedAliasGeneratesDeprecationWarningAndReturnsValue(): void { + $result = $this->runCommandReadingStandardError('--deprecated-string=string'); + + self::assertEquals('FreshRSS deprecation warning: the CLI option(s): deprecated-string are deprecated ' . + 'and will be removed in a future release. Use: string instead', + $result + ); + + $result = $this->runOptionalOptions('--deprecated-string=string'); + + self::assertEquals('string', $result->string); + } + + public function testAlwaysReturnUsageMessageWithUsageInfoForAllOptions(): void { + $result = $this->runOptionalAndRequiredOptions(''); + + self::assertEquals('Usage: cli-parser-test.php --required=<required> [-s --string=<string>] [-i --int=<int>] [-b --bool=<bool>] [-f --flag]', + $result->usage, + ); + } + + private function runOptionalOptions(string $cliOptions = ''): CliOptionsOptionalTest { + $command = __DIR__ . '/cli-parser-test.php'; + $className = CliOptionsOptionalTest::class; + + $result = shell_exec("CLI_PARSER_TEST_OPTIONS_CLASS='$className' $command $cliOptions 2>/dev/null"); + $result = is_string($result) ? unserialize($result) : new CliOptionsOptionalTest(); + + /** @var CliOptionsOptionalTest $result */ + return $result; + } + + private function runOptionalAndRequiredOptions(string $cliOptions = ''): CliOptionsOptionalAndRequiredTest { + $command = __DIR__ . '/cli-parser-test.php'; + $className = CliOptionsOptionalAndRequiredTest::class; + + $result = shell_exec("CLI_PARSER_TEST_OPTIONS_CLASS='$className' $command $cliOptions 2>/dev/null"); + $result = is_string($result) ? unserialize($result) : new CliOptionsOptionalAndRequiredTest(); + + /** @var CliOptionsOptionalAndRequiredTest $result */ + return $result; + } + + private function runCommandReadingStandardError(string $cliOptions = ''): string { + $command = __DIR__ . '/cli-parser-test.php'; + $className = CliOptionsOptionalTest::class; + + $result = shell_exec("CLI_PARSER_TEST_OPTIONS_CLASS='$className' $command $cliOptions 2>&1"); + $result = is_string($result) ? explode("\n", $result) : ''; + + return is_array($result) ? $result[0] : ''; + } +} diff --git a/tests/cli/cli-parser-test.php b/tests/cli/cli-parser-test.php new file mode 100755 index 000000000..6806d29ce --- /dev/null +++ b/tests/cli/cli-parser-test.php @@ -0,0 +1,24 @@ +#!/usr/bin/env php +<?php +declare(strict_types=1); + +require(__DIR__ . '/../../vendor/autoload.php'); +require(__DIR__ . '/CliOptionsParserTest.php'); + +$optionsClass = getenv('CLI_PARSER_TEST_OPTIONS_CLASS'); +if (!is_string($optionsClass) || !class_exists($optionsClass)) { + die('Invalid test static method!'); +} + +switch ($optionsClass) { + case CliOptionsOptionalTest::class: + $options = new CliOptionsOptionalTest(); + break; + case CliOptionsOptionalAndRequiredTest::class: + $options = new CliOptionsOptionalAndRequiredTest(); + break; + default: + die('Unknown test static method!'); +} + +echo serialize($options); |