108 lines
2.9 KiB
Markdown
108 lines
2.9 KiB
Markdown
Verify
|
|
======
|
|
|
|
BDD Assertions for [PHPUnit][1] and [Codeception][2]
|
|
|
|
This is very tiny wrapper for PHPUnit assertions, that are aimed to make tests a bit more readable.
|
|
With [BDD][3] assertions influenced by [Chai][4], [Jasmine][5], and [RSpec][6] your assertions would be a bit closer to natural language.
|
|
|
|
[](https://travis-ci.org/Codeception/Verify) [](https://packagist.org/packages/codeception/verify)
|
|
|
|
```php
|
|
$user = User::find(1);
|
|
|
|
// equal
|
|
verify($user->getName())->equals('davert');
|
|
verify("user have 5 posts", $user->getNumPosts())->equals(5);
|
|
verify($user->getNumPosts())->notEquals(3);
|
|
|
|
// contains
|
|
verify('first user is admin', $user->getRoles())->contains('admin');
|
|
verify("first user is not banned", $user->getRoles())->notContains('banned');
|
|
|
|
// greater / less
|
|
$rate = $user->getRate();
|
|
verify('first user rate is 7', $rate)->equals(7);
|
|
|
|
verify($rate)->greaterThan(5);
|
|
verify($rate)->lessThan(10);
|
|
verify($rate)->lessOrEquals(7);
|
|
verify($rate)->lessOrEquals(8);
|
|
verify($rate)->greaterOrEquals(7);
|
|
verify($rate)->greaterOrEquals(5);
|
|
|
|
// true / false / null
|
|
verify($user->isAdmin())->true();
|
|
verify($user->isBanned())->false();
|
|
verify($user->invitedBy)->null();
|
|
verify($user->getPosts())->notNull();
|
|
|
|
// empty
|
|
verify($user->getComments())->isEmpty();
|
|
verify($user->getRoles())->notEmpty();
|
|
```
|
|
|
|
Shorthands for testing truth/fallacy:
|
|
|
|
```php
|
|
verify_that($user->isActivated());
|
|
verify_not($user->isBanned());
|
|
```
|
|
|
|
These two functions don't check for strict true/false matching, rather `empty` function is used.
|
|
`verify_that` checks that result is not empty value, `verify_not` does the opposite.
|
|
|
|
## Alternative Syntax
|
|
|
|
If you follow TDD/BDD you'd rather use `expect` instead of `verify`. Which are just an alias functions:
|
|
|
|
```php
|
|
expect("user have 5 posts", $user->getNumPosts())->equals(5);
|
|
expect_that($user->isActive());
|
|
expect_not($user->isBanned());
|
|
```
|
|
|
|
## Installation
|
|
|
|
### Installing via Composer
|
|
|
|
Install composer in a common location or in your project:
|
|
|
|
```sh
|
|
curl -s http://getcomposer.org/installer | php
|
|
```
|
|
|
|
Create the `composer.json` file as follows:
|
|
|
|
```json
|
|
"require-dev": {
|
|
"codeception/verify": "*"
|
|
}
|
|
```
|
|
|
|
Run the composer installer:
|
|
|
|
```sh
|
|
php composer.phar install
|
|
```
|
|
|
|
## Usage
|
|
|
|
Use in any test `verify` function instead of `$this->assert*` methods.
|
|
|
|
## Extending
|
|
|
|
`Codeception\Verify` class can be extended with custom assertions. You write your own `verify` function that would instantiate your extended version of Verify class.
|
|
|
|
## License
|
|
|
|
Verify is open-sourced software licensed under the [MIT][7] License. © Codeception PHP Testing Framework
|
|
|
|
[1]: https://phpunit.de/
|
|
[2]: http://codeception.com/
|
|
[3]: https://en.wikipedia.org/wiki/Behavior-driven_development
|
|
[4]: http://chaijs.com/
|
|
[5]: http://jasmine.github.io/
|
|
[6]: http://rspec.info/
|
|
[7]: https://github.com/Codeception/Verify/blob/master/LICENSE
|