Unit Testing

General: ¶

Because the ApPHP Framework testing is built on top of PHPUnit, we strongly recommended that you go through the PHPUnit documentation first to get the basic understanding on how to write a unit test. We summarize in the following the basic principles of writing a unit test in ApPHP.

A unit test is written in terms of a class AbcTest which extends from TestCase, where AbcTest stands for the class being tested. For example, to test the CArray class, we would name the corresponding unit test as CArrayTest by convention. The base class TestCase is meant for generic unit tests. Because PHPUnit_Framework_TestCase is the ancestor class for these classes, we can use all methods inherited from this class.
The unit test class is saved in a PHP file named as AbcTest.php. It may be stored under the directory tests/framework for framework tests or tests/protected for application tests.
The test class mainly contains a set of test methods named as testAbc, where Abc is often the name of the class method to be tested.
A test method usually contains a sequence of assertion statements (e.g. assertTrue, assertEquals) which serve as checkpoints on validating the behavior of the target class.

Installation and usage: ¶

To install and run Unit test you have to perform following actions:

Install composer on your server. https://getcomposer.org

After Composer is installed, install PHPUnit by

composer require phpunit/phpunit --dev

you may also remove it and re-install again:

composer remove phpunit/phpunit --dev
composer update

Make sure you added following to composer.json file:

"scripts": {
    "tests-result": "phpunit --colors=always --log-junit test-results.xml",
    "tests": "phpunit --colors=always",
    "test": "phpunit --colors=always --filter"
}

Create test files in tests/protected directory and write your tests.

Running tests: ¶

To run all your tests use following command in command line:
```
composer tests
```
To run specific test use following command:
```
composer test AbcTest
```
To run specific test from the specific test file use following command:
```
composer test AbcTest::testXyz
```