Skip to content

SettingsParseArgumentsTest: improve the tests #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 21, 2022
Merged

SettingsParseArgumentsTest: improve the tests #112

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b0b246f
SettingsParseArgumentsTest: refactor to dataprovider
jrfnl Feb 19, 2022
2ecddc0
SettingsParseArgumentsTest: add additional test cases
jrfnl Feb 19, 2022
29a36ad
SettingsParseArgumentsTest: add new test for handling of unsupported …
jrfnl Feb 19, 2022
d09ac5f
SettingsParseArgumentsTest: add `@covers` tags
jrfnl Mar 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
344 changes: 235 additions & 109 deletions tests/Unit/SettingsParseArgumentsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,137 +5,263 @@
use PHP_Parallel_Lint\PhpParallelLint\Settings;
use PHP_Parallel_Lint\PhpParallelLint\Tests\UnitTestCase;

/**
* @covers \PHP_Parallel_Lint\PhpParallelLint\Settings::parseArguments
* @covers \PHP_Parallel_Lint\PhpParallelLint\Iterators\ArrayIterator
*/
class SettingsParseArgumentsTest extends UnitTestCase
{
public function testNoneArguments()
/**
* Test that an exception is thrown when an unsupported argument is passed.
*
* @dataProvider dataParseArgumentsInvalidArgument
*
* @param string $command The command as received from the command line.
* @param string $unsupported The unsupported argument which should trigger the exception.
*
* @return void
*/
public function testParseArgumentsInvalidArgument($command, $unsupported)
{
$commandLine = "./parallel-lint .";
$argv = explode(" ", $commandLine);
$settings = Settings::parseArguments($argv);

$expectedSettings = new Settings();
$expectedSettings->shortTag = false;
$expectedSettings->aspTags = false;
$expectedSettings->parallelJobs = 10;
$expectedSettings->extensions = array('php', 'phtml', 'php3', 'php4', 'php5', 'phpt');
$expectedSettings->paths = array('.');
$expectedSettings->excluded = array();
$expectedSettings->colors = Settings::AUTODETECT;
$expectedSettings->showProgress = true;
$expectedSettings->format = Settings::FORMAT_TEXT;
$expectedSettings->syntaxErrorCallbackFile = null;
$this->expectExceptionPolyfill('PHP_Parallel_Lint\PhpParallelLint\Exceptions\InvalidArgumentException');
$this->expectExceptionMessagePolyfill('Invalid argument ' . $unsupported);

$this->assertSame($expectedSettings->shortTag, $settings->shortTag);
$this->assertSame($expectedSettings->aspTags, $settings->aspTags);
$this->assertSame($expectedSettings->parallelJobs, $settings->parallelJobs);
$this->assertSame($expectedSettings->extensions, $settings->extensions);
$this->assertSame($expectedSettings->paths, $settings->paths);
$this->assertSame($expectedSettings->excluded, $settings->excluded);
$this->assertSame($expectedSettings->colors, $settings->colors);
$this->assertSame($expectedSettings->showProgress, $settings->showProgress);
$this->assertSame($expectedSettings->format, $settings->format);
$this->assertSame($expectedSettings->syntaxErrorCallbackFile, $settings->syntaxErrorCallbackFile);
$argv = explode(' ', $command);
Settings::parseArguments($argv);
}

public function testMoreArguments()
/**
* Data provider.
*
* @return array
*/
public function dataParseArgumentsInvalidArgument()
{
$commandLine = "./parallel-lint --exclude vendor --no-colors .";
$argv = explode(" ", $commandLine);
$settings = Settings::parseArguments($argv);

$expectedSettings = new Settings();
$expectedSettings->shortTag = false;
$expectedSettings->aspTags = false;
$expectedSettings->parallelJobs = 10;
$expectedSettings->extensions = array('php', 'phtml', 'php3', 'php4', 'php5', 'phpt');
$expectedSettings->paths = array('.');
$expectedSettings->excluded = array('vendor');
$expectedSettings->colors = Settings::DISABLED;
$expectedSettings->showProgress = true;
$expectedSettings->format = Settings::FORMAT_TEXT;
$expectedSettings->showDeprecated = false;

$this->assertSame($expectedSettings->shortTag, $settings->shortTag);
$this->assertSame($expectedSettings->aspTags, $settings->aspTags);
$this->assertSame($expectedSettings->parallelJobs, $settings->parallelJobs);
$this->assertSame($expectedSettings->extensions, $settings->extensions);
$this->assertSame($expectedSettings->paths, $settings->paths);
$this->assertSame($expectedSettings->excluded, $settings->excluded);
$this->assertSame($expectedSettings->colors, $settings->colors);
$this->assertSame($expectedSettings->showProgress, $settings->showProgress);
$this->assertSame($expectedSettings->format, $settings->format);
$this->assertSame($expectedSettings->showDeprecated, $settings->showDeprecated);
return array(
'Unsupported short argument' => array(
'command' => './parallel-lint --colors -u . --exclude vendor',
'unsupported' => '-u',
),
'Unsupported long argument' => array(
'command' => './parallel-lint . --no-progress --unsupported-arg',
'unsupported' => '--unsupported-arg',
),
'Unsupported argument split by = sign' => array(
'command' => './parallel-lint --exclude=vendor',
'unsupported' => '--exclude=vendor',
),
);
}

public function testColorsForced()
/**
* Test parsing the arguments received from the command line.
*
* @dataProvider dataParseArguments
*
* @param string $command The command as received from the command line.
* @param array $expectedChanged The Settings class properties which are expected to have been
* changed (key) with their value.
*
* @return void
*/
public function testParseArguments($command, array $expectedChanged)
{
$commandLine = "./parallel-lint --exclude vendor --colors .";
$argv = explode(" ", $commandLine);
$settings = Settings::parseArguments($argv);

$expectedSettings = new Settings();
$expectedSettings->colors = Settings::FORCED;
$expected = $this->getExpectedSettings($expectedChanged);

$this->assertSame($expectedSettings->colors, $settings->colors);
}

public function testNoProgress()
{
$commandLine = "./parallel-lint --exclude vendor --no-progress .";
$argv = explode(" ", $commandLine);
$argv = explode(' ', $command);
$settings = Settings::parseArguments($argv);

$expectedSettings = new Settings();
$expectedSettings->showProgress = false;

$this->assertSame($expectedSettings->showProgress, $settings->showProgress);
$this->assertSame($expected, $this->getCurrentSettings($settings));
}

public function testJsonOutput()
/**
* Data provider.
*
* @return array
*/
public function dataParseArguments()
{
$commandLine = './parallel-lint --json .';
$argv = explode(" ", $commandLine);
$settings = Settings::parseArguments($argv);
$this->assertSame(Settings::FORMAT_JSON, $settings->format);
return array(
'No arguments at all' => array(
'command' => './parallel-lint',
'expectedChanged' => array(),
),
'No arguments other than the path' => array(
'command' => './parallel-lint .',
'expectedChanged' => array(
'paths' => array('.'),
),
),
'No arguments other than multiple paths in varying formats' => array(
'command' => './parallel-lint ./src /tests bin ' . __DIR__ . '/../absolute/',
'expectedChanged' => array(
'paths' => array(
'./src',
'/tests',
'bin',
__DIR__ . '/../absolute/',
),
),
),
'Custom path to PHP' => array(
'command' => 'parallel-lint -p path/to/php.exe .',
'expectedChanged' => array(
'phpExecutable' => 'path/to/php.exe',
'paths' => array('.'),
),
),
'Multiple short arguments: -s -a -j 20' => array(
'command' => 'parallel-lint -s -a -j 20 .',
'expectedChanged' => array(
'shortTag' => true,
'aspTags' => true,
'parallelJobs' => 20,
'paths' => array('.'),
),
),
'Multiple extensions, comma separated' => array(
'command' => './parallel-lint -e php,php.dist,phpt .',
'expectedChanged' => array(
'extensions' => array('php', 'php.dist', 'phpt'),
'paths' => array('.'),
),
),
'Multiple long arguments' => array(
'command' => './parallel-lint --exclude vendor --short --asp .',
'expectedChanged' => array(
'excluded' => array('vendor'),
'shortTag' => true,
'aspTags' => true,
'paths' => array('.'),
),
),
'Multiple excludes, including subdir' => array(
'command' => './parallel-lint . --exclude .git --exclude node_modules --exclude tests/fixtures',
'expectedChanged' => array(
'paths' => array('.'),
'excluded' => array(
'.git',
'node_modules',
'tests/fixtures',
),
),
),
'Force enable colors' => array(
'command' => './parallel-lint --exclude vendor --colors .',
'expectedChanged' => array(
'excluded' => array('vendor'),
'colors' => Settings::FORCED,
'paths' => array('.'),
),
),
'Force disable colors' => array(
'command' => './parallel-lint --no-colors .',
'expectedChanged' => array(
'colors' => Settings::DISABLED,
'paths' => array('.'),
),
),
'No progress' => array(
'command' => './parallel-lint --exclude vendor --no-progress .',
'expectedChanged' => array(
'excluded' => array('vendor'),
'showProgress' => false,
'paths' => array('.'),
),
),
'Output Checkstyle' => array(
'command' => './parallel-lint --checkstyle .',
'expectedChanged' => array(
'format' => Settings::FORMAT_CHECKSTYLE,
'paths' => array('.'),
),
),
'Output Json' => array(
'command' => './parallel-lint --json .',
'expectedChanged' => array(
'format' => Settings::FORMAT_JSON,
'paths' => array('.'),
),
),
'Output GitLab' => array(
'command' => './parallel-lint --gitlab .',
'expectedChanged' => array(
'format' => Settings::FORMAT_GITLAB,
'paths' => array('.'),
),
),
'Custom path to git' => array(
'command' => 'parallel-lint --git path/to/git.exe .',
'expectedChanged' => array(
'gitExecutable' => 'path/to/git.exe',
'paths' => array('.'),
),
),
'Enable stdin' => array(
'command' => 'parallel-lint --stdin',
'expectedChanged' => array(
'stdin' => true,
),
),
'Enable blame' => array(
'command' => 'parallel-lint --blame .',
'expectedChanged' => array(
'blame' => true,
'paths' => array('.'),
),
),
'Ignore failures' => array(
'command' => 'parallel-lint --ignore-fails .',
'expectedChanged' => array(
'ignoreFails' => true,
'paths' => array('.'),
),
),
'Show deprecations' => array(
'command' => 'parallel-lint --show-deprecated .',
'expectedChanged' => array(
'showDeprecated' => true,
'paths' => array('.'),
),
),
'Callback file' => array(
'command' => './parallel-lint --syntax-error-callback ./path/to/my_custom_callback_file.php .',
'expectedChanged' => array(
'syntaxErrorCallbackFile' => './path/to/my_custom_callback_file.php',
'paths' => array('.'),
),
),
);
}

public function testGitLabOutput()
/**
* Helper method: retrieve the default values of the properties in the Settings class and
* use these to create the expected values of the properties.
*
* @param array $changed Changes to the settings compared to the default values.
*
* @return array
*/
private function getExpectedSettings(array $changed)
{
$commandLine = './parallel-lint --gitlab .';
$argv = explode(" ", $commandLine);
$settings = Settings::parseArguments($argv);
$this->assertSame(Settings::FORMAT_GITLAB, $settings->format);
}

public function testCheckstyleOutput()
{
$commandLine = './parallel-lint --checkstyle .';
$argv = explode(" ", $commandLine);
$settings = Settings::parseArguments($argv);
$this->assertSame(Settings::FORMAT_CHECKSTYLE, $settings->format);
}

public function testExtensions()
{
$commandLine = './parallel-lint -e php,php.dist,phpt .';
$argv = explode(" ", $commandLine);
$settings = Settings::parseArguments($argv);

$expectedSettings = new Settings();
$expectedSettings->extensions = array('php', 'php.dist', 'phpt');
$defaults = get_class_vars('\PHP_Parallel_Lint\PhpParallelLint\Settings');
if (PHP_VERSION_ID >= 50400) {
// phpcs:ignore PHPCompatibility.Constants.NewConstants.php_binaryFound
$defaults['phpExecutable'] = PHP_BINARY;
}

$this->assertSame($expectedSettings->extensions, $settings->extensions);
return array_merge($defaults, $changed);
}

public function testFailCallaback()
/**
* Helper method: retrieve the current values of the properties in a Settings object.
*
* @param Settings $settings
*
* @return array
*/
private function getCurrentSettings(Settings $settings)
{
$commandLine = "./parallel-lint --syntax-error-callback ./path/to/my_custom_callback_file.php .";
$argv = explode(" ", $commandLine);
$settings = Settings::parseArguments($argv);

$expectedSettings = new Settings();
$expectedSettings->syntaxErrorCallbackFile = "./path/to/my_custom_callback_file.php";

$this->assertSame($expectedSettings->syntaxErrorCallbackFile, $settings->syntaxErrorCallbackFile);
return get_object_vars($settings);
}
}