Add wp-env as an alternative local development environment

.github/workflows/unit-tests.yml

@@ -57,17 +57,6 @@ jobs:
       matrix:
         php-version: ['8.1', '8.4', '8.5']
 
-    services:
-      mysql:
-        image: mysql:5.7
-        env:
-          MYSQL_ALLOW_EMPTY_PASSWORD: false
-          MYSQL_ROOT_PASSWORD: root
-          MYSQL_DATABASE: wcorg_test
-        ports:
-          - 3306/tcp
-        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
-
     steps:
     - uses: actions/checkout@v4
 
@@ -76,26 +65,34 @@ jobs:
         sudo rm -f /var/lib/man-db/auto-update # https://github.com/actions/runner-images/issues/10977
         sudo apt-get update && sudo apt-get install -y subversion
 
-    - name: Set PHP version
+    - name: Use Node.js 20.x
+      uses: actions/setup-node@v4
+      with:
+        node-version: 20.x
+
+    - name: Set up PHP for Composer
       uses: shivammathur/setup-php@v2
       with:
-        php-version: ${{ matrix.php-version }}
+        php-version: '8.1'
         coverage: none
         tools: composer:v2
       env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Start mysql service
-      run: sudo /etc/init.d/mysql start
+        COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Install dependencies
       run: |
         rm composer.lock || true
         composer install
+        yarn
 
-    - name: Install WordPress
-      run: |
-        bash .docker/bin/install-wp-tests.sh wcorg_test root root 127.0.0.1 latest
+    - name: Build JS assets
+      run: yarn workspaces run build
+
+    - name: Configure wp-env for CI
+      run: echo '{ "phpVersion":"${{ matrix.php-version }}", "multisite":false }' > .wp-env.override.json
+
+    - name: Start wp-env
+      run: npx wp-env start || (echo y | npx wp-env destroy && sleep 10 && npx wp-env start)
 
     - name: Running unit tests
-      run: ./public_html/wp-content/mu-plugins/vendor/bin/phpunit -c phpunit.xml.dist
+      run: npx wp-env run tests-cli --env-cwd=/var/www/html /var/www/html/wp-content/mu-plugins/vendor/bin/phpunit -c phpunit.xml.dist

.gitignore

@@ -8,6 +8,13 @@
 docker-compose.override.yaml
 
 
+#
+# wp-env
+#
+.wp-env-home
+.wp-env.override.json
+
+
 #
 # Misc
 #

.wp-env.json

@@ -0,0 +1,88 @@
+{
+	"core": null,
+	"phpVersion": "8.5",
+	"multisite": true,
+	"port": 80,
+	"testsPort": 8889,
+	"plugins": [
+		"https://downloads.wordpress.org/plugin/akismet.zip",
+		"https://downloads.wordpress.org/plugin/bbpress.zip",
+		"https://downloads.wordpress.org/plugin/classic-editor.zip",
+		"https://downloads.wordpress.org/plugin/custom-content-width.zip",
+		"https://downloads.wordpress.org/plugin/edit-flow.zip",
+		"https://downloads.wordpress.org/plugin/email-post-changes.zip",
+		"https://downloads.wordpress.org/plugin/gutenberg.zip",
+		"https://downloads.wordpress.org/plugin/jetpack.zip",
+		"https://downloads.wordpress.org/plugin/liveblog.zip",
+		"https://downloads.wordpress.org/plugin/public-post-preview.zip",
+		"https://downloads.wordpress.org/plugin/pwa.zip",
+		"https://downloads.wordpress.org/plugin/tagregator.zip",
+		"https://downloads.wordpress.org/plugin/wordpress-importer.zip",
+		"https://downloads.wordpress.org/plugin/wp-cldr.zip",
+		"https://downloads.wordpress.org/plugin/wp-super-cache.zip"
+	],
+	"themes": [
+		"https://downloads.wordpress.org/theme/twentyten.zip",
+		"https://downloads.wordpress.org/theme/twentytwentytwo.zip",
+		"https://downloads.wordpress.org/theme/twentytwentythree.zip",
+		"https://downloads.wordpress.org/theme/twentytwentyfour.zip"
+	],
+	"config": {
+		"IS_WORDCAMP_NETWORK": true,
+		"WP_ENVIRONMENT_TYPE": "local",
+		"SITE_ID_CURRENT_SITE": 1,
+		"BLOG_ID_CURRENT_SITE": 5,
+		"WORDCAMP_NETWORK_ID": 1,
+		"WORDCAMP_ROOT_BLOG_ID": 5,
+		"EVENTS_NETWORK_ID": 2,
+		"EVENTS_ROOT_BLOG_ID": 47,
+		"CAMPUS_NETWORK_ID": 3,
+		"CAMPUS_ROOT_BLOG_ID": 47,
+		"WP_DEBUG": true,
+		"WP_DEBUG_LOG": true,
+		"WP_DEBUG_DISPLAY": true,
+		"SAVEQUERIES": true,
+		"SCRIPT_DEBUG": false,
+		"JETPACK_DEV_DEBUG": true,
+		"DISALLOW_UNFILTERED_HTML": true,
+		"WORDCAMP_QBO_HMAC_KEY": "localhmac",
+		"EMAIL_DEVELOPER_NOTIFICATIONS": "developers@example.test",
+		"EMAIL_CENTRAL_SUPPORT": "support@central.wordcamp.test",
+		"WORDCAMP_ENVIRONMENT": "local"
+	},
+	"mappings": {
+		"wp-content/mu-plugins": "./public_html/wp-content/mu-plugins",
+		"wp-content/mu-plugins/0-aaa-wp-env-constants.php": "./.wp-env/0-early-mu-plugin.php",
+		"wp-content/plugins": "./public_html/wp-content/plugins",
+		"wp-content/sunrise.php": "./public_html/wp-content/sunrise.php",
+		"wp-content/sunrise-wordcamp.php": "./public_html/wp-content/sunrise-wordcamp.php",
+		"wp-content/sunrise-events.php": "./public_html/wp-content/sunrise-events.php",
+		"wp-content/themes/campsite-2017": "./public_html/wp-content/themes/campsite-2017",
+		"wp-content/themes/wordcamp-base-v2": "./public_html/wp-content/themes/wordcamp-base-v2",
+		"wp-content/themes/wporg-events-2023": "./public_html/wp-content/themes/wporg-events-2023",
+		"wp-content/themes/wporg-flagship-landing": "./public_html/wp-content/themes/wporg-flagship-landing"
+	},
+	"lifecycleScripts": {
+		"afterStart": "node .wp-env/setup.mjs"
+	},
+	"env": {
+		"tests": {
+			"config": {
+				"WP_TESTS_MULTISITE": 1,
+				"BLOG_ID_CURRENT_SITE": 1,
+				"WORDCAMP_ROOT_BLOG_ID": 1
+			},
+			"mappings": {
+				"wp-content/mu-plugins": "./public_html/wp-content/mu-plugins",
+				"wp-content/mu-plugins/0-aaa-wp-env-constants.php": "./.wp-env/0-early-mu-plugin.php",
+				"wp-content/plugins": "./public_html/wp-content/plugins",
+				"wp-content/sunrise.php": "./public_html/wp-content/sunrise.php",
+				"wp-content/sunrise-wordcamp.php": "./public_html/wp-content/sunrise-wordcamp.php",
+				"wp-content/sunrise-events.php": "./public_html/wp-content/sunrise-events.php",
+				"phpunit.xml.dist": "./phpunit.xml.dist",
+				"phpunit-bootstrap.php": "./phpunit-bootstrap.php",
+				"phpunit-database-testcase.php": "./phpunit-database-testcase.php"
+			}
+		}
+	}
+}

.wp-env/0-early-mu-plugin.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Wp-env early-loading mu-plugin.
+ *
+ * Wp-env runs `wp core install` before `wp config set`, so custom constants
+ * aren't available when mu-plugins first load during installation. This file
+ * provides safe defaults so the mu-plugins don't cause fatal errors during
+ * that initial bootstrap.
+ *
+ * This file is mapped into the mu-plugins directory by .wp-env.json and is
+ * NOT part of the production codebase.
+ *
+ * @see https://github.com/WordPress/wordpress-develop/pull/XXXX (proposed wp_get_mu_plugins filter)
+ */
+
+$defaults = array(
+	'WORDCAMP_ENVIRONMENT'  => 'local',
+	'WORDCAMP_NETWORK_ID'   => 1,
+	'WORDCAMP_ROOT_BLOG_ID' => 5,
+	'EVENTS_NETWORK_ID'     => 2,
+	'EVENTS_ROOT_BLOG_ID'   => 47,
+	'CAMPUS_NETWORK_ID'     => 3,
+	'CAMPUS_ROOT_BLOG_ID'   => 47,
+	'SITE_ID_CURRENT_SITE'  => 1,
+	'BLOG_ID_CURRENT_SITE'  => 5,
+);
+
+foreach ( $defaults as $name => $value ) {
+	if ( ! defined( $name ) ) {
+		define( $name, $value );
+	}
+}