fokin/phpunit-failures-formatter

Helps to colorize and format failure messages

v1.2 2023-05-12 20:51 UTC

Requires

• php: >=8.0

MIT

• Victor Fokin

README

Can be used with phpunit or codeception to format failure messages for test assertions. It can create colored messages describing expected result in green, actual result (failure) in red. Additionally it will format various data you supply that may help you to identify the cause of failure. Incoming parameters and results in various PHP formats, URLs etc. Also it adds Jira tags so that failure can be copied from console to Jira issue.

Installation

composer require --dev fokin/phpunit-failures-formatter

##Usage

You can use formatter directly by creating new object new Formatter()

or add trait to your TestCase class: use Fokin\PhpunitFailuresFormatter\FormatterTrait;. In second case you will be able to call expected() method directly $this->expected(...)

You can also define your own method of calling formatter or override formatter class to add your own methods.

In your test case: $this->assertTrue(false, $this->expected('I thought that it would be true') ->actual('Sad to admit that it is false') ->reg(['This is example array'=> 'that would be printed'], 'Example of incoming data') ->res('Example result data') ->url('http://localhost/bad_page', 'URL that failed') ->jiraIssue('ABC-123', 'Last known issue for this case') );

To add Jira tags to the output define constant JIRA_TAGS