Merge pull request #10 from WordPress-Phoenix/bhgc-1685-unit-test-out…

…-of-the-box

BHGC-1685: unit test out of the box

README.md

@@ -12,7 +12,7 @@ performance matters...) into the onecms-docker plugins dir.
 
 4. Go to Plugins.
 
-5. Network activate plugin.
+5. Activate the `WordPress Development Toolkit` plugin.
 
 6. Go back to https://wp.docker/wp-admin/.
 

app/boilerplates/simple/.circleci/config.yml

@@ -2,17 +2,36 @@ version: 2
 
 jobs:
   build:
+    environment:
+      WP_MULTISITE: 1
+      WP_TESTS_DIR: /tmp/wordpress-tests-lib
+      WP_CORE_DIR: /tmp/wordpress/
     docker:
       - image: circleci/php:7.1-node-browsers
+      - image: circleci/mysql:5.5.58
     working_directory: ~/repo
     steps:
       - checkout
+      - run: sudo apt-get update; sudo apt-get install mysql-client subversion
+      - run: sudo docker-php-ext-install mysqli
       - run: sudo chmod 777 -R ~
       - run: echo $PWD
+      - run: echo $WP_TESTS_DIR
+      - run: echo $WP_CORE_DIR
       - run: ls -lart
       - run: env COMPOSER=composer-test.json composer install --prefer-source --no-interaction
-      - run: sudo ./bin/phpcs --config-set installed_paths $(readlink -f vendor/wp-coding-standards/wpcs/)
+      - run: sudo ./bin/phpcs --config-set installed_paths vendor/wp-coding-standards/wpcs/
       - run: env COMPOSER=composer-test.json composer test
+      - run:
+          name: Installing Tests
+          command: |
+            rm -rf $WP_TESTS_DIR $WP_CORE_DIR
+            bash ./.circleci/install-wp-tests.sh wordpress_test root '' 127.0.0.1 latest
+      - run:
+          name: Running Tests
+          command: |
+            ./bin/phpunit --coverage-clover clover.xml --config ./.circleci/phpunit.xml
+            ./bin/coverage-check clover.xml 90
   notify:
     docker:
       - image: circleci/node:latest

app/boilerplates/simple/.circleci/install-wp-tests.sh

@@ -0,0 +1,152 @@
+#!/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]+$ ]]; 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-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 https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes
+		svn co --quiet 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

app/boilerplates/simple/.circleci/phpunit.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<phpunit
+        bootstrap="../tests/bootstrap.php"
+        backupGlobals="false"
+        colors="true"
+        convertErrorsToExceptions="true"
+        convertNoticesToExceptions="true"
+        convertWarningsToExceptions="true"
+        mapTestClassNameToCoveredClassName="true"
+        verbose="false"
+        stopOnIncomplete="true"
+>
+    <testsuites>
+        <testsuite>
+            <directory prefix="test-" suffix=".php">../tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">../app/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

app/boilerplates/simple/.gitignore

@@ -3,6 +3,7 @@
 
 # circle ci
 /lib/*/.circleci
+clover.xml
 
 # composer
 composer.phar

app/boilerplates/simple/app/admin/class-app.php

@@ -41,7 +41,7 @@ class App {
 	 * @param string $installed_url Installed URL.
 	 * @param string $version       Version.
 	 */
-	function __construct( $installed_dir, $installed_url, $version ) {
+	public function __construct( $installed_dir, $installed_url, $version ) {
 		$this->installed_dir = $installed_dir;
 		$this->installed_url = $installed_url;
 		$this->version       = $version;

app/boilerplates/simple/app/class-plugin.php

@@ -37,7 +37,6 @@ class Plugin extends Abstract_Plugin {
 	 */
 	protected static $current_file = __FILE__;
 
-
 	/**
 	 * Initialize the plugin - for public (front end)
 	 *
@@ -51,15 +50,18 @@ public function onload( $instance ) {
 
 	/**
 	 * Initialize public / shared functionality using new Class(), add_action() or add_filter().
+	 *
+	 * @return void
 	 */
 	public function init() {
 		do_action( static::$action_prefix . 'before_init' );
-
 		do_action( static::$action_prefix . 'after_init' );
 	}
 
 	/**
 	 * Initialize functionality only loaded for logged-in users.
+	 *
+	 * @return void
 	 */
 	public function authenticated_init() {
 		if ( is_user_logged_in() ) {
@@ -77,7 +79,7 @@ public function authenticated_init() {
 	/**
 	 * Defines and Globals.
 	 *
-	 * @return mixed|void
+	 * @return void
 	 */
 	protected function defines_and_globals() {
 	}

app/boilerplates/simple/composer-test.json

@@ -4,9 +4,13 @@
 	"vendor-dir": "vendor"
   },
   "require-dev": {
-	"wp-coding-standards/wpcs": "^0.10"
+	"wp-coding-standards/wpcs": "^0.10",
+	"rregeer/phpunit-coverage-check": "^0.1.6",
+	"phpunit/phpunit": "^6"
   },
   "scripts": {
-	"test": "./bin/phpcs --standard=./.circleci/codesniffer.ruleset.xml --extensions='php,css' ./"
+	"test": "./bin/phpcs --standard=./.circleci/codesniffer.ruleset.xml --extensions='php,css' ./",
+	"fix": "./bin/phpcbf --standard=./.circleci/codesniffer.ruleset.xml --extensions='php,js,css' --ignore=*/lib/* ./",
+	"phpunit": "./bin/phpunit --stop-on-error"
   }
 }