Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inventor96/fatfree-test-manager
A lightweight class to run and report the results from unit tests using the Fat-Free Framework Test class.
https://github.com/inventor96/fatfree-test-manager
composer fat-free-framework fatfree-framework fatfreeframework testing unit-testing
Last synced: about 1 month ago
JSON representation
A lightweight class to run and report the results from unit tests using the Fat-Free Framework Test class.
- Host: GitHub
- URL: https://github.com/inventor96/fatfree-test-manager
- Owner: inventor96
- License: mit
- Created: 2021-03-10T00:45:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-12T02:20:00.000Z (almost 4 years ago)
- Last Synced: 2024-11-18T09:43:06.366Z (about 2 months ago)
- Topics: composer, fat-free-framework, fatfree-framework, fatfreeframework, testing, unit-testing
- Language: PHP
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fat-Free Test Manager
A lightweight class to run and report the results from unit tests using the [Fat-Free Framework `Test` class](https://fatfreeframework.com/3.7/test).
## Installation
```
composer require --dev inventor96/fatfree-test-manager
```
## Usage
The goal of this tool is to be as simple and lightweight as possible.
### Overview
The idea is that we'll scan one folder (non-recursively) for all files that end with `Test.php` (e.g. `MyAwesomeTest.php`). For each of the files found, we find the first class definition, instantiate that class, and then call all public methods in that class that start with `test` (e.g. `public function testIfThisWorks() { ... }`).
With this structure in place, simply call `TestManager::runAndReportTests('directory/with/test/files');`.
### Extending `TestBase`
The test classes must extend `TestBase`, directly or indirectly. If indirectly (the test classes extend another class that extends `TestBase`), the constructor of the class(es) in the middle will want to pass an array as the second parameter to the parent constructor of class names that includes their own. This will allow the report to include the correct class and method name of the testing method.
For example:
```php
class MyTestBase extends TestBase {
public function __construct(\Test &$test_instance) {
parent::__construct($test_instance, [get_class()]);
}
}
```
### Running code before/after test classes and methods
If a test class (or a class it extends) has a method named `preClass()`, `preTest()`, `postTest()`, or `postClass()`; each method will be called at the respective time.
| Method | Called Time |
| ------ | ----------- |
| `preClass()` | Immediately after the class is instantiated |
| `preTest()` | Before each `test*()` method in the class |
| `postTest()` | After each `test*()` method in the class |
| `postClass()` | After all tests in the class have been run, and `postTest()` has been called (if present) |
### Multiple Folders
If you have more than one folder with tests, you can create an instance of the [Fat-Free Framework `Test` class](https://fatfreeframework.com/3.7/test) and call `TestManager::runTests('a/directory/with/tests', $your_instance_of_Test);` for each directory, then call `TestManager::reportTests($your_instance_of_Test);` at the end.
### Exit Codes
By default, `runAndReportTests()` and `reportTests()` will end the PHP process with an exit code of 1 if there were failed tests, or 0 if all were successful. To disable this behavior and allow the script to continue, set the last parameter to `false`.
## General Example
`example_dir/ExampleTest.php`:
```php
pre_class_called++;
}
public function postClass() {
$this->post_class_called++;
echo "preClass() called: {$this->pre_class_called}".PHP_EOL;
echo "postClass() called: {$this->post_class_called}".PHP_EOL;
echo "preTest() called: {$this->pre_test_called}".PHP_EOL;
echo "postTest() called: {$this->post_test_called}".PHP_EOL;
}
public function preTest() {
$this->pre_test_called++;
}
public function postTest() {
$this->post_test_called++;
}
private function testThisShouldNeverGetCalled() {
// private methods should never get called by the TestManager
$this->expect(false, 'This is not the method you are looking for...');
}
public function testPassExample() {
$this->expect(true, 'the message for a passing test');
}
public function testFailExample() {
$this->expect(false, 'the message for a failed test');
}
public function testPassAndFailExample() {
$this->expect(true);
$this->expect(false);
}
public function testWithException() {
throw new Exception("This is the message for an exception");
}
}
```
`example_dir/test_runner.php`:
```php