Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/cartforge.co/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ |
<?php
/**
* Tests for the \PHP_CodeSniffer\Ruleset class.
*
* @author Juliette Reinders Folmer <[email protected]>
* @copyright 2019 Juliette Reinders Folmer. All rights reserved.
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Tests\Core\Ruleset;
use PHP_CodeSniffer\Ruleset;
use PHP_CodeSniffer\Tests\ConfigDouble;
use PHPUnit\Framework\TestCase;
use ReflectionObject;
/**
* Tests for the \PHP_CodeSniffer\Ruleset class.
*
* @covers \PHP_CodeSniffer\Ruleset
*/
final class RuleInclusionTest extends TestCase
{
/**
* The Ruleset object.
*
* @var \PHP_CodeSniffer\Ruleset
*/
protected static $ruleset;
/**
* Path to the ruleset file.
*
* @var string
*/
private static $standard = '';
/**
* The original content of the ruleset.
*
* @var string
*/
private static $contents = '';
/**
* Initialize the config and ruleset objects based on the `RuleInclusionTest.xml` ruleset file.
*
* @beforeClass
*
* @return void
*/
public static function initializeConfigAndRuleset()
{
$standard = __DIR__.'/'.basename(__FILE__, '.php').'.xml';
self::$standard = $standard;
// On-the-fly adjust the ruleset test file to be able to test
// sniffs included with relative paths.
$contents = file_get_contents($standard);
self::$contents = $contents;
$repoRootDir = basename(dirname(dirname(dirname(__DIR__))));
$newPath = $repoRootDir;
if (DIRECTORY_SEPARATOR === '\\') {
$newPath = str_replace('\\', '/', $repoRootDir);
}
$adjusted = str_replace('%path_root_dir%', $newPath, $contents);
if (file_put_contents($standard, $adjusted) === false) {
self::markTestSkipped('On the fly ruleset adjustment failed');
}
$config = new ConfigDouble(["--standard=$standard"]);
self::$ruleset = new Ruleset($config);
}//end initializeConfigAndRuleset()
/**
* Reset ruleset file.
*
* @after
*
* @return void
*/
public function resetRuleset()
{
file_put_contents(self::$standard, self::$contents);
}//end resetRuleset()
/**
* Test that sniffs are registered.
*
* @return void
*/
public function testHasSniffCodes()
{
$this->assertCount(48, self::$ruleset->sniffCodes);
}//end testHasSniffCodes()
/**
* Test that sniffs are correctly registered, independently of the syntax used to include the sniff.
*
* @param string $key Expected array key.
* @param string $value Expected array value.
*
* @dataProvider dataRegisteredSniffCodes
*
* @return void
*/
public function testRegisteredSniffCodes($key, $value)
{
$this->assertArrayHasKey($key, self::$ruleset->sniffCodes);
$this->assertSame($value, self::$ruleset->sniffCodes[$key]);
}//end testRegisteredSniffCodes()
/**
* Data provider.
*
* @see self::testRegisteredSniffCodes()
*
* @return array<array<string>>
*/
public static function dataRegisteredSniffCodes()
{
return [
[
'PSR2.Classes.ClassDeclaration',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff',
],
[
'PSR2.Classes.PropertyDeclaration',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\PropertyDeclarationSniff',
],
[
'PSR2.ControlStructures.ControlStructureSpacing',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\ControlStructureSpacingSniff',
],
[
'PSR2.ControlStructures.ElseIfDeclaration',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\ElseIfDeclarationSniff',
],
[
'PSR2.ControlStructures.SwitchDeclaration',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\SwitchDeclarationSniff',
],
[
'PSR2.Files.ClosingTag',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\Files\ClosingTagSniff',
],
[
'PSR2.Files.EndFileNewline',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\Files\EndFileNewlineSniff',
],
[
'PSR2.Methods.FunctionCallSignature',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\FunctionCallSignatureSniff',
],
[
'PSR2.Methods.FunctionClosingBrace',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\FunctionClosingBraceSniff',
],
[
'PSR2.Methods.MethodDeclaration',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\MethodDeclarationSniff',
],
[
'PSR2.Namespaces.NamespaceDeclaration',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\Namespaces\NamespaceDeclarationSniff',
],
[
'PSR2.Namespaces.UseDeclaration',
'PHP_CodeSniffer\Standards\PSR2\Sniffs\Namespaces\UseDeclarationSniff',
],
[
'PSR1.Classes.ClassDeclaration',
'PHP_CodeSniffer\Standards\PSR1\Sniffs\Classes\ClassDeclarationSniff',
],
[
'PSR1.Files.SideEffects',
'PHP_CodeSniffer\Standards\PSR1\Sniffs\Files\SideEffectsSniff',
],
[
'PSR1.Methods.CamelCapsMethodName',
'PHP_CodeSniffer\Standards\PSR1\Sniffs\Methods\CamelCapsMethodNameSniff',
],
[
'Generic.PHP.DisallowAlternativePHPTags',
'PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\DisallowAlternativePHPTagsSniff',
],
[
'Generic.PHP.DisallowShortOpenTag',
'PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\DisallowShortOpenTagSniff',
],
[
'Generic.Files.ByteOrderMark',
'PHP_CodeSniffer\Standards\Generic\Sniffs\Files\ByteOrderMarkSniff',
],
[
'Squiz.Classes.ValidClassName',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes\ValidClassNameSniff',
],
[
'Generic.NamingConventions.UpperCaseConstantName',
'PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\UpperCaseConstantNameSniff',
],
[
'Generic.Files.LineEndings',
'PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineEndingsSniff',
],
[
'Generic.Files.LineLength',
'PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff',
],
[
'Squiz.WhiteSpace.SuperfluousWhitespace',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\SuperfluousWhitespaceSniff',
],
[
'Generic.Formatting.DisallowMultipleStatements',
'PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\DisallowMultipleStatementsSniff',
],
[
'Generic.WhiteSpace.ScopeIndent',
'PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\ScopeIndentSniff',
],
[
'Generic.WhiteSpace.DisallowTabIndent',
'PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\DisallowTabIndentSniff',
],
[
'Generic.PHP.LowerCaseKeyword',
'PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\LowerCaseKeywordSniff',
],
[
'Generic.PHP.LowerCaseConstant',
'PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\LowerCaseConstantSniff',
],
[
'Squiz.Scope.MethodScope',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\Scope\MethodScopeSniff',
],
[
'Squiz.WhiteSpace.ScopeKeywordSpacing',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\ScopeKeywordSpacingSniff',
],
[
'Squiz.Functions.FunctionDeclaration',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\FunctionDeclarationSniff',
],
[
'Squiz.Functions.LowercaseFunctionKeywords',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\LowercaseFunctionKeywordsSniff',
],
[
'Squiz.Functions.FunctionDeclarationArgumentSpacing',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\FunctionDeclarationArgumentSpacingSniff',
],
[
'PEAR.Functions.ValidDefaultValue',
'PHP_CodeSniffer\Standards\PEAR\Sniffs\Functions\ValidDefaultValueSniff',
],
[
'Squiz.Functions.MultiLineFunctionDeclaration',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\MultiLineFunctionDeclarationSniff',
],
[
'Generic.Functions.FunctionCallArgumentSpacing',
'PHP_CodeSniffer\Standards\Generic\Sniffs\Functions\FunctionCallArgumentSpacingSniff',
],
[
'Squiz.ControlStructures.ControlSignature',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ControlSignatureSniff',
],
[
'Squiz.WhiteSpace.ControlStructureSpacing',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\ControlStructureSpacingSniff',
],
[
'Squiz.WhiteSpace.ScopeClosingBrace',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\ScopeClosingBraceSniff',
],
[
'Squiz.ControlStructures.ForEachLoopDeclaration',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ForEachLoopDeclarationSniff',
],
[
'Squiz.ControlStructures.ForLoopDeclaration',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ForLoopDeclarationSniff',
],
[
'Squiz.ControlStructures.LowercaseDeclaration',
'PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\LowercaseDeclarationSniff',
],
[
'Generic.ControlStructures.InlineControlStructure',
'PHP_CodeSniffer\Standards\Generic\Sniffs\ControlStructures\InlineControlStructureSniff',
],
[
'PSR12.Operators.OperatorSpacing',
'PHP_CodeSniffer\Standards\PSR12\Sniffs\Operators\OperatorSpacingSniff',
],
[
'Generic.Arrays.ArrayIndent',
'PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\ArrayIndentSniff',
],
[
'Generic.Metrics.CyclomaticComplexity',
'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\CyclomaticComplexitySniff',
],
[
'Generic.NamingConventions.CamelCapsFunctionName',
'PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff',
],
[
'Generic.Metrics.NestingLevel',
'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\NestingLevelSniff',
],
];
}//end dataRegisteredSniffCodes()
/**
* Test that setting properties for standards, categories, sniffs works for all supported rule
* inclusion methods.
*
* @param string $sniffClass The name of the sniff class.
* @param string $propertyName The name of the changed property.
* @param string|int|bool $expectedValue The value expected for the property.
*
* @dataProvider dataSettingProperties
*
* @return void
*/
public function testSettingProperties($sniffClass, $propertyName, $expectedValue)
{
$this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs);
$hasProperty = (new ReflectionObject(self::$ruleset->sniffs[$sniffClass]))->hasProperty($propertyName);
$errorMsg = sprintf('Property %s does not exist on sniff class %s', $propertyName, $sniffClass);
$this->assertTrue($hasProperty, $errorMsg);
$actualValue = self::$ruleset->sniffs[$sniffClass]->$propertyName;
$this->assertSame($expectedValue, $actualValue);
}//end testSettingProperties()
/**
* Data provider.
*
* @see self::testSettingProperties()
*
* @return array<string, array<string, string|int|bool>>
*/
public static function dataSettingProperties()
{
return [
'Set property for complete standard: PSR2 ClassDeclaration' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff',
'propertyName' => 'indent',
'expectedValue' => '20',
],
'Set property for complete standard: PSR2 SwitchDeclaration' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\SwitchDeclarationSniff',
'propertyName' => 'indent',
'expectedValue' => '20',
],
'Set property for complete standard: PSR2 FunctionCallSignature' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\FunctionCallSignatureSniff',
'propertyName' => 'indent',
'expectedValue' => '20',
],
'Set property for complete category: PSR12 OperatorSpacing' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\PSR12\Sniffs\Operators\OperatorSpacingSniff',
'propertyName' => 'ignoreSpacingBeforeAssignments',
'expectedValue' => false,
],
'Set property for individual sniff: Generic ArrayIndent' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\ArrayIndentSniff',
'propertyName' => 'indent',
'expectedValue' => '2',
],
'Set property for individual sniff using sniff file inclusion: Generic LineLength' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff',
'propertyName' => 'lineLimit',
'expectedValue' => '10',
],
'Set property for individual sniff using sniff file inclusion: CamelCapsFunctionName' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff',
'propertyName' => 'strict',
'expectedValue' => false,
],
'Set property for individual sniff via included ruleset: NestingLevel - nestingLevel' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\NestingLevelSniff',
'propertyName' => 'nestingLevel',
'expectedValue' => '2',
],
'Set property for all sniffs in an included ruleset: NestingLevel - absoluteNestingLevel' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\NestingLevelSniff',
'propertyName' => 'absoluteNestingLevel',
'expectedValue' => true,
],
// Testing that setting a property at error code level does *not* work.
'Set property for error code will not change the sniff property value: CyclomaticComplexity' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\CyclomaticComplexitySniff',
'propertyName' => 'complexity',
'expectedValue' => 10,
],
];
}//end dataSettingProperties()
/**
* Test that setting properties for standards, categories on sniffs which don't support the property will
* silently ignore the property and not set it.
*
* @param string $sniffClass The name of the sniff class.
* @param string $propertyName The name of the property which should not be set.
*
* @dataProvider dataSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails
*
* @return void
*/
public function testSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails($sniffClass, $propertyName)
{
$this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs, 'Sniff class '.$sniffClass.' not listed in registered sniffs');
$hasProperty = (new ReflectionObject(self::$ruleset->sniffs[$sniffClass]))->hasProperty($propertyName);
$errorMsg = sprintf('Property %s registered for sniff %s which does not support it', $propertyName, $sniffClass);
$this->assertFalse($hasProperty, $errorMsg);
}//end testSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails()
/**
* Data provider.
*
* @see self::testSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails()
*
* @return array<string, array>string, string>>
*/
public static function dataSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails()
{
return [
'Set property for complete standard: PSR2 ClassDeclaration' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\PSR1\Sniffs\Classes\ClassDeclarationSniff',
'propertyName' => 'setforallsniffs',
],
'Set property for complete standard: PSR2 FunctionCallSignature' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\FunctionCallSignatureSniff',
'propertyName' => 'setforallsniffs',
],
'Set property for complete category: PSR12 OperatorSpacing' => [
'sniffClass' => 'PHP_CodeSniffer\Standards\PSR12\Sniffs\Operators\OperatorSpacingSniff',
'propertyName' => 'setforallincategory',
],
];
}//end dataSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails()
}//end class