DmsAsserts.php

<?php

namespace Dms\Common\Testing;

/**
 * The common asserts used throughout the dms testing suite.
 *
 * @author Elliot Levin <elliotlevin@hotmail.com>
 */
trait DmsAsserts
{
    /**
     * @param callable $operation
     * @param string   $exception
     * @param string   $message
     *
     * @return \Throwable|null
     * @throws \Throwable
     */
    public function assertThrows(callable $operation, $exception = \Exception::class, $message = 'Failed asserting that the operation throws an exception')
    {
        $thrownException = true;

        try {
            $operation();
            $thrownException = false;
        } catch (\Throwable $e) {
            if (strpos(get_class($e), 'PHPUnit_Framework') === 0) {
                throw $e;
            }

            $this->assertInstanceOf($exception, $e);
            return $e;
        }

        if (!$thrownException) {
            $this->fail($message);
        }

        return null;
    }
}