hoa / test
The Hoa\Test library.
Installs: 6 912
Dependents: 58
Suggesters: 0
Security: 0
Stars: 12
Watchers: 8
Forks: 8
Open Issues: 8
Requires
- atoum/atoum: ~3.0
- atoum/praspel-extension: ~0.17
- atoum/ruler-extension: ~1.3
- atoum/visibility-extension: ~1.3
- hoa/cli: ~2.0
- hoa/consistency: ~1.0
- hoa/console: ~3.0
- hoa/devtools: ~1.0
- hoa/file: ~1.0
- hoa/kitab: ~0.6
- hoa/protocol: ~1.0
- hoa/ustring: ~4.0
- dev-master / 2.x-dev
- 2.17.08.18
- 2.17.08.16
- 2.17.08.15
- 2.17.02.27
- 2.17.02.24
- 2.17.01.16
- 2.16.10.25
- 2.16.08.17
- 2.16.08.16
- 2.16.08.15
- 2.16.06.20
- 2.16.03.03
- 2.16.01.19
- 2.16.01.14
- 2.16.01.11
- 1.15.10.29
- 1.15.10.21
- 1.15.07.30
- 1.15.06.25
- 1.15.05.29
- 1.15.04.16
- 1.15.02.20
- 1.14.12.10
- 1.14.12.01
- 1.14.11.26
- 1.14.11.24
- 0.14.11.09
- 0.14.09.24
- 0.14.09.23
- 0.14.09.22
- 0.14.09.17
- 0.14.09.16
This package is auto-updated.
Last update: 2021-09-20 08:32:07 UTC
README
Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
Hoa\Test
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.
Installation
With Composer, to include this library into
your dependencies, you need to
require hoa/test
:
$ composer require hoa/test '~2.0'
For more installation procedures, please read the Source page.
Testing
Before running the test suites, the development dependencies must be installed:
$ composer install
Then, to run all the test suites:
$ vendor/bin/hoa test:run
For more information, please read the contributor guide.
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:
-f
/--files
to select files,-d
/--directories
to select directories,-n
/--namespaces
to select classes in some namespaces,-l
/--libraries
to select all tests of some libraries,-a
/--all
to select all tests of all libraries.
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:
-c
/--classes
to generate tests of some classes,-n
/--namespaces
to generate tests of all classes in some namespaces,-d
/--dry-run
to generate tests but output them instead of save them.
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
or
$ hoa test:run --directories Test/Praspel/
to only run the test suite generated by the Praspel tools.
Environment variables
HOA_ATOUM_BIN
: This variable represents the path to the atoum binary.
Documentation
The
hack book of Hoa\Test
contains
detailed information about how to use this library and how it works.
To generate the documentation locally, execute the following commands:
$ composer require --dev hoa/devtools $ vendor/bin/hoa devtools:documentation --open
More documentation can be found on the project's website: hoa-project.net.
Getting help
There are mainly two ways to get help:
- On the
#hoaproject
IRC channel, - On the forum at users.hoa-project.net.
Contribution
Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.
License
Hoa is under the New BSD License (BSD-3-Clause). Please, see
LICENSE
for details.