https://github.com/devlop/phpunit-exception-assertions
PHPUnit assertions for exceptions.
https://github.com/devlop/phpunit-exception-assertions
phpunit phpunit-assertions
Last synced: 9 months ago
JSON representation
PHPUnit assertions for exceptions.
- Host: GitHub
- URL: https://github.com/devlop/phpunit-exception-assertions
- Owner: devlop
- License: mit
- Created: 2021-02-22T10:09:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-05T08:42:39.000Z (over 4 years ago)
- Last Synced: 2024-11-11T20:13:44.868Z (about 1 year ago)
- Topics: phpunit, phpunit-assertions
- Language: PHP
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PHPUnit Exception Assertions
Trait containing assertions for easier testing of thrown (or not thrown) exceptions.
# Installation
```bash
composer require --dev devlop/phpunit-exception-assertions
```
# Usage
Include the trait to get access to the assertions.
```php
use Devlop\PHPUnit\ExceptionAssertions;
class YourTest extends TestCase
{
use ExceptionAssertions;
}
```
# Available Assertions
## assertExceptionThrown
Asserts that a specific exception was thrown during the execution of the callback,
if the callback finishes without the exception being thrown, the assertion fails.
To check for any exception, use `\Throwable::class` as first argument since all exceptions inherits from [`\Throwable`](https://www.php.net/manual/en/class.throwable.php).
```php
$this->assertExceptionThrown(\InvalidArgumentException::class, function () : void {
// code that should throw the expected exception
});
```
## assertExceptionNotThrown
Asserts that a specific exception was not thrown during the execution of the callback,
if the specified exception was thrown during execution the assertion fails.
**use with caution** - this will only assert that a specific exception was not thrown and
the assertion will pass for any other exceptions thrown, intentional or accidental.
In most cases it is probably better to `assertNoExceptionsThrown` instead.
```php
$this->assertExceptionNotThrown(\InvalidArgumentException::class, function () : void {
// code that should not throw the exception
});
```
## assertNoExceptionsThrown
Asserts that no exceptions was thrown during the execution of the callback,
if any exceptions was thrown during the execution the assertion fails.
```php
$this->assertNoExceptionsThrown(function () : void {
// code that should not throw any exceptions
});
```