1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
<?php
/**
* Tests for the \PHP_CodeSniffer\Util\Common::getSniffCode() method.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2024 PHPCSStandards and contributors
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Tests\Core\Util\Common;
use PHP_CodeSniffer\Util\Common;
use PHPUnit\Framework\TestCase;
/**
* Tests for the \PHP_CodeSniffer\Util\Common::getSniffCode() method.
*
* @covers \PHP_CodeSniffer\Util\Common::getSniffCode
*/
final class GetSniffCodeTest extends TestCase
{
/**
* Test receiving an expected exception when the $sniffClass parameter is not passed a string value or is passed an empty string.
*
* @param string $input NOT a fully qualified sniff class name.
*
* @dataProvider dataGetSniffCodeThrowsExceptionOnInvalidInput
*
* @return void
*/
public function testGetSniffCodeThrowsExceptionOnInvalidInput($input)
{
$exception = 'InvalidArgumentException';
$message = 'The $sniffClass parameter must be a non-empty string';
if (method_exists($this, 'expectException') === true) {
// PHPUnit 5+.
$this->expectException($exception);
$this->expectExceptionMessage($message);
} else {
// PHPUnit 4.
$this->setExpectedException($exception, $message);
}
Common::getSniffCode($input);
}//end testGetSniffCodeThrowsExceptionOnInvalidInput()
/**
* Data provider.
*
* @see testGetSniffCodeThrowsExceptionOnInvalidInput()
*
* @return array<string, array<string>>
*/
public static function dataGetSniffCodeThrowsExceptionOnInvalidInput()
{
return [
'Class name is not a string' => [true],
'Class name is empty' => [''],
];
}//end dataGetSniffCodeThrowsExceptionOnInvalidInput()
/**
* Test receiving an expected exception when the $sniffClass parameter is not passed a value which
* could be a fully qualified sniff(test) class name.
*
* @param string $input String input which can not be a fully qualified sniff(test) class name.
*
* @dataProvider dataGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass
*
* @return void
*/
public function testGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass($input)
{
$exception = 'InvalidArgumentException';
$message = 'The $sniffClass parameter was not passed a fully qualified sniff(test) class name. Received:';
if (method_exists($this, 'expectException') === true) {
// PHPUnit 5+.
$this->expectException($exception);
$this->expectExceptionMessage($message);
} else {
// PHPUnit 4.
$this->setExpectedException($exception, $message);
}
Common::getSniffCode($input);
}//end testGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass()
/**
* Data provider.
*
* @see testGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass()
*
* @return array<string, array<string>>
*/
public static function dataGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass()
{
return [
'Unqualified class name' => ['ClassName'],
'Fully qualified class name, not enough parts' => ['Fully\\Qualified\\ClassName'],
'Fully qualified class name, doesn\'t end on Sniff or UnitTest' => ['Fully\\Sniffs\\Qualified\\ClassName'],
];
}//end dataGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass()
/**
* Test transforming a sniff class name to a sniff code.
*
* @param string $fqnClass A fully qualified sniff class name.
* @param string $expected Expected function output.
*
* @dataProvider dataGetSniffCode
*
* @return void
*/
public function testGetSniffCode($fqnClass, $expected)
{
$this->assertSame($expected, Common::getSniffCode($fqnClass));
}//end testGetSniffCode()
/**
* Data provider.
*
* @see testGetSniffCode()
*
* @return array<string, array<string, string>>
*/
public static function dataGetSniffCode()
{
return [
'PHPCS native sniff' => [
'fqnClass' => 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\Arrays\\ArrayIndentSniff',
'expected' => 'Generic.Arrays.ArrayIndent',
],
'Class is a PHPCS native test class' => [
'fqnClass' => 'PHP_CodeSniffer\\Standards\\Generic\\Tests\\Arrays\\ArrayIndentUnitTest',
'expected' => 'Generic.Arrays.ArrayIndent',
],
'Sniff in external standard without namespace prefix' => [
'fqnClass' => 'MyStandard\\Sniffs\\PHP\\MyNameSniff',
'expected' => 'MyStandard.PHP.MyName',
],
'Test in external standard without namespace prefix' => [
'fqnClass' => 'MyStandard\\Tests\\PHP\\MyNameSniff',
'expected' => 'MyStandard.PHP.MyName',
],
'Sniff in external standard with namespace prefix' => [
'fqnClass' => 'Vendor\\Package\\MyStandard\\Sniffs\\Category\\AnalyzeMeSniff',
'expected' => 'MyStandard.Category.AnalyzeMe',
],
'Test in external standard with namespace prefix' => [
'fqnClass' => 'Vendor\\Package\\MyStandard\\Tests\\Category\\AnalyzeMeUnitTest',
'expected' => 'MyStandard.Category.AnalyzeMe',
],
/*
* These are not valid sniff codes and is an undesirable result, but can't be helped
* as changing this would be a BC-break.
* Supporting these to allow for <rule> tags directly including sniff files.
* See: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/675
*/
'Fully qualified class name, ends on Sniff, but isn\'t' => [
'fqnClass' => 'Fully\\Sniffs\\AbstractSomethingSniff',
'expected' => '.Sniffs.AbstractSomething',
],
'Sniff provided via file include and doesn\'t comply with naming conventions [1]' => [
'fqnClass' => 'CheckMeSniff',
'expected' => '..CheckMe',
],
'Sniff provided via file include and doesn\'t comply with naming conventions [2]' => [
'fqnClass' => 'CompanyName\\CheckMeSniff',
'expected' => '.CompanyName.CheckMe',
],
'Sniff provided via file include and doesn\'t comply with naming conventions [3]' => [
'fqnClass' => 'CompanyName\\Sniffs\\CheckMeSniff',
'expected' => '.Sniffs.CheckMe',
],
'Sniff provided via file include and doesn\'t comply with naming conventions [4]' => [
'fqnClass' => 'CompanyName\\CustomSniffs\\Whatever\\CheckMeSniff',
'expected' => 'CompanyName.Whatever.CheckMe',
],
];
}//end dataGetSniffCode()
}//end class
|
