Changeset 14691

Timestamp:

03/10/2026 05:11:01 AM (4 days ago)

Author:

dd32

Message:

Github actions: Run the Handbook unit tests.

Closes ​https://github.com/WordPress/wordpress.org/pull/559

Location:

sites/trunk

Files:

• .github/workflows/unit-tests.yml (modified) (2 diffs)
• wordpress.org/public_html/wp-content/plugins/handbook/phpunit/bootstrap.php (modified) (2 diffs)
• wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/handbook.php (modified) (3 diffs)
• wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/init.php (modified) (2 diffs)
• wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/template-tags.php (modified) (2 diffs)

sites/trunk/.github/workflows/unit-tests.yml

@@ -2 +2 @@
 
 on:
+  pull_request:
   push:
-    branches: [ trunk ]
-  pull_request:
     branches: [ trunk ]
 
@@ -52 +51 @@
         working-directory: ${{ matrix.working-directory }}
         run: phpunit ${{ matrix.phpunit-args }}
+
+  # WordPress-dependent PHP tests — require wp-env (Docker).
+  php-wordpress:
+    name: "WP: ${{ matrix.name }}"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Handbook Plugin
+            plugin-directory: wordpress.org/public_html/wp-content/plugins/handbook
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install wp-env
+        run: npm -g install @wordpress/env
+
+      - name: Start wp-env
+        working-directory: ${{ matrix.plugin-directory }}
+        run: wp-env start
+
+      - name: Install PHPUnit Polyfills
+        working-directory: ${{ matrix.plugin-directory }}
+        run: wp-env run tests-cli composer require --dev yoast/phpunit-polyfills:^4.0 --working-dir=/wordpress-phpunit
+
+      - name: Run PHPUnit
+        working-directory: ${{ matrix.plugin-directory }}
+        run: wp-env run tests-cli --env-cwd=wp-content/plugins/$(basename ${{ matrix.plugin-directory }}) phpunit --no-configuration --bootstrap phpunit/bootstrap.php phpunit/tests/

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/bootstrap.php

@@ -15 +15 @@
     $_tests_dir = substr( __FILE__, 0, $pos ) . '/tests/phpunit/';
 }
+// Check for wp-env test directory.
+elseif ( ! $_tests_dir && file_exists( '/wordpress-phpunit/includes/functions.php' ) ) {
+    $_tests_dir = '/wordpress-phpunit/';
+}
 // Elseif no path yet, assume a temp directory path.
 elseif ( ! $_tests_dir ) {
@@ -23 +27 @@
     echo "Could not find $_tests_dir/includes/functions.php\n";
     exit( 1 );
+}
+
+// Set polyfills path if available (required by WP test suite).
+if ( ! defined( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH' ) && file_exists( $_tests_dir . '/vendor/yoast/phpunit-polyfills' ) ) {
+    define( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH', $_tests_dir . '/vendor/yoast/phpunit-polyfills' );
 }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/handbook.php

@@ -18 +18 @@
     protected $handbook;
 
-    public function setUp() {
+    public function setUp(): void {
         parent::setup();
         WPorg_Handbook_Init::init();
@@ -26 +26 @@
     }
 
-    public function tearDown() {
+    public function tearDown(): void {
         parent::tearDown();
 
@@ -456 +456 @@
         $this->assertTrue( isset( $wp_registered_sidebars[ 'handbook' ] ) );
         $this->assertSame(
-            [ 'name', 'id', 'description', 'class', 'before_widget', 'after_widget', 'before_title', 'after_title', 'before_sidebar', 'after_sidebar' ],
+            [ 'name', 'id', 'description', 'class', 'before_widget', 'after_widget', 'before_title', 'after_title', 'before_sidebar', 'after_sidebar', 'show_in_rest' ],
             array_keys( $wp_registered_sidebars[ 'handbook' ] )
         );

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/init.php

@@ -5 +5 @@
 class WPorg_Handbook_Init_Test extends WP_UnitTestCase {
 
-    public function setUp() {
+    public function setUp(): void {
         parent::setup();
 
@@ -11 +11 @@
     }
 
-    public function tearDown() {
+    public function tearDown(): void {
         parent::tearDown();
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/template-tags.php

@@ -5 +5 @@
 class WPorg_Handbook_Template_Tags_Test extends WP_UnitTestCase {
 
-    public function setUp() {
+    public function setUp(): void {
         parent::setup();
 
@@ -11 +11 @@
     }
 
-    public function tearDown() {
+    public function tearDown(): void {
         parent::tearDown();