devlop/phpunit-exception-assertions

PHPUnit assertions for exceptions.

1.1.1 2021-03-05 08:28 UTC

Requires

• php: ^7.4|^8.0
• phpunit/phpunit: ^9.5

Requires (Dev)

• symfony/var-dumper: ^5.2

MIT

• Johan Rosenson

README

PHPUnit Exception Assertions

Trait containing assertions for easier testing of thrown (or not thrown) exceptions.

Installation

composer require --dev devlop/phpunit-exception-assertions

Usage

Include the trait to get access to the assertions.

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.

$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.

$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.

$this->assertNoExceptionsThrown(function () : void {
    // code that should not throw any exceptions
});