PHPUnit Tests #27980
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: PHPUnit Tests | |
| on: | |
| push: | |
| branches: | |
| - trunk | |
| - '3.[7-9]' | |
| - '[4-9].[0-9]' | |
| tags: | |
| - '[0-9]+.[0-9]' | |
| - '[0-9]+.[0-9].[0-9]+' | |
| pull_request: | |
| branches: | |
| - trunk | |
| - '3.[7-9]' | |
| - '[4-9].[0-9]' | |
| workflow_dispatch: | |
| # Once weekly On Sundays at 00:00 UTC. | |
| schedule: | |
| - cron: '0 0 * * 0' | |
| # Cancels all previous workflow runs for pull requests that have not completed. | |
| concurrency: | |
| # The concurrency group contains the workflow name and the branch name for pull requests | |
| # or the commit hash for any other events. | |
| group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }} | |
| cancel-in-progress: true | |
| env: | |
| PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: ${{ true }} | |
| # Controls which npm script to use for running PHPUnit tests. Options ar `php` and `php-composer`. | |
| PHPUNIT_SCRIPT: php | |
| LOCAL_PHP_MEMCACHED: ${{ false }} | |
| SLOW_TESTS: 'external-http,media,restapi' | |
| jobs: | |
| # Runs the PHPUnit tests for WordPress. | |
| # | |
| # Performs the following steps: | |
| # - Sets environment variables. | |
| # - Sets up the environment variables needed for testing with memcached (if desired). | |
| # - Installs Node.js. | |
| # - Installs npm dependencies | |
| # - Configures caching for Composer. | |
| # - Installs Composer dependencies. | |
| # - Logs Docker debug information (about the Docker installation within the runner). | |
| # - Starts the WordPress Docker container. | |
| # - Starts the Memcached server after the Docker network has been created (if desired). | |
| # - Logs general debug information about the runner. | |
| # - Logs the running Docker containers. | |
| # - Logs debug information from inside the WordPress Docker container. | |
| # - Logs debug information about what's installed within the WordPress Docker containers. | |
| # - Install WordPress within the Docker container. | |
| # - Run the PHPUnit tests. | |
| # - Ensures version-controlled files are not modified or deleted. | |
| # - Checks out the WordPress Test reporter repository. | |
| # - Reconnect the directory to the Git repository. | |
| # - Submit the test results to the WordPress.org host test results. | |
| test-php: | |
| name: ${{ matrix.php }}${{ matrix.multisite && ' multisite' || '' }}${{ matrix.split_slow && ' slow tests' || '' }}${{ matrix.memcached && ' with memcached' || '' }} on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| timeout-minutes: 20 | |
| if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| php: [ '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0' ] | |
| os: [ ubuntu-latest ] | |
| memcached: [ false ] | |
| split_slow: [ false ] | |
| multisite: [ false, true ] | |
| include: | |
| # Additional "slow" jobs for PHP 5.6. | |
| - php: '5.6' | |
| os: ubuntu-latest | |
| memcached: false | |
| multisite: false | |
| split_slow: true | |
| - php: '5.6' | |
| os: ubuntu-latest | |
| memcached: false | |
| multisite: true | |
| split_slow: true | |
| # Include jobs for PHP 7.4 with memcached. | |
| - php: '7.4' | |
| os: ubuntu-latest | |
| memcached: true | |
| multisite: false | |
| - php: '7.4' | |
| os: ubuntu-latest | |
| memcached: true | |
| multisite: true | |
| # Report the results of the PHP 7.4 without memcached job. | |
| - php: '7.4' | |
| os: ubuntu-latest | |
| memcached: false | |
| multisite: false | |
| report: true | |
| env: | |
| LOCAL_PHP: ${{ matrix.php }}-fpm | |
| LOCAL_PHP_MEMCACHED: ${{ matrix.memcached }} | |
| PHPUNIT_CONFIG: ${{ matrix.multisite && 'tests/phpunit/multisite.xml' || 'phpunit.xml.dist' }} | |
| steps: | |
| - name: Configure environment variables | |
| run: | | |
| echo "PHP_FPM_UID=$(id -u)" >> $GITHUB_ENV | |
| echo "PHP_FPM_GID=$(id -g)" >> $GITHUB_ENV | |
| - name: Checkout repository | |
| uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 | |
| - name: Install Node.js | |
| uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 | |
| with: | |
| node-version-file: '.nvmrc' | |
| cache: npm | |
| - name: Install npm dependencies | |
| run: npm ci | |
| - name: Get composer cache directory | |
| id: composer-cache | |
| run: echo "composer_dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT | |
| - name: Cache Composer dependencies | |
| uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7 # v3.0.11 | |
| env: | |
| cache-name: cache-composer-dependencies | |
| with: | |
| path: ${{ steps.composer-cache.outputs.composer_dir }} | |
| key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.lock') }} | |
| - name: Install Composer dependencies | |
| run: | | |
| docker-compose run --rm php composer --version | |
| # The PHPUnit 7.x phar is not compatible with PHP 8 and won't be updated, | |
| # as PHPUnit 7 is no longer supported. The Composer-installed PHPUnit should be | |
| # used for PHP 8 testing instead. | |
| if [ ${{ env.LOCAL_PHP }} == '8.0-fpm' ]; then | |
| docker-compose run --rm php composer install --ignore-platform-reqs | |
| echo "PHPUNIT_SCRIPT=php-composer" >> $GITHUB_ENV | |
| elif [ ${{ env.LOCAL_PHP }} == '7.1-fpm' ]; then | |
| docker-compose run --rm php composer update | |
| git checkout -- composer.lock | |
| elif [[ ${{ env.LOCAL_PHP }} == '5.6-fpm' || ${{ env.LOCAL_PHP }} == '7.0-fpm' ]]; then | |
| docker-compose run --rm php composer require --dev phpunit/phpunit:"^5.7" --update-with-dependencies | |
| git checkout -- composer.lock composer.json | |
| else | |
| docker-compose run --rm php composer install | |
| fi | |
| - name: Docker debug information | |
| run: | | |
| docker -v | |
| docker-compose -v | |
| - name: Start Docker environment | |
| run: | | |
| npm run env:start | |
| # The memcached server needs to start after the Docker network has been set up with `npm run env:start`. | |
| - name: Start the Memcached server. | |
| if: ${{ matrix.memcached }} | |
| run: | | |
| cp tests/phpunit/includes/object-cache.php src/wp-content/object-cache.php | |
| docker run --name memcached --net $(basename "$PWD")_wpdevnet -d memcached | |
| - name: General debug information | |
| run: | | |
| npm --version | |
| node --version | |
| curl --version | |
| git --version | |
| svn --version | |
| - name: Log running Docker containers | |
| run: docker ps -a | |
| - name: WordPress Docker container debug information | |
| run: | | |
| docker-compose run --rm mysql mysql --version | |
| docker-compose run --rm php php --version | |
| docker-compose run --rm php php -m | |
| docker-compose run --rm php php -i | |
| docker-compose run --rm php locale -a | |
| - name: Install WordPress | |
| run: npm run env:install | |
| - name: Run slow PHPUnit tests | |
| if: ${{ matrix.split_slow }} | |
| run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }} --group ${{ env.SLOW_TESTS }} | |
| - name: Run PHPUnit tests for single site excluding slow tests | |
| if: ${{ matrix.php < '7.0' && ! matrix.split_slow && ! matrix.multisite }} | |
| run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }} --exclude-group ${{ env.SLOW_TESTS }},ajax,ms-files,ms-required | |
| - name: Run PHPUnit tests for Multisite excluding slow tests | |
| if: ${{ matrix.php < '7.0' && ! matrix.split_slow && matrix.multisite }} | |
| run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }} --exclude-group ${{ env.SLOW_TESTS }},ajax,ms-files,ms-excluded,oembed-headers | |
| - name: Run PHPUnit tests | |
| if: ${{ matrix.php >= '7.0' }} | |
| run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }} | |
| - name: Run AJAX tests | |
| if: ${{ ! matrix.split_slow }} | |
| run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }} --group ajax | |
| - name: Run ms-files tests as a multisite install | |
| if: ${{ matrix.multisite && ! matrix.split_slow }} | |
| run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c tests/phpunit/multisite.xml --group ms-files | |
| - name: Run external HTTP tests | |
| if: ${{ ! matrix.multisite && ! matrix.split_slow }} | |
| run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c phpunit.xml.dist --group external-http | |
| # __fakegroup__ is excluded to force PHPUnit to ignore the <exclude> settings in phpunit.xml.dist. | |
| - name: Run (xDebug) tests | |
| if: ${{ ! matrix.split_slow }} | |
| run: LOCAL_PHP_XDEBUG=true npm run test:${{ env.PHPUNIT_SCRIPT }} -- -v --group xdebug --exclude-group __fakegroup__ | |
| - name: Ensure version-controlled files are not modified or deleted | |
| run: git diff --exit-code | |
| - name: Checkout the WordPress Test Reporter | |
| if: ${{ github.repository == 'WordPress/wordpress-develop' && github.ref == 'refs/heads/trunk' && matrix.report }} | |
| uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 | |
| with: | |
| repository: 'WordPress/phpunit-test-runner' | |
| path: 'test-runner' | |
| - name: Submit test results to the WordPress.org host test results | |
| if: ${{ github.repository == 'WordPress/wordpress-develop' && github.ref == 'refs/heads/trunk' && matrix.report }} | |
| env: | |
| WPT_REPORT_API_KEY: "${{ secrets.WPT_REPORT_API_KEY }}" | |
| run: docker-compose run --rm -e WPT_REPORT_API_KEY -e WPT_PREPARE_DIR=/var/www -e WPT_TEST_DIR=/var/www php php test-runner/report.php | |
| slack-notifications: | |
| name: Slack Notifications | |
| uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk | |
| needs: [ test-php ] | |
| if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name != 'pull_request' && always() }} | |
| with: | |
| calling_status: ${{ needs.test-php.result == 'success' && 'success' || needs.test-php.result == 'cancelled' && 'cancelled' || 'failure' }} | |
| secrets: | |
| SLACK_GHA_SUCCESS_WEBHOOK: ${{ secrets.SLACK_GHA_SUCCESS_WEBHOOK }} | |
| SLACK_GHA_CANCELLED_WEBHOOK: ${{ secrets.SLACK_GHA_CANCELLED_WEBHOOK }} | |
| SLACK_GHA_FIXED_WEBHOOK: ${{ secrets.SLACK_GHA_FIXED_WEBHOOK }} | |
| SLACK_GHA_FAILURE_WEBHOOK: ${{ secrets.SLACK_GHA_FAILURE_WEBHOOK }} | |
| failed-workflow: | |
| name: Failed workflow tasks | |
| runs-on: ubuntu-latest | |
| needs: [ test-php, slack-notifications ] | |
| if: | | |
| always() && | |
| github.repository == 'WordPress/wordpress-develop' && | |
| github.event_name != 'pull_request' && | |
| github.run_attempt < 2 && | |
| ( | |
| needs.test-php.result == 'cancelled' || needs.test-php.result == 'failure' | |
| ) | |
| steps: | |
| - name: Dispatch workflow run | |
| uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975 # v6.4.0 | |
| with: | |
| retries: 2 | |
| retry-exempt-status-codes: 418 | |
| script: | | |
| github.rest.actions.createWorkflowDispatch({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| workflow_id: 'failed-workflow.yml', | |
| ref: 'trunk', | |
| inputs: { | |
| run_id: '${{ github.run_id }}' | |
| } | |
| }); |