reusable-performance-test-v2.yml

##
# A reusable workflow that runs the performance test suite.
#
# This workflow is used by `trunk` and branches >= 6.8.
##
name: Run performance Tests

on:
  workflow_call:
    inputs:
      subject:
        description: Subject of the test. One of `current`, `before`, or `base`.
        required: true
        type: string
      LOCAL_DIR:
        description: 'Where to run WordPress from.'
        required: false
        type: 'string'
        default: 'build'
      BASE_TAG:
        description: 'The version being used for baseline measurements.'
        required: false
        type: 'string'
        default: '7.0.0'
      TARGET_SHA:
        description: 'SHA hash of the target commit used for "before" measurements.'
        required: true
        type: 'string'
      php-version:
        description: 'The PHP version to use.'
        required: false
        type: 'string'
        default: 'latest'
      memcached:
        description: 'Whether to enable memcached.'
        required: false
        type: 'boolean'
        default: false
      multisite:
        description: 'Whether to use Multisite.'
        required: false
        type: 'boolean'
        default: false
    outputs:
      BASE_TAG:
        description: 'The version being used for baseline measurements.'
        value: ${{ inputs.BASE_TAG }}
    secrets:
      CODEVITALS_PROJECT_TOKEN:
        description: 'The authorization token for https://www.codevitals.run/project/wordpress.'
        required: false

env:
  PUPPETEER_SKIP_DOWNLOAD: true

  # Prevent wp-scripts from downloading extra Playwright browsers,
  # since Chromium will be installed in its dedicated step already.
  PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true

  # Performance testing should be performed in an environment reflecting a standard production environment.
  LOCAL_WP_DEBUG: false
  LOCAL_SCRIPT_DEBUG: false
  LOCAL_SAVEQUERIES: false
  LOCAL_WP_DEVELOPMENT_MODE: "''"

  BASE_TAG: ${{ inputs.BASE_TAG }}
  TARGET_SHA: ${{ inputs.TARGET_SHA }}

  LOCAL_DIR: ${{ inputs.LOCAL_DIR }}
  LOCAL_PHP_MEMCACHED: ${{ inputs.memcached }}
  LOCAL_PHP: ${{ inputs.php-version }}${{ 'latest' != inputs.php-version && '-fpm' || '' }}
  LOCAL_MULTISITE: ${{ inputs.multisite }}

# Disable permissions for all available scopes by default.
# Any needed permissions should be configured at the job level.
permissions: {}

jobs:
  # Performs the following steps:
  # - Configure environment variables.
  # - Checkout repository.
  # - Set up Node.js.
  # - Set up PHP.
  # - Log debug information.
  # - Install npm dependencies.
  # - Install Playwright browsers.
  # - Build WordPress.
  # - Start Docker environment.
  # - Put the baseline or target version of WordPress in place if necessary.
  # - Install object cache drop-in.
  # - Log running Docker containers.
  # - Docker debug information.
  # - Install WordPress.
  # - WordPress debug information.
  # - Enable themes on Multisite.
  # - Install WordPress Importer plugin.
  # - Import mock data.
  # - Deactivate WordPress Importer plugin.
  # - Update permalink structure.
  # - Install additional languages.
  # - Disable external HTTP requests.
  # - Disable cron.
  # - List defined constants.
  # - Install MU plugin.
  # - Run performance tests.
  # - Archive artifacts.
  # - Ensure version-controlled files are not modified or deleted.
  performance:
    name: Test ${{ inputs.subject == 'base' && inputs.BASE_TAG || inputs.subject }}
    runs-on: ubuntu-24.04
    permissions:
      contents: read

    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@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          show-progress: ${{ runner.debug == '1' && 'true' || 'false' }}
          fetch-depth: ${{ github.event_name == 'workflow_dispatch' && '2' || '1' }}
          persist-credentials: false

      - name: Set up Node.js
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version-file: '.nvmrc'
          package-manager-cache: false

      - name: Set up npm
        # Release branches run this workflow from trunk, but some older branches may lack the action.
        if: ${{ hashFiles('.github/actions/setup-npm/action.yml') != '' }}
        uses: ./.github/actions/setup-npm

      - name: Set up PHP
        if: ${{ inputs.subject == 'base' }}
        uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # 2.37.2
        with:
          php-version: ${{ inputs.php-version }}
          tools: wp-cli
          coverage: none

      - name: Log debug information
        run: |
          npm --version
          node --version
          curl --version
          git --version
          locale -a

      - name: Install npm dependencies
        run: npm ci

      - name: Install Playwright browsers
        run: npm exec --no -- playwright install --with-deps chromium

      - name: Start Docker environment
        run: npm run env:start

      - name: Build WordPress
        timeout-minutes: 5
        run: npm run build

      - name: Download previous build artifact (target branch or previous commit)
        if: ${{ inputs.subject == 'before' }}
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        id: get-previous-build
        with:
          script: |
            const artifacts = await github.rest.actions.listArtifactsForRepo({
              owner: context.repo.owner,
              repo: context.repo.repo,
              name: 'wordpress-build-' + process.env.TARGET_SHA,
            });
            const matchArtifact = artifacts.data.artifacts[0];
            if ( ! matchArtifact ) {
              core.setFailed( 'No artifact found!' );
              return false;
            }
            const download = await github.rest.actions.downloadArtifact( {
              owner: context.repo.owner,
              repo: context.repo.repo,
              artifact_id: matchArtifact.id,
              archive_format: 'zip',
            } );
            const fs = require( 'fs' );
            fs.writeFileSync( process.env.GITHUB_WORKSPACE + '/before.zip', Buffer.from( download.data ) )
            return true;

      - name: Unzip the previous build
        if: ${{ inputs.subject == 'before' }}
        run: |
          unzip "${GITHUB_WORKSPACE}/before.zip"
          unzip -o "${GITHUB_WORKSPACE}/wordpress.zip"

      - name: Set the environment to the baseline version
        if: ${{ inputs.subject == 'base' }}
        run: |
          VERSION="${BASE_TAG%.0}"
          wp core download --version="$VERSION" --force --path="${LOCAL_DIR}"

      - name: Install object cache drop-in
        if: ${{ inputs.memcached }}
        run: cp src/wp-content/object-cache.php build/wp-content/object-cache.php

      - name: Log running Docker containers
        run: docker ps -a

      - name: Docker debug information
        run: |
          docker -v
          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: Check version number
        run: npm run env:cli -- core version --path="/var/www/${LOCAL_DIR}"

      - name: Enable themes on Multisite
        if: ${{ inputs.multisite }}
        run: |
          npm run env:cli -- theme enable twentytwentyone --network --path="/var/www/${LOCAL_DIR}"
          npm run env:cli -- theme enable twentytwentythree --network --path="/var/www/${LOCAL_DIR}"
          npm run env:cli -- theme enable twentytwentyfour --network --path="/var/www/${LOCAL_DIR}"
          npm run env:cli -- theme enable twentytwentyfive --network --path="/var/www/${LOCAL_DIR}"

      - name: Install WordPress Importer plugin
        run: npm run env:cli -- plugin install wordpress-importer --activate --path="/var/www/${LOCAL_DIR}"

      - name: Import mock data
        run: |
          curl -O https://raw.githubusercontent.com/WordPress/theme-test-data/b9752e0533a5acbb876951a8cbb5bcc69a56474c/themeunittestdata.wordpress.xml
          npm run env:cli -- import themeunittestdata.wordpress.xml --authors=create --path="/var/www/${LOCAL_DIR}"
          rm themeunittestdata.wordpress.xml

      - name: Deactivate WordPress Importer plugin
        run: npm run env:cli -- plugin deactivate wordpress-importer --path="/var/www/${LOCAL_DIR}"

      - name: Install additional languages
        run: |
          npm run env:cli -- language core install de_DE --path="/var/www/${LOCAL_DIR}"
          npm run env:cli -- language plugin install de_DE --all --path="/var/www/${LOCAL_DIR}"
          npm run env:cli -- language theme install de_DE --all --path="/var/www/${LOCAL_DIR}"

      # Prevent background update checks from impacting test stability.
      - name: Disable external HTTP requests
        run: npm run env:cli -- config set WP_HTTP_BLOCK_EXTERNAL true --raw --type=constant --path="/var/www/${LOCAL_DIR}"

      # Prevent background tasks from impacting test stability.
      - name: Disable cron
        run: npm run env:cli -- config set DISABLE_WP_CRON true --raw --type=constant --path="/var/www/${LOCAL_DIR}"

      - name: List defined constants
        run: npm run env:cli -- config list --path="/var/www/${LOCAL_DIR}"

      - name: Install MU plugin
        run: |
          mkdir "./${LOCAL_DIR}/wp-content/mu-plugins"
          cp ./tests/performance/wp-content/mu-plugins/server-timing.php "./${LOCAL_DIR}/wp-content/mu-plugins/server-timing.php"

      - name: Run performance tests
        run: npm run test:performance
        env:
          TEST_RESULTS_PREFIX: ${{ inputs.subject != 'current' && inputs.subject || '' }}

      - name: Archive artifacts
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        if: always()
        with:
          name: performance-${{ inputs.multisite && 'multisite' || 'single' }}-${{ inputs.memcached && 'memcached' || 'default' }}-${{ inputs.subject }}
          path: artifacts
          if-no-files-found: error
          include-hidden-files: true
          retention-days: 1

      - name: Ensure version-controlled files are not modified or deleted
        run: git diff --exit-code