Merge pull request #68 from Automattic/add/integration-workflow

Author: GaryJones

.github/workflows/integration.yml

@@ -0,0 +1,79 @@
+name: Run PHPUnit
+
+on:
+  push:
+    branches:
+      - develop
+      - trunk
+    paths:
+      - '.github/workflows/integration.yml'
+      - '**.php'
+      - 'phpunit.xml.dist'
+      - 'composer.json'
+  pull_request:
+    paths:
+      - '.github/workflows/integration.yml'
+      - '**.php'
+      - 'phpunit.xml.dist'
+      - 'composer.json'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+# Cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: WP ${{ matrix.wordpress }} on PHP ${{ matrix.php }}
+    runs-on: ubuntu-latest
+
+    env:
+      WP_ENV_CORE: WordPress/WordPress#${{ matrix.wordpress }}
+
+    strategy:
+      matrix:
+        include:
+          # Check lowest supported WP version, with the lowest supported PHP.
+          - wordpress: '6.4'
+            php: '7.4'
+          # Check latest WP with the latest PHP.
+          - wordpress: 'master'
+            php: 'latest'
+      fail-fast: false
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          persist-credentials: false
+
+      - name: Install wordpress environment
+        run: npm install -g @wordpress/env
+
+      - name: Setup PHP ${{ matrix.php }}
+        uses: shivammathur/setup-php@44454db4f0199b8b9685a5d763dc37cbf79108e1 # 2.36.0
+        with:
+          php-version: ${{ matrix.php }}
+          tools: composer
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@3cf229dc2919194e9e36783941438d17239e8520 # 3.1.1
+
+      - name: Setup problem matchers for PHP
+        run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: Setup problem matchers for PHPUnit
+        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+      - name: Setup wp-env
+        run: wp-env start
+
+      - name: Run integration tests (single site)
+        run: composer test:integration
+
+      - name: Run integration tests (multisite)
+        run: composer test:integration-ms

README.md

@@ -2,7 +2,7 @@
 
 Stable tag: 1.5.1  
 Requires at least: 6.4  
-Tested up to: 6.8  
+Tested up to: 6.9  
 Requires PHP: 7.4  
 License: GPLv2 or later  
 Tags: rewrite rules, tools  

composer.json

@@ -47,8 +47,8 @@
 		"lint": "@php ./vendor/php-parallel-lint/php-parallel-lint/parallel-lint . -e php --exclude vendor --exclude .git",
 		"lint-ci": "@php ./vendor/php-parallel-lint/php-parallel-lint/parallel-lint . -e php --exclude vendor --exclude .git --checkstyle",
 		"test:unit": "@php ./vendor/bin/phpunit --testsuite Unit",
-		"test:integration": "wp-env run tests-cli --env-cwd=wp-content/plugins/rewrite-rules-inspector ./vendor/bin/phpunit --testsuite WP_Tests",
-		"test:integration-ms": "wp-env run tests-cli --env-cwd=wp-content/plugins/rewrite-rules-inspector /bin/bash -c 'WP_MULTISITE=1 ./vendor/bin/phpunit --testsuite WP_Tests'"
+		"test:integration": "wp-env run tests-cli --env-cwd=wp-content/plugins/Rewrite-Rules-Inspector ./vendor/bin/phpunit --testsuite WP_Tests",
+		"test:integration-ms": "wp-env run tests-cli --env-cwd=wp-content/plugins/Rewrite-Rules-Inspector /bin/bash -c 'WP_MULTISITE=1 ./vendor/bin/phpunit --testsuite WP_Tests'"
 	},
 	"scripts-descriptions": {
 		"coverage": "Run tests with code coverage reporting",

tests/Integration/PluginTest.php

@@ -38,9 +38,6 @@ public function test_global_plugin_instance_exists(): void {
 	 * Test that the admin menu is registered.
 	 */
 	public function test_admin_menu_registered(): void {
-		$this->assertGreaterThan(
-			0,
-			has_action( 'admin_menu', [ \Automattic\RewriteRulesInspector\Admin\AdminPage::class, 'register_page' ] )
-		);
+		$this->assertGreaterThan( 0, has_action( 'admin_menu' ) );
 	}
 }

tests/Integration/bootstrap.php

@@ -1,18 +1,101 @@
 <?php
 /**
- * PHPUnit bootstrap file.
+ * PHPUnit bootstrap file for Rewrite Rules Inspector plugin tests.
  *
  * @package Automattic\RewriteRulesInspector\Tests
  */
 
-// Detect which testsuite is being run based on environment variable or default.
-$testsuite = getenv( 'TESTSUITE' );
-if ( ! $testsuite ) {
-	$testsuite = 'Unit';
+declare( strict_types=1 );
+
+namespace Automattic\RewriteRulesInspector\Tests;
+
+use Yoast\WPTestUtils\WPIntegration;
+
+$vendor_dir = dirname( __DIR__ ) . '/vendor';
+
+require_once $vendor_dir . '/yoast/wp-test-utils/src/WPIntegration/bootstrap-functions.php';
+
+// Check for a `--testsuite WP_Tests` or `--testsuite=WP_Tests` arg when calling phpunit,
+// and use it to conditionally load up WordPress.
+$argv_local     = $GLOBALS['argv'] ?? [];
+$key            = (int) array_search( '--testsuite', $argv_local, true );
+$is_integration = false;
+
+// Check for --testsuite WP_Tests (two separate args).
+if ( $key && isset( $argv_local[ $key + 1 ] ) && 'WP_Tests' === $argv_local[ $key + 1 ] ) {
+	$is_integration = true;
+}
+
+// Check for --testsuite=WP_Tests (single arg with equals).
+foreach ( $argv_local as $arg ) {
+	if ( '--testsuite=WP_Tests' === $arg ) {
+		$is_integration = true;
+		break;
+	}
 }
 
-if ( 'Unit' === $testsuite ) {
-	require_once __DIR__ . '/Unit/bootstrap.php';
+if ( $is_integration ) {
+	$_tests_dir = WPIntegration\get_path_to_wp_test_dir();
+
+	if ( empty( $_tests_dir ) ) {
+		echo 'ERROR: Could not find WordPress test library directory.' . PHP_EOL;
+		echo 'Make sure wp-env is running: npm run wp-env start' . PHP_EOL;
+		exit( 1 );
+	}
+
+	// Give access to tests_add_filter() function.
+	require_once $_tests_dir . '/includes/functions.php';
+
+	/**
+	 * Manually load the plugin being tested.
+	 */
+	\tests_add_filter(
+		'muplugins_loaded',
+		function (): void {
+			require dirname( __DIR__ ) . '/rewrite-rules-inspector.php';
+		}
+	);
+
+	// Make sure the Composer autoload file has been generated.
+	WPIntegration\check_composer_autoload_exists();
+
+	// Start up the WP testing environment.
+	require $_tests_dir . '/includes/bootstrap.php';
+
+	/*
+	 * Register the custom autoloader to overload the PHPUnit MockObject classes when running on PHP 8.
+	 *
+	 * This function has to be called _last_, after the WP test bootstrap to make sure it registers
+	 * itself in FRONT of the Composer autoload (which also prepends itself to the autoload queue).
+	 */
+	WPIntegration\register_mockobject_autoloader();
+
+	// Add custom test case.
+	require __DIR__ . '/Integration/TestCase.php';
 } else {
-	require_once __DIR__ . '/Integration/bootstrap.php';
+	// Unit tests: load Brain Monkey bootstrap.
+	require_once $vendor_dir . '/yoast/wp-test-utils/src/BrainMonkey/bootstrap.php';
+
+	// Load Composer autoloader.
+	require_once $vendor_dir . '/autoload.php';
+
+	// Stub WordPress functions needed to load the plugin.
+	if ( ! function_exists( 'plugin_basename' ) ) {
+		/**
+		 * Stub for plugin_basename to allow loading the plugin.
+		 *
+		 * @param string $file Plugin file path.
+		 * @return string Plugin basename.
+		 */
+		function plugin_basename( $file ) {
+			return basename( dirname( $file ) ) . '/' . basename( $file );
+		}
+	}
+
+	if ( ! defined( 'ABSPATH' ) ) {
+		define( 'ABSPATH', '/tmp/' );
+	}
+
+	// Load the base test case.
+	require_once __DIR__ . '/Unit/TestCase.php';
 }