ekandreas/testrunner

WordPress Plugin Test Helper with Docker

, _(*1)

*** WORK IN PROGRESS ***, _(*2)

When you develop a plugin for WordPress it's important to also build test cases and use them continuous., _(*3)

This package is a helper to run tests within your plugin folder but use Docker as a testing instance and report generator., _(*4)

The testsuite should be placed within a plugin that's going to be tested., _(*5)

root
│   wp-admin
└───wp-content
    ├───plugins
    │   ├───your-plugin <- install with composer require ekandreas/testrunner:*
    │   │   ...

Note! First time is going to take a long time due to creating images and installing wordpress-develop folder, etc., _(*6)

To continuously run tests to a plugin use the partitial test command:, _(*7)

dep tests:run

Requirements

• Docker-machine with VirtualBox
• PHP Composer

Setup

Install this lib with composer, eg:, _(*8)

composer require ekandreas/testrunner:dev-master

Now create a deployment file in root of your plugin, eg:, _(*9)

<!-- deploy.php -->
date_default_timezone_set('Europe/Stockholm');
include_once 'vendor/ekandreas/testrunner/recipe.php';

You can now enjoy tests with docker with the following deployment command:, _(*10)

vendor/bin/dep tests

This is only the first time, aprox 10 min first time., _(*11)

And with continuous tests:, _(*12)

vendor/bin/dep tests:run

Only seconds to a test report., _(*13)

Deploy file example

<?php
date_default_timezone_set('Europe/Stockholm');

include_once 'vendor/ekandreas/testrunner/recipe.php';

set( 'docker_host_name', 'tests');

Complete run

vendor/bin/dep tests

Partitial run

Booting up Docker and make installation

dep tests:up

Rebuild Docker container images

dep tests:rebuild

Running just the tests (after tests:up)

dep tests:run

Stop the tests

This will kill the containers, _(*14)

dep tests:stop

Killing Docker machine

This will kill the virtual test machine, _(*15)

dep tests:kill

Recipe parameters, options

If you don't want to use the default docker-machine, define your own, eg:, _(*16)

<!-- deploy.php -->
date_default_timezone_set('Europe/Stockholm');
include_once 'vendor/ekandreas/testrunner/recipe.php';
set( 'docker_host_name', 'tests');

If you don't have a docker machine setup then the deploy script will try to create it for you. Virtualbox as default., _(*17)

TODO

• Just one single command dep tests to check and startup mysql and install if missing.