Skip to content

Unit testing

Dominus comes with its own little testing framework, which can be used to run simple unit tests.

You can generate tests easily using the dominus cli with the command generate test MyTest.

To create a unit test we begin by creating a new Test suite class in the Tests directory of a Dominus project, you can also create any number of subdirectories if you want to group your test suites further and the framework will scan for them recursively.

Make sure your filename is the same as your class name!

Our test suite class must extend the Dominus\System\Tests\DominusTest base class.

1
2
3
4
5
6
7
8
<?php
namespace Tests;

use Dominus\System\Tests\DominusTest;

class MyTest extends DominusTest
{
}

We will use the Dominus\System\Attributes\TestName attribute to name our test suite something accordingly.

The same attribute can be used to name your test cases if placed on the class method.

Naming test suites and cases

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<?php
namespace Tests;

use Dominus\System\Tests\DominusTest;
use Dominus\System\Attributes\TestName;

#[TestName('My test suite name')]
class MyTest extends DominusTest
{
}

Now, we can create our individual test cases.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
<?php
namespace Tests;

use Dominus\System\Tests\DominusTest;
use Dominus\System\Attributes\TestName;
use Dominus\System\Attributes\TestRequestParameters;
use Dominus\System\Exceptions\TestFailedAssertionException;
use Dominus\System\Request;

#[TestName('My test suite name')]
class MyTest extends DominusTest
{
    /**
     * @throws TestFailedAssertionException
     */
    #[TestRequestParameters([
        'myParameter' => 'value', // parameters set here will be used to populate the Request object
    ])]
    #[TestName('My test case 1')]
    public function test_case_1(
        Request $request
    )
    {
        $this->assert($request->get('myParameter') === 'value');
    }

    /**
     * @throws TestFailedAssertionException
     */
    #[TestRequestParameters([
        'myParameter' => 'value', // parameters set here will be used to populate the Request object
    ])]
    #[TestName('My test case 2')]
    public function test_case_2(
        Request $request
    )
    {
        $this->assert($request->get('myParameter') === 'value');
    }
}

Finally, we need to return the test instance so that the test framework can use it;

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?php
namespace Tests;

use Dominus\System\Tests\DominusTest;
use Dominus\System\Attributes\TestName;
use Dominus\System\Attributes\TestRequestParameters;
use Dominus\System\Exceptions\TestFailedAssertionException;
use Dominus\System\Request;

#[TestName('My test suite name')]
class MyTest extends DominusTest
{
    /**
     * @throws TestFailedAssertionException
     */
     #[TestRequestParameters([
        'myParameter' => 'value', // parameters set here will be used to populate the Request object
    ])]
    #[TestName('My test case 1')]
    public function test_case_1(
        Request $request
    )
    {
        $this->assert($request->get('myParameter') === 'value');
    }
}

return new MyTest();

Now all that remains is to actually run our tests, to do this you can execute the run_tests.php file in the Dominus project root.

Unit test command example