jchook/phpunit-assert-throws

Exception assertions for PHPUnit

v1.0.3 2019-04-13 22:17 UTC

Requires

• phpunit/phpunit: >=7.0.0

MIT

• Wes Roberts
• Librarian

README

Industry standard, lambda-based exception testing assertions for PHPUnit.

Installation

Easily install it with composer:

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.

Rationale

To enable lambda-based exception testing syntax to PHPUnit.

• 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:

<?php

// Within your test case...
$x = new MyTestedObject();
$this->assertThrows(
  MyException::class,
  fn() => $x->doSomethingBad()
);

Advanced Example

The class below demonstrates more advanced features.

<?php

declare(strict_types=1);

// PHPUnit
use PHPUnit\Framework\TestCase;

// This library
use Jchook\AssertThrows\AssertThrows;

// Your classes
use MyNamespace\MyException;
use MyNamespace\MyObject;

final class MyTest extends TestCase
{
	use AssertThrows; // <--- adds the assertThrows method

	public function testMyObject()
	{
		$obj = new MyObject();

		// Ensure that a function throws a specific exception
		$this->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.

License

MIT