Skip to content

Commit

Permalink
Closes #3 and add unit test.
Browse files Browse the repository at this point in the history
  • Loading branch information
fumikito committed Feb 6, 2020
1 parent 9a3fd39 commit cac287b
Show file tree
Hide file tree
Showing 9 changed files with 289 additions and 12 deletions.
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
tests/ export-ignore
bin/ export-ignore
.travis.yml export-ignore
16 changes: 8 additions & 8 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,19 @@ php:
- '7.1'
- '7.2'
- '7.3'
services: mysql
env:
matrix:
- WP_VERSION=latest
- WP_VERSION=5.0
before_script:
- composer install
- bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
script:
- composer test
before_deploy:
- echo 'Making deploy packages...'
- rm -rfv .git
- rm -rfv bin
- rm -rfv tests
- rm -rfv .gitignore
- rm -rfv .travis.yml
- rm -rfv vendor
- rm -rfv composer.lock
- rm -rfv phpunit.xml.dist
- bash bin/cleanup.sh
- zip -r wp-block-creator.zip ./
deploy:
provider: releases
Expand All @@ -38,3 +37,4 @@ deploy:
repo: hametuha/wp-block-creator
tags: true
php: '7.0'
condition: $WP_VERSION = latest
13 changes: 13 additions & 0 deletions bin/cleanup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/usr/bin/env bash

set -e

# Remove unwanted files.
rm -rf .git
rm -rf .gitignore
rm -rf .travis.yml
rm -rf bin
rm -rf vendor
rm -rf tests
rm -rf composer.lock
rm -rf phpunit.xml.dist
155 changes: 155 additions & 0 deletions bin/install-wp-tests.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
#!/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}
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-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 --ignore-externals https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes
svn co --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/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
9 changes: 7 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"minimum-stability": "stable",
"require": {
"php": "^5.6|^7.0",
"hametuha/singleton-pattern": "^1.0",
"hametuha/singleton-pattern": "^1.1",
"hametuha/string-utility": "^1.1",
"hametuha/wp-enqueue-manager": "^1.0"
"hametuha/wp-enqueue-manager": "^1.1"
},
"require-dev": {
"phpunit/phpunit": "^5.7"
Expand All @@ -26,5 +26,10 @@
"psr-0": {
"Hametuha\\WpBlockCreator": "src"
}
},
"autoload-dev": {
"psr-0": {
"Hametuha\\WpBlockCreatorTest": "tests/src"
}
}
}
28 changes: 28 additions & 0 deletions src/Hametuha/WpBlockCreator/Pattern/AbstractBlock.php
Original file line number Diff line number Diff line change
Expand Up @@ -141,4 +141,32 @@ protected function get_block_name() {
protected function is_rest() {
return defined( 'REST_REQUEST' ) && REST_REQUEST;
}

/**
* Get warning comment for dynamic block.
*
* @param string $label Label string for comment header.
* @param string $desc Description in commnet body
* @param string $icon Default warning. Use dashicons icon name.
*
* @return string
*/
protected function get_placeholder_for_editor( $label = '', $desc = '', $icon = 'warning' ) {
$label = (string) $label;
$desc = (string) $desc;
if ( $label ) {
$label = sprintf(
'<div class="components-placeholder__label"><span class="dashicons dashicons-%s"></span>%s</div>',
esc_attr( $icon ),
esc_html( $label )
);
}
if ( $desc ) {
$desc = sprintf(
'<div class="components-placeholder__fieldset"><p>%s</p></div>',
esc_html( $desc )
);
}
return sprintf( '<div class="components-placeholder">%s%s</div>', $label, $desc );
}
}
27 changes: 25 additions & 2 deletions tests/bootstrap.php
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
<?php
// Include autoloader.
require_once dirname( __DIR__ ) . '/vendor/autoload.php';
/**
* PHPUnit bootstrap file
*
* @package wp-block-creator
*/

$_tests_dir = getenv( 'WP_TESTS_DIR' );
if ( ! $_tests_dir ) {
$_tests_dir = sys_get_temp_dir() . '/wordpress-tests';
}

// Give access to tests_add_filter() function.
require_once $_tests_dir . '/includes/functions.php';

/**
* Manually load the plugin being tested.
*/
function _manually_load_plugin() {
require dirname( __DIR__ ) . '/vendor/autoload.php';
}

tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' );

// Start up the WP testing environment.
require $_tests_dir . '/includes/bootstrap.php';
21 changes: 21 additions & 0 deletions tests/src/Hametuha/WpBlockCreatorTest/ConditionalMethodBlock.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

namespace Hametuha\WpBlockCreatorTest;


use Hametuha\WpBlockCreator\Pattern\AbstractBlock;

class ConditionalMethodBlock extends AbstractBlock {

protected function get_script() {
return '';
}

public function test_is_rest() {
return $this->is_rest();
}

public function test_placeholder( $label, $desc ) {
return $this->get_placeholder_for_editor( $label, $desc );
}
}
29 changes: 29 additions & 0 deletions tests/test-protected.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

class WpBlockCreatorProtectedTest extends WP_UnitTestCase {

/**
* @var \Hametuha\WpBlockCreatorTest\ConditionalMethodBlock
*/
protected $block = null;

function setUp() {
$this->block = \Hametuha\WpBlockCreatorTest\ConditionalMethodBlock::get_instance();
parent::setUp();
}


public function test_rest() {
$this->assertFalse( $this->block->test_is_rest() );

$expected = <<<HTML
<div class="components-placeholder">
<div class="components-placeholder__label"><span class="dashicons dashicons-warning"></span>aaa</div>
<div class="components-placeholder__fieldset"><p>bbb</p></div>
</div>
HTML;

$actual = $this->block->test_placeholder( 'aaa', 'bbb' );
$this->assertXmlStringEqualsXmlString( $expected, $actual );
}
}

0 comments on commit cac287b

Please sign in to comment.