osflab/test

OSF simple unit test component

3.0.0 2018-02-26 14:34 UTC

Requires

• php: ^7.1.0
• osflab/console: ~3.0.0

Suggests

• osflab/container: ~3.0.0

AGPL-3.0-or-later

• Guillaume Ponçon

README

A very quick learning time unit test component, that uses the command line to run the tests. Although it is under development, this component works.

Installation

You need at least php 7.1 and composer to use this component:

sudo apt install composer

From github

Installation:

git clone [e-mail]:osflab/test.git
cd test && composer install

Use osflab/test in your app with composer

To use it in your project, just add osflab/test in your composer.json file.

Usage

To run your tests, use the command line:

bin/runtests [directory] [filter]

The test runner find recursively the Test.php files in [directory] (default is current) and run it. The second parameter [filter] can be used to run only certain tests.

Simple example:

bin/runtests

Output:

- \Osf\Test\Test ...................................................... [  OK  ]
- 1 test file(s), 2 tests passed, success ^^

When this component is installed as a dependency of your project, the runtests binary is available in vendor/bin directory.

Example in the Application component project:

vendor/bin/runtests . Acl

Output:

- \Osf\Application\Acl\Test ........................................... [  OK  ]
- \Osf\Application\Config\Test ........................................ [ SKIP ]
- 1 test file(s), 51 tests passed, success ^^

Writing Test.php files

The Test.php file content look like this:

use Osf\Test\Runner as OsfTest;

class Test extends OsfTest
{
    public static function run()
    {
        self::reset();

        // Your test here
        try {
            self::assert(/* condition */, /* [message if fails] */);
            self::assertEqual(/* calculated */, /* expected */, /* [message if fails] */);
            // ...
        }

        // Displays an exception
        catch (\Exception $e) {
            self::assertFalseException($e);
        }

        return self::getResult();
    }
}