Make WordPress Core


Ignore:
Timestamp:
07/03/2024 02:28:46 PM (8 months ago)
Author:
desrosj
Message:

Build/Test Tools: Make use of new reusable workflows for 4.9.

This updates the 4.9 branch to utilize the new reusable workflows in trunk introduced in [58165].

This also includes backports for a some additional improvements and bug fixes that are necessary for the local development environment to continue working long term:

  • The image and platform properties for the mysql container have been updated to always prefer amd64 containers (#60822).
  • macos-13 is now pinned for MacOS jobs instead of macos-latest (#61340).
  • Migrating to Docker Compose V2 (#60901).
  • Removing the version property from docker-compose.yml (#59416).
  • Improvements to how artifacts and comments for Playground testing are generated.
  • Removing SVN related commands causing failures (#61216).
  • Updating the actions/github-scripts action to the latest version.
  • Improvements to the healthcheck command for the mysql container (#58867).

Merges [51673], [53552], [56464], [57918], [58157], [57124], [57125], [57249] to the 4.9 branch.

Props johnbillion, joemcgill, swissspidy, thelovekesh, narenin, mukesh27, JeffPaul, peterwilsoncc, zieladam, ockham, SergeyBiryukov, jorbin, Clorith, afragen, jrf.
See #58867, #61340, #60822, #61216, #60901, #61101, #59416, #59805, #61213.

Location:
branches/4.9
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • branches/4.9

  • branches/4.9/.github/workflows/phpunit-tests.yml

    r55527 r58636  
    2222# Cancels all previous workflow runs for pull requests that have not completed.
    2323concurrency:
    24     # The concurrency group contains the workflow name and the branch name for pull requests
    25     # or the commit hash for any other events.
     24  # The concurrency group contains the workflow name and the branch name for pull requests
     25  # or the commit hash for any other events.
    2626  group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }}
    2727  cancel-in-progress: true
    2828
    29 env:
    30   LOCAL_DIR: build
    31   PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: ${{ true }}
    32   COMPOSER_INSTALL: ${{ false }}
    33   # Controls which npm script to use for running PHPUnit tests. Options ar `php` and `php-composer`.
    34   PHPUNIT_SCRIPT: php
    35   LOCAL_PHP_MEMCACHED: ${{ false }}
    36   SLOW_TESTS: 'external-http,media,restapi'
     29# Disable permissions for all available scopes by default.
     30# Any needed permissions should be configured at the job level.
     31permissions: {}
    3732
    3833jobs:
    39   # Sets up WordPress for testing or development use.
    4034  #
    41   # Performs the following steps:
    42   # - Cancels all previous workflow runs for pull requests that have not completed.
    43   # - Checks out the repository.
    44   # - Logs debug information about the GitHub Action runner.
    45   # - Installs NodeJS.
    46   # _ Installs npm dependencies.
    47   # - Builds WordPress to run from the `build` directory.
    48   # - Creates a ZIP file of compiled WordPress.
    49   # - Uploads ZIP file as an artifact.
    50   setup-wordpress:
    51     name: Setup WordPress
    52     runs-on: ubuntu-latest
     35  # Creates a PHPUnit test job for each PHP combination.
     36  #
     37  test-php:
     38    name: PHP ${{ matrix.php }}
     39    uses: WordPress/wordpress-develop/.github/workflows/reusable-phpunit-tests-v1.yml@trunk
     40    permissions:
     41      contents: read
     42    secrets: inherit
    5343    if: ${{ github.repository == 'WordPress/wordpress-develop' || github.event_name == 'pull_request' }}
    54 
    55     steps:
    56       - name: Checkout repository
    57         uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
    58 
    59       - name: Log debug information
    60         run: |
    61           echo "$GITHUB_REF"
    62           echo "$GITHUB_EVENT_NAME"
    63           npm --version
    64           node --version
    65           curl --version
    66           git --version
    67           svn --version
    68           php --version
    69           php -i
    70           locale -a
    71 
    72       - name: Set up Node.js
    73         uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
    74         with:
    75           node-version-file: '.nvmrc'
    76           cache: npm
    77 
    78       - name: Install Dependencies
    79         run: npm ci
    80 
    81       - name: Build WordPress
    82         run: npm run build
    83 
    84       - name: Create ZIP artifact
    85         uses: thedoctor0/zip-release@a24011d8d445e4da5935a7e73c1f98e22a439464 # v0.7.1
    86         with:
    87           filename: built-wp-${{ github.sha }}.zip
    88           exclusions: '*.git* /*node_modules/* packagehash.txt'
    89 
    90       - name: Upload build artifact
    91         uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
    92         with:
    93           name: built-wp-${{ github.sha }}
    94           path: built-wp-${{ github.sha }}.zip
    95           if-no-files-found: error
    96 
    97   # Runs the PHPUnit tests for WordPress.
    98   #
    99   # Performs the following steps:
    100   # - Sets environment variables.
    101   # - Sets up the environment variables needed for testing with memcached (if desired).
    102   # - Downloads the built WordPress artifact from the previous job.
    103   # - Unzips the artifact.
    104   # - Installs NodeJS.
    105   # _ Installs npm dependencies.
    106   # - Configures caching for Composer.
    107   # _ Installs Composer dependencies (if desired).
    108   # - Logs Docker debug information (about the Docker installation within the runner).
    109   # - Starts the WordPress Docker container.
    110   # - Starts the Memcached server after the Docker network has been created (if desired).
    111   # - Logs general debug information about the runner.
    112   # - Logs the running Docker containers.
    113   # - Logs debug information from inside the WordPress Docker container.
    114   # - Logs debug information about what's installed within the WordPress Docker containers.
    115   # - Install WordPress within the Docker container.
    116   # - Run the PHPUnit tests.
    117   # - Checks out the WordPress Test reporter repository.
    118   # - Reconnect the directory to the Git repository.
    119   # - Submit the test results to the WordPress.org host test results.
    120   test-php:
    121     name: ${{ matrix.php }}${{ matrix.multisite && ' multisite' || '' }}${{ matrix.split_slow && ' slow tests' || '' }}${{ matrix.memcached && ' with memcached' || '' }} on ${{ matrix.os }}
    122     needs: setup-wordpress
    123     runs-on: ${{ matrix.os }}
    124     timeout-minutes: 20
    12544    strategy:
    12645      fail-fast: false
    12746      matrix:
     47        os: [ ubuntu-latest ]
    12848        php: [ '5.3', '5.4', '5.5' ]
    129         os: [ ubuntu-latest ]
    130         memcached: [ false ]
    13149        split_slow: [ false, true ]
    13250        multisite: [ false, true ]
     51        memcached: [ false ]
     52
    13353        include:
    13454          # Additional "slow" jobs for PHP 5.6.
     
    194114            multisite: true
    195115            split_slow: false
    196           # Include job for PHP 7.2 with memcached.
     116          # Include jobs for PHP 7.2 with memcached.
    197117          - php: '7.2'
    198118            phpunit: '6-php-7.2'
     
    201121            multisite: false
    202122            split_slow: false
     123          - php: '7.2'
     124            phpunit: '6-php-7.2'
     125            os: ubuntu-latest
     126            memcached: true
     127            multisite: true
     128            split_slow: false
    203129
    204     env:
    205       LOCAL_PHP: ${{ matrix.php }}-fpm
    206       LOCAL_PHPUNIT: ${{ matrix.phpunit && matrix.phpunit || matrix.php }}-fpm
    207       LOCAL_PHP_MEMCACHED: ${{ matrix.memcached }}
    208       PHPUNIT_CONFIG: ${{ matrix.multisite && 'tests/phpunit/multisite.xml' || 'phpunit.xml.dist' }}
    209 
    210     steps:
    211       - name: Configure environment variables
    212         run: |
    213           echo "PHP_FPM_UID=$(id -u)" >> $GITHUB_ENV
    214           echo "PHP_FPM_GID=$(id -g)" >> $GITHUB_ENV
    215 
    216       - name: Download the built WordPress artifact
    217         uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
    218         with:
    219           name: built-wp-${{ github.sha }}
    220 
    221       - name: Unzip built artifact
    222         run: unzip built-wp-${{ github.sha }}.zip
    223 
    224       - name: Set up Node.js
    225         uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
    226         with:
    227           node-version-file: '.nvmrc'
    228           cache: npm
    229 
    230       - name: Install Dependencies
    231         run: npm ci
    232 
    233       - name: Cache Composer dependencies
    234         if: ${{ env.COMPOSER_INSTALL == true }}
    235         uses: actions/cache@69d9d449aced6a2ede0bc19182fadc3a0a42d2b0 # v3.2.6
    236         env:
    237           cache-name: cache-composer-dependencies
    238         with:
    239           path: ${{ steps.composer-cache.outputs.dir }}
    240           key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.lock') }}
    241 
    242       - name: Install Composer dependencies
    243         if: ${{ env.COMPOSER_INSTALL == true }}
    244         run: |
    245           docker-compose run --rm php composer --version
    246           docker-compose run --rm php composer install
    247 
    248       - name: Docker debug information
    249         run: |
    250           docker -v
    251           docker-compose -v
    252 
    253       - name: Start Docker environment
    254         run: |
    255           npm run env:start
    256 
    257       # The memcached server needs to start after the Docker network has been set up with `npm run env:start`.
    258       - name: Start the Memcached server.
    259         if: ${{ matrix.memcached }}
    260         run: |
    261           cp tests/phpunit/includes/object-cache.php build/wp-content/object-cache.php
    262           docker run --name memcached --net $(basename "$PWD")_wpdevnet -d memcached
    263 
    264       - name: General debug information
    265         run: |
    266           npm --version
    267           node --version
    268           curl --version
    269           git --version
    270           svn --version
    271 
    272       - name: Log running Docker containers
    273         run: docker ps -a
    274 
    275       - name: WordPress Docker container debug information
    276         run: |
    277           docker-compose run --rm mysql mysql --version
    278           docker-compose run --rm php php --version
    279           docker-compose run --rm php php -m
    280           docker-compose run --rm php php -i
    281           docker-compose run --rm php locale -a
    282 
    283       - name: Install WordPress
    284         run: npm run env:install
    285 
    286       - name: Run slow PHPUnit tests
    287         if: ${{ matrix.split_slow }}
    288         run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }} --group ${{ env.SLOW_TESTS }}
    289 
    290       - name: Run PHPUnit tests for single site excluding slow tests
    291         if: ${{ matrix.php < '7.0' && ! matrix.split_slow && ! matrix.multisite }}
    292         run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }} --exclude-group ${{ env.SLOW_TESTS }},ajax,ms-files,ms-required
    293 
    294       - name: Run PHPUnit tests for Multisite excluding slow tests
    295         if: ${{ matrix.php < '7.0' && ! matrix.split_slow && matrix.multisite }}
    296         run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }} --exclude-group ${{ env.SLOW_TESTS }},ajax,ms-files,ms-excluded,oembed-headers
    297 
    298       - name: Run PHPUnit tests
    299         if: ${{ matrix.php >= '7.0' }}
    300         run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }}
    301 
    302       - name: Run AJAX tests
    303         if: ${{ ! matrix.multisite && ! matrix.split_slow }}
    304         run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c ${{ env.PHPUNIT_CONFIG }} --group ajax
    305 
    306       - name: Run ms-files tests as a multisite install
    307         if: ${{ matrix.multisite && ! matrix.split_slow }}
    308         run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c tests/phpunit/multisite.xml --group ms-files
    309 
    310       - name: Run external HTTP tests
    311         if: ${{ ! matrix.multisite && ! matrix.split_slow }}
    312         run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c phpunit.xml.dist --group external-http
    313 
    314       - name: Checkout the WordPress Test Reporter
    315         if: ${{ github.repository == 'WordPress/wordpress-develop' && github.ref == 'refs/heads/trunk' && matrix.report }}
    316         uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
    317         with:
    318           repository: 'WordPress/phpunit-test-runner'
    319           path: 'test-runner'
    320 
    321       - name: Set up the Git repository
    322         if: ${{ github.repository == 'WordPress/wordpress-develop' && github.ref == 'refs/heads/trunk' && matrix.report }}
    323         run: |
    324           git init
    325           git remote add origin https://github.com/WordPress/wordpress-develop.git
    326           git fetch
    327           git reset origin/trunk
    328 
    329       - name: Submit test results to the WordPress.org host test results
    330         if: ${{ github.repository == 'WordPress/wordpress-develop' && github.ref == 'refs/heads/trunk' && matrix.report }}
    331         env:
    332           WPT_REPORT_API_KEY: "${{ secrets.WPT_REPORT_API_KEY }}"
    333         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
     130    with:
     131      os: ${{ matrix.os }}
     132      php: ${{ matrix.php }}
     133      phpunit: ${{ matrix.phpunit && matrix.phpunit || matrix.php }}
     134      multisite: ${{ matrix.multisite }}
     135      split_slow: ${{ matrix.split_slow }}
     136      memcached: ${{ matrix.memcached }}
     137      phpunit-config: ${{ matrix.multisite && 'tests/phpunit/multisite.xml' || 'phpunit.xml.dist' }}
    334138
    335139  slack-notifications:
    336140    name: Slack Notifications
    337141    uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
    338     needs: [ setup-wordpress, test-php ]
     142    permissions:
     143      actions: read
     144      contents: read
     145    needs: [ test-php ]
    339146    if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name != 'pull_request' && always() }}
    340147    with:
     
    349156    name: Failed workflow tasks
    350157    runs-on: ubuntu-latest
     158    permissions:
     159      actions: write
    351160    needs: [ test-php, slack-notifications ]
    352161    if: |
     
    361170    steps:
    362171      - name: Dispatch workflow run
    363         uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975 # v6.4.0
     172        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
    364173        with:
    365174          retries: 2
Note: See TracChangeset for help on using the changeset viewer.