Download the PHP package scriptfusion/phpunit-immediate-exception-printer without Composer
On this page you can find all versions of the php package scriptfusion/phpunit-immediate-exception-printer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download scriptfusion/phpunit-immediate-exception-printer
More information about scriptfusion/phpunit-immediate-exception-printer
Files in scriptfusion/phpunit-immediate-exception-printer
Package phpunit-immediate-exception-printer
Short Description Immediately prints exceptions and assertion failures during testing.
License LGPL-3.0-only
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package phpunit-immediate-exception-printer
PHPUnit Immediate Printer
Pip is a PHPUnit extension that immediately prints exceptions and assertion failures during a test run. Normally PHPUnit keeps failure details secret until the end of the test run, but sometimes we don't want to wait that long. With Pip, all secrets are immediately revealed, with a few extra benefits, too.
Benefits
- Display the name of each test case as it is executed.
- Display the execution time of each test in configurable, tiered colour bands.
- Immediately print exceptions, assertion failures, warnings, notice and deprecation messages as they occur.
- Flawless test suite indicator: success dot turns to red exclamation mark if any prior tests failed. Useful for CI consoles without a scrollback buffer.
Preview
The following preview is somewhat atypical but shows all supported output cases at once. Of course, we expect all your tests to be mostly green!
Pip makes no attempt to modify the test summary; only runtime output is changed.
Usage
-
Add the dependency to your Composer file's
require-devsection. -
Declare the printer extension in your
phpunit.xmlconfiguration file. -
Run the tests!
- Enjoy immediate test execution feedback.
Configuration
Pip's behaviour can be customized by adding <parameter> nodes as children of the <bootstrap> node in phpunit.xml, with name and value attributes corresponding to the table below.
| Parameter name | Default value | Description |
|---|---|---|
| perf.slow | 200 (ms) | Sets the performance threshold for slow (yellow) tests. |
| perf.vslow | 1000 (ms) | Sets the performance threshold for very slow (red) tests. |
| test.dp.args | true | True to show the arguments passed by the data provider, false to hide. |
| test.name.strip | '' | Strips the specified matching portion of the test name. |
Requirements
| Pip version | PHPUnit versions | Minimum PHP version |
|---|---|---|
| 3 | 10 / 11 | 8.1 / 8.2 |
| 2 | yanked | - |
| 1 | 5 / 6 | 5.6 / 7.0 |
Testing Pip
To run the full test suite, use the following command.
Pip'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. To run CapabilitiesTest, specify the following command
The real tests, also known as functional tests, are located in test/functional, written in PHPT format. PHPT is a scarcely documented format designed to support testing PHP itself. 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.
Writing functional tests
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.
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.
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
Thanks to the following open source projects that inspired this project.
- diablomedia/phpunit-pretty-printer – Design and implementation.
- whatthejeff/nyancat-phpunit-resultprinter – Testing.
- skyzyx/phpunit-result-printer – Design.
