clagiordano/phpunit-result-printer

Phpunit custom result printer class


Keywords
cli, phpunit, phpunit-tests, printer, results, unittesting
License
MIT

Documentation

PHPUnit result printer

PHPUnit result printer is a custom phpunit result printer with pretty output and timings

Sample image:

sample_output.png

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them

  • php >= 5.4
  • composer

Installing

The recommended way to install phpunit-result-printer is through Composer.

composer require clagiordano/phpunit-result-printer

After install you can edit your phpunit.xml as follow:

<phpunit
    ...
    printerClass="clagiordano\PhpunitResultPrinter\ResultPrinter"
>
...
</phpunit>

A full phpunit.xml example:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit backupGlobals="false"
         backupStaticAttributes="false"
         bootstrap="vendor/autoload.php"
         colors="true"
         convertErrorsToExceptions="true"
         convertNoticesToExceptions="true"
         convertWarningsToExceptions="true"
         processIsolation="false"
         stopOnFailure="false"
         verbose="true"
         printerClass="clagiordano\PhpunitResultPrinter\ResultPrinter"
        >
    <testsuites>
        <testsuite name="Package Test Suite">
            <directory suffix=".php">./tests/</directory>
        </testsuite>
    </testsuites>
</phpunit>

Running the tests

You can clone and test this project with the following commands:

git clone https://github.com/clagiordano/phpunit-result-printer.git
cd phpunit-result-printer
composer install
./vendor/bin/phpunit

One of the previous tests fails for demo purpose

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details