peridot-php / peridot
Event driven BDD test framework for PHP 7.1+
Installs: 187 842
Dependents: 158
Suggesters: 0
Security: 0
Stars: 328
Watchers: 11
Forks: 27
Open Issues: 8
Requires
- php: >=5.4
- evenement/evenement: ^2
- peridot-php/peridot-scope: ^1
- phpunit/php-timer: ^1
- symfony/console: ^2|^3
Requires (Dev)
- dev-master
- 2.0.x-dev
- 1.19.0
- 1.18.1
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.2
- 1.15.1
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.5
- 1.8.4
- 1.8.3
- 1.8.2
- 1.8.1
- 1.8.0
- 1.7.1
- 1.7.0
- 1.6.1
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.1
- 1.3.0
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.7
- 1.1.6
- 1.1.4
- 1.1.3
- 1.1.1
- 1.1.0
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- dev-peridot-phpunit-poc
- dev-multiple-paths
This package is not auto-updated.
Last update: 2024-12-21 17:27:44 UTC
README
The highly extensible, highly enjoyable, PHP testing framework.
Read more at peridot-php.github.io or head over to the wiki.
Building PHAR
Peridot's phar is built using Box. Once box is installed, the phar can be built using the following command from the project directory:
box build
Generating Peridot's documentation
Peridot API documentation is generated using apigen. Once apigen is installed, run the following command from the project directory:
apigen generate
This will output documentation to the docs/ directory.
Running Peridot's tests
Peridot's test suite can be run using Peridot:
$ bin/peridot
And a sample of output:
Release
We use Robo for releases.
robo release [version] [site-path]
using assert for expectations
Peridot sets ASSERT_CALLBACK via assert_options in order to throw exceptions when using the native assert function. Peridot specs are considered passing if they don't throw an exception; if you are using assert for expectations and you find your specs are triggering false positives, you may need to update zend.assertions to 1 in your php.ini. This is set to -1 by default in PHP 7+
If you aren't too keen on using assert for testing, there are a ton of assertion/expectation libraries out there. Anything that throws exceptions in response to a failed assertion will do. The peridot-php org has authored Leo, and this library offers a richer assertion vocabulary for testing.