Merge pull request #2228 from erikn69/test_exception

drbyte · web-flow · commit cbd19cf852a5 · 2022-10-21T21:18:12.000-04:00
Add tests for display roles/permissions on UnauthorizedException
diff --git a/src/Exceptions/UnauthorizedException.php b/src/Exceptions/UnauthorizedException.php
@@ -15,8 +15,7 @@ public static function forRoles(array $roles): self
         $message = 'User does not have the right roles.';
 
         if (config('permission.display_role_in_exception')) {
-            $permStr = implode(', ', $roles);
-            $message = 'User does not have the right roles. Necessary roles are '.$permStr;
+            $message .= ' Necessary roles are '.implode(', ', $roles);
         }
 
         $exception = new static(403, $message, null, []);
@@ -30,8 +29,7 @@ public static function forPermissions(array $permissions): self
         $message = 'User does not have the right permissions.';
 
         if (config('permission.display_permission_in_exception')) {
-            $permStr = implode(', ', $permissions);
-            $message = 'User does not have the right permissions. Necessary permissions are '.$permStr;
+            $message .= ' Necessary permissions are '.implode(', ', $permissions);
         }
 
         $exception = new static(403, $message, null, []);
@@ -45,8 +43,7 @@ public static function forRolesOrPermissions(array $rolesOrPermissions): self
         $message = 'User does not have any of the necessary access rights.';
 
         if (config('permission.display_permission_in_exception') && config('permission.display_role_in_exception')) {
-            $permStr = implode(', ', $rolesOrPermissions);
-            $message = 'User does not have the right permissions. Necessary permissions are '.$permStr;
+            $message .= ' Necessary roles or permissions are '.implode(', ', $rolesOrPermissions);
         }
 
         $exception = new static(403, $message, null, []);
diff --git a/tests/PermissionMiddlewareTest.php b/tests/PermissionMiddlewareTest.php
@@ -5,6 +5,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Config;
 use InvalidArgumentException;
 use Spatie\Permission\Contracts\Permission;
 use Spatie\Permission\Exceptions\UnauthorizedException;
@@ -147,19 +148,41 @@ public function the_required_permissions_can_be_fetched_from_the_exception()
     {
         Auth::login($this->testUser);
 
+        $message = null;
         $requiredPermissions = [];
 
         try {
             $this->permissionMiddleware->handle(new Request(), function () {
                 return (new Response())->setContent('<html></html>');
             }, 'some-permission');
         } catch (UnauthorizedException $e) {
+            $message = $e->getMessage();
             $requiredPermissions = $e->getRequiredPermissions();
         }
 
+        $this->assertEquals('User does not have the right permissions.', $message);
         $this->assertEquals(['some-permission'], $requiredPermissions);
     }
 
+    /** @test */
+    public function the_required_permissions_can_be_displayed_in_the_exception()
+    {
+        Auth::login($this->testUser);
+        Config::set(['permission.display_permission_in_exception' => true]);
+
+        $message = null;
+
+        try {
+            $this->permissionMiddleware->handle(new Request(), function () {
+                return (new Response())->setContent('<html></html>');
+            }, 'some-permission');
+        } catch (UnauthorizedException $e) {
+            $message = $e->getMessage();
+        }
+
+        $this->assertStringEndsWith('Necessary permissions are some-permission', $message);
+    }
+
     /** @test */
     public function use_not_existing_custom_guard_in_permission()
     {
diff --git a/tests/RoleMiddlewareTest.php b/tests/RoleMiddlewareTest.php
@@ -5,6 +5,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Config;
 use InvalidArgumentException;
 use Spatie\Permission\Exceptions\UnauthorizedException;
 use Spatie\Permission\Middlewares\RoleMiddleware;
@@ -113,19 +114,41 @@ public function the_required_roles_can_be_fetched_from_the_exception()
     {
         Auth::login($this->testUser);
 
+        $message = null;
         $requiredRoles = [];
 
         try {
             $this->roleMiddleware->handle(new Request(), function () {
                 return (new Response())->setContent('<html></html>');
             }, 'some-role');
         } catch (UnauthorizedException $e) {
+            $message = $e->getMessage();
             $requiredRoles = $e->getRequiredRoles();
         }
 
+        $this->assertEquals('User does not have the right roles.', $message);
         $this->assertEquals(['some-role'], $requiredRoles);
     }
 
+    /** @test */
+    public function the_required_roles_can_be_displayed_in_the_exception()
+    {
+        Auth::login($this->testUser);
+        Config::set(['permission.display_role_in_exception' => true]);
+
+        $message = null;
+
+        try {
+            $this->roleMiddleware->handle(new Request(), function () {
+                return (new Response())->setContent('<html></html>');
+            }, 'some-role');
+        } catch (UnauthorizedException $e) {
+            $message = $e->getMessage();
+        }
+
+        $this->assertStringEndsWith('Necessary roles are some-role', $message);
+    }
+
     /** @test */
     public function use_not_existing_custom_guard_in_role()
     {
diff --git a/tests/RoleOrPermissionMiddlewareTest.php b/tests/RoleOrPermissionMiddlewareTest.php
@@ -5,6 +5,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Config;
 use InvalidArgumentException;
 use Spatie\Permission\Exceptions\UnauthorizedException;
 use Spatie\Permission\Middlewares\RoleOrPermissionMiddleware;
@@ -123,6 +124,47 @@ public function user_can_access_permission_or_role_with_guard_admin_while_login_
         );
     }
 
+    /** @test */
+    public function the_required_permissions_or_roles_can_be_fetched_from_the_exception()
+    {
+        Auth::login($this->testUser);
+
+        $message = null;
+        $requiredRolesOrPermissions = [];
+
+        try {
+            $this->roleOrPermissionMiddleware->handle(new Request(), function () {
+                return (new Response())->setContent('<html></html>');
+            }, 'some-permission|some-role');
+        } catch (UnauthorizedException $e) {
+            $message = $e->getMessage();
+            $requiredRolesOrPermissions = $e->getRequiredPermissions();
+        }
+
+        $this->assertEquals('User does not have any of the necessary access rights.', $message);
+        $this->assertEquals(['some-permission', 'some-role'], $requiredRolesOrPermissions);
+    }
+
+    /** @test */
+    public function the_required_permissions_or_roles_can_be_displayed_in_the_exception()
+    {
+        Auth::login($this->testUser);
+        Config::set(['permission.display_permission_in_exception' => true]);
+        Config::set(['permission.display_role_in_exception' => true]);
+
+        $message = null;
+
+        try {
+            $this->roleOrPermissionMiddleware->handle(new Request(), function () {
+                return (new Response())->setContent('<html></html>');
+            }, 'some-permission|some-role');
+        } catch (UnauthorizedException $e) {
+            $message = $e->getMessage();
+        }
+
+        $this->assertStringEndsWith('Necessary roles or permissions are some-permission, some-role', $message);
+    }
+
     protected function runMiddleware($middleware, $name, $guard = null)
     {
         try {
