Skip to content

Commit 83e7d55

Browse files
athlanathlan
authored
Feature/phpunit tests (#8)
* Unit tests added. * Travis added * Add Travis CI badge
1 parent 7f7faa7 commit 83e7d55

File tree

10 files changed

+473
-0
lines changed

10 files changed

+473
-0
lines changed

‎.travis.yml‎

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

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Plugin allows to use post's custom fields values in permalink structure by adding %field_fieldname%, for posts, pages and custom post types.
44

5+
![Build Status](https://travis-ci.org/athlan/wordpress-custom-fields-permalink-plugin.svg?branch=master)
6+
57
---
68

79
* Contributors: <a href="https://github.com/athlan">athlan</a>

‎bin/install-wp-tests.sh‎

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

‎phpunit.xml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?xml version="1.0"?>
2+
<phpunit
3+
bootstrap="test/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="" suffix=".php">./test/suites/</directory>
13+
</testsuite>
14+
</testsuites>
15+
</phpunit>

‎test/PermalinkAsserter.php‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
class PermalinkAsserter
4+
{
5+
private $unitTestCase;
6+
7+
public function __construct(WP_UnitTestCase $unitTestCase) {
8+
$this->unitTestCase = $unitTestCase;
9+
}
10+
11+
public function hasPermalink($post, $permalink) {
12+
$actual = wp_make_link_relative(get_the_permalink($post));
13+
14+
$this->unitTestCase->assertEquals($permalink, $actual);
15+
}
16+
}

‎test/PermalinkSteps.php‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
class PermalinkSteps
4+
{
5+
public function __construct() {
6+
}
7+
8+
public function givenPermalinkStructure($structure) {
9+
global $wp_rewrite;
10+
11+
$wp_rewrite->init();
12+
$wp_rewrite->set_permalink_structure($structure);
13+
$wp_rewrite->flush_rules();
14+
}
15+
16+
public function givenPostnamePermalinkStructure() {
17+
$this->givenPermalinkStructure("/%postname%/");
18+
}
19+
}

‎test/bootstrap.php‎

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

‎test/suites/BasicPostNamePermalinkStructure/BasicPostNamePermalinkStructure.php‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<?php
2+
3+
class BasicPostNamePermalinkStructure extends WP_UnitTestCase {
4+
5+
/**
6+
* @var PermalinkSteps
7+
*/
8+
private $permalinkSteps;
9+
10+
/**
11+
* @var PermalinkAsserter
12+
*/
13+
private $permalinkAsserter;
14+
15+
public function setUp() {
16+
parent::setUp();
17+
18+
$this->permalinkSteps = new PermalinkSteps($this);
19+
$this->permalinkAsserter = new PermalinkAsserter($this);
20+
}
21+
22+
function test_generates_permalink_to_post() {
23+
// given
24+
$this->permalinkSteps->givenPostnamePermalinkStructure();
25+
26+
$postParams = [
27+
'post_title' => 'Some post title',
28+
'meta_input' => [
29+
'some_meta_key' => 'Some meta value',
30+
],
31+
];
32+
$createdPostId = $this->factory()->post->create($postParams);
33+
34+
// when & then
35+
$this->permalinkAsserter->hasPermalink($createdPostId, "/some-post-title/");
36+
}
37+
38+
function test_go_to_post_when_simple_postname_permalink_structure_and_plugin_activated() {
39+
// given
40+
$this->permalinkSteps->givenPostnamePermalinkStructure();
41+
42+
$postParams = [
43+
'post_title' => 'Some post title',
44+
'meta_input' => [
45+
'some_meta_key' => 'Some meta value',
46+
],
47+
];
48+
$createdPostId = $this->factory()->post->create($postParams);
49+
50+
// when
51+
$this->go_to('/some-post-title/');
52+
53+
// then
54+
$this->assertFalse(is_404());
55+
$this->assertEquals($createdPostId, get_the_ID());
56+
}
57+
}

0 commit comments

Comments
 (0)