Merge pull request #15 from patchlevel/if-exception-expected-and-not-thrown-fail

If exception is expected and not thrown, fail the test

Author: DanielBadura

src/Test/AggregateRootTestCase.php

@@ -127,6 +127,8 @@ final public function assert(): self
             return $this;
         }
 
+        $this->expectedExceptionWasNotThrown();
+
         if (!$aggregate instanceof AggregateRoot) {
             throw new NoAggregateCreated();
         }
@@ -187,4 +189,24 @@ private function handleException(Throwable $throwable): void
             throw $throwable;
         }
     }
+
+    private function expectedExceptionWasNotThrown(): void
+    {
+        if ($this->expectedException !== null) {
+            self::assertThat(null, new ExceptionConstraint($this->expectedException));
+        }
+
+        if ($this->expectedExceptionMessage === null) {
+            return;
+        }
+
+        self::assertThat(
+            null,
+            new ExceptionMessageIsOrContains($this->expectedExceptionMessage),
+            sprintf(
+                'Failed asserting that exception with message "%s" is thrown',
+                $this->expectedExceptionMessage,
+            ),
+        );
+    }
 }

tests/Unit/Test/AggregateRootTestCaseTest.php

@@ -23,6 +23,7 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
+use Throwable;
 
 #[CoversClass(AggregateRootTestCase::class)]
 final class AggregateRootTestCaseTest extends TestCase
@@ -86,6 +87,91 @@ public function testExceptionAndMessage(): void
         self::assertSame(2, $test::getCount());
     }
 
+    public function testExceptionNotThrown(): void
+    {
+        $test = $this->getTester();
+
+        $test
+            ->given(
+                new ProfileCreated(
+                    ProfileId::fromString('1'),
+                    Email::fromString('hq@patchlevel.de'),
+                ),
+            )
+            ->when(
+                static fn (Profile $profile) => $profile->visitProfile(new VisitProfile(ProfileId::fromString('2'))),
+            )
+            ->expectsException(ProfileError::class);
+
+        $exception = null;
+
+        try {
+            $test->assert();
+        } catch (Throwable $e) {
+            $exception = $e;
+        }
+
+        self::assertNotNull($exception);
+        self::assertSame('Failed asserting that exception of type "Patchlevel\EventSourcing\PhpUnit\Tests\Unit\Fixture\ProfileError" is thrown.', $exception->getMessage());
+    }
+
+    public function testExceptionNotThrownWithMessageSpecified(): void
+    {
+        $test = $this->getTester();
+
+        $test
+            ->given(
+                new ProfileCreated(
+                    ProfileId::fromString('1'),
+                    Email::fromString('hq@patchlevel.de'),
+                ),
+            )
+            ->when(
+                static fn (Profile $profile) => $profile->visitProfile(new VisitProfile(ProfileId::fromString('2'))),
+            )
+            ->expectsExceptionMessage('throwing so that you can catch it!');
+
+        $exception = null;
+
+        try {
+            $test->assert();
+        } catch (Throwable $e) {
+            $exception = $e;
+        }
+
+        self::assertNotNull($exception);
+        self::assertSame("Failed asserting that exception with message \"throwing so that you can catch it!\" is thrown\nFailed asserting that exception message '' contains 'throwing so that you can catch it!'.", $exception->getMessage());
+    }
+
+    public function testExceptionNotThrownAndMessageSpecified(): void
+    {
+        $test = $this->getTester();
+
+        $test
+            ->given(
+                new ProfileCreated(
+                    ProfileId::fromString('1'),
+                    Email::fromString('hq@patchlevel.de'),
+                ),
+            )
+            ->when(
+                static fn (Profile $profile) => $profile->visitProfile(new VisitProfile(ProfileId::fromString('2'))),
+            )
+            ->expectsException(ProfileError::class)
+            ->expectsExceptionMessage('throwing so that you can catch it!');
+
+        $exception = null;
+
+        try {
+            $test->assert();
+        } catch (Throwable $e) {
+            $exception = $e;
+        }
+
+        self::assertNotNull($exception);
+        self::assertSame('Failed asserting that exception of type "Patchlevel\EventSourcing\PhpUnit\Tests\Unit\Fixture\ProfileError" is thrown.', $exception->getMessage());
+    }
+
     public function testExceptionUncatched(): void
     {
         $test = $this->getTester();