phpunit README

The project's README from github.com/sebastianbergmann/phpunit. As one markdown file: README.md.

PHPUnit

CI Status codecov Latest Stable Version Total Downloads Monthly Downloads Daily Downloads

PHPUnit

PHPUnit is a programmer-oriented testing framework for PHP. It is an instance of the xUnit architecture for unit testing frameworks.

Installation

We distribute a PHP Archive (PHAR) that has all required dependencies of PHPUnit bundled in a single file:

$ wget https://phar.phpunit.de/phpunit-X.Y.phar

$ php phpunit-X.Y.phar --version

Please replace X.Y with the version of PHPUnit you are interested in.

Alternatively, you may use Composer to download and install PHPUnit as well as its dependencies. Please refer to the documentation for details on how to install PHPUnit.

Contribute

Please refer to CONTRIBUTING.md for information on how to contribute to PHPUnit and its related projects.

A big "Thank you!" to everyone who has contributed to PHPUnit! You can find a detailed list of contributors on every PHPUnit related package on GitHub.

Here is a list of all components that are primarily developed and maintained by Sebastian Bergmann:

A very special thanks to everyone who has contributed to the PHPUnit Manual.

In addition to the components listed above, PHPUnit depends on the components listed below:

These tools are used to develop PHPUnit:

Sponsors

It has taken Sebastian Bergmann thousands of hours to develop, test, and support PHPUnit. You can sponsor his Open Source work through GitHub Sponsors, for example.

These businesses support Sebastian Bergmann's work on PHPUnit:

Bubble Shooter in2it vof Mailtrap
Testmo GmbH TestMu AI Tideways GmbH
TYPO3 GmbH VEMA Versicherungsmakler Genossenschaft eG

Would you like to see your logo here as well as on the PHPUnit website? Contact Sebastian Bergmann at [email protected] to learn more about how you can support his work on PHPUnit.

Whether you are a CEO, CFO, CTO, or a developer: your company surely depends on Open Source software. It is time to pay your share and support maintainers like Sebastian Bergmann.

phpunit (sebastianbergmann/phpunit)

test-automation
Searching Database…

20.1K ·GitHub
What is this?PHPUnit is a programmer-oriented testing framework for PHP, built on the xUnit architecture - the classic pattern for unit testing frameworks.
Is this a library I add to my project, or a tool I run on its own?It's a framework rather than an app: you write tests as PHP classes in your own codebase, and PHPUnit executes them from the command line and reports the results. There is no graphical interface.
Do I need anything besides PHP on my machine?No. The distributed PHAR bundles all required dependencies of PHPUnit in one file, so there is nothing extra to install by hand.
Will it run on my operating system?It is plain PHP, so it runs anywhere PHP does - Linux, macOS and Windows. The README imposes no OS restrictions.
What is PHPUnit built from - one package or many?Many. The project is split into a family of small components maintained by its author - php-file-iterator, php-invoker, sebastian/diff, sebastian/exporter, sebastian/type and more - plus third-party packages like nikic/php-parser and theseer/tokenizer.
Can it tell me how much of my code the tests actually cover?Yes. Code coverage is developed as its own component of the project, php-code-coverage, maintained alongside PHPUnit itself.
Is it free, and how is development funded?It is free and open source under the BSD-3-Clause license. Sebastian Bergmann's thousands of hours of work are supported through GitHub Sponsors, and companies can back the project to get their logo on the README.
How mature is this project?Very. The repository dates back to December 2009, has over 20,000 GitHub stars, and its CI runs nightly builds and automated release jobs.
What are similar projects?mockery, testify, pest, mockito, ava, mocha, pytest, googletest
Size
379.8 MB
Stars
20.1K
Age
16y
Commits · 90 Days