-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
AbstractFixerTestCase.php
487 lines (398 loc) · 18.9 KB
/
AbstractFixerTestCase.php
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
<?php
declare(strict_types=1);
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier <fabien@symfony.com>
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace PhpCsFixer\Tests\Test;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\AbstractProxyFixer;
use PhpCsFixer\Fixer\ConfigurableFixerInterface;
use PhpCsFixer\Fixer\DeprecatedFixerInterface;
use PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer;
use PhpCsFixer\FixerConfiguration\FixerOptionInterface;
use PhpCsFixer\FixerDefinition\CodeSampleInterface;
use PhpCsFixer\FixerDefinition\FileSpecificCodeSampleInterface;
use PhpCsFixer\FixerDefinition\VersionSpecificCodeSampleInterface;
use PhpCsFixer\Linter\CachingLinter;
use PhpCsFixer\Linter\Linter;
use PhpCsFixer\Linter\LinterInterface;
use PhpCsFixer\Linter\ProcessLinter;
use PhpCsFixer\PhpunitConstraintIsIdenticalString\Constraint\IsIdenticalString;
use PhpCsFixer\Preg;
use PhpCsFixer\StdinFileInfo;
use PhpCsFixer\Tests\Test\Assert\AssertTokensTrait;
use PhpCsFixer\Tests\TestCase;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* @internal
*/
abstract class AbstractFixerTestCase extends TestCase
{
use AssertTokensTrait;
/**
* @var null|LinterInterface
*/
protected $linter;
/**
* @var null|AbstractFixer
*/
protected $fixer;
/**
* do not modify this structure without prior discussion.
*
* @var array<string,array>
*/
private $allowedRequiredOptions = [
'header_comment' => ['header' => true],
];
/**
* do not modify this structure without prior discussion.
*
* @var array<string,bool>
*/
private $allowedFixersWithoutDefaultCodeSample = [
'general_phpdoc_annotation_remove' => true,
'general_phpdoc_tag_rename' => true,
];
protected function setUp(): void
{
parent::setUp();
$this->linter = $this->getLinter();
$this->fixer = $this->createFixer();
}
protected function tearDown(): void
{
parent::tearDown();
$this->linter = null;
$this->fixer = null;
}
final public function testIsRisky(): void
{
if ($this->fixer->isRisky()) {
self::assertValidDescription($this->fixer->getName(), 'risky description', $this->fixer->getDefinition()->getRiskyDescription());
} else {
static::assertNull($this->fixer->getDefinition()->getRiskyDescription(), sprintf('[%s] Fixer is not risky so no description of it expected.', $this->fixer->getName()));
}
if ($this->fixer instanceof AbstractProxyFixer) {
return;
}
$reflection = new \ReflectionMethod($this->fixer, 'isRisky');
// If fixer is not risky then the method `isRisky` from `AbstractFixer` must be used
static::assertSame(
!$this->fixer->isRisky(),
AbstractFixer::class === $reflection->getDeclaringClass()->getName()
);
}
final public function testFixerDefinitions(): void
{
$fixerName = $this->fixer->getName();
$definition = $this->fixer->getDefinition();
$fixerIsConfigurable = $this->fixer instanceof ConfigurableFixerInterface;
self::assertValidDescription($fixerName, 'summary', $definition->getSummary());
$samples = $definition->getCodeSamples();
static::assertNotEmpty($samples, sprintf('[%s] Code samples are required.', $fixerName));
$configSamplesProvided = [];
$dummyFileInfo = new StdinFileInfo();
foreach ($samples as $sampleCounter => $sample) {
static::assertInstanceOf(CodeSampleInterface::class, $sample, sprintf('[%s] Sample #%d', $fixerName, $sampleCounter));
static::assertIsInt($sampleCounter);
$code = $sample->getCode();
static::assertNotEmpty($code, sprintf('[%s] Sample #%d', $fixerName, $sampleCounter));
if (!($this->fixer instanceof SingleBlankLineAtEofFixer)) {
static::assertStringEndsWith("\n", $code, sprintf('[%s] Sample #%d must end with linebreak', $fixerName, $sampleCounter));
}
$config = $sample->getConfiguration();
if (null !== $config) {
static::assertTrue($fixerIsConfigurable, sprintf('[%s] Sample #%d has configuration, but the fixer is not configurable.', $fixerName, $sampleCounter));
$configSamplesProvided[$sampleCounter] = $config;
} elseif ($fixerIsConfigurable) {
if (!$sample instanceof VersionSpecificCodeSampleInterface) {
static::assertArrayNotHasKey('default', $configSamplesProvided, sprintf('[%s] Multiple non-versioned samples with default configuration.', $fixerName));
}
$configSamplesProvided['default'] = true;
}
if ($sample instanceof VersionSpecificCodeSampleInterface && !$sample->isSuitableFor(\PHP_VERSION_ID)) {
continue;
}
if ($fixerIsConfigurable) {
// always re-configure as the fixer might have been configured with diff. configuration form previous sample
$this->fixer->configure($config ?? []);
}
Tokens::clearCache();
$tokens = Tokens::fromCode($code);
$this->fixer->fix(
$sample instanceof FileSpecificCodeSampleInterface ? $sample->getSplFileInfo() : $dummyFileInfo,
$tokens
);
static::assertTrue($tokens->isChanged(), sprintf('[%s] Sample #%d is not changed during fixing.', $fixerName, $sampleCounter));
$duplicatedCodeSample = array_search(
$sample,
\array_slice($samples, 0, $sampleCounter),
false
);
static::assertFalse(
$duplicatedCodeSample,
sprintf('[%s] Sample #%d duplicates #%d.', $fixerName, $sampleCounter, $duplicatedCodeSample)
);
}
if ($fixerIsConfigurable) {
if (isset($configSamplesProvided['default'])) {
reset($configSamplesProvided);
static::assertSame('default', key($configSamplesProvided), sprintf('[%s] First sample must be for the default configuration.', $fixerName));
} elseif (!isset($this->allowedFixersWithoutDefaultCodeSample[$fixerName])) {
static::assertArrayHasKey($fixerName, $this->allowedRequiredOptions, sprintf('[%s] Has no sample for default configuration.', $fixerName));
}
if (\count($configSamplesProvided) < 2) {
static::fail(sprintf('[%s] Configurable fixer only provides a default configuration sample and none for its configuration options.', $fixerName));
}
$options = $this->fixer->getConfigurationDefinition()->getOptions();
foreach ($options as $option) {
static::assertMatchesRegularExpression('/^[a-z_]+[a-z]$/', $option->getName(), sprintf('[%s] Option %s is not snake_case.', $fixerName, $option->getName()));
}
}
static::assertIsInt($this->fixer->getPriority());
}
final public function testFixersAreFinal(): void
{
$reflection = new \ReflectionClass($this->fixer);
static::assertTrue(
$reflection->isFinal(),
sprintf('Fixer "%s" must be declared "final".', $this->fixer->getName())
);
}
final public function testDeprecatedFixersHaveCorrectSummary(): void
{
$reflection = new \ReflectionClass($this->fixer);
$comment = $reflection->getDocComment();
static::assertStringNotContainsString(
'DEPRECATED',
$this->fixer->getDefinition()->getSummary(),
'Fixer cannot contain word "DEPRECATED" in summary'
);
if ($this->fixer instanceof DeprecatedFixerInterface) {
static::assertStringContainsString('@deprecated', $comment);
} elseif (\is_string($comment)) {
static::assertStringNotContainsString('@deprecated', $comment);
}
}
/**
* Blur filter that find candidate fixer for performance optimization to use only `insertSlices` instead of multiple `insertAt` if there is no other collection manipulation.
*/
public function testFixerUseInsertSlicesWhenOnlyInsertionsArePerformed(): void
{
$reflection = new \ReflectionClass($this->fixer);
$tokens = Tokens::fromCode(file_get_contents($reflection->getFileName()));
$sequences = $this->findAllTokenSequences($tokens, [[T_VARIABLE, '$tokens'], [T_OBJECT_OPERATOR], [T_STRING]]);
$usedMethods = array_unique(array_map(static function (array $sequence): string {
$last = end($sequence);
return $last->getContent();
}, $sequences));
// if there is no `insertAt`, it's not a candidate
if (!\in_array('insertAt', $usedMethods, true)) {
$this->expectNotToPerformAssertions();
return;
}
$usedMethods = array_filter($usedMethods, static function (string $method): bool {
return 0 === Preg::match('/^(count|find|generate|get|is|rewind)/', $method);
});
$allowedMethods = ['insertAt'];
$nonAllowedMethods = array_diff($usedMethods, $allowedMethods);
if ([] === $nonAllowedMethods) {
$fixerName = $this->fixer->getName();
if (\in_array($fixerName, [
// DO NOT add anything to this list at ease, align with core contributors whether it makes sense to insert tokens individually or by bulk for your case.
// The original list of the fixers being exceptions and insert tokens individually came from legacy reasons when it was the only available methods to insert tokens.
'blank_line_after_namespace',
'blank_line_after_opening_tag',
'blank_line_before_statement',
'class_attributes_separation',
'date_time_immutable',
'declare_strict_types',
'doctrine_annotation_braces',
'doctrine_annotation_spaces',
'final_internal_class',
'final_public_method_for_abstract_class',
'function_typehint_space',
'heredoc_indentation',
'method_chaining_indentation',
'native_constant_invocation',
'new_with_braces',
'no_short_echo_tag',
'not_operator_with_space',
'not_operator_with_successor_space',
'php_unit_internal_class',
'php_unit_no_expectation_annotation',
'php_unit_set_up_tear_down_visibility',
'php_unit_size_class',
'php_unit_test_annotation',
'php_unit_test_class_requires_covers',
'phpdoc_to_param_type',
'phpdoc_to_property_type',
'phpdoc_to_return_type',
'random_api_migration',
'semicolon_after_instruction',
'single_line_after_imports',
'static_lambda',
'strict_param',
'void_return',
], true)) {
static::markTestIncomplete(sprintf('Fixer "%s" may be optimized to use `Tokens::insertSlices` instead of `%s`, please help and optimize it.', $fixerName, implode(', ', $allowedMethods)));
}
static::fail(sprintf('Fixer "%s" shall be optimized to use `Tokens::insertSlices` instead of `%s`.', $fixerName, implode(', ', $allowedMethods)));
}
$this->addToAssertionCount(1);
}
final public function testFixerConfigurationDefinitions(): void
{
if (!$this->fixer instanceof ConfigurableFixerInterface) {
$this->expectNotToPerformAssertions(); // not applied to the fixer without configuration
return;
}
$configurationDefinition = $this->fixer->getConfigurationDefinition();
foreach ($configurationDefinition->getOptions() as $option) {
static::assertInstanceOf(FixerOptionInterface::class, $option);
static::assertNotEmpty($option->getDescription());
static::assertSame(
!isset($this->allowedRequiredOptions[$this->fixer->getName()][$option->getName()]),
$option->hasDefault(),
sprintf(
$option->hasDefault()
? 'Option `%s` of fixer `%s` is wrongly listed in `$allowedRequiredOptions` structure, as it is not required. If you just changed that option to not be required anymore, please adjust mentioned structure.'
: 'Option `%s` of fixer `%s` shall not be required. If you want to introduce new required option please adjust `$allowedRequiredOptions` structure.',
$option->getName(),
$this->fixer->getName()
)
);
static::assertStringNotContainsString(
'DEPRECATED',
$option->getDescription(),
'Option description cannot contain word "DEPRECATED"'
);
}
}
protected function createFixer(): AbstractFixer
{
$fixerClassName = preg_replace('/^(PhpCsFixer)\\\\Tests(\\\\.+)Test$/', '$1$2', static::class);
return new $fixerClassName();
}
protected function getTestFile(string $filename = __FILE__): \SplFileInfo
{
static $files = [];
if (!isset($files[$filename])) {
$files[$filename] = new \SplFileInfo($filename);
}
return $files[$filename];
}
/**
* Tests if a fixer fixes a given string to match the expected result.
*
* It is used both if you want to test if something is fixed or if it is not touched by the fixer.
* It also makes sure that the expected output does not change when run through the fixer. That means that you
* do not need two test cases like [$expected] and [$expected, $input] (where $expected is the same in both cases)
* as the latter covers both of them.
* This method throws an exception if $expected and $input are equal to prevent test cases that accidentally do
* not test anything.
*
* @param string $expected The expected fixer output
* @param null|string $input The fixer input, or null if it should intentionally be equal to the output
* @param null|\SplFileInfo $file The file to fix, or null if unneeded
*/
protected function doTest(string $expected, ?string $input = null, ?\SplFileInfo $file = null): void
{
if ($expected === $input) {
throw new \InvalidArgumentException('Input parameter must not be equal to expected parameter.');
}
$file = $file ?? $this->getTestFile();
$fileIsSupported = $this->fixer->supports($file);
if (null !== $input) {
static::assertNull($this->lintSource($input));
Tokens::clearCache();
$tokens = Tokens::fromCode($input);
if ($fileIsSupported) {
static::assertTrue($this->fixer->isCandidate($tokens), 'Fixer must be a candidate for input code.');
static::assertFalse($tokens->isChanged(), 'Fixer must not touch Tokens on candidate check.');
$this->fixer->fix($file, $tokens);
}
static::assertThat(
$tokens->generateCode(),
new IsIdenticalString($expected),
'Code build on input code must match expected code.'
);
static::assertTrue($tokens->isChanged(), 'Tokens collection built on input code must be marked as changed after fixing.');
$tokens->clearEmptyTokens();
static::assertSame(
\count($tokens),
\count(array_unique(array_map(static function (Token $token): string {
return spl_object_hash($token);
}, $tokens->toArray()))),
'Token items inside Tokens collection must be unique.'
);
Tokens::clearCache();
$expectedTokens = Tokens::fromCode($expected);
static::assertTokens($expectedTokens, $tokens);
}
static::assertNull($this->lintSource($expected));
Tokens::clearCache();
$tokens = Tokens::fromCode($expected);
if ($fileIsSupported) {
$this->fixer->fix($file, $tokens);
}
static::assertThat(
$tokens->generateCode(),
new IsIdenticalString($expected),
'Code build on expected code must not change.'
);
static::assertFalse($tokens->isChanged(), 'Tokens collection built on expected code must not be marked as changed after fixing.');
}
protected function lintSource(string $source): ?string
{
try {
$this->linter->lintSource($source)->check();
} catch (\Exception $e) {
return $e->getMessage()."\n\nSource:\n{$source}";
}
return null;
}
private function getLinter(): LinterInterface
{
static $linter = null;
if (null === $linter) {
$linter = new CachingLinter(
getenv('FAST_LINT_TEST_CASES') ? new Linter() : new ProcessLinter()
);
}
return $linter;
}
private static function assertValidDescription(string $fixerName, string $descriptionType, string $description): void
{
static::assertMatchesRegularExpression('/^[A-Z`][^"]+\.$/', $description, sprintf('[%s] The %s must start with capital letter or a ` and end with dot.', $fixerName, $descriptionType));
static::assertStringNotContainsString('phpdocs', $description, sprintf('[%s] `PHPDoc` must not be in the plural in %s.', $fixerName, $descriptionType));
static::assertCorrectCasing($description, 'PHPDoc', sprintf('[%s] `PHPDoc` must be in correct casing in %s.', $fixerName, $descriptionType));
static::assertCorrectCasing($description, 'PHPUnit', sprintf('[%s] `PHPUnit` must be in correct casing in %s.', $fixerName, $descriptionType));
static::assertFalse(strpos($descriptionType, '``'), sprintf('[%s] The %s must no contain sequential backticks.', $fixerName, $descriptionType));
}
private static function assertCorrectCasing(string $needle, string $haystack, string $message): void
{
static::assertSame(substr_count(strtolower($haystack), strtolower($needle)), substr_count($haystack, $needle), $message);
}
private function findAllTokenSequences(Tokens $tokens, array $sequence): array
{
$lastIndex = 0;
$sequences = [];
while ($found = $tokens->findSequence($sequence, $lastIndex)) {
$keys = array_keys($found);
$sequences[] = $found;
$lastIndex = $keys[2];
}
return $sequences;
}
}