Skip to content

Commit 45ada5f

Browse files
author
Ming
authored
Merge pull request #10 from WordPress-Phoenix/bhgc-1685-unit-test-out-of-the-box
BHGC-1685: unit test out of the box
2 parents 86b535b + e721205 commit 45ada5f

File tree

13 files changed

+2042
-9
lines changed

13 files changed

+2042
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ performance matters...) into the onecms-docker plugins dir.
1212

1313
4. Go to Plugins.
1414

15-
5. Network activate plugin.
15+
5. Activate the `WordPress Development Toolkit` plugin.
1616

1717
6. Go back to https://wp.docker/wp-admin/.
1818

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,36 @@ version: 2
22

33
jobs:
44
build:
5+
environment:
6+
WP_MULTISITE: 1
7+
WP_TESTS_DIR: /tmp/wordpress-tests-lib
8+
WP_CORE_DIR: /tmp/wordpress/
59
docker:
610
- image: circleci/php:7.1-node-browsers
11+
- image: circleci/mysql:5.5.58
712
working_directory: ~/repo
813
steps:
914
- checkout
15+
- run: sudo apt-get update; sudo apt-get install mysql-client subversion
16+
- run: sudo docker-php-ext-install mysqli
1017
- run: sudo chmod 777 -R ~
1118
- run: echo $PWD
19+
- run: echo $WP_TESTS_DIR
20+
- run: echo $WP_CORE_DIR
1221
- run: ls -lart
1322
- run: env COMPOSER=composer-test.json composer install --prefer-source --no-interaction
14-
- run: sudo ./bin/phpcs --config-set installed_paths $(readlink -f vendor/wp-coding-standards/wpcs/)
23+
- run: sudo ./bin/phpcs --config-set installed_paths vendor/wp-coding-standards/wpcs/
1524
- run: env COMPOSER=composer-test.json composer test
25+
- run:
26+
name: Installing Tests
27+
command: |
28+
rm -rf $WP_TESTS_DIR $WP_CORE_DIR
29+
bash ./.circleci/install-wp-tests.sh wordpress_test root '' 127.0.0.1 latest
30+
- run:
31+
name: Running Tests
32+
command: |
33+
./bin/phpunit --coverage-clover clover.xml --config ./.circleci/phpunit.xml
34+
./bin/coverage-check clover.xml 90
1635
notify:
1736
docker:
1837
- image: circleci/node:latest
Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
#!/usr/bin/env bash
2+
3+
if [ $# -lt 3 ]; then
4+
echo "usage: $0 <db-name> <db-user> <db-pass> [db-host] [wp-version] [skip-database-creation]"
5+
exit 1
6+
fi
7+
8+
DB_NAME=$1
9+
DB_USER=$2
10+
DB_PASS=$3
11+
DB_HOST=${4-localhost}
12+
WP_VERSION=${5-latest}
13+
SKIP_DB_CREATE=${6-false}
14+
15+
TMPDIR=${TMPDIR-/tmp}
16+
TMPDIR=$(echo $TMPDIR | sed -e "s/\/$//")
17+
WP_TESTS_DIR=${WP_TESTS_DIR-$TMPDIR/wordpress-tests-lib}
18+
WP_CORE_DIR=${WP_CORE_DIR-$TMPDIR/wordpress/}
19+
20+
download() {
21+
if [ `which curl` ]; then
22+
curl -s "$1" > "$2";
23+
elif [ `which wget` ]; then
24+
wget -nv -O "$2" "$1"
25+
fi
26+
}
27+
28+
if [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+$ ]]; then
29+
WP_TESTS_TAG="branches/$WP_VERSION"
30+
elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
31+
if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
32+
# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
33+
WP_TESTS_TAG="tags/${WP_VERSION%??}"
34+
else
35+
WP_TESTS_TAG="tags/$WP_VERSION"
36+
fi
37+
elif [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
38+
WP_TESTS_TAG="trunk"
39+
else
40+
# http serves a single offer, whereas https serves multiple. we only want one
41+
download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
42+
grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json
43+
LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//')
44+
if [[ -z "$LATEST_VERSION" ]]; then
45+
echo "Latest WordPress version could not be found"
46+
exit 1
47+
fi
48+
WP_TESTS_TAG="tags/$LATEST_VERSION"
49+
fi
50+
51+
set -ex
52+
53+
install_wp() {
54+
55+
if [ -d $WP_CORE_DIR ]; then
56+
return;
57+
fi
58+
59+
mkdir -p $WP_CORE_DIR
60+
61+
if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
62+
mkdir -p $TMPDIR/wordpress-nightly
63+
download https://wordpress.org/nightly-builds/wordpress-latest.zip $TMPDIR/wordpress-nightly/wordpress-nightly.zip
64+
unzip -q $TMPDIR/wordpress-nightly/wordpress-nightly.zip -d $TMPDIR/wordpress-nightly/
65+
mv $TMPDIR/wordpress-nightly/wordpress/* $WP_CORE_DIR
66+
else
67+
if [ $WP_VERSION == 'latest' ]; then
68+
local ARCHIVE_NAME='latest'
69+
elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+ ]]; then
70+
# https serves multiple offers, whereas http serves single.
71+
download https://api.wordpress.org/core/version-check/1.7/ $TMPDIR/wp-latest.json
72+
if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
73+
# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
74+
LATEST_VERSION=${WP_VERSION%??}
75+
else
76+
# otherwise, scan the releases and get the most up to date minor version of the major release
77+
local VERSION_ESCAPED=`echo $WP_VERSION | sed 's/\./\\\\./g'`
78+
LATEST_VERSION=$(grep -o '"version":"'$VERSION_ESCAPED'[^"]*' $TMPDIR/wp-latest.json | sed 's/"version":"//' | head -1)
79+
fi
80+
if [[ -z "$LATEST_VERSION" ]]; then
81+
local ARCHIVE_NAME="wordpress-$WP_VERSION"
82+
else
83+
local ARCHIVE_NAME="wordpress-$LATEST_VERSION"
84+
fi
85+
else
86+
local ARCHIVE_NAME="wordpress-$WP_VERSION"
87+
fi
88+
download https://wordpress.org/${ARCHIVE_NAME}.tar.gz $TMPDIR/wordpress.tar.gz
89+
tar --strip-components=1 -zxmf $TMPDIR/wordpress.tar.gz -C $WP_CORE_DIR
90+
fi
91+
92+
download https://raw.github.com/markoheijnen/wp-mysqli/master/db.php $WP_CORE_DIR/wp-content/db.php
93+
}
94+
95+
install_test_suite() {
96+
# portable in-place argument for both GNU sed and Mac OSX sed
97+
if [[ $(uname -s) == 'Darwin' ]]; then
98+
local ioption='-i .bak'
99+
else
100+
local ioption='-i'
101+
fi
102+
103+
# set up testing suite if it doesn't yet exist
104+
if [ ! -d $WP_TESTS_DIR ]; then
105+
# set up testing suite
106+
mkdir -p $WP_TESTS_DIR
107+
svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes
108+
svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/data/ $WP_TESTS_DIR/data
109+
fi
110+
111+
if [ ! -f wp-tests-config.php ]; then
112+
download https://develop.svn.wordpress.org/${WP_TESTS_TAG}/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php
113+
# remove all forward slashes in the end
114+
WP_CORE_DIR=$(echo $WP_CORE_DIR | sed "s:/\+$::")
115+
sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
116+
sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php
117+
sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php
118+
sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php
119+
sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php
120+
fi
121+
122+
}
123+
124+
install_db() {
125+
126+
if [ ${SKIP_DB_CREATE} = "true" ]; then
127+
return 0
128+
fi
129+
130+
# parse DB_HOST for port or socket references
131+
local PARTS=(${DB_HOST//\:/ })
132+
local DB_HOSTNAME=${PARTS[0]};
133+
local DB_SOCK_OR_PORT=${PARTS[1]};
134+
local EXTRA=""
135+
136+
if ! [ -z $DB_HOSTNAME ] ; then
137+
if [ $(echo $DB_SOCK_OR_PORT | grep -e '^[0-9]\{1,\}$') ]; then
138+
EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp"
139+
elif ! [ -z $DB_SOCK_OR_PORT ] ; then
140+
EXTRA=" --socket=$DB_SOCK_OR_PORT"
141+
elif ! [ -z $DB_HOSTNAME ] ; then
142+
EXTRA=" --host=$DB_HOSTNAME --protocol=tcp"
143+
fi
144+
fi
145+
146+
# create database
147+
mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA
148+
}
149+
150+
install_wp
151+
install_test_suite
152+
install_db
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?xml version="1.0"?>
2+
<phpunit
3+
bootstrap="../tests/bootstrap.php"
4+
backupGlobals="false"
5+
colors="true"
6+
convertErrorsToExceptions="true"
7+
convertNoticesToExceptions="true"
8+
convertWarningsToExceptions="true"
9+
mapTestClassNameToCoveredClassName="true"
10+
verbose="false"
11+
stopOnIncomplete="true"
12+
>
13+
<testsuites>
14+
<testsuite>
15+
<directory prefix="test-" suffix=".php">../tests/</directory>
16+
</testsuite>
17+
</testsuites>
18+
<filter>
19+
<whitelist processUncoveredFilesFromWhitelist="true">
20+
<directory suffix=".php">../app/</directory>
21+
</whitelist>
22+
</filter>
23+
</phpunit>

app/boilerplates/simple/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
# circle ci
55
/lib/*/.circleci
6+
clover.xml
67

78
# composer
89
composer.phar

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class App {
4141
* @param string $installed_url Installed URL.
4242
* @param string $version Version.
4343
*/
44-
function __construct( $installed_dir, $installed_url, $version ) {
44+
public function __construct( $installed_dir, $installed_url, $version ) {
4545
$this->installed_dir = $installed_dir;
4646
$this->installed_url = $installed_url;
4747
$this->version = $version;

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ class Plugin extends Abstract_Plugin {
3737
*/
3838
protected static $current_file = __FILE__;
3939

40-
4140
/**
4241
* Initialize the plugin - for public (front end)
4342
*
@@ -51,15 +50,18 @@ public function onload( $instance ) {
5150

5251
/**
5352
* Initialize public / shared functionality using new Class(), add_action() or add_filter().
53+
*
54+
* @return void
5455
*/
5556
public function init() {
5657
do_action( static::$action_prefix . 'before_init' );
57-
5858
do_action( static::$action_prefix . 'after_init' );
5959
}
6060

6161
/**
6262
* Initialize functionality only loaded for logged-in users.
63+
*
64+
* @return void
6365
*/
6466
public function authenticated_init() {
6567
if ( is_user_logged_in() ) {
@@ -77,7 +79,7 @@ public function authenticated_init() {
7779
/**
7880
* Defines and Globals.
7981
*
80-
* @return mixed|void
82+
* @return void
8183
*/
8284
protected function defines_and_globals() {
8385
}

app/boilerplates/simple/composer-test.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
44
"vendor-dir": "vendor"
55
},
66
"require-dev": {
7-
"wp-coding-standards/wpcs": "^0.10"
7+
"wp-coding-standards/wpcs": "^0.10",
8+
"rregeer/phpunit-coverage-check": "^0.1.6",
9+
"phpunit/phpunit": "^6"
810
},
911
"scripts": {
10-
"test": "./bin/phpcs --standard=./.circleci/codesniffer.ruleset.xml --extensions='php,css' ./"
12+
"test": "./bin/phpcs --standard=./.circleci/codesniffer.ruleset.xml --extensions='php,css' ./",
13+
"fix": "./bin/phpcbf --standard=./.circleci/codesniffer.ruleset.xml --extensions='php,js,css' --ignore=*/lib/* ./",
14+
"phpunit": "./bin/phpunit --stop-on-error"
1115
}
1216
}

0 commit comments

Comments
 (0)