Skip to content

Commit e04666d

Browse files
SebKaySebKay
committed
Installed test scaffolding
1 parent 95716ad commit e04666d

File tree

6 files changed

+336
-0
lines changed

6 files changed

+336
-0
lines changed

‎.travis.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
sudo: false
2+
dist: trusty
3+
4+
language: php
5+
6+
notifications:
7+
email:
8+
on_success: never
9+
on_failure: change
10+
11+
branches:
12+
only:
13+
- master
14+
15+
cache:
16+
directories:
17+
- $HOME/.composer/cache
18+
19+
matrix:
20+
include:
21+
- php: 7.2
22+
env: WP_VERSION=latest
23+
- php: 7.1
24+
env: WP_VERSION=latest
25+
- php: 7.0
26+
env: WP_VERSION=latest
27+
- php: 5.6
28+
env: WP_VERSION=latest
29+
- php: 5.6
30+
env: WP_VERSION=trunk
31+
- php: 5.6
32+
env: WP_TRAVISCI=phpcs
33+
- php: 5.3
34+
env: WP_VERSION=latest
35+
dist: precise
36+
37+
before_script:
38+
- export PATH="$HOME/.composer/vendor/bin:$PATH"
39+
- |
40+
if [ -f ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini ]; then
41+
phpenv config-rm xdebug.ini
42+
else
43+
echo "xdebug.ini does not exist"
44+
fi
45+
- |
46+
if [[ ! -z "$WP_VERSION" ]] ; then
47+
bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
48+
composer global require "phpunit/phpunit=4.8.*|5.7.*"
49+
fi
50+
- |
51+
if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then
52+
composer global require wp-coding-standards/wpcs
53+
phpcs --config-set installed_paths $HOME/.composer/vendor/wp-coding-standards/wpcs
54+
fi
55+
56+
script:
57+
- |
58+
if [[ ! -z "$WP_VERSION" ]] ; then
59+
phpunit
60+
WP_MULTISITE=1 phpunit
61+
fi
62+
- |
63+
if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then
64+
phpcs
65+
fi

‎bin/install-wp-tests.sh‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
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]+\-(beta|RC)[0-9]+$ ]]; then
29+
WP_BRANCH=${WP_VERSION%\-*}
30+
WP_TESTS_TAG="branches/$WP_BRANCH"
31+
32+
elif [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+$ ]]; then
33+
WP_TESTS_TAG="branches/$WP_VERSION"
34+
elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
35+
if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
36+
# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
37+
WP_TESTS_TAG="tags/${WP_VERSION%??}"
38+
else
39+
WP_TESTS_TAG="tags/$WP_VERSION"
40+
fi
41+
elif [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
42+
WP_TESTS_TAG="trunk"
43+
else
44+
# http serves a single offer, whereas https serves multiple. we only want one
45+
download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
46+
grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json
47+
LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//')
48+
if [[ -z "$LATEST_VERSION" ]]; then
49+
echo "Latest WordPress version could not be found"
50+
exit 1
51+
fi
52+
WP_TESTS_TAG="tags/$LATEST_VERSION"
53+
fi
54+
set -ex
55+
56+
install_wp() {
57+
58+
if [ -d $WP_CORE_DIR ]; then
59+
return;
60+
fi
61+
62+
mkdir -p $WP_CORE_DIR
63+
64+
if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
65+
mkdir -p $TMPDIR/wordpress-nightly
66+
download https://wordpress.org/nightly-builds/wordpress-latest.zip $TMPDIR/wordpress-nightly/wordpress-nightly.zip
67+
unzip -q $TMPDIR/wordpress-nightly/wordpress-nightly.zip -d $TMPDIR/wordpress-nightly/
68+
mv $TMPDIR/wordpress-nightly/wordpress/* $WP_CORE_DIR
69+
else
70+
if [ $WP_VERSION == 'latest' ]; then
71+
local ARCHIVE_NAME='latest'
72+
elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+ ]]; then
73+
# https serves multiple offers, whereas http serves single.
74+
download https://api.wordpress.org/core/version-check/1.7/ $TMPDIR/wp-latest.json
75+
if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
76+
# version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x
77+
LATEST_VERSION=${WP_VERSION%??}
78+
else
79+
# otherwise, scan the releases and get the most up to date minor version of the major release
80+
local VERSION_ESCAPED=`echo $WP_VERSION | sed 's/\./\\\\./g'`
81+
LATEST_VERSION=$(grep -o '"version":"'$VERSION_ESCAPED'[^"]*' $TMPDIR/wp-latest.json | sed 's/"version":"//' | head -1)
82+
fi
83+
if [[ -z "$LATEST_VERSION" ]]; then
84+
local ARCHIVE_NAME="wordpress-$WP_VERSION"
85+
else
86+
local ARCHIVE_NAME="wordpress-$LATEST_VERSION"
87+
fi
88+
else
89+
local ARCHIVE_NAME="wordpress-$WP_VERSION"
90+
fi
91+
download https://wordpress.org/${ARCHIVE_NAME}.tar.gz $TMPDIR/wordpress.tar.gz
92+
tar --strip-components=1 -zxmf $TMPDIR/wordpress.tar.gz -C $WP_CORE_DIR
93+
fi
94+
95+
download https://raw.github.com/markoheijnen/wp-mysqli/master/db.php $WP_CORE_DIR/wp-content/db.php
96+
}
97+
98+
install_test_suite() {
99+
# portable in-place argument for both GNU sed and Mac OSX sed
100+
if [[ $(uname -s) == 'Darwin' ]]; then
101+
local ioption='-i.bak'
102+
else
103+
local ioption='-i'
104+
fi
105+
106+
# set up testing suite if it doesn't yet exist
107+
if [ ! -d $WP_TESTS_DIR ]; then
108+
# set up testing suite
109+
mkdir -p $WP_TESTS_DIR
110+
svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes
111+
svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/data/ $WP_TESTS_DIR/data
112+
fi
113+
114+
if [ ! -f wp-tests-config.php ]; then
115+
download https://develop.svn.wordpress.org/${WP_TESTS_TAG}/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php
116+
# remove all forward slashes in the end
117+
WP_CORE_DIR=$(echo $WP_CORE_DIR | sed "s:/\+$::")
118+
sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
119+
sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php
120+
sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php
121+
sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php
122+
sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php
123+
fi
124+
125+
}
126+
127+
install_db() {
128+
129+
if [ ${SKIP_DB_CREATE} = "true" ]; then
130+
return 0
131+
fi
132+
133+
# parse DB_HOST for port or socket references
134+
local PARTS=(${DB_HOST//\:/ })
135+
local DB_HOSTNAME=${PARTS[0]};
136+
local DB_SOCK_OR_PORT=${PARTS[1]};
137+
local EXTRA=""
138+
139+
if ! [ -z $DB_HOSTNAME ] ; then
140+
if [ $(echo $DB_SOCK_OR_PORT | grep -e '^[0-9]\{1,\}$') ]; then
141+
EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp"
142+
elif ! [ -z $DB_SOCK_OR_PORT ] ; then
143+
EXTRA=" --socket=$DB_SOCK_OR_PORT"
144+
elif ! [ -z $DB_HOSTNAME ] ; then
145+
EXTRA=" --host=$DB_HOSTNAME --protocol=tcp"
146+
fi
147+
fi
148+
149+
# create database
150+
mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA
151+
}
152+
153+
install_wp
154+
install_test_suite
155+
install_db

‎phpcs.xml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<?xml version="1.0"?>
2+
<ruleset name="WordPress Coding Standards based custom ruleset for your plugin">
3+
<description>Generally-applicable sniffs for WordPress plugins.</description>
4+
5+
<!-- What to scan -->
6+
<file>.</file>
7+
<exclude-pattern>/vendor/</exclude-pattern>
8+
<exclude-pattern>/node_modules/</exclude-pattern>
9+
10+
<!-- How to scan -->
11+
<!-- Usage instructions: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage -->
12+
<!-- Annotated ruleset: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
13+
<arg value="sp"/> <!-- Show sniff and progress -->
14+
<arg name="basepath" value="./"/><!-- Strip the file paths down to the relevant bit -->
15+
<arg name="colors"/>
16+
<arg name="extensions" value="php"/>
17+
<arg name="parallel" value="8"/><!-- Enables parallel processing when available for faster results. -->
18+
19+
<!-- Rules: Check PHP version compatibility -->
20+
<!-- https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
21+
<config name="testVersion" value="5.3-"/>
22+
<!-- https://github.com/PHPCompatibility/PHPCompatibilityWP -->
23+
<rule ref="PHPCompatibilityWP"/>
24+
25+
<!-- Rules: WordPress Coding Standards -->
26+
<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards -->
27+
<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties -->
28+
<config name="minimum_supported_wp_version" value="4.6"/>
29+
<rule ref="WordPress">
30+
<exclude name="WordPress.VIP"/>
31+
</rule>
32+
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
33+
<properties>
34+
<!-- Value: replace the function, class, and variable prefixes used. Separate multiple prefixes with a comma. -->
35+
<property name="prefixes" type="array" value="my-plugin"/>
36+
</properties>
37+
</rule>
38+
<rule ref="WordPress.WP.I18n">
39+
<properties>
40+
<!-- Value: replace the text domain used. -->
41+
<property name="text_domain" type="array" value="my-plugin"/>
42+
</properties>
43+
</rule>
44+
<rule ref="WordPress.WhiteSpace.ControlStructureSpacing">
45+
<properties>
46+
<property name="blank_line_check" value="true"/>
47+
</properties>
48+
</rule>
49+
</ruleset>

‎phpunit.xml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
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+
>
10+
<testsuites>
11+
<testsuite>
12+
<directory prefix="test-" suffix=".php">./tests/</directory>
13+
<exclude>./tests/test-sample.php</exclude>
14+
</testsuite>
15+
</testsuites>
16+
</phpunit>

‎tests/bootstrap.php‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
/**
3+
* PHPUnit bootstrap file
4+
*
5+
* @package Wordpress_Plugin_Template
6+
*/
7+
8+
$_tests_dir = getenv( 'WP_TESTS_DIR' );
9+
10+
if ( ! $_tests_dir ) {
11+
$_tests_dir = rtrim( sys_get_temp_dir(), '/\\' ) . '/wordpress-tests-lib';
12+
}
13+
14+
if ( ! file_exists( $_tests_dir . '/includes/functions.php' ) ) {
15+
echo "Could not find $_tests_dir/includes/functions.php, have you run bin/install-wp-tests.sh ?" . PHP_EOL; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
16+
exit( 1 );
17+
}
18+
19+
// Give access to tests_add_filter() function.
20+
require_once $_tests_dir . '/includes/functions.php';
21+
22+
/**
23+
* Manually load the plugin being tested.
24+
*/
25+
function _manually_load_plugin() {
26+
require dirname( dirname( __FILE__ ) ) . '/wordpress-plugin-template.php';
27+
}
28+
tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' );
29+
30+
// Start up the WP testing environment.
31+
require $_tests_dir . '/includes/bootstrap.php';

‎tests/test-sample.php‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
/**
3+
* Class SampleTest
4+
*
5+
* @package Wordpress_Plugin_Template
6+
*/
7+
8+
/**
9+
* Sample test case.
10+
*/
11+
class SampleTest extends WP_UnitTestCase {
12+
13+
/**
14+
* A single example test.
15+
*/
16+
public function test_sample() {
17+
// Replace this with some actual testing code.
18+
$this->assertTrue( true );
19+
}
20+
}

0 commit comments

Comments
 (0)