WordPressのプラグインを開発する際も、テストコードを書くことで思わぬバグの発生を防ぐことができるが、PHPUnitのテスト環境を作成するのが結構面倒。今回は、MacでLocal（旧Local by Flywheel）を使ってWordPress開発している環境でどのようにPHPUnit用のWordPressを作成したかの覚書。
以前にMAMPでの環境作りの記事を書いたが、テストを使う側に関してはMAMPでもLocalでも共通なので、プラグイン側の設定はこちらを参考に。
前提条件・用語解説
| 用語 | 説明 |
|---|---|
| テスト用 WordPress 本体 | テストスイートで利用する WordPress コア。WP_CORE_DIR で指定。 |
WordPress PHPUnit テストスイート (wp-tests) | tests/phpunit 配下のテスト実行に必要なファイル群。WP_TESTS_DIR で指定。 |
| テストスイート | 上記 2 つ（WordPress 本体 + wp-tests）の総称。 |
| Local (旧 Local by Flywheel) | macOS 向けのローカル WordPress 開発環境。 |
事前準備
- WP CLI, subversion, curl, wgetをインストールしておく
テスト用WordPress 本体をLocalで作成する
テストスイートをセットアップ
サンプルプラグインのスカフォールドを作成すると、./bin/install-wp-tests.shにインストールスクリプトが作成されるのでそれを使って、テストスイートをセットアップする。
テストスイートとは、通常のWordPressコアに、テスト関連のファイル（PHPUnit）を読み込んで実行するWordPress環境。
インストールスクリプトをLocalに合わせてWPディレクトリと、MySQLのデータベース名、ユーザー名とパスワード、ホスト名とソケットパスを修正する。
# インストールしたテスト用 WordPress 本体とテストスイートの配置先ディレクトリを指定
export WP_CORE_DIR="/Users/ship/Sites/wp-test-suit/app/public"
export WP_TESTS_DIR="/Users/ship/Sites/wp-test-suit/app/public/wptest-tests"
# データベース情報（テスト用 DB はLocalによって作成されたものを使用）
DB_NAME=${1-local}
DB_USER=${2-root}
DB_PASS=${3-root}
# テストスイートのDatabaseタブに表示されるSocket情報に書き換える
DB_HOST=${4-localhost:/Users/ship/Library/Application Support/Local/run/hrU9p8IBw/mysql/mysqld.sock
WP_VERSION=${5-latest}
# DB 作成はスキップ（すでにLocalで作成したものがあるので）
SKIP_DB_CREATE=${6-true}テストスイート用WordPressのSite shellを開き、サイトを起動させた状態で、インストールスクリプトを実行
% /Users/ship/Sites/lcdev/app/public/wp-content/plugins/lineconnect/bin/install-wp-tests.sh実行すると、テストスイート用WPのサイトディレクトリ内、public/ 以下に「wptest-tests/」ができる。このフルパスをWP_TESTS_DIR環境変数に入れておくことで、テスト実行時にこのテストスイートが使用される。
% export WP_TESTS_DIR=/Users/ship/Sites/wp-test-suit/app/public/wptest-testsこれでテスト実行時に使われるWordPressの用意ができた。テストの実行方法などは下記のMAMPでテスト環境を作成した時と同じなのでそちらを参照してほしい。
インストールスクリプト全文
#!/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
export WP_CORE_DIR="/Users/ship/Sites/wp-test-suit/app/public"
export WP_TESTS_DIR="/Users/ship/Sites/wp-test-suit/app/public/wptest-tests"
DB_NAME=${1-local}
DB_USER=${2-root}
DB_PASS=${3-root}
DB_HOST=${4-localhost:/Users/ship/Library/Application Support/Local/run/Q7xi0yX2k/mysql/mysqld.sock}
WP_VERSION=${5-latest}
SKIP_DB_CREATE=${6-true}
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.githubusercontent.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
Comments