[FEATURE] Upgrade php version, change typo3 testing framework and upg…

…raded code style tool versions (#13) * updated php version to 8.3, changed testing framework and code-style versions * fixed pipeline * fixed pipeline * fix phpstan * changed version of scrutinizer to php83 * removed mysql info from test.yml * fix pipeline * switch to mariadb in tests.yml * added db distribution to test.yml * fix pipeline * fix pipeline * fix pipeline * chore: use git checkout depth 10 * fixed code review issues --------- Co-authored-by: thomas.layh <[email protected]>
AOEpeople · Apr 22, 2024 · 219c10c · 219c10c
1 parent 6831690
commit 219c10c
Show file tree

Hide file tree

Showing 32 changed files with 426 additions and 730 deletions.
diff --git a/.code-quality/ecs.php b/.code-quality/ecs.php
@@ -2,70 +2,46 @@
 
 declare(strict_types=1);
 
-use PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer;
-use PhpCsFixer\Fixer\Import\OrderedImportsFixer;
+use PhpCsFixer\Fixer\FunctionNotation\FunctionTypehintSpaceFixer;
 use PhpCsFixer\Fixer\Operator\NotOperatorWithSuccessorSpaceFixer;
-use PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer;
 use PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer;
-use PhpCsFixer\Fixer\Strict\StrictComparisonFixer;
-use PhpCsFixer\Fixer\Strict\StrictParamFixer;
-use PhpCsFixer\Fixer\StringNotation\ExplicitStringVariableFixer;
-use PhpCsFixer\Fixer\Whitespace\ArrayIndentationFixer;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayListItemNewlineFixer;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer;
 use Symplify\CodingStandard\Fixer\LineLength\DocBlockLineLengthFixer;
 use Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Option;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
 
-return static function (ContainerConfigurator $containerConfigurator): void {
-    $parameters = $containerConfigurator->parameters();
-    $parameters->set(
-        Option::PATHS,
+return ECSConfig::configure()
+    ->withPaths([
+        __DIR__ . '/../Classes',
+        __DIR__ . '/../Tests',
+        __DIR__ . '/ecs.php',
+    ])
+    ->withSets([
+        SetList::PSR_12,
+        SetList::COMMON,
+        SetList::SYMPLIFY,
+        SetList::CLEAN_CODE,
+    ])
+    ->withConfiguredRule(
+        LineLengthFixer::class,
         [
-            __DIR__ . '/../Classes',
-            __DIR__ . '/ecs.php',
-        ]
-    );
-
-    $containerConfigurator->import(SetList::COMMON);
-    $containerConfigurator->import(SetList::CLEAN_CODE);
-    $containerConfigurator->import(SetList::PSR_12);
-    $containerConfigurator->import(SetList::SYMPLIFY);
-
-    $containerConfigurator->services()
-        ->set(LineLengthFixer::class)
-        ->call('configure', [[
             LineLengthFixer::LINE_LENGTH => 140,
             LineLengthFixer::INLINE_SHORT_LINES => false,
-        ]]);
-
-    // Skip Rules and Sniffer
-    $parameters->set(
-        Option::SKIP,
-        [
-            // Default Skips
-            Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer::class => [
-                __DIR__ . '/ecs.php',
-            ],
-            ArrayListItemNewlineFixer::class => null,
-            ArrayOpenerAndCloserNewlineFixer::class => null,
-            ClassAttributesSeparationFixer::class => null,
-            OrderedImportsFixer::class => null,
-            NotOperatorWithSuccessorSpaceFixer::class => null,
-            ExplicitStringVariableFixer::class => null,
-            ArrayIndentationFixer::class => null,
-            DocBlockLineLengthFixer::class => null,
-            '\SlevomatCodingStandard\Sniffs\Whitespaces\DuplicateSpacesSniff.DuplicateSpaces' => null,
-            '\SlevomatCodingStandard\Sniffs\Namespaces\ReferenceUsedNamesOnlySniff.PartialUse' => null,
-
-            // @todo for next upgrade
-            NoSuperfluousPhpdocTagsFixer::class => null,
-            // @todo strict php
-            DeclareStrictTypesFixer::class => null,
-            StrictComparisonFixer::class => null,
-            StrictParamFixer::class => null,
         ]
-    );
-};
+    )
+    ->withSkip([
+        NotOperatorWithSuccessorSpaceFixer::class => null,
+        DocBlockLineLengthFixer::class => null,
+        ArrayListItemNewlineFixer::class => null,
+        ArrayOpenerAndCloserNewlineFixer::class => null,
+        FunctionTypehintSpaceFixer::class => [
+            __DIR__ . '/../Tests/Unit/TYPO3/AdditionalResponseHeadersTest.php',
+            __DIR__ . '/../Classes/TYPO3/Hooks/ClearCacheMenuHook.php',
+            __DIR__ . '/../Classes/TYPO3/Configuration/ExtensionConfiguration.php',
+        ],
+        DeclareStrictTypesFixer::class => null,
+    ])
+    ->withSpacing(OPTION::INDENTATION_SPACES, "\n");
diff --git a/.code-quality/phpstan-baseline.neon b/.code-quality/phpstan-baseline.neon
@@ -10,17 +10,3 @@ parameters:
 			count: 3
 			path: ../Classes/Form/Element/AbstractFormSelectElement.php
 
-		-
-			message: "#^Parameter \\#1 \\.\\.\\.\\$predicates of method TYPO3\\\\CMS\\\\Core\\\\Database\\\\Query\\\\QueryBuilder\\:\\:where\\(\\) expects array\\<int, mixed\\>\\|Doctrine\\\\DBAL\\\\Query\\\\Expression\\\\CompositeExpression, string given\\.$#"
-			count: 1
-			path: ../Classes/System/Db/FeatureFlagData.php
-
-		-
-			message: "#^Method Aoe\\\\FeatureFlag\\\\System\\\\Typo3\\\\TCA\\:\\:updateMapping\\(\\) has parameter \\$featureFlag with no typehint specified\\.$#"
-			count: 1
-			path: ../Classes/System/Typo3/TCA.php
-
-		-
-			message: "#^Method Aoe\\\\FeatureFlag\\\\System\\\\Typo3\\\\TCA\\:\\:updateMapping\\(\\) has parameter \\$pid with no typehint specified\\.$#"
-			count: 1
-			path: ../Classes/System/Typo3/TCA.php
diff --git a/.code-quality/phpstan.neon b/.code-quality/phpstan.neon
@@ -1,9 +1,7 @@
 includes:
+    - ../.Build/vendor/symplify/phpstan-rules/config/services/services.neon
+    - ../.Build/vendor/symplify/phpstan-rules/config/code-complexity-rules.neon
     - phpstan-baseline.neon
-    - ../.Build/vendor/symplify/phpstan-rules/packages/cognitive-complexity/config/cognitive-complexity-rules.neon
-
-rules:
-    - Symplify\PHPStanRules\Rules\NoDefaultExceptionRule
 
 parameters:
     level: 6
@@ -13,21 +11,8 @@ parameters:
     inferPrivatePropertyTypeFromConstructor: true
     checkMissingIterableValueType: false
     checkGenericClassInNonGenericObjectType: false
-    checkAlwaysTrueCheckTypeFunctionCall: false
-    checkAlwaysTrueStrictComparison: false
 
 services:
-    - class: Symplify\Astral\Naming\SimpleNameResolver
-    - class: Symplify\PHPStanRules\CognitiveComplexity\AstCognitiveComplexityAnalyzer
-    - class: Symplify\PHPStanRules\CognitiveComplexity\NodeTraverser\ComplexityNodeTraverserFactory
-    - class: Symplify\PHPStanRules\CognitiveComplexity\DataCollector\CognitiveComplexityDataCollector
-    - class: Symplify\PHPStanRules\CognitiveComplexity\NodeVisitor\NestingNodeVisitor
-    - class: Symplify\PHPStanRules\CognitiveComplexity\NodeVisitor\ComplexityNodeVisitor
-    - class: Symplify\PHPStanRules\CognitiveComplexity\NodeAnalyzer\ComplexityAffectingNodeFinder
-    - class: Symplify\PackageBuilder\Php\TypeChecker
-    - class: Symplify\PackageBuilder\Matcher\ArrayStringAndFnMatcher
-    - class: Symplify\PHPStanRules\TypeAnalyzer\ObjectTypeAnalyzer
-    - class: Symplify\PHPStanRules\TypeAnalyzer\TypeUnwrapper
     -
         class: Symplify\PHPStanRules\Rules\ForbiddenFuncCallRule
         tags: [phpstan.rules.rule]
@@ -38,4 +23,4 @@ services:
                 - die
                 - dump
                 - compact
-                - var_dump
+                - var_dump
diff --git a/.code-quality/rector.php b/.code-quality/rector.php
@@ -2,105 +2,42 @@
 
 declare(strict_types=1);
 
-use Rector\Arguments\Rector\ClassMethod\ArgumentAdderRector;
-use Rector\CodeQuality\Rector\Equal\UseIdenticalOverEqualWithSameTypeRector;
 use Rector\CodeQuality\Rector\Identical\FlipTypeControlToUseExclusiveTypeRector;
-use Rector\CodeQuality\Rector\Isset_\IssetOnPropertyObjectToPropertyExistsRector;
-use Rector\CodeQualityStrict\Rector\If_\MoveOutMethodCallInsideIfConditionRector;
-use Rector\CodingStyle\Rector\ClassMethod\ReturnArrayClassMethodToYieldRector;
-use Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector;
-use Rector\CodingStyle\Rector\Encapsed\WrapEncapsedVariableInCurlyBracesRector;
-use Rector\CodingStyle\Rector\FuncCall\ConsistentPregDelimiterRector;
-use Rector\CodingStyle\Rector\PostInc\PostIncDecToPreIncDecRector;
-use Rector\CodingStyle\Rector\Property\AddFalseDefaultToBoolPropertyRector;
-use Rector\Core\Configuration\Option;
-use Rector\DeadCode\Rector\Cast\RecastingRemovalRector;
-use Rector\DeadCode\Rector\ClassMethod\RemoveDelegatingParentCallRector;
+use Rector\Config\RectorConfig;
 use Rector\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector;
-use Rector\Defluent\Rector\Return_\ReturnFluentChainMethodCallToNormalMethodCallRector;
 use Rector\EarlyReturn\Rector\If_\ChangeAndIfToEarlyReturnRector;
-use Rector\EarlyReturn\Rector\If_\ChangeOrIfReturnToEarlyReturnRector;
-use Rector\EarlyReturn\Rector\Return_\ReturnBinaryAndToEarlyReturnRector;
-use Rector\Naming\Rector\ClassMethod\RenameVariableToMatchNewTypeRector;
-use Rector\Naming\Rector\Foreach_\RenameForeachValueVariableToMatchMethodCallReturnTypeRector;
-use Rector\Naming\Rector\Property\MakeBoolPropertyRespectIsHasWasMethodNamingRector;
-use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
-use Rector\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector;
+use Rector\Set\ValueObject\SetList;
 use Rector\PHPUnit\Set\PHPUnitSetList;
-use Rector\Privatization\Rector\Class_\ChangeReadOnlyVariableWithDefaultValueToConstantRector;
 use Rector\Privatization\Rector\Class_\FinalizeClassesWithoutChildrenRector;
-use Rector\Privatization\Rector\Class_\RepeatedLiteralToClassConstantRector;
-use Rector\Privatization\Rector\Property\PrivatizeLocalPropertyToPrivatePropertyRector;
-use Rector\Set\ValueObject\SetList;
-use Rector\TypeDeclaration\Rector\ClassMethod\AddArrayParamDocTypeRector;
-use Rector\TypeDeclaration\Rector\ClassMethod\AddArrayReturnDocTypeRector;
-use Rector\TypeDeclaration\Rector\FunctionLike\ParamTypeDeclarationRector;
-use Rector\TypeDeclaration\Rector\FunctionLike\ReturnTypeDeclarationRector;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
-
-return static function (ContainerConfigurator $containerConfigurator): void {
-
-    $containerConfigurator->import(SetList::CODE_QUALITY);
-    $containerConfigurator->import(SetList::CODE_QUALITY_STRICT);
-    $containerConfigurator->import(SetList::CODING_STYLE);
-    $containerConfigurator->import(SetList::DEAD_CODE);
-    $containerConfigurator->import(SetList::EARLY_RETURN);
-    $containerConfigurator->import(SetList::PRIVATIZATION);
-    $containerConfigurator->import(SetList::TYPE_DECLARATION);
-    $containerConfigurator->import(SetList::PSR_4);
-    $containerConfigurator->import(SetList::MYSQL_TO_MYSQLI);
-    $containerConfigurator->import(SetList::TYPE_DECLARATION_STRICT);
-    $containerConfigurator->import(SetList::UNWRAP_COMPAT);
-
-    $containerConfigurator->import(SetList::PHP_72);
-    $containerConfigurator->import(SetList::PHP_73);
-    $containerConfigurator->import(SetList::PHP_74);
-    $containerConfigurator->import(SetList::PHP_80);
-
-    $containerConfigurator->import(PHPUnitSetList::PHPUNIT_CODE_QUALITY);
-
-    $parameters = $containerConfigurator->parameters();
-    $parameters->set(
-        Option::PATHS,
-        [
-            __DIR__ . '/../Classes',
-            __DIR__ . '/rector.php',
-        ]
-    );
-
-    $parameters->set(Option::AUTO_IMPORT_NAMES, false);
-    $parameters->set(Option::AUTOLOAD_PATHS, [__DIR__ . '/../Classes']);
-    $parameters->set(
-        Option::SKIP,
-        [
-            RecastingRemovalRector::class,
-            ConsistentPregDelimiterRector::class,
-            PostIncDecToPreIncDecRector::class,
-            FinalizeClassesWithoutChildrenRector::class,
-            ChangeOrIfReturnToEarlyReturnRector::class,
-            ChangeAndIfToEarlyReturnRector::class,
-            ReturnBinaryAndToEarlyReturnRector::class,
-            MakeBoolPropertyRespectIsHasWasMethodNamingRector::class,
-            MoveOutMethodCallInsideIfConditionRector::class,
-            ReturnArrayClassMethodToYieldRector::class,
-            AddArrayParamDocTypeRector::class,
-            AddArrayReturnDocTypeRector::class,
-            ReturnFluentChainMethodCallToNormalMethodCallRector::class,
-            IssetOnPropertyObjectToPropertyExistsRector::class,
-            FlipTypeControlToUseExclusiveTypeRector::class,
-            RepeatedLiteralToClassConstantRector::class,
-            RenameVariableToMatchNewTypeRector::class,
-            AddLiteralSeparatorToNumberRector::class,
-            RenameForeachValueVariableToMatchMethodCallReturnTypeRector::class,
-            ChangeReadOnlyVariableWithDefaultValueToConstantRector::class,
-            PrivatizeLocalPropertyToPrivatePropertyRector::class,
-            RemoveDelegatingParentCallRector::class,
-            RemoveExtraParametersRector::class => [
-                __DIR__ . '/../Classes/Domain/Repository/MappingRepository.php'
-            ]
-        ]
-    );
-
-    $services = $containerConfigurator->services();
-    $services->set(RemoveUnusedPrivatePropertyRector::class);
-};
+use Rector\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector;
+use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictSetUpRector;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/../Classes',
+        __DIR__ . '/../Tests',
+        __DIR__ . '/rector.php',
+    ])
+    ->withPhpSets(
+        true
+    )
+    ->withSets([
+        SetList::CODE_QUALITY,
+        SetList::STRICT_BOOLEANS,
+        SetList::CODING_STYLE,
+        SetList::DEAD_CODE,
+        SetList::EARLY_RETURN,
+        SetList::PRIVATIZATION,
+        SetList::TYPE_DECLARATION,
+        SetList::INSTANCEOF,
+        PHPUnitSetList::PHPUNIT_CODE_QUALITY
+    ])
+    ->withSkip([
+        FinalizeClassesWithoutChildrenRector::class,
+        ChangeAndIfToEarlyReturnRector::class,
+        TypedPropertyFromStrictSetUpRector::class,
+        AddMethodCallBasedStrictParamTypeRector::class,
+        FlipTypeControlToUseExclusiveTypeRector::class,
+    ])
+    ->withAutoloadPaths([__DIR__ . '/../Classes'])
+    ->registerService(RemoveUnusedPrivatePropertyRector::class);
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -11,17 +11,18 @@ jobs:
       fail-fast: false
       matrix:
         typo3: [ ^11.5 ]
-        php: [ '7.4', '8.0', '8.1' ]
-        mysql: [ '5.7' ]
+        php: [ '7.4', '8.0', '8.1', '8.2', '8.3' ]
     steps:
-      - name: Set up MySQL ${{ matrix.mysql }}
-        uses: mirromutth/[email protected]
-        with:
-          mysql version: ${{ matrix.mysql }}
-          mysql root password: 'root'
 
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 10
+      - uses: shogo82148/actions-setup-mysql@v1
+        with:
+          distribution: "mariadb"
+          mysql-version: "10.5"
+          root-password: root
 
       - name: Set up PHP Version ${{ matrix.php }}
         uses: shivammathur/setup-php@v2
@@ -47,22 +48,22 @@ jobs:
         run: find . -name \*.php ! -path "./.Build/*" ! -path "./scripts/*" ! -path "./typo3_src/*" | parallel --gnu php -d display_errors=stderr -l {} > /dev/null \;
 
       - name: Unit Tests without coverage
-        if: matrix.typo3 != '^11.5' || matrix.php != '7.4'
+        if: matrix.typo3 != '^11.5' || matrix.php != '8.3'
         run: |
-          export "UNIT_XML"=.Build/vendor/nimut/testing-framework/res/Configuration/UnitTests.xml
+          export "UNIT_XML"=.Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml
           .Build/bin/phpunit --colors -c $UNIT_XML Tests/Unit
 
       - name: Unit Tests with coverage
-        if: matrix.typo3 == '^11.5' && matrix.php == '7.4'
+        if: matrix.typo3 == '^11.5' && matrix.php == '8.3'
         run: |
-          export "UNIT_XML"=.Build/vendor/nimut/testing-framework/res/Configuration/UnitTests.xml
-          .Build/bin/phpunit --whitelist Classes --coverage-clover=unittest-coverage.clover --colors -c $UNIT_XML Tests/Unit/
+          export "UNIT_XML"=.Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests-v10.xml 
+          .Build/bin/phpunit --coverage-filter Classes --coverage-clover=unittest-coverage.clover --colors -c $UNIT_XML Tests/Unit/
 
       - name: Functional Tests without coverage
         run: |
-          export "FUNCTIONAL_XML"=.Build/vendor/nimut/testing-framework/res/Configuration/FunctionalTests.xml
+          export "FUNCTIONAL_XML"=.Build/vendor/typo3/testing-framework/Resources/Core/Build/FunctionalTests.xml
           .Build/bin/phpunit --colors -c $FUNCTIONAL_XML Tests/Functional
-        if: matrix.typo3 != '^11.5' || matrix.php != '7.4'
+        if: matrix.typo3 != '^11.5' || matrix.php != '8.3'
         env:
           typo3DatabaseHost: 127.0.0.1
           typo3DatabaseName: typo3
@@ -71,18 +72,17 @@ jobs:
 
       - name: Functional Tests with coverage
         run: |
-          export "FUNCTIONAL_XML"=.Build/vendor/nimut/testing-framework/res/Configuration/FunctionalTests.xml
-          find 'Tests/Functional' -wholename '*Test.php' | parallel --gnu 'echo; echo "Running functional test suite {}"; .Build/bin/phpunit --whitelist Classes --coverage-clover={}functionaltest-coverage.clover --colors -c $FUNCTIONAL_XML {}'
-        if: matrix.typo3 == '^11.5' && matrix.php == '7.4'
+          export "FUNCTIONAL_XML"=.Build/vendor/typo3/testing-framework/Resources/Core/Build/FunctionalTests-v10.xml
+          find 'Tests/Functional' -wholename '*Test.php' | parallel --gnu 'echo; echo "Running functional test suite {}"; .Build/bin/phpunit --coverage-filter Classes --coverage-clover={}functionaltest-coverage.clover --colors -c $FUNCTIONAL_XML {}'
+        if: matrix.typo3 == '^11.5' && matrix.php == '8.3'
         env:
           typo3DatabaseHost: 127.0.0.1
           typo3DatabaseName: typo3
           typo3DatabasePassword: root
           typo3DatabaseUsername: root
 
-      - name: Upload coverage results to Scrutinizer
-        if: matrix.typo3 == '^11.5' && matrix.php == '7.4'
-        run: |
-          wget https://scrutinizer-ci.com/ocular.phar
-          php ocular.phar code-coverage:upload --format=php-clover unittest-coverage.clover
-          find 'Tests/Functional' -wholename '*Test.php' -exec php ocular.phar code-coverage:upload --format=php-clover {}functionaltest-coverage.clover \;
+      - name: Upload functional coverage results to Scrutinizer
+        uses: sudo-bot/action-scrutinizer@latest
+        if: matrix.typo3 == '^11.5' && matrix.php == '8.3'
+        with:
+          cli-args: "--format=php-clover functional-coverage.clover --revision=${{ github.event.pull_request.head.sha || github.sha }}"
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@
 .Build
 
 # PHP Dependencies + Dev
+Tests/.phpunit.result.cache
 /composer.lock
 /index.php
 /typo3