Hoa central
README
Hoa

Hoa is a modular, extensible and structured set of PHP libraries. Moreover, Hoa aims at being a bridge between industrial and research worlds.

Hoa

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

In each library, a Test/ directory contains test suites. So far, only unit tests are supported. They are written with atoum.

Installation

With Composer, to include this library into your dependencies, you need to require `hoa/test`:

```json { "require": { "hoa/test": "~1.0" } } ```

Please, read the website to get more informations about how to install.

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:

```sh $ 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:

```php namespace Hoa;

class Bar extends { 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:

```php namespace Hoa;

class Baz { /**

-c/--classes to generate tests of some classes,

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:

```sh $ 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:

```sh $ hoa test:run –libraries Foo ```

or

```sh $ hoa test:run –directories Test/Praspel/ ```

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

Environment variables

Documentation

Different documentations can be found on the website: http://hoa-project.net/.

License

Hoa is under the New BSD License (BSD-3-Clause). Please, see `LICENSE`.