Prep work to migrate to PHPUnit 9.x

Author: sanmai

.appveyor.yml

@@ -6,6 +6,7 @@
         "PHPUnit\\Framework\\Constraint\\IsIdentical",
         "PHPUnit\\Framework\\TestCase",
         "PHPUnit\\Runner\\Version",
+        "PHPUnitGoodPractices\\Polyfill\\PolyfillTrait",
         "PHPUnitGoodPractices\\Traits\\ExpectationViaCodeOverAnnotationTrait",
         "PHPUnitGoodPractices\\Traits\\ExpectOverSetExceptionTrait",
         "PHPUnitGoodPractices\\Traits\\IdentityOverEqualityTrait",

.circleci/config.yml

@@ -0,0 +1,123 @@
+name: CI
+
+on:
+  - pull_request
+  - push
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        include:
+          - operating-system: 'ubuntu-20.04'
+            php-version: '5.6'
+            composer-flags: '--prefer-stable --prefer-lowest' # should be checked on lowest supported PHP version
+
+          - operating-system: 'ubuntu-20.04'
+            php-version: '7.0'
+            job-description: 'with Sf ^3'
+            execute-flex-with-symfony-version: '^3' # Explicit check for Sf 3.x compatibility
+
+          - operating-system: 'ubuntu-20.04'
+            php-version: '7.1'
+            job-description: 'with Sf ^4'
+            execute-flex-with-symfony-version: '^4' # Explicit check for Sf 4.x compatibility
+
+          - operating-system: 'ubuntu-20.04'
+            php-version: '7.2'
+            job-description: 'with Sf ^5'
+            execute-flex-with-symfony-version: '^5' # Explicit check for Sf 5.x compatibility
+
+          - operating-system: 'ubuntu-20.04'
+            php-version: '7.3'
+            job-description: 'with legacy Tokenizer' # should be checked on any job, one is enough
+            PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER: 1
+            SYMFONY_DEPRECATIONS_HELPER: 'disabled'
+
+          - operating-system: 'ubuntu-20.04'
+            php-version: '7.4'
+            job-description: 'with migration rules'
+            execute-migration-rules: 'yes' # should be checked on highest supported PHP version
+
+          - operating-system: 'ubuntu-20.04'
+            php-version: '8.0'
+            composer-flags: '--ignore-platform-req=php' # as this is a version not yet officially supported by PHP CS Fixer
+            PHP_CS_FIXER_IGNORE_ENV: 1
+
+          - operating-system: 'windows-latest'
+            php-version: '7.4'
+            job-description: 'on Windows'
+            FAST_LINT_TEST_CASES: 1
+
+          - operating-system: 'macos-latest'
+            php-version: '7.4'
+            job-description: 'on macOS'
+
+    name: PHP ${{ matrix.php-version }} ${{ matrix.job-description }}
+
+    runs-on: ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: none
+          tools: flex
+        env:
+          fail-fast: false # disabled as old PHP version cannot run flex
+
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: composer-${{ runner.os }}-${{ matrix.php-version }}-${{ hashFiles('**/composer.*') }}-${{ matrix.composer-flags }}
+          restore-keys: |
+            composer-${{ runner.os }}-${{ matrix.php-version }}-${{ hashFiles('**/composer.*') }}-
+            composer-${{ runner.os }}-${{ matrix.php-version }}-
+            composer-${{ runner.os }}-
+            composer-
+
+      - name: Configure Symfony Flex
+        run: |
+            composer config extra.symfony.require ${{ matrix.execute-flex-with-symfony-version }}
+        if: "matrix.execute-flex-with-symfony-version"
+
+      - name: Install dependencies
+        uses: nick-invision/retry@v2
+        with:
+          timeout_minutes: 5
+          max_attempts: 5
+          retry_wait_seconds: 30
+          command: |
+            composer update --optimize-autoloader --no-interaction --no-progress ${{ matrix.composer-flags }}
+            composer info -D | sort
+
+      - name: Execute migration rules
+        run: |
+          php php-cs-fixer fix --rules @PHP73Migration,@PHP71Migration:risky,blank_line_after_opening_tag -q
+        if: "matrix.execute-migration-rules == 'yes'"
+
+      - name: Run tests
+        continue-on-error: ${{ matrix.php-version == '8.0' }}
+        env:
+          PHP_CS_FIXER_IGNORE_ENV: ${{ matrix.PHP_CS_FIXER_IGNORE_ENV }}
+          FAST_LINT_TEST_CASES: ${{ matrix.FAST_LINT_TEST_CASES }}
+          PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER: ${{ matrix.PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER }}
+          SYMFONY_DEPRECATIONS_HELPER: ${{ matrix.SYMFONY_DEPRECATIONS_HELPER }}
+        run: |
+          vendor/bin/phpunit
+
+      - name: Run PHP CS Fixer
+        env:
+          PHP_CS_FIXER_IGNORE_ENV: ${{ matrix.PHP_CS_FIXER_IGNORE_ENV }}
+          PHP_CS_FIXER_FUTURE_MODE: 1
+        run: |
+          php php-cs-fixer --diff --dry-run -v fix

.composer-require-checker.json

@@ -1,5 +1,3 @@
-# yamllint disable rule:line-length
-
 name: Static Code Analysis
 
 on:
@@ -11,7 +9,7 @@ jobs:
     strategy:
       matrix:
         operating-system:
-          - ubuntu-latest
+          - ubuntu-20.04
         php-version:
           - 7.4
 

.github/workflows/ci.yml

@@ -1,21 +1,22 @@
-# yamllint disable rule:line-length
-
 name: YAML Validation
 
 on:
   pull_request:
+    paths:
+      - '**.y?ml'
   push:
+    paths:
+      - '**.y?ml'
 
 jobs:
   validate-yaml:
     name: Validate YAML
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Run YAMLlint
+      - name: Run yamllint
         run: |
-          find . -path \*/vendor -prune -false -o -name \*.y*ml | xargs yamllint -d relaxed
-
+          find . -path \*/vendor -prune -false -o -name \*.y*ml | xargs yamllint

.github/workflows/sca.yaml renamed to .github/workflows/sca.yml

@@ -23,7 +23,7 @@ $config = PhpCsFixer\Config::create()
     ->setRiskyAllowed(true)
     ->setRules([
         '@PHP56Migration' => true,
-        '@PHPUnit60Migration:risky' => true,
+        '@PHPUnit75Migration:risky' => true,
         '@PhpCsFixer' => true,
         '@PhpCsFixer:risky' => true,
         'header_comment' => ['header' => $header],

.github/workflows/yaml.yaml renamed to .github/workflows/yaml.yml

@@ -22,50 +22,7 @@ before_install:
 
 jobs:
     include:
-        - &STANDARD_TEST_JOB
-            stage: Fast Test
-            php: 7.0
-            install:
-                # Composer: enforce given Symfony components version
-                - if [ "$SYMFONY_VERSION" != "" ]; then composer global show symfony/flex -q || travis_retry composer global require $DEFAULT_COMPOSER_FLAGS symfony/flex; fi
-                - if [ "$SYMFONY_VERSION" != "" ]; then composer config extra.symfony.require $SYMFONY_VERSION || true; fi
-
-                - travis_retry composer update $DEFAULT_COMPOSER_FLAGS $COMPOSER_FLAGS
-                - composer info -D | sort
-            script:
-                - vendor/bin/phpunit || travis_terminate 1
-                - PHP_CS_FIXER_FUTURE_MODE=1 php php-cs-fixer --diff --dry-run -v fix
-
-        -
-            <<: *STANDARD_TEST_JOB
-            stage: Test
-            php: 5.6
-            env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
-
-        -
-            <<: *STANDARD_TEST_JOB
-            stage: Test
-            php: 7.1
-            name: 7.1 | Symfony ~4.1.0
-            env: SYMFONY_DEPRECATIONS_HELPER=disabled PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER=1 SYMFONY_VERSION="~4.1.0"
-
-        -
-            <<: *STANDARD_TEST_JOB
-            stage: Test
-            php: 7.2
-            name: 7.2 | Symfony ^5.0
-            env: SYMFONY_DEPRECATIONS_HELPER=disabled PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER=1 SYMFONY_VERSION="^5.0"
-
         -
-            <<: *STANDARD_TEST_JOB
-            stage: Test
-            php: 7.3
-            name: 7.3 | With migration rules
-            before_script:
-                - php php-cs-fixer fix --rules @PHP73Migration,@PHP71Migration:risky,blank_line_after_opening_tag -q || travis_terminate 1
-
-        -
-            <<: *STANDARD_TEST_JOB
             stage: Test
             php: 7.4
             name: 7.4 | Collect coverage
@@ -82,19 +39,16 @@ jobs:
 
                 # Install PCOV
                 - pecl install pcov
+            install:
+                - travis_retry composer update $DEFAULT_COMPOSER_FLAGS $COMPOSER_FLAGS
+                - composer info -D | sort
             before_script:
                 # Make code compatible with PHPUnit 8
                 - PHP_CS_FIXER_FUTURE_MODE=1 php php-cs-fixer fix --rules=void_return -q tests || return 0
             script:
                 - vendor/bin/phpunit --testsuite coverage --exclude-group covers-nothing --coverage-clover build/logs/clover.xml || travis_terminate 1
                 - php vendor/bin/php-coveralls -v
 
-        -
-            <<: *STANDARD_TEST_JOB
-            stage: Test
-            php: nightly
-            env: COMPOSER_FLAGS="--ignore-platform-reqs" PHP_CS_FIXER_IGNORE_ENV=1 SYMFONY_DEPRECATIONS_HELPER=weak
-
         -
             stage: Deployment
             php: 7.4
@@ -116,6 +70,3 @@ jobs:
                     tags: true
             after_deploy:
                 - ./dev-tools/trigger-website.sh ${TRAVIS_TOKEN} ${TRAVIS_TAG}
-
-    allow_failures:
-        - php: nightly

.php_cs.dist

@@ -0,0 +1,6 @@
+extends: relaxed
+
+rules:
+  line-length:
+    max: 180
+    level: warning

.travis.yml

@@ -41,6 +41,7 @@
         "php-cs-fixer/phpunit-constraint-isidenticalstring": "^1.2",
         "php-cs-fixer/phpunit-constraint-xmlmatchesxsd": "^1.2.1",
         "phpunit/phpunit": "^5.7.27 || ^6.5.14 || ^7.1",
+        "phpunitgoodpractices/polyfill": "^1.5",
         "phpunitgoodpractices/traits": "^1.9.1",
         "symfony/phpunit-bridge": "^5.1",
         "symfony/yaml": "^3.0 || ^4.0 || ^5.0"