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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
|
<?php
/**
* Tests PHPCS native handling of sniff deprecations.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2024 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 PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase;
/**
* Tests PHPCS native handling of sniff deprecations.
*
* @covers \PHP_CodeSniffer\Ruleset::hasSniffDeprecations
* @covers \PHP_CodeSniffer\Ruleset::showSniffDeprecations
*/
final class ShowSniffDeprecationsTest extends AbstractRulesetTestCase
{
/**
* Test the return value of the hasSniffDeprecations() method.
*
* @param string $standard The standard to use for the test.
* @param bool $expected The expected function return value.
*
* @dataProvider dataHasSniffDeprecations
*
* @return void
* @group nodebci
*/
public function testHasSniffDeprecations($standard, $expected)
{
$config = new ConfigDouble(['.', "--standard=$standard"]);
$ruleset = new Ruleset($config);
$this->assertSame($expected, $ruleset->hasSniffDeprecations());
}//end testHasSniffDeprecations()
/**
* Data provider.
*
* @see testHasSniffDeprecations()
*
* @return array<string, array<string, string|bool>>
*/
public static function dataHasSniffDeprecations()
{
return [
'Standard not using deprecated sniffs: PSR1' => [
'standard' => 'PSR1',
'expected' => false,
],
'Standard using deprecated sniffs: Test Fixture' => [
'standard' => __DIR__.'/ShowSniffDeprecationsTest.xml',
'expected' => true,
],
];
}//end dataHasSniffDeprecations()
/**
* Test that the listing with deprecated sniffs will not show when specific command-line options are being used [1].
*
* @param string $standard The standard to use for the test.
* @param array<string> $additionalArgs Optional. Additional arguments to pass.
*
* @dataProvider dataDeprecatedSniffsListDoesNotShow
*
* @return void
* @group nodebci
*/
public function testDeprecatedSniffsListDoesNotShow($standard, $additionalArgs=[])
{
$args = $additionalArgs;
$args[] = '.';
$args[] = "--standard=$standard";
$config = new ConfigDouble($args);
$ruleset = new Ruleset($config);
$this->expectOutputString('');
$ruleset->showSniffDeprecations();
}//end testDeprecatedSniffsListDoesNotShow()
/**
* Data provider.
*
* @see testDeprecatedSniffsListDoesNotShow()
*
* @return array<string, array<string, string|array<string>>>
*/
public static function dataDeprecatedSniffsListDoesNotShow()
{
return [
'Standard not using deprecated sniffs: PSR1' => [
'standard' => 'PSR1',
],
'Standard using deprecated sniffs; explain mode' => [
'standard' => __DIR__.'/ShowSniffDeprecationsTest.xml',
'additionalArgs' => ['-e'],
],
'Standard using deprecated sniffs; quiet mode' => [
'standard' => __DIR__.'/ShowSniffDeprecationsTest.xml',
'additionalArgs' => ['-q'],
],
];
}//end dataDeprecatedSniffsListDoesNotShow()
/**
* Test that the listing with deprecated sniffs will not show when specific command-line options are being used [2].
*
* {@internal Separate test method for the same thing as this test will only work in CS mode.}
*
* @param string $standard The standard to use for the test.
* @param array<string> $additionalArgs Optional. Additional arguments to pass.
*
* @dataProvider dataDeprecatedSniffsListDoesNotShowNeedsCsMode
*
* @return void
*/
public function testDeprecatedSniffsListDoesNotShowNeedsCsMode($standard, $additionalArgs=[])
{
if (PHP_CODESNIFFER_CBF === true) {
$this->markTestSkipped('This test needs CS mode to run');
}
$this->testDeprecatedSniffsListDoesNotShow($standard, $additionalArgs);
}//end testDeprecatedSniffsListDoesNotShowNeedsCsMode()
/**
* Data provider.
*
* @see testDeprecatedSniffsListDoesNotShowNeedsCsMode()
*
* @return array<string, array<string, string|array<string>>>
*/
public static function dataDeprecatedSniffsListDoesNotShowNeedsCsMode()
{
return [
'Standard using deprecated sniffs; documentation is requested' => [
'standard' => __DIR__.'/ShowSniffDeprecationsTest.xml',
'additionalArgs' => ['--generator=text'],
],
];
}//end dataDeprecatedSniffsListDoesNotShowNeedsCsMode()
/**
* Test that the listing with deprecated sniffs will not show when using a standard containing deprecated sniffs,
* but only running select non-deprecated sniffs (using `--sniffs=...`).
*
* @return void
* @group nodebci
*/
public function testDeprecatedSniffsListDoesNotShowWhenSelectedSniffsAreNotDeprecated()
{
$standard = __DIR__.'/ShowSniffDeprecationsTest.xml';
$config = new ConfigDouble(['.', "--standard=$standard"]);
$ruleset = new Ruleset($config);
/*
* Apply sniff restrictions.
* For tests we need to manually trigger this if the standard is "installed", like with the fixtures these tests use.
*/
$restrictions = [];
$sniffs = [
'TestStandard.SetProperty.AllowedAsDeclared',
'TestStandard.SetProperty.AllowedViaStdClass',
];
foreach ($sniffs as $sniffCode) {
$parts = explode('.', strtolower($sniffCode));
$sniffName = $parts[0].'\\sniffs\\'.$parts[1].'\\'.$parts[2].'sniff';
$restrictions[strtolower($sniffName)] = true;
}
$sniffFiles = [];
$allSniffs = $ruleset->sniffCodes;
foreach ($allSniffs as $sniffName) {
$sniffFile = str_replace('\\', DIRECTORY_SEPARATOR, $sniffName);
$sniffFile = __DIR__.DIRECTORY_SEPARATOR.$sniffFile.'.php';
$sniffFiles[] = $sniffFile;
}
$ruleset->registerSniffs($sniffFiles, $restrictions, []);
$ruleset->populateTokenListeners();
$this->expectOutputString('');
$ruleset->showSniffDeprecations();
}//end testDeprecatedSniffsListDoesNotShowWhenSelectedSniffsAreNotDeprecated()
/**
* Test that the listing with deprecated sniffs will not show when using a standard containing deprecated sniffs,
* but all deprecated sniffs have been excluded from the run (using `--exclude=...`).
*
* @return void
* @group nodebci
*/
public function testDeprecatedSniffsListDoesNotShowWhenAllDeprecatedSniffsAreExcluded()
{
$standard = __DIR__.'/ShowSniffDeprecationsTest.xml';
$config = new ConfigDouble(['.', "--standard=$standard"]);
$ruleset = new Ruleset($config);
/*
* Apply sniff restrictions.
* For tests we need to manually trigger this if the standard is "installed", like with the fixtures these tests use.
*/
$exclusions = [];
$exclude = [
'TestStandard.Deprecated.WithLongReplacement',
'TestStandard.Deprecated.WithoutReplacement',
'TestStandard.Deprecated.WithReplacement',
'TestStandard.Deprecated.WithReplacementContainingLinuxNewlines',
'TestStandard.Deprecated.WithReplacementContainingNewlines',
];
foreach ($exclude as $sniffCode) {
$parts = explode('.', strtolower($sniffCode));
$sniffName = $parts[0].'\\sniffs\\'.$parts[1].'\\'.$parts[2].'sniff';
$exclusions[strtolower($sniffName)] = true;
}
$sniffFiles = [];
$allSniffs = $ruleset->sniffCodes;
foreach ($allSniffs as $sniffName) {
$sniffFile = str_replace('\\', DIRECTORY_SEPARATOR, $sniffName);
$sniffFile = __DIR__.DIRECTORY_SEPARATOR.$sniffFile.'.php';
$sniffFiles[] = $sniffFile;
}
$ruleset->registerSniffs($sniffFiles, [], $exclusions);
$ruleset->populateTokenListeners();
$this->expectOutputString('');
$ruleset->showSniffDeprecations();
}//end testDeprecatedSniffsListDoesNotShowWhenAllDeprecatedSniffsAreExcluded()
/**
* Test deprecated sniffs are listed alphabetically in the deprecated sniffs warning.
*
* This tests a number of different aspects:
* 1. That the summary line uses the correct grammar when there is are multiple deprecated sniffs.
* 2. That there is no trailing whitespace when the sniff does not provide a custom message.
* 3. That custom messages containing new line characters (any type) are handled correctly and
* that those new line characters are converted to the OS supported new line char.
*
* @return void
* @group nodebci
*/
public function testDeprecatedSniffsWarning()
{
$standard = __DIR__.'/ShowSniffDeprecationsTest.xml';
$config = new ConfigDouble(["--standard=$standard", '--no-colors']);
$ruleset = new Ruleset($config);
$expected = 'WARNING: The ShowSniffDeprecationsTest standard uses 5 deprecated sniffs'.PHP_EOL;
$expected .= '--------------------------------------------------------------------------------'.PHP_EOL;
$expected .= '- TestStandard.Deprecated.WithLongReplacement'.PHP_EOL;
$expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL;
$expected .= ' Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vel'.PHP_EOL;
$expected .= ' vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium sed.'.PHP_EOL;
$expected .= ' Fusce egestas congue massa semper cursus. Donec quis pretium tellus. In'.PHP_EOL;
$expected .= ' lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan'.PHP_EOL;
$expected .= ' eros sapien at sem. Sed pulvinar aliquam malesuada. Aliquam erat volutpat.'.PHP_EOL;
$expected .= ' Mauris gravida rutrum lectus at egestas. Fusce tempus elit in tincidunt'.PHP_EOL;
$expected .= ' dictum. Suspendisse dictum egestas sapien, eget ullamcorper metus elementum'.PHP_EOL;
$expected .= ' semper. Vestibulum sem justo, consectetur ac tincidunt et, finibus eget'.PHP_EOL;
$expected .= ' libero.'.PHP_EOL;
$expected .= '- TestStandard.Deprecated.WithoutReplacement'.PHP_EOL;
$expected .= ' This sniff has been deprecated since v3.4.0 and will be removed in v4.0.0.'.PHP_EOL;
$expected .= '- TestStandard.Deprecated.WithReplacement'.PHP_EOL;
$expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL;
$expected .= ' Use the Stnd.Category.OtherSniff sniff instead.'.PHP_EOL;
$expected .= '- TestStandard.Deprecated.WithReplacementContainingLinuxNewlines'.PHP_EOL;
$expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL;
$expected .= ' Lorem ipsum dolor sit amet, consectetur adipiscing elit.'.PHP_EOL;
$expected .= ' Fusce vel vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium'.PHP_EOL;
$expected .= ' sed.'.PHP_EOL;
$expected .= ' Fusce egestas congue massa semper cursus. Donec quis pretium tellus.'.PHP_EOL;
$expected .= ' In lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan'.PHP_EOL;
$expected .= ' eros sapien at sem.'.PHP_EOL;
$expected .= ' Sed pulvinar aliquam malesuada. Aliquam erat volutpat. Mauris gravida rutrum'.PHP_EOL;
$expected .= ' lectus at egestas.'.PHP_EOL;
$expected .= '- TestStandard.Deprecated.WithReplacementContainingNewlines'.PHP_EOL;
$expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL;
$expected .= ' Lorem ipsum dolor sit amet, consectetur adipiscing elit.'.PHP_EOL;
$expected .= ' Fusce vel vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium'.PHP_EOL;
$expected .= ' sed.'.PHP_EOL;
$expected .= ' Fusce egestas congue massa semper cursus. Donec quis pretium tellus.'.PHP_EOL;
$expected .= ' In lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan'.PHP_EOL;
$expected .= ' eros sapien at sem.'.PHP_EOL;
$expected .= ' Sed pulvinar aliquam malesuada. Aliquam erat volutpat. Mauris gravida rutrum'.PHP_EOL;
$expected .= ' lectus at egestas'.PHP_EOL.PHP_EOL;
$expected .= 'Deprecated sniffs are still run, but will stop working at some point in the'.PHP_EOL;
$expected .= 'future.'.PHP_EOL.PHP_EOL;
$this->expectOutputString($expected);
$ruleset->showSniffDeprecations();
}//end testDeprecatedSniffsWarning()
/**
* Test deprecated sniffs are listed alphabetically in the deprecated sniffs warning.
*
* This tests the following aspects:
* 1. That the summary line uses the correct grammar when there is a single deprecated sniff.
* 2. That the separator line below the summary maximizes at the longest line length.
* 3. That the word wrapping respects the maximum report width.
* 4. That the sniff name is truncated if it is longer than the max report width.
*
* @param int $reportWidth Report width for the test.
* @param string $expectedOutput Expected output.
*
* @dataProvider dataReportWidthIsRespected
*
* @return void
* @group nodebci
*/
public function testReportWidthIsRespected($reportWidth, $expectedOutput)
{
// Set up the ruleset.
$standard = __DIR__.'/ShowSniffDeprecationsReportWidthTest.xml';
$config = new ConfigDouble(['.', "--standard=$standard", "--report-width=$reportWidth", '--no-colors']);
$ruleset = new Ruleset($config);
$this->expectOutputString($expectedOutput);
$ruleset->showSniffDeprecations();
}//end testReportWidthIsRespected()
/**
* Data provider.
*
* @see testReportWidthIsRespected()
*
* @return array<string, array<string, int|string>>
*/
public static function dataReportWidthIsRespected()
{
$summaryLine = 'WARNING: The ShowSniffDeprecationsTest standard uses 1 deprecated sniff'.PHP_EOL;
// phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Test readability is more important.
return [
'Report width small: 40; with truncated sniff name and wrapped header and footer lines' => [
'reportWidth' => 40,
'expectedOutput' => 'WARNING: The ShowSniffDeprecationsTest'.PHP_EOL
.'standard uses 1 deprecated sniff'.PHP_EOL
.'----------------------------------------'.PHP_EOL
.'- TestStandard.Deprecated.WithLongR...'.PHP_EOL
.' This sniff has been deprecated since'.PHP_EOL
.' v3.8.0 and will be removed in'.PHP_EOL
.' v4.0.0. Lorem ipsum dolor sit amet,'.PHP_EOL
.' consectetur adipiscing elit. Fusce'.PHP_EOL
.' vel vestibulum nunc. Sed luctus'.PHP_EOL
.' dolor tortor, eu euismod purus'.PHP_EOL
.' pretium sed. Fusce egestas congue'.PHP_EOL
.' massa semper cursus. Donec quis'.PHP_EOL
.' pretium tellus. In lacinia, augue ut'.PHP_EOL
.' ornare porttitor, diam nunc faucibus'.PHP_EOL
.' purus, et accumsan eros sapien at'.PHP_EOL
.' sem. Sed pulvinar aliquam malesuada.'.PHP_EOL
.' Aliquam erat volutpat. Mauris'.PHP_EOL
.' gravida rutrum lectus at egestas.'.PHP_EOL
.' Fusce tempus elit in tincidunt'.PHP_EOL
.' dictum. Suspendisse dictum egestas'.PHP_EOL
.' sapien, eget ullamcorper metus'.PHP_EOL
.' elementum semper. Vestibulum sem'.PHP_EOL
.' justo, consectetur ac tincidunt et,'.PHP_EOL
.' finibus eget libero.'.PHP_EOL.PHP_EOL
.'Deprecated sniffs are still run, but'.PHP_EOL
.'will stop working at some point in the'.PHP_EOL
.'future.'.PHP_EOL.PHP_EOL,
],
'Report width default: 80' => [
'reportWidth' => 80,
'expectedOutput' => $summaryLine.str_repeat('-', 80).PHP_EOL
.'- TestStandard.Deprecated.WithLongReplacement'.PHP_EOL
.' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL
.' Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vel'.PHP_EOL
.' vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium sed.'.PHP_EOL
.' Fusce egestas congue massa semper cursus. Donec quis pretium tellus. In'.PHP_EOL
.' lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan'.PHP_EOL
.' eros sapien at sem. Sed pulvinar aliquam malesuada. Aliquam erat volutpat.'.PHP_EOL
.' Mauris gravida rutrum lectus at egestas. Fusce tempus elit in tincidunt'.PHP_EOL
.' dictum. Suspendisse dictum egestas sapien, eget ullamcorper metus elementum'.PHP_EOL
.' semper. Vestibulum sem justo, consectetur ac tincidunt et, finibus eget'.PHP_EOL
.' libero.'.PHP_EOL.PHP_EOL
.'Deprecated sniffs are still run, but will stop working at some point in the'.PHP_EOL
.'future.'.PHP_EOL.PHP_EOL,
],
'Report width matches longest line: 666; the message should not wrap' => [
// Length = 4 padding + 75 base line + 587 custom message.
'reportWidth' => 666,
'expectedOutput' => $summaryLine.str_repeat('-', 666).PHP_EOL
.'- TestStandard.Deprecated.WithLongReplacement'.PHP_EOL
.' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vel vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium sed. Fusce egestas congue massa semper cursus. Donec quis pretium tellus. In lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan eros sapien at sem. Sed pulvinar aliquam malesuada. Aliquam erat volutpat. Mauris gravida rutrum lectus at egestas. Fusce tempus elit in tincidunt dictum. Suspendisse dictum egestas sapien, eget ullamcorper metus elementum semper. Vestibulum sem justo, consectetur ac tincidunt et, finibus eget libero.'
.PHP_EOL.PHP_EOL
.'Deprecated sniffs are still run, but will stop working at some point in the future.'.PHP_EOL.PHP_EOL,
],
'Report width wide: 1000; delimiter line length should match longest line' => [
'reportWidth' => 1000,
'expectedOutput' => $summaryLine.str_repeat('-', 666).PHP_EOL
.'- TestStandard.Deprecated.WithLongReplacement'.PHP_EOL
.' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vel vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium sed. Fusce egestas congue massa semper cursus. Donec quis pretium tellus. In lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan eros sapien at sem. Sed pulvinar aliquam malesuada. Aliquam erat volutpat. Mauris gravida rutrum lectus at egestas. Fusce tempus elit in tincidunt dictum. Suspendisse dictum egestas sapien, eget ullamcorper metus elementum semper. Vestibulum sem justo, consectetur ac tincidunt et, finibus eget libero.'
.PHP_EOL.PHP_EOL
.'Deprecated sniffs are still run, but will stop working at some point in the future.'.PHP_EOL.PHP_EOL,
],
];
// phpcs:enable
}//end dataReportWidthIsRespected()
/**
* Test deprecated sniffs are listed alphabetically in the deprecated sniffs warning.
*
* Additionally, this test verifies that deprecated sniffs are still registered to run.
*
* @return void
* @group nodebci
*/
public function testDeprecatedSniffsAreListedAlphabetically()
{
// Set up the ruleset.
$standard = __DIR__.'/ShowSniffDeprecationsOrderTest.xml';
$config = new ConfigDouble(["--standard=$standard", '--no-colors']);
$ruleset = new Ruleset($config);
$expected = 'WARNING: The ShowSniffDeprecationsTest standard uses 2 deprecated sniffs'.PHP_EOL;
$expected .= '--------------------------------------------------------------------------------'.PHP_EOL;
$expected .= '- TestStandard.Deprecated.WithoutReplacement'.PHP_EOL;
$expected .= ' This sniff has been deprecated since v3.4.0 and will be removed in v4.0.0.'.PHP_EOL;
$expected .= '- TestStandard.Deprecated.WithReplacement'.PHP_EOL;
$expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL;
$expected .= ' Use the Stnd.Category.OtherSniff sniff instead.'.PHP_EOL.PHP_EOL;
$expected .= 'Deprecated sniffs are still run, but will stop working at some point in the'.PHP_EOL;
$expected .= 'future.'.PHP_EOL.PHP_EOL;
$this->expectOutputString($expected);
$ruleset->showSniffDeprecations();
// Verify that the sniffs have been registered to run.
$this->assertCount(2, $ruleset->sniffCodes, 'Incorrect number of sniff codes registered');
$this->assertArrayHasKey(
'TestStandard.Deprecated.WithoutReplacement',
$ruleset->sniffCodes,
'WithoutReplacement sniff not registered'
);
$this->assertArrayHasKey(
'TestStandard.Deprecated.WithReplacement',
$ruleset->sniffCodes,
'WithReplacement sniff not registered'
);
}//end testDeprecatedSniffsAreListedAlphabetically()
/**
* Test that an exception is thrown when any of the interface required methods does not
* comply with the return type/value requirements.
*
* @param string $standard The standard to use for the test.
* @param string $exceptionMessage The contents of the expected exception message.
*
* @dataProvider dataExceptionIsThrownOnIncorrectlyImplementedInterface
*
* @return void
* @group nodebci
*/
public function testExceptionIsThrownOnIncorrectlyImplementedInterface($standard, $exceptionMessage)
{
$this->expectRuntimeExceptionMessage($exceptionMessage);
// Set up the ruleset.
$standard = __DIR__.'/'.$standard;
$config = new ConfigDouble(["--standard=$standard"]);
$ruleset = new Ruleset($config);
$ruleset->showSniffDeprecations();
}//end testExceptionIsThrownOnIncorrectlyImplementedInterface()
/**
* Data provider.
*
* @see testExceptionIsThrownOnIncorrectlyImplementedInterface()
*
* @return array<string, array<string, string>>
*/
public static function dataExceptionIsThrownOnIncorrectlyImplementedInterface()
{
return [
'getDeprecationVersion() does not return a string' => [
'standard' => 'ShowSniffDeprecationsInvalidDeprecationVersionTest.xml',
'exceptionMessage' => 'The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\InvalidDeprecationVersionSniff::getDeprecationVersion() method must return a non-empty string, received double',
],
'getRemovalVersion() does not return a string' => [
'standard' => 'ShowSniffDeprecationsInvalidRemovalVersionTest.xml',
'exceptionMessage' => 'The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\InvalidRemovalVersionSniff::getRemovalVersion() method must return a non-empty string, received array',
],
'getDeprecationMessage() does not return a string' => [
'standard' => 'ShowSniffDeprecationsInvalidDeprecationMessageTest.xml',
'exceptionMessage' => 'The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\InvalidDeprecationMessageSniff::getDeprecationMessage() method must return a string, received object',
],
'getDeprecationVersion() returns an empty string' => [
'standard' => 'ShowSniffDeprecationsEmptyDeprecationVersionTest.xml',
'exceptionMessage' => 'The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\EmptyDeprecationVersionSniff::getDeprecationVersion() method must return a non-empty string, received ""',
],
'getRemovalVersion() returns an empty string' => [
'standard' => 'ShowSniffDeprecationsEmptyRemovalVersionTest.xml',
'exceptionMessage' => 'The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\EmptyRemovalVersionSniff::getRemovalVersion() method must return a non-empty string, received ""',
],
];
}//end dataExceptionIsThrownOnIncorrectlyImplementedInterface()
}//end class
|
