setup unit tests

Signed-off-by: Joe Fusco <[email protected]>

.docker/Dockerfile

@@ -0,0 +1,46 @@
+ARG WP_VERSION=latest
+
+FROM wordpress:${WP_VERSION}
+
+# Needed to specify the build args again after the FROM command.
+ARG WP_VERSION
+
+# Save the build args for use by the runtime environment
+ENV WP_VERSION=${WP_VERSION}
+
+# Needed for Codeception WPDB test integration.
+RUN docker-php-ext-install pdo pdo_mysql
+
+# Install WP cli
+RUN curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar \
+	&& chmod +x wp-cli.phar \
+	&& mv wp-cli.phar /usr/local/bin/wp \
+	&& wp --info
+
+RUN set -e \
+	; apt-get -qq update \
+	; apt-get install \
+	default-mysql-client \
+	less \
+	openssh-server \
+	sudo \
+	subversion \
+	default-mysql-client \
+	telnet \
+	vim \
+	-qq --no-install-recommends \
+	; sudo adduser www-data sudo \
+	; rm -rf /var/lib/apt/lists/* \
+	&& pecl install pcov \
+	&& docker-php-ext-enable pcov
+
+# Copy the script to create the testing environment
+COPY scripts/init-testing-environment.sh /usr/local/bin/
+RUN chmod +x /usr/local/bin/init-testing-environment.sh
+
+# Install composer
+COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
+RUN chmod +x /usr/local/bin/composer
+
+ENTRYPOINT ["docker-entrypoint.sh"]
+CMD ["apache2-foreground"]

.docker/scripts/init-testing-environment.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# Exits with a status of 0 (true) if provided version number is higher than proceeding numbers.
+version_gt() {
+    test "$(printf '%s\n' "$@" | sort -V | head -n 1)" != "$1";
+}
+
+cd /var/www/html/wp-content/plugins/$WP_PLUGIN_FOLDER
+
+# Setup WordPress test core files and database
+bash -c "./bin/install-wp-tests.sh $WP_TESTS_DB_NAME $WORDPRESS_DB_USER $WORDPRESS_DB_PASSWORD $WORDPRESS_DB_HOST $WP_VERSION"
+
+# Install composer deps
+composer install
+
+# Back to the root WP folder
+cd /var/www/html/

.docker/wp-cli/wp-cli.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+/public/bin/wp-cli.phar "$@"

.env.testing.example

@@ -0,0 +1,10 @@
+TEST_SITE_DB_DSN=mysql:host=127.0.0.1:33066;dbname=wordpress
+TEST_SITE_DB_USER=root
+TEST_SITE_DB_PASSWORD=wordpress
+TEST_SITE_TABLE_PREFIX=wp_
+TEST_SITE_ADMIN_USERNAME=admin
+TEST_SITE_ADMIN_PASSWORD=password
+TEST_SITE_WP_ADMIN_PATH=/wp-admin
+TEST_SITE_WP_URL=http://localhost:8080
+HEADLESS_SITE_URL=http://localhost:3000
+WP_VERSION=6.0.1-php8.1-apache

.github/workflows/test-plugin.yml

@@ -0,0 +1,36 @@
+name: Test Plugin
+
+on:
+  pull_request:
+    paths-ignore:
+      - '**/*.md'
+
+jobs:
+  test_plugin:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Create Docker Containers
+        working-directory: ./
+        run: docker-compose up -d
+
+      - name: Sleep 15 seconds
+        run: sleep 15
+
+      - name: Setup testing framework
+        working-directory: ./
+        run: docker exec -e COVERAGE=1 $(docker-compose ps -q wordpress) init-testing-environment.sh
+
+      - name: Install and activate WP GraphQL
+        working-directory: ./
+        run: docker exec --workdir=/var/www/html/wp-content/plugins/wp-graphql-content-blocks $(docker-compose ps -q wordpress) wp plugin install wp-graphql --activate --allow-root
+
+      - name: Install Dependencies
+        working-directory: ./
+        run: docker exec -e COVERAGE=1 -w /var/www/html/wp-content/plugins/wp-graphql-content-blocks $(docker-compose ps -q wordpress) composer install
+
+      - name: Run unit tests
+        working-directory: ./
+        run: docker exec -e COVERAGE=1 -w /var/www/html/wp-content/plugins/wp-graphql-content-blocks $(docker-compose ps -q wordpress) composer test

.gitignore

@@ -8,3 +8,16 @@ node_modules
 
 # e2e tests
 artifacts
+
+# unit tests
+.phpunit.result.cache
+
+# filesystem
+.DS_Store
+
+# environment
+.env
+
+# docker
+.docker/plugins/
+!.docker/plugins/test-cpt

bin/install-wp-tests.sh

@@ -0,0 +1,181 @@
+#!/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}
+TMPDIR=$(echo $TMPDIR | sed -e "s/\/$//")
+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]+\-(beta|RC)[0-9]+$ ]]; then
+	WP_BRANCH=${WP_VERSION%\-*}
+	WP_TESTS_TAG="branches/$WP_BRANCH"
+
+elif [[ $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 -ex
+
+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-trunk
+		rm -rf $TMPDIR/wordpress-trunk/*
+		svn export --quiet https://core.svn.wordpress.org/trunk $TMPDIR/wordpress-trunk/wordpress
+		mv $TMPDIR/wordpress-trunk/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
+		rm -rf $WP_TESTS_DIR/{includes,data}
+		svn export --quiet --ignore-externals https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes
+		svn export --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:__DIR__ . '/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
+
+}
+
+recreate_db() {
+	shopt -s nocasematch
+	if [[ $1 =~ ^(y|yes)$ ]]
+	then
+		mysqladmin drop $DB_NAME -f --user="$DB_USER" --password="$DB_PASS"$EXTRA
+		create_db
+		echo "Recreated the database ($DB_NAME)."
+	else
+		echo "Leaving the existing database ($DB_NAME) in place."
+	fi
+	shopt -u nocasematch
+}
+
+create_db() {
+	mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA
+}
+
+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
+	if [ $(mysql --user="$DB_USER" --password="$DB_PASS"$EXTRA --execute='show databases;' | grep ^$DB_NAME$) ]
+	then
+		echo "Reinstalling will delete the existing test database ($DB_NAME)"
+		read -p 'Are you sure you want to proceed? [y/N]: ' DELETE_EXISTING_DB
+		recreate_db $DELETE_EXISTING_DB
+	else
+		create_db
+	fi
+}
+
+install_wp
+install_test_suite
+install_db

bin/run-docker.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+set -eu
+
+##
+# Use this script through Composer scripts in the composer.json.
+# To quickly build a docker container for the test suite.
+##
+print_usage_instructions() {
+    echo "Usage: composer docker:build";
+    echo "";
+    echo "Example use:";
+    echo "  composer docker:build";
+    echo "";
+    echo "  WP_VERSION=5.9 composer docker:build";
+    exit 1
+}
+
+if [ $# -eq 0 ]; then
+    print_usage_instructions
+fi
+
+TAG=${TAG-latest}
+WP_VERSION=${WP_VERSION-latest}
+
+BUILD_NO_CACHE=${BUILD_NO_CACHE-}
+
+subcommand=$1; shift
+case "$subcommand" in
+    "build" )
+        while getopts ":c" opt; do
+            case ${opt} in
+                c )
+                    echo "Build without cache"
+                    BUILD_NO_CACHE=--no-cache
+                    ;;
+                \? ) print_usage_instructions;;
+                * ) print_usage_instructions;;
+            esac
+        done
+        docker build $BUILD_NO_CACHE \
+                    -t faustwp:${TAG}-wp-${WP_VERSION} \
+                    --build-arg WP_VERSION=${WP_VERSION} \
+                    ./.docker;
+        ;;
+    \? ) print_usage_instructions;;
+    * ) print_usage_instructions;;
+esac

composer.json

@@ -5,8 +5,11 @@
   "prefer-stable": true,
   "minimum-stability": "dev",
   "require-dev": {
+    "brain/monkey": "^2.6",
+    "php-parallel-lint/php-parallel-lint": "^1.3",
+    "phpunit/phpunit": "^9.5",
     "wpengine/wpengine-coding-standards": "dev-develop",
-    "php-parallel-lint/php-parallel-lint": "^1.3"
+    "yoast/phpunit-polyfills": "^1.0"
   },
   "scripts": {
     "lint": "parallel-lint -e php --no-colors --exclude vendor .",
@@ -23,5 +26,10 @@
     "allow-plugins": {
       "dealerdirect/phpcodesniffer-composer-installer": true
     }
+  },
+  "autoload-dev": {
+    "psr-4": {
+        "WPGraphQLContentBlocks\\Tests\\Unit\\": "tests/unit/"
+    }
   }
 }