Merge branch 'PHPCSStandards:master' into DocXMLSquizClassesClassDeclaration

Author: braindawg

.github/CONTRIBUTING.md

@@ -376,6 +376,14 @@ To run the tests specific to the use of `PHP_CODESNIFFER_CBF === true`:
     vendor/bin/phpunit --group CBF --exclude-group nothing
     ```
 
+#### Other notes about writing tests
+
+* The `Config` class uses a number of static properties and can have a performance impact on the tests too.
+    To get round both these issues, use the `ConfigDouble` class instead.
+    Generally speaking, only tests which test the behaviour of the `Config` class itself where it relates to the static properties, should use the real `Config` class for testing.
+    In such cases, the `PHP_CodeSniffer\Tests\Core\Config\AbstractRealConfigTestCase` should be used as the base test class.
+* Tests for the `Runner` class often can't create their own `Config` object in the tests, so run into the same issue.
+    Those tests should use the `PHP_CodeSniffer\Tests\Core\Runner\AbstractRunnerTestCase` base class, which will ensure the Config is clean.
 
 ### Submitting Your Pull Request
 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -51,13 +51,13 @@ A clear and concise description of what you expected to happen.
 
 ## Versions (please complete the following information)
 
-|                                       |                                                                                                           |
-|--------------------------|----------------------------------------------------------------------  |
-| Operating System           | [e.g., Windows 10, MacOS 10.15]                                                       |
-| PHP version                    | [e.g., 7.2, 8.1]                                                                                     |
-| PHP_CodeSniffer version | [e.g., 3.7.2, master]                                                                            |
-| Standard                         | [e.g., PSR2, PSR12, Squiz, custom]                                                      |
-| Install type                      | [e.g. Composer (global/local), PHAR, git clone, other (please expand)] |
+|                                          |                                                                                                                |
+|-----------------------------|---------------------------------------------------------------------------- |
+| Operating System            | (e.g., Windows 10, MacOS 10.15)                                                           |
+| PHP version                      | (e.g., 7.2, 8.1)                                                                                          |
+| PHP_CodeSniffer version | (e.g., 3.7.2, master)                                                                                  |
+| Standard                          | (e.g., PSR2, PSR12, Squiz, custom)                                                          |
+| Install type                       | (e.g. Composer (global/local), PHAR, git clone, other (please expand)) |
 
 ## Additional context
 

.github/labeler.yml

@@ -5,11 +5,11 @@ labels:
     draft: false
     author-can-merge: false
 
-  - label: "Core Component: Config & Ruleset & CLI options"
+  - label: "Core Component: Config & CLI options"
     draft: false
     files:
       - "src/Config.php$"
-  - label: "Core Component: Config & Ruleset & CLI options"
+  - label: "Core Component: Ruleset"
     draft: false
     files:
       - "src/Ruleset.php$"

.github/workflows/build-phar.yml

@@ -6,6 +6,7 @@ on:
   push:
     branches:
       - master
+      - 4.0
     paths:
       - '.github/workflows/build-phar.yml'
       - '.github/workflows/reusable-build-phar.yml'

.github/workflows/label-remove-outdated.yml

@@ -8,6 +8,7 @@ on:
   pull_request_target:
     types:
       - closed
+      - review_requested
 
 jobs:
   on-issue-close:
@@ -27,6 +28,19 @@ jobs:
             Status: needs investigation
             Status: triage
 
+  on-pr-review-request:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'PHPCSStandards' && github.event.action == 'review_requested'
+
+    name: "Clean up labels on PR (re-)review request"
+
+    steps:
+      - uses: mondeja/remove-labels-gh-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          labels: |
+            Status: awaiting feedback
+
   on-pr-merge:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'PHPCSStandards' && github.event.pull_request.merged == true
@@ -48,7 +62,8 @@ jobs:
 
   on-pr-close:
     runs-on: ubuntu-latest
-    if: github.repository_owner == 'PHPCSStandards' && github.event_name == 'pull_request_target' && github.event.pull_request.merged == false
+    # yamllint disable-line rule:line-length
+    if: github.repository_owner == 'PHPCSStandards' && github.event_name == 'pull_request_target' && github.event.action == 'closed' && github.event.pull_request.merged == false
 
     name: Clean up labels on PR close
 

.github/workflows/quicktest.yml

@@ -1,10 +1,11 @@
 name: Quicktest
 
 on:
-  # Run on pushes to all branches except for `master`.
+  # Run on pushes to all branches except for `master`/`4.0`.
   push:
     branches-ignore:
       - master
+      - 4.0
     paths-ignore:
       - '**.md'
   # Allow manually triggering the workflow.

.github/workflows/test.yml

@@ -1,11 +1,12 @@
 name: Test
 
 on:
-  # Run on pushes to `master` and on all pull requests.
+  # Run on pushes to `master`/`4.0` and on all pull requests.
   # Prevent the build from running when there are only irrelevant changes.
   push:
     branches:
       - master
+      - 4.0
     tags:
       - '**'
     paths-ignore:
@@ -44,7 +45,7 @@ jobs:
       group: ${{ github.workflow }}-${{ github.job }}-${{ strategy.job-index }}-${{ github.ref }}
       cancel-in-progress: true
 
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     needs: build
 
     strategy:
@@ -60,6 +61,11 @@ jobs:
           # Installing on Windows with PHP 5.4 runs into all sorts of problems (which are not ours).
           - php: '5.4'
             os: 'windows-latest'
+          # By default, the memory limit should be disabled with setup_php, but we're still running
+          # into memory limit issues when the full test suite is run on PHP 5.6 in Windows.
+          # As support for PHP < 7.2 will be dropped in PHPCS 4.0 anyhow, let's just skip the build.
+          - php: '5.6'
+            os: 'windows-latest'
 
         include:
           # Skip test runs on builds which are also run in the coverage job.
@@ -73,16 +79,33 @@ jobs:
           - php: '8.4'
             skip_tests: true
 
+          # The default libxml library on Ubuntu images is a little out of date.
+          # To safeguard support for the latest libxml we need to update the library on the fly.
+          # This only needs to be tested with one PHP version for each libxml minor to verify support.
+          # Testing against multiple PHP versions would not yield a difference in results.
+          - php: '8.0'
+            os: 'ubuntu-latest'
+            libxml_minor: '2.11'
+          - php: '8.3'
+            os: 'ubuntu-latest'
+            libxml_minor: '2.13'
+
           # Extra builds running only the unit tests with different PHP ini settings.
           - php: '5.5'
             os: 'ubuntu-latest'
             custom_ini: true
           - php: '7.0'
             os: 'ubuntu-latest'
             custom_ini: true
+          - php: '8.0'
+            os: 'ubuntu-latest'
+            custom_ini: true
+          - php: '8.2'
+            os: 'ubuntu-latest'
+            custom_ini: true
 
     # yamllint disable-line rule:line-length
-    name: "PHP: ${{ matrix.php }} ${{ matrix.custom_ini && ' with custom ini settings' || '' }} (${{ matrix.os == 'ubuntu-latest' && 'Linux' || 'Win'  }})"
+    name: "PHP: ${{ matrix.php }} ${{ matrix.custom_ini && ' with custom ini settings' || '' }}${{ matrix.libxml_minor && format( ' with libxml {0}', matrix.libxml_minor ) || '' }} (${{ matrix.os == 'ubuntu-latest' && 'Linux' || 'Win'  }})"
 
     continue-on-error: ${{ matrix.php == '8.5' }}
 
@@ -93,6 +116,70 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: "libxml2: find the latest relevant tag"
+        if: ${{ matrix.libxml_minor }}
+        id: libxml_version
+        uses: oprypin/find-latest-tag@v1
+        with:
+          repository: GNOME/libxml2
+          releases-only: false  # The libxml2 repository doesn't use GitHub's "release" feature.
+          prefix: 'v${{ matrix.libxml_minor }}.' # Limit the result to the minor we're interested in.
+          sort-tags: true # Find the "greatest" version for that minor based on semver.
+
+      # To put it simply: we need to remove the 'v' prefix from the version number.
+      - name: "libxml2: parse the version to a patch version"
+        if: ${{ matrix.libxml_minor }}
+        id: libxml_patch_version
+        shell: bash
+        env:
+          TAG: ${{ steps.libxml_version.outputs.tag }}
+        run: echo "PATCH=$( echo "$TAG" | cut -b 2- )" >> "$GITHUB_OUTPUT"
+
+      - name: "libxml2: restore cache"
+        if: ${{ matrix.libxml_minor }}
+        id: libxml_cache_restore
+        uses: actions/cache/restore@v4
+        with:
+          path: "libxml2-${{ steps.libxml_patch_version.outputs.PATCH }}"
+          key: "${{ matrix.os }}-libxml-${{ matrix.libxml_minor }}-${{ steps.libxml_patch_version.outputs.PATCH }}"
+
+      # Updating the lists can fail intermittently, typically after Microsoft has released a new package.
+      # This should not be blocking for this job, so ignore any errors from this step.
+      # Ref: https://github.com/dotnet/core/issues/4167
+      - name: "libxml2: Update the available packages list"
+        if: ${{ matrix.libxml_minor && steps.libxml_cache_restore.outputs.cache-hit != 'true' }}
+        continue-on-error: true
+        run: sudo apt-get update
+
+      - name: "libxml2: Download and build package (linux only)"
+        if: ${{ matrix.libxml_minor && steps.libxml_cache_restore.outputs.cache-hit != 'true' }}
+        env:
+          PATCH: ${{ steps.libxml_patch_version.outputs.PATCH }}
+        run: |
+          sudo apt-get install -y wget build-essential
+          wget "https://download.gnome.org/sources/libxml2/${{ matrix.libxml_minor }}/libxml2-$PATCH.tar.xz"
+          tar -xf "libxml2-$PATCH.tar.xz"
+          cd "libxml2-$PATCH"
+          ./configure --prefix=/usr/local
+          make
+
+      - name: "libxml2: save cache"
+        if: ${{ matrix.libxml_minor && steps.libxml_cache_restore.outputs.cache-hit != 'true' }}
+        id: libxml_cache_save
+        uses: actions/cache/save@v4
+        with:
+          path: "libxml2-${{ steps.libxml_patch_version.outputs.PATCH }}"
+          key: ${{ steps.libxml_cache_restore.outputs.cache-primary-key }}
+
+      - name: "libxml2: Install package (linux only)"
+        if: ${{ matrix.libxml_minor }}
+        env:
+          PATCH: ${{ steps.libxml_patch_version.outputs.PATCH }}
+        run: |
+          cd "libxml2-$PATCH"
+          sudo make install
+          sudo ldconfig
+
       - name: Setup ini config
         id: set_ini
         shell: bash
@@ -101,7 +188,7 @@ jobs:
           # Also turn on error_reporting to ensure all notices are shown.
           if [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" == '5.5' ]]; then
             echo 'PHP_INI=error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On, asp_tags=On' >> "$GITHUB_OUTPUT"
-          elif [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" == '7.0' ]]; then
+          elif [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" != '5.5' ]]; then
             echo 'PHP_INI=error_reporting=-1, display_errors=On, date.timezone=Australia/Sydney, short_open_tag=On' >> "$GITHUB_OUTPUT"
           else
             echo 'PHP_INI=error_reporting=-1, display_errors=On' >> "$GITHUB_OUTPUT"
@@ -113,7 +200,9 @@ jobs:
           php-version: ${{ matrix.php }}
           ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
           coverage: none
-          tools: cs2pr
+
+      - name: "DEBUG: show libxml loaded version (php)"
+        run: php -r 'echo "libxml loaded version = ", LIBXML_LOADED_VERSION, PHP_EOL;'
 
       # This action also handles the caching of the dependencies.
       - name: Set up node
@@ -135,37 +224,35 @@ jobs:
       - name: Install Composer dependencies
         uses: "ramsey/composer-install@v3"
         with:
-          composer-options: ${{ matrix.php == '8.5' && '--ignore-platform-req=php' || '' }}
+          composer-options: ${{ matrix.php == '8.5' && '--ignore-platform-req=php+' || '' }}
           custom-cache-suffix: $(date -u "+%Y-%m")
 
-      # Note: The code style check is run multiple times against every PHP version
-      # as it also acts as an integration test.
       - name: 'PHPCS: set the path to PHP'
         run: php "bin/phpcs" --config-set php_path php
 
       - name: 'PHPUnit: run the full test suite without code coverage'
         if: ${{ matrix.skip_tests != true }}
         run: php "vendor/bin/phpunit" tests/AllTests.php --no-coverage
 
+      # Do one test run against the complete test suite in CBF mode to ensure all tests can run in CBF mode.
+      - name: 'PHPUnit: run the full test suite without code coverage in CBF mode (PHP 8.3 only)'
+        if: ${{ matrix.php == '8.3' }}
+        run: php "vendor/bin/phpunit" tests/AllTests.php --exclude-group nothing --no-coverage
+        env:
+          PHP_CODESNIFFER_CBF: '1'
+
       - name: 'PHPUnit: run select tests in CBF mode'
-        if: ${{ matrix.skip_tests != true }}
+        if: ${{ matrix.skip_tests != true && matrix.php != '8.3' }}
         run: php "vendor/bin/phpunit" tests/AllTests.php --group CBF --exclude-group nothing --no-coverage
         env:
           PHP_CODESNIFFER_CBF: '1'
 
+      # Note: The code style check is run multiple times against every PHP version
+      # as it also acts as an integration test.
       - name: 'PHPCS: check code style without cache, no parallel'
-        if: ${{ matrix.custom_ini == false && matrix.php != '7.4' }}
+        if: ${{ matrix.custom_ini == false }}
         run: php "bin/phpcs" --no-cache --parallel=1
 
-      - name: 'PHPCS: check code style to show results in PR'
-        if: ${{ matrix.custom_ini == false && matrix.php == '7.4' }}
-        id: phpcs
-        run: php "bin/phpcs" --no-cache --parallel=1 --report-full --report-checkstyle=./phpcs-report.xml
-
-      - name: Show PHPCS results in PR
-        if: ${{ always() && steps.phpcs.outcome == 'failure' && matrix.php == '7.4' }}
-        run: cs2pr ./phpcs-report.xml
-
       - name: Download the PHPCS phar
         if: ${{ matrix.custom_ini == false }}
         uses: actions/download-artifact@v4
@@ -216,14 +303,12 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup ini config
-        if: ${{ matrix.os != 'windows-latest' }}
+        if: ${{ matrix.custom_ini == true && matrix.os != 'windows-latest' }}
         id: set_ini
         shell: bash
         run: |
           # Set the "short_open_tag" ini to make sure specific conditions are tested.
-          if [[ ${{ matrix.custom_ini }} == true && "${{ matrix.php }}" == '7.2' ]]; then
-            echo 'PHP_INI=, date.timezone=Australia/Sydney, short_open_tag=On' >> "$GITHUB_OUTPUT"
-          fi
+          echo 'PHP_INI=, date.timezone=Australia/Sydney, short_open_tag=On' >> "$GITHUB_OUTPUT"
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
@@ -275,37 +360,26 @@ jobs:
         if: ${{ steps.phpunit_version.outputs.VERSION >= '9.3' }}
         run: php "vendor/bin/phpunit" --coverage-cache ./build/phpunit-cache --warm-coverage-cache
 
-      - name: "Run the unit tests with code coverage (PHPUnit < 9.3)"
-        if: ${{ matrix.os != 'windows-latest' && steps.phpunit_version.outputs.VERSION < '9.3' }}
-        run: php "vendor/bin/phpunit" tests/AllTests.php
-
-      - name: "Run the unit tests with code coverage (PHPUnit 9.3+)"
-        if: ${{ matrix.os != 'windows-latest' && steps.phpunit_version.outputs.VERSION >= '9.3' }}
-        run: php "vendor/bin/phpunit" tests/AllTests.php --coverage-cache ./build/phpunit-cache
-
-      - name: "Run select tests in CBF mode with code coverage (PHPUnit < 9.3)"
-        if: ${{ matrix.os != 'windows-latest' && steps.phpunit_version.outputs.VERSION < '9.3' }}
+      - name: "Run the unit tests with code coverage"
+        if: ${{ matrix.os != 'windows-latest' }}
         run: >
           php "vendor/bin/phpunit" tests/AllTests.php
-          --group CBF --exclude-group nothing --coverage-clover build/logs/clover-cbf.xml
-        env:
-          PHP_CODESNIFFER_CBF: '1'
+          ${{ steps.phpunit_version.outputs.VERSION >= '9.3' && '--coverage-cache ./build/phpunit-cache' || '' }}
 
-      - name: "Run select tests in CBF mode with code coverage (PHPUnit 9.3+)"
-        if: ${{ matrix.os != 'windows-latest' && steps.phpunit_version.outputs.VERSION >= '9.3' }}
+      - name: "Run select tests in CBF mode with code coverage"
+        if: ${{ matrix.os != 'windows-latest' }}
         run: >
-          php "vendor/bin/phpunit" tests/AllTests.php --coverage-cache ./build/phpunit-cache
+          php "vendor/bin/phpunit" tests/AllTests.php
+          ${{ steps.phpunit_version.outputs.VERSION >= '9.3' && '--coverage-cache ./build/phpunit-cache' || '' }}
           --group CBF --exclude-group nothing --coverage-clover build/logs/clover-cbf.xml
         env:
           PHP_CODESNIFFER_CBF: '1'
 
-      - name: "Run the unit tests which may have different outcomes on Windows with code coverage (PHPUnit < 9.3)"
-        if: ${{ matrix.os == 'windows-latest' && steps.phpunit_version.outputs.VERSION < '9.3' }}
-        run: php "vendor/bin/phpunit" tests/AllTests.php --group Windows
-
-      - name: "Run the unit tests which may have different outcomes on Windows with code coverage (PHPUnit 9.3+)"
-        if: ${{ matrix.os == 'windows-latest' && steps.phpunit_version.outputs.VERSION >= '9.3' }}
-        run: php "vendor/bin/phpunit" tests/AllTests.php --group Windows --coverage-cache ./build/phpunit-cache
+      - name: "Run the unit tests which may have different outcomes on Windows with code coverage"
+        if: ${{ matrix.os == 'windows-latest' }}
+        run: >
+          php "vendor/bin/phpunit" tests/AllTests.php --group Windows
+          ${{ steps.phpunit_version.outputs.VERSION >= '9.3' && '--coverage-cache ./build/phpunit-cache' || '' }}
 
       - name: "Upload coverage results to Coveralls (normal run)"
         if: ${{ success() }}