Very briefly explained, Unit Testing is writing code to test “units” of other code, so that tests can be re-run at any time to determine whether or not code has been “broken” (vs. manually testing applications, which is lengthy and potentially unreliable). The word “unit” is used to mean anything that provides a clearly defined API, such as a PHP class or function.

DokuWiki's unit tests are located in the _test directory of a git checkout. They are not included in the regular releases.

We use the PHPUnit test framework for PHP. This page guides you through preparing your test environment, running tests and writing your own tests.

• PHPUnit 3.6.10+ http://www.phpunit.de/
• PHP 5.3+ http://www.php.net

Download the current phar from https://phpunit.de/ and make it executable. Eg:

$> cd dokuwiki/_test
$> wget https://phar.phpunit.de/phpunit.phar -O phpunit
$> chmod u+x phpunit

Running the test suite is simple, here's how.

Just change to the _test directory and run phpunit:

cd _test/
phpunit

PHPUnit will fail on some systems with a headers already sent error. This is a known problem with PHPUnit, the error can be avoided by passing the '–stderr' flag to phpunit:

phpunit --stderr

Tests can be assigned to a group by mentioning the group name in the comment header. It is also possible to assign a file to multiple groups. Here is an example:

<?php
/**
 * Tests to ensure creole syntax is correctly processed
 * and creates expected XHTML output
 *
 * @group plugin_creole
 * @group plugins
 */
class plugin_creole_test extends DokuWikiTest {
...
}

This assigns the tests to the groups plugin_creole and plugins.

Group names can be used to only run certain test groups or to exclude them from a test run. The following example only runs the tests for all plugins by using the option –group:

phpunit --stderr --group plugins

To exclude certain test from running use the option –exclude-group. For example use the following command to avoid long running test or tests accessing the Internet:

phpunit --stderr --exclude-group slow,internet

Test Test

You can run a single test file by providing it as an argument to phpunit:

phpunit --stderr tests/inc/common_cleanText.test.php

PHPUnit makes writing new tests as painless as possible. In general it means writing a fairly simple PHP class and placing it in the right directory with the right file name. Once that's done, the test can immediately be executed as explained above.

For a general overview on how to write unit tests refer to the PHPUnit manual and the existing tests, our DokuWiki specific parts are described below.

Tests are placed somewhere below the ./_test/tests/ directory. Generally it's recommended this directory structure follow that of the DokuWiki code it is testing i.e. tests for ./feed.php go directly under ./_test/tests while tests for ./inc/auth/plain.php would go under ./_test/tests/inc/auth.

All tests need to end in .test.php to be found automatically by the test suite. For DokuWiki code files that contain many unrelated or complex functions you may want to create multiple test files. Eg. rather than having a single _test/tests/inc/common.test.php, having files like _test/tests/inc/common_clientip.test.php and _test/tests/inc/common_obfuscate.test.php is recommended.

Each test file has to contain one or more¹⁾ classes inheriting from DokuWikiTest. This class can have multiple test functions, each named with a test_. Inside these functions your assertion can be written.

Our testsuite runs a setUpBeforeClass() method on instantiating each test class which will:

• setup a minimal data directory (copied from _test/data) in the system's TEMP directory
• create a custom config directory in the system's TEMP directory
  • with default configs
  • some overrides from _test/conf
• rerun DokuWiki initialization

This setup won't load any plug-ins. If you need to enable a plug-in you can override the DokuWikiTest::$pluginsEnabled array and provide the plugin names to load.

Additionally the test suite runs a setUp() method before every test. It does:

• reload the dokuwiki config
• reload the plugin controller and plug-ins
• reload the event handler
• ensure existing of some files (see init_files())
• ensure dokuwiki paths (see init_path())
• reload global variables like $_SERVER

There is no real process isolation between all tests, each test class should have a pretty clean DokuWiki environment to work on. This also includes DokuWiki's autoloader mechanism, so there should be no need to require_once any files yourself.

Unit tests should test minimal code parts (units) whenever possible. But with a complex application like DokuWiki this isn't always possible. This is why our test suite allows to run simple integration tests as well using a fake request.

Using this mechanism a HTTP request is faked and the resulting HTML output can be inspected. This also allows for testing plugin events.

The TestRequest class is used to run a request. A request contains three steps:

1. Initialization
2. Prepare request
3. send request

The initialization is done by:

$request = new TestRequest();

Once it's initialized you can prepare the request. The preparation can be register event hooks or setting request variables.

The request variables are set via setter methods and look like:

Finally you have to execute the request. This can be done by calling the $request->execute('someurl') method. The return value of the execute method is the html content rendered by DokuWiki.

Additionally there are two methods for POST and GET calls. They may be shorter then using the setter methods.

// a get request
$request->get(array('id' => 'start'), '/doku.php');
// a post request
$request->post(array('id' => 'start'), '/doku.php');

The result of a request is a TestResponse object.

As mentioned the requests are not real requests. Every call you make in your test changes the behavior of DokuWiki on the request.

Here this is used to hook a event.

function testHookTriggering() {
    global $EVENT_HANDLER;
 
    $request = new TestRequest(); // initialize the request
    $hookTriggered = false; // initialize a test variable
 
    // register a hook
    $EVENT_HANDLER->register_hook('TPL_CONTENT_DISPLAY', 'AFTER', null,
        function() use (&$hookTriggered) {
            $hookTriggered = true;
        }
    );
 
    // do the request
    $request->execute();
 
    // check the result of our variable
    $this->assertTrue($hookTriggered, 'Hook was not triggered as expected!');
}

Sometimes you want to inspect the resulting html of a request. To provide a little comfort we use the phpQuery library. With this you can use operate in a jQuery like style on the html.

A simple example is:

function testSimpleRun() {
    // make a request
    $request = new TestRequest();
    $response = $request->execute();
 
    // get the generator name from the meta tag.
    $generator = $response->queryHTML('meta[name="generator"]')->attr('content');
 
    // check the result
    $this->assertEquals('DokuWiki', $generator);
}

Sometime you need unit tests in your extensions²⁾. Here you can use the same classes and methods as used in the DokuWiki core. The plugin wizard has an option to add an example test in your plugin skeleton.

Just put your tests under the <extension dir>/_test/ folder. The tests must conform to the naming convention., eg. your test cases must extend the DokuWikiTest class and the file name must end with .test.php.

To work, your plugin needs to be enabled during the test. This is done by putting it and all plugins it depends on in the $pluginsEnabled member.

Plugin tests should declare a group for all their tests named plugin_<pluginname> to make it easy to run them separately.

If your plugin needs additional files during testing, you can copy them to the test directory in a setUpBeforeClass() method. Be sure to call the parent first.

Here's a small example:

/**
 * @group plugin_data
 * @group plugins
 */
class helper_plugin_data_test extends DokuWikiTest {
 
    protected $pluginsEnabled = array('data', 'sqlite');
 
    public static function setUpBeforeClass(){
        parent::setUpBeforeClass();
        // copy our own config files to the test directory
        TestUtils::rcopy(dirname(DOKU_CONF), dirname(__FILE__).'/conf');
    }
 
    public function testExample() {
        $this->assertTrue(true,'if this fails your computer is broken');
    }
}

A plugin's config can simply be changed by writing to the $conf array. The changes can e.g. be done in the test functions themselves or in the function setUp(). Config changes in function setUpBeforeClass() will have no effect. Have a look at this example:

    function setUp(){
        global $conf;
 
        parent::setUp();
 
        $conf ['plugin']['creole']['precedence'] = 'Creole';
        $conf ['plugin']['creole']['linebreak']  = 'Whitespace';
    }

So the correct indexing for plugins is $conf ['plugin']['plugin name']['option name'].

Plugin authors are encouraged to register their plugins with Travis CI to have automated testing. The Plugin Wizard adds an appropriate .travis.yml to your plugin when you select the Unit Test option. The needed build environment is provided by the dokuwiki-travis script.

It is possible to integrate javascript-tests written in qunit to the automated testing with Travis CI. The basis for this is npm, grunt and phantomjs.

.travis.yml

language: php
php:
  - "5.5"
  - "5.4"
  - "5.3"
env:
  - DOKUWIKI=master
  - DOKUWIKI=stable
  - DOKUWIKI=old-stable
before_install:
  - wget https://raw.github.com/splitbrain/dokuwiki-travis/master/travis.sh
  - npm install
install: sh travis.sh
script:
  - cd _test && phpunit --stderr --group plugin_yourplugin
  - cd ../lib/plugins/yourplugin && grunt

npm needs a package.json to install the dependencies:

package.json

{
  "name": "yourplugin",
  "devDependencies": {
    "grunt": "^0.4.5",
    "grunt-contrib-qunit": "^0.7.0",
    "jquery": "^2.1.4",
    "qunitjs": "^1.18.0"
  }
}

grunt needs a Gruntfile.js to define the tasks:

Gruntfile.js

module.exports = function(grunt) {
  grunt.initConfig({
    pkg: grunt.file.readJSON('package.json'), // the package file to use
 
    qunit: {
      all: ['_jstest/*.html']
    }
});
grunt.loadNpmTasks('grunt-contrib-qunit');
grunt.registerTask('default', ['qunit']);
};

Finally the qunit html-files have to be adjusted to be able to work with node_modules for automated testing and with online-libraries for browser-testing:

qunit.test.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>tests for your plugin</title>
    <link rel="stylesheet" href="//code.jquery.com/qunit/qunit-1.18.0.css">
    <script src="../node_modules/jquery/dist/jquery.js"></script>
    <script>window.jQuery || document.write('<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"><\/script>')</script>
</head>
<body>
<div id="qunit"></div>
<div id="qunit-fixture"></div>
<script src="../node_modules/qunitjs/qunit/qunit.js"></script>
<script>window.QUnit || document.write('<script src="//code.jquery.com/qunit/qunit-1.18.0.js"><\/script>')</script>
<script src="../script/myscript.js"></script>
<script src="mytest.tests.js"></script>
 
</body>
</html>

See the edittable plugin for an implementation of this approach.

• Unit Testing Syntax Plugins
• Integrating Unit tests in Intellij IDEA/PHPStorm