Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ New
PHPCSUtils\TestUtils\ConfigDouble class
The PHP_CodeSniffer native `Config` class contains a number of static properties. As the value of these static properties will be retained between instantiations of the class, config values set in one test can influence the results for another test, which makes tests unstable. This commit introduces a test "double" of the `Config` class which prevents this from happening. In _most_ cases, tests should be using this class instead of the "normal" Config, with the exception of select tests for the PHPCS Config class itself. Includes tests covering the new class. Includes implementing use of the test double in the `UtilityMethodTestCase` class.
- Loading branch information
Showing
4 changed files
with
626 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| <?php | ||
| /** | ||
| * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers. | ||
| * | ||
| * @package PHPCSUtils | ||
| * @copyright 2019-2024 PHPCSUtils Contributors | ||
| * @license https://opensource.org/licenses/LGPL-3.0 LGPL3 | ||
| * @link https://github.com/PHPCSStandards/PHPCSUtils | ||
| */ | ||
|
|
||
| namespace PHPCSUtils\TestUtils; | ||
|
|
||
| use PHP_CodeSniffer\Config; | ||
| use ReflectionProperty; | ||
|
|
||
| /** | ||
| * Config class for use in the tests. | ||
| * | ||
| * The PHP_CodeSniffer Config class contains a number of static properties. | ||
| * As the value of these static properties will be retained between instantiations of the class, | ||
| * config values set in one test can influence the results for another test, which makes tests unstable. | ||
| * | ||
| * This class is a "double" of the Config class which prevents this from happening. | ||
| * In _most_ cases, tests should be using this class instead of the "normal" Config, | ||
| * with the exception of select tests for the PHPCS Config class itself. | ||
| * | ||
| * @since 1.1.0 | ||
| */ | ||
| final class ConfigDouble extends Config | ||
| { | ||
|
|
||
| /** | ||
| * Whether or not the setting of a standard should be skipped. | ||
| * | ||
| * @since 1.1.0 | ||
| * | ||
| * @var bool | ||
| */ | ||
| private $skipSettingStandard = false; | ||
|
|
||
| /** | ||
| * Creates a clean Config object and populates it with command line values. | ||
| * | ||
| * @since 1.1.0 | ||
| * | ||
| * @param array<string> $cliArgs An array of values gathered from CLI args. | ||
| * @param bool $skipSettingStandard Whether to skip setting a standard to prevent | ||
| * the Config class trying to auto-discover a ruleset file. | ||
| * Should only be set to `true` for tests which actually test | ||
| * the ruleset auto-discovery. | ||
| * Note: there is no need to set this to `true` when a standard | ||
| * is being passed via the `$cliArgs`. Those settings will always | ||
| * respected. | ||
| * Defaults to `false`. Will result in the standard being set | ||
| * to "PSR1" if not provided via `$cliArgs`. | ||
| * @param bool $skipSettingReportWidth Whether to skip setting a report-width to prevent | ||
| * the Config class trying to auto-discover the screen width. | ||
| * Should only be set to `true` for tests which actually test | ||
| * the screen width auto-discovery. | ||
| * Note: there is no need to set this to `true` when a report-width | ||
| * is being passed via the `$cliArgs`. Those settings will always | ||
| * respected. | ||
| * Defaults to `false`. Will result in the reportWidth being set | ||
| * to "80" if not provided via `$cliArgs`. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function __construct(array $cliArgs = [], $skipSettingStandard = false, $skipSettingReportWidth = false) | ||
| { | ||
| $this->skipSettingStandard = $skipSettingStandard; | ||
|
|
||
| $this->resetStatics(); | ||
| $this->preventReadingCodeSnifferConfFile(); | ||
|
|
||
| parent::__construct($cliArgs); | ||
|
|
||
| if ($skipSettingReportWidth !== true) { | ||
| $this->preventAutoDiscoveryScreenWidth(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Sets the command line values and optionally prevents a file system search for a custom ruleset. | ||
| * | ||
| * @since 1.1.0 | ||
| * | ||
| * @param array<string> $args An array of command line arguments to set. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function setCommandLineValues($args) | ||
| { | ||
| parent::setCommandLineValues($args); | ||
|
|
||
| if ($this->skipSettingStandard !== true) { | ||
| $this->preventSearchingForRuleset(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Reset the static properties of the Config class to their default values. | ||
| * | ||
| * @since 1.1.0 | ||
| * | ||
| * @return void | ||
| */ | ||
| private function resetStatics() | ||
| { | ||
| self::setStaticConfigProperty('overriddenDefaults', []); | ||
| self::setStaticConfigProperty('executablePaths', []); | ||
| } | ||
|
|
||
| /** | ||
| * Prevent the values in a potentially available user-specific `CodeSniffer.conf` file | ||
| * from influencing the tests. | ||
| * | ||
| * This also prevents some file system calls which can influence the test runtime. | ||
| * | ||
| * @since 1.1.0 | ||
| * | ||
| * @return void | ||
| */ | ||
| private function preventReadingCodeSnifferConfFile() | ||
| { | ||
| self::setStaticConfigProperty('configData', []); | ||
| self::setStaticConfigProperty('configDataFile', ''); | ||
| } | ||
|
|
||
| /** | ||
| * Prevent searching for a custom ruleset by faking that a standard has been set, but only if the test | ||
| * being run doesn't set a standard itself. | ||
| * | ||
| * This also prevents some file system calls which can influence the test runtime. | ||
| * | ||
| * The standard being set is the smallest one available so the ruleset initialization | ||
| * will be the fastest possible. | ||
| * | ||
| * @since 1.1.0 | ||
| * | ||
| * @return void | ||
| */ | ||
| private function preventSearchingForRuleset() | ||
| { | ||
| $overriddenDefaults = $this->getStaticConfigProperty('overriddenDefaults'); | ||
| if (isset($overriddenDefaults['standards']) === false) { | ||
| $this->standards = ['PSR1']; | ||
| $overriddenDefaults['standards'] = true; | ||
| } | ||
|
|
||
| self::setStaticConfigProperty('overriddenDefaults', $overriddenDefaults); | ||
| } | ||
|
|
||
| /** | ||
| * Prevent a call to stty to figure out the screen width, but only if the test being run | ||
| * doesn't set a report width itself. | ||
| * | ||
| * @since 1.1.0 | ||
| * | ||
| * @return void | ||
| */ | ||
| private function preventAutoDiscoveryScreenWidth() | ||
| { | ||
| $settings = $this->getSettings(); | ||
| if ($settings['reportWidth'] === 'auto') { | ||
| $this->reportWidth = self::DEFAULT_REPORT_WIDTH; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Helper function to retrieve the value of a private static property on the Config class. | ||
| * | ||
| * @since 1.1.0 | ||
| * | ||
| * @param string $name The name of the property to retrieve. | ||
| * | ||
| * @return mixed | ||
| */ | ||
| public static function getStaticConfigProperty($name) | ||
| { | ||
| $property = new ReflectionProperty('PHP_CodeSniffer\Config', $name); | ||
| $property->setAccessible(true); | ||
| return $property->getValue(); | ||
| } | ||
|
|
||
| /** | ||
| * Helper function to set the value of a private static property on the Config class. | ||
| * | ||
| * @since 1.1.0 | ||
| * | ||
| * @param string $name The name of the property to set. | ||
| * @param mixed $value The value to set the property to. | ||
| * | ||
| * @return void | ||
| */ | ||
| public static function setStaticConfigProperty($name, $value) | ||
| { | ||
| $property = new ReflectionProperty('PHP_CodeSniffer\Config', $name); | ||
| $property->setAccessible(true); | ||
| $property->setValue(null, $value); | ||
| $property->setAccessible(false); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.