Skip to content

Commit

Permalink
Added testing section to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Bilge committed Mar 8, 2017
1 parent f2848fe commit 65bbdc9
Showing 1 changed file with 29 additions and 7 deletions.
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ Immediate Exception Printer is a [PHPUnit][PHPUnit] plug-in that prints out exce
* Display the execution time of each test in tiered colour bands.
* Display the name of each test case as it is executed.

## Preview

The following preview is somewhat atypical but shows all tested output cases this printer supports.

![Preview image](https://raw.githubusercontent.com/ScriptFUSION/PHPUnit-Immediate-Exception-Printer/master/doc/images/test%20run%201.0.png)

Not shown: the normal test summary output you're used to seeing at the end of a test run. This library makes no attempt to modify the summary; only runtime output is changed.

## Usage

1. Add the library to your Composer file's `require-dev` section.
Expand All @@ -40,18 +48,32 @@ Immediate Exception Printer is a [PHPUnit][PHPUnit] plug-in that prints out exce

4. Enjoy immediate test execution feedback.

## Preview
## Requirements

The following preview is somewhat atypical but shows all tested output cases this printer supports.
* PHP 5.6 or newer.
* [PHPUnit][PHPUnit] 5.5 or newer. PHPUnit 6 not yet supported.

![Preview image](https://raw.githubusercontent.com/ScriptFUSION/PHPUnit-Immediate-Exception-Printer/master/doc/images/test%20run%201.0.png)
## Testing

Not shown: the normal test summary output you're used to seeing at the end of a test run. This library makes no attempt to modify the summary; only runtime output is changed.
The printer's capabilities are exploited via `CapabilitiesTest`. However, this test file isn't run directly because many of these tests are designed to fail. Instead, we write tests that run PHPUnit internally, each of which invokes one of the capability test cases and verifies its output.

## Requirements
The real tests, also known as *functional tests*, are located in `test/functional`, written in PHPT format. PHPT is a [scarcely documented format](http://qa.php.net/phpt_details.php) designed to support [testing PHP itself](https://qa.php.net/write-test.php). An undocumented feature of PHPUnit is its limited support for a subset of the PHPT test specification, which we exploit to test PHPUnit itself with our printer implementation loaded.

To run the tests, simply specify `vendor/bin/phpunit -c test` on the command line from the project directory. By default, we run all the functional PHPT tests. To run `CapabilitiesTest` instead, specify `vendor/bin/phpunit -c test test/CapabilitiesTest`.

### Writing a functional test

To test the output of a particular capability we run `CapabilitiesTest` with the `--filter` option to target a specific test case. Each functional test contains the arguments passed to PHPUnit in the `--ARGS--` section of the file. These arguments can be pasted directly after the PHPUnit command to see the resulting output from that test case. We verify the output in the `--EXPECTF--` section of the file.

One challenge we must overcome is verifying coloured output including ANSI escape sequences. To see these escape sequences we can pipe the output of a specific capability test to `cat -v` as shown in the following example.

```bash
vendor/bin/phpunit -c test --colors=always test/CapabilitiesTest --filter ::testSuccess$ | cat -v
```

The output from `cat` will print the "escape" character as `^[`. We must replace each occurrence of this character sequence with the literal escape character (ASCII character 27). The easiest way to obtain the real escape character is to just copy it from an existing functional test.

* PHP 5.6 or newer
* [PHPUnit][PHPUnit] 5.5 or newer
Create a new functional test by copying an existing test as a template, then modify the PHPUnit arguments and the expected output to match what we expect using the techniques just described. Don't forget to give the test a clear description in the `--TEST--` section!

## Inspiration

Expand Down

0 comments on commit 65bbdc9

Please sign in to comment.