peridot-php/peridot
Stars: 327
Forks: 29
Pull Requests: 118
Issues: 98
Watchers: 11
Last Updated: 2023-06-01 12:41:01
Event driven BDD test framework for PHP
License: MIT License
Languages: PHP, Makefile, Batchfile
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.
OPEN ISSUES
See all- Running tests in separate processes by @JoelLarson
- symfony2 usage example by @laland
- Ability to exclude directories by @brianium
- Run-time scope properties leak across suites by @ezzatron
- Scenario Provisioning: Thoughts on new feature? by @ghost
- Fix release strategy by @brianium
- Fix console output under Windows by @ezzatron
- setDefinitionArguments() claims to return $this, but doesn't by @ezzatron
- setParent() claims to return mixed|void, should omit @return by @ezzatron
- ReporterInterface does not include the methods added by HasEventEmitterTrait by @ezzatron
- Data providers / parameterized tests by @ezzatron
- beforeAll on suite/file level and global beforeAll by @denblackstache
- Peridot 2.0 Ideas by @ragboyjr
RELEASES
See all- 1.19.0 by @ezzatron
- by @ezzatron
- 1.9.0 by @brianium
- 1.5.0 by @ezzatron
- 1.4.0 by @ezzatron
- 1.3.1 by @ezzatron
- 1.3.0 by @ezzatron
- 1.2.3 by @ezzatron
- 1.2.2 by @ezzatron
- 1.2.1 by @ezzatron
- 1.2.0 by @ezzatron
- 1.1.7 by @ezzatron
- 1.1.6 by @ezzatron
- 1.1.4 by @ezzatron
- 1.1.3 by @ezzatron
- 1.1.1 by @brianium
- 1.1.0 by @brianium