Download the PHP package ergebnis/phpunit-agent-reporter without Composer
On this page you can find all versions of the php package ergebnis/phpunit-agent-reporter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ergebnis/phpunit-agent-reporter
More information about ergebnis/phpunit-agent-reporter
Files in ergebnis/phpunit-agent-reporter
Package phpunit-agent-reporter
Short Description Provides an extension for reporting phpunit/phpunit test execution details to agents.
License MIT
Homepage https://github.com/ergebnis/phpunit-agent-reporter
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-agent-reporter
phpunit-agent-reporter
This project provides a composer package and a Phar archive with an extension for reporting phpunit/phpunit test execution details to agents.
Example
After installing and bootstrapping the extension, when running your tests with phpunit/phpunit, the extension will detect whether an agent is running the tests and replace the default output with test execution details that are easier for agents to consume.
When tests pass, the extension outputs:
When tests fail (exit code 1), the extension outputs:
When tests fail with comparison assertions, the actual, diff, and expected fields provide details about the mismatch. These fields are only present for comparison failures.
When tests error (exit code 2), the extension outputs:
The summary always reports the count for every category, so that an agent has a complete overview of the test run. The details section, however, only contains an entry for a category when the test run produces at least one occurrence of it, so that an agent has all the information it can act on without unnecessary noise. For example, when tests trigger deprecations, the extension outputs:
The phpunitDeprecations, phpunitNotices, and phpunitWarnings categories report deprecations, notices, and warnings triggered by phpunit/phpunit itself - as opposed to deprecations, notices, and warnings triggered by PHP or by the code under test. For example, when a test configures no expectations for a mock object, phpunit/phpunit triggers a PHPUnit notice, and the extension outputs:
A phpunitDeprecations, phpunitNotices, or phpunitWarnings entry triggered by the test runner itself - rather than by a test - contains only a message. The phpunitNotices category requires phpunit/phpunit:^12.1.0; on older versions its count is always 0.
The JSON output conforms to the JSON schema included in this package.
Agent Detection
The extension uses ergebnis/agent-detector to detect the presence of agents.
Compatibility
The extension is compatible with the following versions of phpunit/phpunit:
Installation
Installation with composer
Run
to install ergebnis/phpunit-agent-reporter as a composer package.
Installation as Phar
Download phpunit-agent-reporter.phar from the latest release.
Usage
Bootstrapping the extension
Before the extension can report test execution details in phpunit/phpunit, you need to bootstrap it.
Bootstrapping the extension as a composer package
To bootstrap the extension as a composer package when using
phpunit/phpunit:^13.0.0phpunit/phpunit:^12.0.0phpunit/phpunit:^11.0.0phpunit/phpunit:^10.0.0
adjust your phpunit.xml configuration file and configure the
extensionselement onphpunit/phpunit:^13.0.0extensionselement onphpunit/phpunit:^12.0.0extensionselement onphpunit/phpunit:^11.0.0extensionselement onphpunit/phpunit:^10.0.0
Bootstrapping the extension as a PHAR
To bootstrap the extension as a PHAR when using
phpunit/phpunit:^13.0.0phpunit/phpunit:^12.0.0phpunit/phpunit:^11.0.0phpunit/phpunit:^10.0.0
adjust your phpunit.xml configuration file and configure the
extensionsDirectoryattribute and theextensionselement onphpunit/phpunit:^13.0.0extensionsDirectoryattribute and theextensionselement onphpunit/phpunit:^12.0.0extensionsDirectoryattribute and theextensionselement onphpunit/phpunit:^11.0.0extensionsDirectoryattribute and theextensionselement onphpunit/phpunit:^10.0.0
Changelog
The maintainers of this project record notable changes to this project in a changelog.
Contributing
The maintainers of this project suggest following the contribution guide.
Code of Conduct
The maintainers of this project ask contributors to follow the code of conduct.
General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by sponsoring @ergebnis.
PHP Version Support Policy
This project currently supports the following PHP versions:
The maintainers of this project add support for a PHP version following its initial release and may drop support for a PHP version when it has reached its end of life.
Security Policy
This project has a security policy.
License
This project uses the MIT license.
Credits
This package is inspired by nunomaduro/pao, originally licensed under MIT by Nuno Maduro.
Social
Follow @localheinz and @ergebnis on Twitter.
All versions of phpunit-agent-reporter with dependencies
ergebnis/agent-detector Version ^1.0.1
phpunit/phpunit Version ^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0