Make PHPUnit\TextUI\ResultPrinter an interface

[jaydiablo]

Q	A
PHPUnit version	8.x+ (8.5.2 for sure)
PHP version	any
Installation Method	n/a

Summary

The PHPUnit\TextUI\ResultPrinter class is marked as internal (https://github.com/sebastianbergmann/phpunit/blob/master/src/TextUI/ResultPrinter.php#L29) which is causing notices to be emitted during test runs that have an external result printer configured:

diablomedia/phpunit-pretty-printer#27
mikeerickson/phpunit-pretty-result-printer#155
indentno/phpunit-pretty-print#28

/var/www/html $ bin/phpunit --filter ArraysTest
PHPUnit 8.5.2 by Sebastian Bergmann and contributors.

Testing Project Test Suite

                       App\Tests\Common\ArraysTest ...

Time: 216 ms, Memory: 8.00 MB

OK (3 tests, 6 assertions)

Other deprecation notices (1)

  1x: The "PHPUnit\TextUI\ResultPrinter" class is considered internal This class is not covered by the backward compatibility promise for PHPUnit. It may change without further notice. You should not use it from "DiabloMedia\PHPUnit\Printer\PrettyPrinter".

Is it possible to have this class be part of the public API as mentioned in #3236 ?

If not, what is the recommended way to implement result printers?

Thanks!

[sebastianbergmann]

Let me start by saying that

Other deprecation notices (1)

  1x: The "PHPUnit\TextUI\ResultPrinter" class is considered internal This class is not covered by the backward compatibility promise for PHPUnit. It may change without further notice. You should not use it from "DiabloMedia\PHPUnit\Printer\PrettyPrinter".

is not emitted by PHPUnit. I assume that you are using a wrapper around PHPUnit, probably something like Symfony's PHPUnit bridge.

With that out of the way, yes, the fact that PHPUnit\TextUI\ResultPrinter is marked @internal is a problem. Its implementation is, and should stay, internal. However, for legacy reasons, it is also a public API as extending this class is an intended way for augmenting or changing the output printed by PHPUnit.

I think the best way forward is to

• Rename PHPUnit\TextUI\ResultPrinter to PHPUnit\TextUI\DefaultResultPrinter and keep it marked as @internal
• Make PHPUnit\TextUI\ResultPrinter an interface implemented by PHPUnit\TextUI\DefaultResultPrinter; this interface would not be marked @internal

This change will break backward compatibility, of course.

[epdenouden]

@jaydiablo The logging code could use a good spring cleaning, however this will have to wait until the replacement for TestListeners is ready for production.

The current listener system is hard to work with with newer use cases like the execution reordering. If you want to get some feel for the hoops to jump through, have a look at #3417.

I assume that you are using a wrapper around PHPUnit, probably something like Symfony's PHPUnit bridge.

Yes, this is one of the functionalities that the bridge offers which needs to stay after the refactoring.