Close search

Hack book de Hoa\Test

Unfortunately, the documentation of this library has not been written yet. However, the file may contain enough information to help you. This document is an extract of the file.
Sorry for this inconvenience. Be ensured we are working hard to fix this.

Help on IRC Help on Gitter Documentation Board

This library provides tools to create and run tests for Hoa libraries.

In each library, a Test/ directory contains test suites. They are written with atoum.

Learn more.

Quick usage

As a quick overview, we see how to execute, write and generate unit tests. Let Hoa\Foo be a library.

Execute tests

To execute some tests, we will use the hoa test:run command. We have several options to select a set of tests:

Most of the time, we will run all tests of a library, and then all the tests of all libraries. Thus:

$ hoa test:run --libraries Foo
# do something
$ hoa test:run --all

Manual unit tests

First, let's create the Hoa/Foo/Test/Unit/Bar.php file, that contains:

namespace Hoa\Foo\Test\Unit;

class Bar extends \Hoa\Test\Unit\Suite
    public function caseBaz()
        $this->integer(7 * 3 * 2)->isEqualTo(42);

A class represents a test suite (that extends the Hoa\Test\Unit\Suite class). A method represents a test case, where its name must be prefixed by case.

The Hoa\Test library enables the Praspel extension for atoum. Consequently, we have the realdom, sample, sampleMany etc. asserters to automatically generate data.

Automatically generate unit tests

Thanks to Praspel, we are able to automatically generate test suites. Those test suites are compiled into executable test suites written with atoum's API with the help of the Praspel extension for atoum.

Let Hoa\Foo\Baz be the following class:

namespace Hoa\Foo;

class Baz
     * @requires x: /foo.+ba[rz]/;
     * @ensures  \result: true;
    public function qux()
        // …

Then, to automatically generate a test suite, we will use the hoa test:generate command. It has the following options:

The dry-run mode is very helpful. We encourage you to often generate tests with this option to see what happens. This option is also helpful when having some errors.

Thus, to automatically generate tests of the Hoa\Foo\Baz class, we will make:

$ hoa test:generate --classes Hoa.Foo.Baz

Hoa.Foo.Baz is equivalent to Hoa\\Foo\\Baz, it avoids to escape backslashes. Then to execute this test suite, nothing new:

$ hoa test:run --libraries Foo


$ hoa test:run --directories Test/Praspel/

to only run the test suite generated by the Praspel tools.

Environment variables

Une erreur ou une suggestion sur la documentation ? Les contributions sont ouvertes !