[CMSP-633] PHP 8.3 and unit tests (#26)

* add some initial phpunit scaffolding

* add a test workflow

* fix dirname for phpcs

* fix the paths

* drop phpunit to 9

* bump mu-plugin version
probably we should make a -dev workflow like other plugins...

* set the pantheon environment in the bootstrap before we load the plugin
we need to know this early

* test the main plugin file

* add shortcut for multisite tests

* add some logging to the test script and use the new composer script

* set the env variable in the bootstrap

* ...and remove it from the main test class

* network test scaffold

* change emoji to a broom
so it doesn't look like a failure

* use colors

* add multisite tests

* colors

* add show_return_to_pantheon_button filter to bootstrap
this allows us to test that the button displays appropriately
there's some messy logic that can/should be cleaned up in there but that's out of scope of these tests

* test the return to pantheon button

* linting fixes

* test the page cache class

* add tests for plugin notice

* add tests for pantheon-updates.php

* shellcheck the bin folder
but don't bother shellchecking the wp tests installer which we didn't write

* remove vestigial code checking Return_To_Pantheon_Button_HTML exists

.gitattributes

@@ -1,7 +1,8 @@
 # Directories
 /.github export-ignore
-/tests export-ignore # This doesn't exist yet, but hopefully it will in the future.
+/tests export-ignore 
 /vendor export-ignore
+/bin export-ignore
 
 # Files
 /.DS_Store export-ignore
@@ -13,4 +14,4 @@
 /CODEOWNERS export-ignore
 /composer.lock export-ignore
 /CONTRIBUTING.md export-ignore
-/phpunit.xml.dist export-ignore # This also doesn't exist, but hopefully one day...
+/phpunit.xml.dist export-ignore 

.github/workflows/shellcheck.yml

@@ -0,0 +1,14 @@
+name: Shellcheck
+on:
+  push:
+    paths:
+      - 'bin/*.sh'
+jobs:
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Shellcheck
+        run: find bin/ -name "*.sh" | grep -v "install-wp-tests.sh" | xargs shellcheck

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Test
+on:
+  schedule:
+    - cron: '0 0 * * *'
+  push:
+    branches:
+      - '**'
+env:
+  TERM: xterm-256color
+jobs:
+  php8-compatibility:
+    name: PHP 8.x Compatibility
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: PHP Compatibility
+        uses: pantheon-systems/phpcompatibility-action@dev
+        with:
+          test-versions: 8.0-
+          paths: ${{ github.workspace }}/*.php ${{ github.workspace }}/inc/*.php ${{ github.workspace }}/inc/network/*.php
+  test:
+    needs: php8-compatibility
+    name: Test
+    runs-on: ubuntu-latest
+    services:
+      mariadb:
+        image: mariadb:10.6
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup PHP 8.3
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+          extensions: mysqli, zip, imagick
+      - name: Start MySQL
+        run: sudo systemctl start mysql
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/vendor
+          key: test-phpunit-dependencies-${{ hashFiles('composer.json') }}
+          restore-keys: test-phpunit-dependencies-${{ hashFiles('composer.json') }}
+      - name: Install Composer dependencies
+        run: composer install
+      - name: Run PHPUnit
+        run: bash ./bin/phpunit-test.sh
+

bin/install-local-tests.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+set -e
+
+# Initialize variables with default values
+TMPDIR="/tmp"
+DB_NAME="wordpress_test"
+DB_USER="root"
+DB_PASS=""
+DB_HOST="127.0.0.1"
+WP_VERSION="latest"
+SKIP_DB=""
+
+# Display usage information
+usage() {
+  echo "Usage:"
+  echo "./install-local-tests.sh [--dbname=wordpress_test] [--dbuser=root] [--dbpass=''] [--dbhost=127.0.0.1] [--wpversion=latest] [--no-db]"
+}
+
+# Parse command-line arguments
+for i in "$@"
+do
+case $i in
+    --dbname=*)
+    DB_NAME="${i#*=}"
+    shift
+    ;;
+    --dbuser=*)
+    DB_USER="${i#*=}"
+    shift
+    ;;
+    --dbpass=*)
+    DB_PASS="${i#*=}"
+    shift
+    ;;
+    --dbhost=*)
+    DB_HOST="${i#*=}"
+    shift
+    ;;
+    --wpversion=*)
+    WP_VERSION="${i#*=}"
+    shift
+    ;;
+    --no-db)
+    SKIP_DB="true"
+    shift
+    ;;
+    *)
+    # unknown option
+    usage
+    exit 1
+    ;;
+esac
+done
+
+# Run install-wp-tests.sh
+echo "Installing local tests into ${TMPDIR}"
+bash "$(dirname "$0")/install-wp-tests.sh" "$DB_NAME" "$DB_USER" "$DB_PASS" "$DB_HOST" "$WP_VERSION" "$SKIP_DB"
+
+# Run PHPUnit
+echo "Running PHPUnit"
+composer phpunit

bin/install-wp-tests.sh

@@ -0,0 +1,151 @@
+#!/usr/bin/env bash
+
+if [ $# -lt 3 ]; then
+	echo "usage: $0 <db-name> <db-user> <db-pass> [db-host] [wp-version] [skip-database-creation]"
+	exit 1
+fi
+
+DB_NAME=$1
+DB_USER=$2
+DB_PASS=$3
+DB_HOST=${4-localhost}
+WP_VERSION=${5-latest}
+SKIP_DB_CREATE=${6-false}
+
+TMPDIR=${TMPDIR-/tmp}
+WP_TESTS_DIR=${WP_TESTS_DIR-$TMPDIR/wordpress-tests-lib}
+WP_CORE_DIR=${WP_CORE_DIR-$TMPDIR/wordpress/}
+
+download() {
+    if [ `which curl` ]; then
+        curl -s "$1" > "$2";
+    elif [ `which wget` ]; then
+        wget -nv -O "$2" "$1"
+    fi
+}
+
+if [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+$ ]]; then
+	WP_TESTS_TAG="branches/$WP_VERSION"
+elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
+	if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
+		# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
+		WP_TESTS_TAG="tags/${WP_VERSION%??}"
+	else
+		WP_TESTS_TAG="tags/$WP_VERSION"
+	fi
+elif [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
+	WP_TESTS_TAG="trunk"
+else
+	# http serves a single offer, whereas https serves multiple. we only want one
+	download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
+	grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json
+	LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//')
+	if [[ -z "$LATEST_VERSION" ]]; then
+		echo "Latest WordPress version could not be found"
+		exit 1
+	fi
+	WP_TESTS_TAG="tags/$LATEST_VERSION"
+fi
+
+set -e
+
+install_wp() {
+
+	if [ -d $WP_CORE_DIR ]; then
+		return;
+	fi
+
+	mkdir -p $WP_CORE_DIR
+
+	if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
+		mkdir -p $TMPDIR/wordpress-nightly
+		download https://wordpress.org/nightly-builds/wordpress-latest.zip  $TMPDIR/wordpress-nightly/wordpress-nightly.zip
+		unzip -q $TMPDIR/wordpress-nightly/wordpress-nightly.zip -d $TMPDIR/wordpress-nightly/
+		mv $TMPDIR/wordpress-nightly/wordpress/* $WP_CORE_DIR
+	else
+		if [ $WP_VERSION == 'latest' ]; then
+			local ARCHIVE_NAME='latest'
+		elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+ ]]; then
+			# https serves multiple offers, whereas http serves single.
+			download https://api.wordpress.org/core/version-check/1.7/ $TMPDIR/wp-latest.json
+			if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
+				# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
+				LATEST_VERSION=${WP_VERSION%??}
+			else
+				# otherwise, scan the releases and get the most up to date minor version of the major release
+				local VERSION_ESCAPED=`echo $WP_VERSION | sed 's/\./\\\\./g'`
+				LATEST_VERSION=$(grep -o '"version":"'$VERSION_ESCAPED'[^"]*' $TMPDIR/wp-latest.json | sed 's/"version":"//' | head -1)
+			fi
+			if [[ -z "$LATEST_VERSION" ]]; then
+				local ARCHIVE_NAME="wordpress-$WP_VERSION"
+			else
+				local ARCHIVE_NAME="wordpress-$LATEST_VERSION"
+			fi
+		else
+			local ARCHIVE_NAME="wordpress-$WP_VERSION"
+		fi
+		download https://wordpress.org/${ARCHIVE_NAME}.tar.gz  $TMPDIR/wordpress.tar.gz
+		tar --strip-components=1 -zxmf $TMPDIR/wordpress.tar.gz -C $WP_CORE_DIR
+	fi
+
+	download https://raw.github.com/markoheijnen/wp-mysqli/master/db.php $WP_CORE_DIR/wp-content/db.php
+}
+
+install_test_suite() {
+	# portable in-place argument for both GNU sed and Mac OSX sed
+	if [[ $(uname -s) == 'Darwin' ]]; then
+		local ioption='-i .bak'
+	else
+		local ioption='-i'
+	fi
+
+	# set up testing suite if it doesn't yet exist
+	if [ ! -d $WP_TESTS_DIR ]; then
+		# set up testing suite
+		mkdir -p $WP_TESTS_DIR
+		svn co --quiet --ignore-externals https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes
+		svn co --quiet --ignore-externals https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/data/ $WP_TESTS_DIR/data
+	fi
+
+	if [ ! -f wp-tests-config.php ]; then
+		download https://develop.svn.wordpress.org/${WP_TESTS_TAG}/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php
+		# remove all forward slashes in the end
+		WP_CORE_DIR=$(echo $WP_CORE_DIR | sed "s:/\+$::")
+		sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
+		sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php
+		sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php
+		sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php
+		sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php
+	fi
+
+}
+
+install_db() {
+
+	if [ ${SKIP_DB_CREATE} = "true" ]; then
+		return 0
+	fi
+
+	# parse DB_HOST for port or socket references
+	local PARTS=(${DB_HOST//\:/ })
+	local DB_HOSTNAME=${PARTS[0]};
+	local DB_SOCK_OR_PORT=${PARTS[1]};
+	local EXTRA=""
+
+	if ! [ -z $DB_HOSTNAME ] ; then
+		if [ $(echo $DB_SOCK_OR_PORT | grep -e '^[0-9]\{1,\}$') ]; then
+			EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp"
+		elif ! [ -z $DB_SOCK_OR_PORT ] ; then
+			EXTRA=" --socket=$DB_SOCK_OR_PORT"
+		elif ! [ -z $DB_HOSTNAME ] ; then
+			EXTRA=" --host=$DB_HOSTNAME --protocol=tcp"
+		fi
+	fi
+
+	# create database
+	mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA
+}
+
+install_wp
+install_test_suite
+install_db

bin/phpunit-test.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -e
+
+DIRNAME=$(dirname "$0")
+
+echo "🤔 Installing WP Unit tests..."
+bash "${DIRNAME}/install-wp-tests.sh" wordpress_test root root 127.0.0.1 latest
+
+echo "🏃‍♂️ Running PHPUnit on Single Site"
+composer phpunit --ansi
+
+echo "🧹 Removing files before testing nightly WP..."
+rm -rf "$WP_TESTS_DIR" "$WP_CORE_DIR"
+
+echo "🤔 Installing WP Unit tests with WP nightly version..."
+bash "${DIRNAME}/install-wp-tests.sh" wordpress_test root root 127.0.0.1 nightly true
+echo "🏃‍♂️ Running PHPUnit on Single Site (Nightly WordPress)"
+composer phpunit --ansi
+
+bash "${DIRNAME}/install-wp-tests.sh" wordpress_test root root 127.0.0.1 latest true
+echo "🏃‍♂️ Running PHPUnit on Multisite"
+composer test:multisite --ansi

composer.json

@@ -7,15 +7,30 @@
     "vlucas/phpdotenv": "*"
   },
   "require-dev": {
-    "pantheon-systems/pantheon-wp-coding-standards": "^2.0"
+    "pantheon-systems/pantheon-wp-coding-standards": "^2.0",
+    "phpunit/phpunit": "^9",
+    "yoast/phpunit-polyfills": "^2.0"
   },
   "config": {
     "allow-plugins": {
       "dealerdirect/phpcodesniffer-composer-installer": true
     }
   },
   "scripts": {
-    "lint": "vendor/bin/phpcs -s .",
-    "lint:cbf": "vendor/bin/phpcbf -s ."
+    "lint": [
+      "@phplint",
+      "@phpcs"
+    ],
+    "phplint": "find . -type f -name '*.php' -not -path './vendor/*' -not -path './tests/*' -exec php -l {} \\;",
+    "phpcs": "vendor/bin/phpcs -s .",
+    "phpcbf": "vendor/bin/phpcbf -s .",
+    "phpunit": "vendor/bin/phpunit --colors=always",
+    "test": [
+      "@phpunit",
+      "@test:multisite"
+    ],
+    "test:multisite": "WP_MULTISITE=1 vendor/bin/phpunit --colors=always",
+    "test:install": "bin/install-local-tests.sh --no-db",
+    "test:install:withdb": "bin/install-local-tests.sh"
   }
 }

pantheon.php

@@ -3,14 +3,14 @@
  * Plugin Name: Pantheon
  * Plugin URI: https://pantheon.io/
  * Description: Building on Pantheon's and WordPress's strengths, together.
- * Version: 1.2.0
+ * Version: 1.2.1
  * Author: Pantheon
  * Author URI: https://pantheon.io/
  *
  * @package pantheon
  */
 
-define( 'PANTHEON_MU_PLUGIN_VERSION', '1.2.0' );
+define( 'PANTHEON_MU_PLUGIN_VERSION', '1.2.1' );
 
 if ( isset( $_ENV['PANTHEON_ENVIRONMENT'] ) ) {
 

phpunit.xml.dist

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<phpunit 
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+	bootstrap="tests/phpunit/bootstrap.php" 
+	backupGlobals="false" 
+	colors="true" 
+	cacheResult="false" 
+	xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd" 
+  >
+  <testsuites>
+    <testsuite name="main">
+      <directory prefix="test-" suffix=".php">./tests/phpunit/</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>