Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mindplay-dk/testies
a lightweight library of functions for quick, simple unit-testing.
https://github.com/mindplay-dk/testies
Last synced: 2 months ago
JSON representation
a lightweight library of functions for quick, simple unit-testing.
- Host: GitHub
- URL: https://github.com/mindplay-dk/testies
- Owner: mindplay-dk
- Created: 2015-05-20T16:24:21.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T17:09:22.000Z (7 months ago)
- Last Synced: 2024-10-13T13:09:01.134Z (3 months ago)
- Language: PHP
- Size: 161 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
mindplay/testies
================
[](https://packagist.org/packages/mindplay/testies)
Yeah, testies: a lightweight library of functions for quick, simple unit-testing.
Tries to honor the [Go language philosophy of testing](http://golang.org/doc/faq#How_do_I_write_a_unit_test) - paraphrasing:
> testing frameworks tend to develop into mini-languages of their own, with conditionals and controls and printing
> mechanisms, but PHP already has all those capabilities; why recreate them? We'd rather write tests in PHP; it's one
> fewer language to learn and the approach keeps the tests straightforward and easy to understand.
The primary test API is a set of functions in the `mindplay\testies` namespace.
Internally, the API is backed by a pair of simple "driver" and configuration classes - these are left
as open as possible, and you should feel comfortable extending these and tailoring them specifically to suit the
test-requirements for whatever you're testing.
## Usage
Install via Composer:
composer require-dev mindplay/testies
Then create a test script - the format is pretty simple:
```php
0, "value should be positive", $value);
}
test(
'Checking out some numbers',
function () {
checkValue(123);
checkValue(-1);
}
);
```
Note that the diagnostic output will always refer to the line number in the test-closure that
generated the assertion result.
## Test Server
⚠️ *This feature is still rough.*
PHP provides a [built-in development web server](http://php.net/manual/en/features.commandline.webserver.php).
For basic integration tests, a simple wrapper class to launch and shut down a server is provided - the
following example uses `nyholm/psr7` and the `zaphyr-org/http-client` client library:
```php
use Nyholm\Psr7\Factory\Psr17Factory;
use Zaphyr\HttpClient\Client;
use function mindplay\testies\{test, ok, eq};
$server = new TestServer(__DIR__, 8088);
test(
'Can get home page',
function () {
$server = new TestServer(__DIR__, 8088);
$http = new Psr17Factory();
$client = new Client($http, $http);
$response = $client->sendRequest($http->createRequest("GET", "http://127.0.0.1:8088/index.php"));
eq($response->getStatusCode(), 200);
ok(strpos($response->getBody(), 'Welcome') !== false, "it should capture the response body");
}
);
```
Note that the server is automatically shut down when the `$server` object falls out of scope - if you
need to explicitly shut down a server, just destroy the server object with e.g. `unset($server)`.
Keep in mind that starting and stopping many server instances can slow down your test drastically - it's
often a good idea to open one server instance and share it between test-functions. Creating and disposing
of clients, on the other hand, is recommended, as sharing client state could lead to unreliable tests.
## Options
A few simple configuration options are provided via the `configure()` function, which provides access
to the current instance of `TestConfiguration`.
### Code Coverage
To enable code coverage and display the summary result on the console:
```php
configure()->enableCodeCoverage();
```
To output a `clover.xml` file for integration with external analysis tools, specify an output path:
```php
configure()->enableCodeCoverage(__DIR__ . '/build/clover.xml');
```
To enable code coverage analysis only for files in certain folders, pass a path (or array of paths) like so:
```php
configure()->enableCodeCoverage(__DIR__ . '/build/clover.xml', dirname(__DIR__) . '/src');
```
### Verbosity
By default, test output does not produce messages about successful assertions, only failures - if you
want more stuff to look at, enable verbose output:
```php
configure()->enableVerboseOutput();
```
You can also enable this from the command line with the `-v` or `--verbose` switch.
### Strict Error Handling
By default, all PHP errors/warnings/notices are automatically mapped to exceptions via a simple
built-in error handler. If you're testing something that has custom error handling, you can disable it with:
```php
configure()->disableErrorHandler();
```
## Extensibility
The procedural API is actually a thin layer over two classes providing the actual library implementation.
One common reason to use a custom driver, is to override the `TestDriver::format()` method, to customize
how special objects are formatted for output on the console.
To use a custom, derived `TestConfiguration` class:
```php
// Derive your custom configuration class:
class MyTestConfiguration extends TestConfiguration
{
// ...
}
// Head off your test by selecting your custom configuration object:
configure(new MyTestConfiguration);
```
Then proceed with business as usual.
To use a custom, derived `TestDriver` class:
```php
// Derive your custom driver class:
class MyTestDriver extends TestDriver
{
// ...
}
// Boostrap your test by selecting your custom driver:
configure(new TestConfiguration(new TestDriver));
```
Alternatively, create a configuration class that provides a custom default driver class:
```php
class MyTestDriver extends TestDriver
{
// ...
}
class MyTestConfiguration extends TestConfiguration
{
protected function createDefaultDriver()
{
return new MyTestDriver();
}
// ...
}
configure(new MyTestConfiguration);
```
Refer to the actual implementations to see what else is possible - pretty much everything is `public`
or `protected` in these classes, left open for you to call or override as needed.