[9.x] Add closure based exceptions testing (#42155)

* Add closure based exceptions testing

* formatting

Co-authored-by: Taylor Otwell <[email protected]>

Author: shaffe-fr

src/Illuminate/Foundation/Testing/Concerns/InteractsWithExceptionHandling.php

@@ -2,7 +2,9 @@
 
 namespace Illuminate\Foundation\Testing\Concerns;
 
+use Closure;
 use Illuminate\Contracts\Debug\ExceptionHandler;
+use Illuminate\Testing\Assert;
 use Illuminate\Validation\ValidationException;
 use Symfony\Component\Console\Application as ConsoleApplication;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@@ -64,8 +66,7 @@ protected function withoutExceptionHandling(array $except = [])
             $this->originalExceptionHandler = app(ExceptionHandler::class);
         }
 
-        $this->app->instance(ExceptionHandler::class, new class($this->originalExceptionHandler, $except) implements ExceptionHandler
-        {
+        $this->app->instance(ExceptionHandler::class, new class($this->originalExceptionHandler, $except) implements ExceptionHandler {
             protected $except;
             protected $originalHandler;
 
@@ -147,4 +148,50 @@ public function renderForConsole($output, Throwable $e)
 
         return $this;
     }
+
+    /**
+     * Assert that the given callback throws an exception with the given message when invoked.
+     *
+     * @param  \Closure  $test
+     * @param  class-string<\Throwable>  $expectedClass
+     * @param  string|null  $expectedMessage
+     * @return $this
+     */
+    protected function assertThrows(Closure $test, string $expectedClass = Throwable::class, ?string $expectedMessage = null)
+    {
+        try {
+            $test();
+
+            $thrown = false;
+        } catch (Throwable $exception) {
+            $thrown = $exception instanceof $expectedClass;
+
+            $actualMessage = $exception->getMessage();
+        }
+
+        if (! $thrown) {
+            Assert::fail(
+                sprintf(
+                    'Failed asserting that exception of type "%s" is thrown.',
+                    $expectedClass
+                )
+            );
+        }
+
+        if (isset($expectedMessage)) {
+            if (! isset($actualMessage)) {
+                Assert::fail(
+                    sprintf(
+                        'Failed asserting that exception of type "%s" with message "%s" is thrown.',
+                        $expectedClass,
+                        $expectedMessage
+                    )
+                );
+            } else {
+                Assert::assertStringContainsString($expectedMessage, $actualMessage);
+            }
+        }
+
+        return $this;
+    }
 }

tests/Foundation/FoundationExceptionsHandlerTest.php

@@ -10,17 +10,20 @@
 use Illuminate\Contracts\View\Factory as ViewFactory;
 use Illuminate\Database\RecordsNotFoundException;
 use Illuminate\Foundation\Exceptions\Handler;
+use Illuminate\Foundation\Testing\Concerns\InteractsWithExceptionHandling;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
 use Illuminate\Routing\Redirector;
 use Illuminate\Routing\ResponseFactory;
 use Illuminate\Support\MessageBag;
+use Illuminate\Testing\Assert;
 use Illuminate\Validation\ValidationException;
 use Illuminate\Validation\Validator;
 use InvalidArgumentException;
 use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use OutOfRangeException;
+use PHPUnit\Framework\AssertionFailedError;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
@@ -34,6 +37,7 @@
 class FoundationExceptionsHandlerTest extends TestCase
 {
     use MockeryPHPUnitIntegration;
+    use InteractsWithExceptionHandling;
 
     protected $config;
 
@@ -367,6 +371,54 @@ public function getErrorView($e)
 
         $this->assertNull($handler->getErrorView(new HttpException(404)));
     }
+
+    public function testAssertExceptionIsThrown()
+    {
+        $this->assertThrows(function () {
+            throw new Exception;
+        });
+        $this->assertThrows(function () {
+            throw new CustomException;
+        });
+        $this->assertThrows(function () {
+            throw new CustomException;
+        }, CustomException::class);
+        $this->assertThrows(function () {
+            throw new Exception('Some message.');
+        }, expectedMessage: 'Some message.');
+        $this->assertThrows(function () {
+            throw new CustomException('Some message.');
+        }, expectedMessage: 'Some message.');
+        $this->assertThrows(function () {
+            throw new CustomException('Some message.');
+        }, expectedClass: CustomException::class, expectedMessage: 'Some message.');
+
+        try {
+            $this->assertThrows(function () {
+                throw new Exception;
+            }, CustomException::class);
+            $testFailed = true;
+        } catch (AssertionFailedError $exception) {
+            $testFailed = false;
+        }
+
+        if ($testFailed) {
+            Assert::fail('assertThrows failed: non matching exceptions are thrown.');
+        }
+
+        try {
+            $this->assertThrows(function () {
+                throw new Exception('Some message.');
+            }, expectedClass: Exception::class, expectedMessage: 'Other message.');
+            $testFailed = true;
+        } catch (AssertionFailedError $exception) {
+            $testFailed = false;
+        }
+
+        if ($testFailed) {
+            Assert::fail('assertThrows failed: non matching message are thrown.');
+        }
+    }
 }
 
 class CustomException extends Exception