Add assertPathExists assertion (#146)

This assertion is a convient way to only check whether an endpoint is in the spec or not. Co-authored-by: Alexander Lentner <[email protected]>
hotmeteor · Jul 28, 2023 · 07bef2f · 07bef2f
1 parent f1e369c
commit 07bef2f
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/src/Assertions.php b/src/Assertions.php
@@ -145,6 +145,19 @@ public function assertErrorsContain()
         });
     }
 
+    public function assertPathExists()
+    {
+        return fn () => $this->runAssertion(function () {
+            $exception = app('spectator')->requestException;
+
+            $this->expectsFalse($exception, [
+                InvalidPathException::class,
+            ]);
+
+            return $this;
+        });
+    }
+
     public function dumpSpecErrors()
     {
         return function () {

diff --git a/tests/AssertionsTest.php b/tests/AssertionsTest.php
@@ -73,4 +73,24 @@ public function test_request_assertion_does_not_format_laravel_validation_respon
             ->assertValidRequest()
             ->assertValidResponse(422);
     }
+
+    public function test_asserts_path_exists()
+    {
+        Route::get('/users')->middleware(Middleware::class);
+
+        $this->getJson('/users')
+            ->assertPathExists();
+    }
+
+    public function test_asserts_path_does_not_exist()
+    {
+        $this->expectException(\ErrorException::class);
+        $this->expectExceptionCode(0);
+        $this->expectExceptionMessage('Path [GET /invalid] not found in spec.');
+
+        Route::get('/invalid')->middleware(Middleware::class);
+
+        $this->getJson('/invalid')
+            ->assertPathExists();
+    }
 }