first pass at compat.php checker

.github/workflows/quality-compat.yml

@@ -0,0 +1,100 @@
+name: compat.php Quality Check
+
+on:
+ # PHP compatibility testing was introduced in WordPress 5.5.
+ push:
+ paths:
+ # Only when either the quality script is updated, this file is updated, or compat is updated.
+ - 'tools/quality/compat.php'
+ - 'src/wp-includes/compat.php'
+ - '.github/workflows/quality-compat.yml'
+ pull_request:
+ paths:
+ # Only when either the quality script is updated, this file is updated, or compat is updated.
+ - 'tools/quality/compat.php'
+ - 'src/wp-includes/compat.php'
+ - '.github/workflows/quality-compat.yml'
+ workflow_dispatch:
+
+# 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
+
+# Disable permissions for all available scopes by default.
+# Any needed permissions should be configured at the job level.
+permissions: {}
+
+jobs:
+ quality-compat:
+ name: Check that Compat only contains acceptable functions
+ runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+ with:
+ show-progress: ${{ runner.debug == '1' && 'true' || 'false' }}
+
+ - name: Set up PHP
+ uses: shivammathur/setup-php@c541c155eee45413f5b09a52248675b1a2575231 # v2.31.1
+ with:
+ php-version: 'latest'
+ coverage: none
+ tools: cs2pr
+
+ - name: Run quality script
+ run: php tools/quality/compat.php
+
+
+ slack-notifications:
+ name: Slack Notifications
+ uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
+ permissions:
+ actions: read
+ contents: read
+ needs: [ quality-compat ]
+ if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name != 'pull_request' && always() }}
+ with:
+ calling_status: ${{ contains( needs.*.result, 'cancelled' ) && 'cancelled' || contains( needs.*.result, 'failure' ) && 'failure' || 'success' }}
+ 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
+ permissions:
+ actions: write
+ needs: [ slack-notifications ]
+ if: |
+ always() &&
+ github.repository == 'WordPress/wordpress-develop' &&
+ github.event_name != 'pull_request' &&
+ github.run_attempt < 2 &&
+ (
+ contains( needs.*.result, 'cancelled' ) ||
+ contains( needs.*.result, 'failure' )
+ )
+
+ steps:
+ - name: Dispatch workflow run
+ uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+ 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 }}'
+ }
+ });

tools/quality/compat.php

@@ -0,0 +1,24 @@
+<?php
+
+$compat_path = __DIR__ . '/../../src/wp-includes/compat.php';
+require_once $compat_path;
+
+$functions = get_defined_functions();
+$tokens = token_get_all( file_get_contents( $compat_path ) );
+$last_i = count( $tokens ) - 1;
+$exit_code = 0;
+
+foreach ( $tokens as $i => $token ) {
+ // A function call looks like [ T_STRING function_name, '(' ]
+ if ( is_string( $token ) || $i === $last_i || 'T_STRING' !== token_name( $token[0] ) || '(' !== $tokens[ $i + 1 ] ) {
+ continue;
+ }
+
+ $name = $token[1];
+ if ( ! in_array( $name, $functions['internal'], true ) && ! in_array( $name, $functions['user'], true ) ) {
+ echo "Possible call to undefined function '{$name}' on line {$token[2]}\n";
+ $exit_code = 1;
+ }
+}
+
+exit( $exit_code );