jchook/phpunit-assert-throws

Exception assertions for PHPUnit

PHPUnit assertThrows()

Industry standard, lambda-based exception testing assertions for PHPUnit., _(*1)

Installation

Easily install it with composer:, _(*2)

composer require --dev jchook/phpunit-assert-throws

Or, alternatively copy the tiny gist and add it to you project. No attribution is requried. True artists steal., _(*3)

Rationale

To enable lambda-based exception testing syntax to PHPUnit., _(*4)

• Throw multiple errors per test
• Examine and test errors after they are caught
• Copy-paste usage examples
• Use standard assert* syntax
• Test more than just message, code, and class
• Write simple happy-path tests with assertNotThrows

Example

Just to illustrate the spirit behind the syntax:, _(*5)

assertThrows(
  MyException::class,
  fn() => $x->doSomethingBad()
);
```

---


Advanced Example
----------------

The class below demonstrates more advanced features.

```php
assertThrows(MyException::class, function() use ($obj) {
            $obj->doSomethingBad();
        });

        // Test custom aspects of a custom extension class
        $this->assertThrows(MyException::class,
            function() use ($obj) {
                $obj->doSomethingBad();
            },
            function($exception) {
                $this->assertEquals('Expected value', $exception->getCustomThing());
                $this->assertEquals(123, $exception->getCode());
            }
        );

        // Test that a specific method does *NOT* throw
        $this->assertNotThrows(MyException::class, function() use ($obj) {
            $obj->doSomethingGood();
        });
    }
}

?>

Notes

Yes, assertNotThrows() feels grammatically… odd. However, it conforms with the PHPUnit naming conventions, such as assertNotContains(). Additionally, the PHPUnit team suggests we may not need this inverse assertion., _(*6)

License

MIT, _(*7)