[7.3] PHPUnit migration from annotation to attributes

[llaville]

On the roadmap to the new version 7.3.0 :

• after dropping support to PHP 8.1 by commit da93e6a
• we have to make the unit test suites compatible PHPUnit 11 or greater.

The major change that required our attention is the metatada in PHPUnit 11.

We have now to migrate from PHP doc-comment annotations to PHP 8 attributes to be sure to make our Unit Tests Suites compatible with PHPUnit 11, 12 and 13.

With Rector

To apply changes on all tests directory source code, we will use Rector, with following custom configuration: rector-phpunit.php

<?php declare(strict_types=1);

use Rector\Config\RectorConfig;
use Rector\PHPUnit\Set\PHPUnitSetList;

return RectorConfig::configure()
    ->withPaths(
        [__DIR__ . '/tests']
    )
    ->withSkip(
        [__DIR__ . '/tests/fixtures/']
    )
    ->withSets([
        PhpUnitSetList::ANNOTATIONS_TO_ATTRIBUTES,
    ])
    ->withImportNames()
;

And to check what code refactoring will be done, we can use following command :

vendor/bin/rector process --autoload-file=autoload.php --config=rector-phpunit.php --dry-run

And then do the Job with following command :

vendor/bin/rector process --autoload-file=autoload.php --config=rector-phpunit.php

With PHP-CS-Fixer (alternative)

Alternative way will be to use PHP-CS-Fixer with such following configuration .php-cs-fixer.php file contents :

<?php

$finder = (new PhpCsFixer\Finder())
    ->in(__DIR__ . DIRECTORY_SEPARATOR . 'tests')
;

return (new PhpCsFixer\Config())
    ->setRules([
        'php_unit_attributes' => true,
    ])
    ->setFinder($finder)
;

Checking with command :

vendor/bin/php-cs-fixer check --config=.php-cs-fixer.php

That gave us such results :

PHP CS Fixer 3.95.1 Adalbertus by Fabien Potencier, Dariusz Ruminski and contributors.
PHP runtime: 8.4.21
Loaded config default from ".php-cs-fixer.php".
Running analysis on 11 cores with 10 files per process.
 412/412 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

   1) tests/fixtures/references/vfsStreamZipTestCase.php
   2) tests/ErrorHandlerIssueTest.php
   3) tests/ConditionIssueTest.php
   4) tests/Reference/ParameterTest.php
   5) tests/Sniffs/ClassMemberAccessSniffTest.php
   6) tests/Sniffs/DeprecateDollarBraceStringInterpolationSniffTest.php
   7) tests/Sniffs/MagicMethodsSniffTest.php
   8) tests/Sniffs/OctalNumberFormatSniffTest.php
   9) tests/Sniffs/GotoSniffTest.php
  10) tests/Sniffs/TypedClassConstantSniffTest.php
  11) tests/Sniffs/PropertyHooksSniffTest.php
  12) tests/Sniffs/NullCoalesceOperatorSniffTest.php
  13) tests/Sniffs/ClassConstantSniffTest.php
  14) tests/Sniffs/CombinedComparisonOperatorSniffTest.php
  15) tests/Sniffs/CryptStringSniffTest.php
  16) tests/Sniffs/ReadonlyPropertySniffTest.php
  17) tests/Sniffs/NamedArgumentDeclarationSniffTest.php
  18) tests/Sniffs/PropertyPromotionSniffTest.php
  19) tests/Sniffs/SensitiveParameterAttributeSniffTest.php
  20) tests/Sniffs/StaticVarInitializerSniffTest.php
  21) tests/Sniffs/UseConstFunctionSniffTest.php
  22) tests/Sniffs/GeneratorSniffTest.php
  23) tests/Sniffs/ShortArraySyntaxSniffTest.php
  24) tests/Sniffs/EmptySniffTest.php
  25) tests/Sniffs/MagicClassConstantSniffTest.php
  26) tests/Sniffs/DeclareSniffTest.php
  27) tests/Sniffs/ArrayDereferencingSyntaxSniffTest.php
  28) tests/Sniffs/ConstSyntaxSniffTest.php
  29) tests/Sniffs/DynamicClassConstantFetchSniffTest.php
  30) tests/Sniffs/TypedPropertySniffTest.php
  31) tests/Sniffs/ArrayUnpackingSyntaxSniffTest.php
  32) tests/Sniffs/UseTraitSniffTest.php
  33) tests/Sniffs/EnumerationSniffTest.php
  34) tests/Reference/IssueTest.php
  35) tests/DependencyIssueTest.php
  36) tests/PhpFeaturesIssueTest.php
  37) tests/FunctionIssueTest.php
  38) tests/ClassIssueTest.php
  39) tests/Sniffs/ConditionalCodeSniffTest.php
  40) tests/Sniffs/ArrowFunctionSniffTest.php
  41) tests/Sniffs/BinaryNumberFormatSniffTest.php
  42) tests/Sniffs/FiberSniffTest.php
  43) tests/Sniffs/PropertyDeclarationSniffTest.php
  44) tests/Sniffs/KeywordReservedSniffTest.php
  45) tests/PhpFeatures/Php82IssueTest.php
  46) tests/PhpFeatures/Php53IssueTest.php
  47) tests/NamespaceIssueTest.php
  48) tests/PhpParser/NodeVisitor/NameResolverVisitorTest.php
  49) tests/PhpParser/NodeVisitor/VersionResolverVisitorTest.php
  50) tests/Sniffs/ReadonlyClassSniffTest.php
  51) tests/Sniffs/NullsafeOperatorSniffTest.php
  52) tests/Sniffs/AnonymousClassSniffTest.php
  53) tests/Sniffs/NewInitializerSniffTest.php
  54) tests/Sniffs/MatchSniffTest.php
  55) tests/Sniffs/ClosureSniffTest.php
  56) tests/Sniffs/MethodDeclarationSniffTest.php
  57) tests/Sniffs/OverrideAttributeSniffTest.php
  58) tests/Sniffs/VariadicFunctionSniffTest.php
  59) tests/Sniffs/PowOperatorSniffTest.php
  60) tests/Sniffs/ReturnTypeDeclarationSniffTest.php
  61) tests/Sniffs/TrailingCommaSniffTest.php
  62) tests/Sniffs/AttributeSniffTest.php
  63) tests/Sniffs/FirstClassCallableSniffTest.php
  64) tests/Sniffs/SameSiteCookieSniffTest.php
  65) tests/Sniffs/AllowDynamicPropertiesAttributeSniffTest.php
  66) tests/Sniffs/NonCapturingCatchSniffTest.php
  67) tests/Sniffs/ParamTypeDeclarationSniffTest.php
  68) tests/Sniffs/ClassExprSyntaxSniffTest.php
  69) tests/Sniffs/ShortTernaryOperatorSniffTest.php

Found 69 of 412 files that can be fixed in 0.798 seconds, 200.00 MB memory used

Files that were not fixed due to errors reported during linting before fixing:
   1) /shared/backups/bartlett/php-compatinfo/tests/fixtures/sniffs/deprecated_new_reference.php
   2) /shared/backups/bartlett/php-compatinfo/tests/fixtures/sniffs/keywords_reserved.php
   3) /shared/backups/bartlett/php-compatinfo/tests/fixtures/noContents/parseError.php
   4) /shared/backups/bartlett/php-compatinfo/tests/fixtures/source7813.php

And apply modifications with command :

vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php

But I prefer Rector way that make import FQCN uses very easy compared to CS-Fixer : learn more with PHP-CS-Fixer/PHP-CS-Fixer#6966

[llaville]

Metadata migration (with Rector) gave us following results with commit 79a1bfb