feature/SGRD-4_add-usage-test-case-functions-to-generate-jwt-trait

.github/workflows/test.yaml

@@ -0,0 +1,31 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+
+    tags:
+      - v*
+
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "8.1"
+      - uses: "ramsey/composer-install@v2"
+
+      - name: Run PHPCS
+        run: |
+          composer run-script lint
+
+      - name: Run tests
+        run: |
+          composer run-script test

README.md

@@ -5,6 +5,7 @@
   - [Add new custom guard](#add-new-custom-guard)
 - [Usage example](#usage-example)
 - [Testing](#testing)
+  - [HTTP testing](#http-testing)
 
 ## Installation
 
@@ -73,7 +74,7 @@ class CustomTest extends TestCase
 
     public function testThatIAmActingAsUser(): void
     {
-        $user = User::create();
+        $user = User::factory()->create();
 
         $this->withAccessTokenFor($user);
 
@@ -82,3 +83,53 @@ class CustomTest extends TestCase
     }
 }
 ```
+
+### HTTP testing
+
+`withAccessTokenFor` method is adding the `Bearer` token to `headers` which are sent by http tests. But you need to specify the server url somewhere on your tests. eg. `tests/CreatesApplication`:
+
+```php
+<?php
+use Supaapps\Guard\Tests\Concerns\GenerateJwtToken;
+
+trait CreatesApplication
+{
+    use GenerateJwtToken;
+
+    public function createApplication(): Application
+    {
+        ...
+
+        $this->setAuthServerUrl();
+        return $app;
+    }
+}
+```
+
+Next run your http tests, for example:
+
+```php
+<?php
+
+namespace Tests\Feature;
+
+use Tests\TestCase;
+
+class CustomTest extends TestCase
+{
+    public function itReturnsTheAuthUser(): void
+    {
+        $user = User::factory()->create();
+
+        $this->withAccessTokenFor($user);
+
+        // assume you have /user endpoint that
+        // - uses auth:jwt middleware
+        // - and returns auth user
+        $response = $this->getJson('/user');
+
+        $response->assertOk()
+            ->assertJson($user->toArray());
+    }
+}
+```

composer.json

@@ -33,7 +33,8 @@
     },
     "require-dev": {
         "orchestra/testbench": "^8.21",
-        "nunomaduro/collision": "^7.8"
+        "nunomaduro/collision": "^7.8",
+        "squizlabs/php_codesniffer": "^3.8"
     },
     "autoload-dev": {
         "psr-4": {
@@ -57,7 +58,7 @@
             "@php vendor/bin/testbench serve"
         ],
         "lint": [
-            "@php vendor/bin/phpstan analyse"
+            "@php vendor/bin/phpcs src tests config -v"
         ],
         "test": [
             "@php vendor/bin/testbench package:test"

config/sguard.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * supaapps/supaapps-guard package
  */

src/Auth/JwtAuthDriver.php

@@ -12,9 +12,6 @@
 use Illuminate\Support\Facades\Cache;
 use stdClass;
 
-/**
- *
- */
 class JwtAuthDriver implements Guard
 {
     use GuardHelpers;
@@ -101,7 +98,7 @@ public function user()
      */
     public function fetchPublicKey()
     {
-        $url = rtrim(config('sguard.auth_server_url'),'/') . '/keys/public_key';
+        $url = rtrim(config('sguard.auth_server_url'), '/') . '/keys/public_key';
         return file_get_contents($url);
     }
 
@@ -110,7 +107,7 @@ public function fetchPublicKey()
      */
     public function fetchAlgo()
     {
-        $url = rtrim(config('sguard.auth_server_url'),'/') . '/keys/algo';
+        $url = rtrim(config('sguard.auth_server_url'), '/') . '/keys/algo';
         return file_get_contents($url);
     }
 
@@ -135,25 +132,23 @@ public function validate(array $credentials = [])
                 return $this->fetchAlgo();
             });
             $this->jwtPayload = JWT::decode($bearerToken, new Key(trim($publicKey), trim($algorithm)));
-            if ( config('sguard.realm_name') !== $this->jwtPayload->aud) {
+            if (config('sguard.realm_name') !== $this->jwtPayload->aud) {
                 throw new AuthenticationException('Auth error - realm mismatch');
             }
             $this->firstName = $this->jwtPayload->first_name;
             $this->lastName = $this->jwtPayload->last_name;
             $this->email = $this->jwtPayload->email;
             $this->scopesArray = explode(' ', $this->jwtPayload->scopes);
             $this->scopes = $this->jwtPayload->scopes;
-            if (strpos($this->scopes, '/' . config('sguard.realm_name') .'/*') !== false) {
+            if (strpos($this->scopes, '/' . config('sguard.realm_name') . '/*') !== false) {
                 $this->admin = true;
             } else {
                 $this->admin = false;
             }
-
         } catch (\Throwable $ex) {
             throw new AuthenticationException('Auth error - ' . $ex->getMessage());
         }
 
-
         return true;
     }
 

src/GuardServiceProvider.php

@@ -36,6 +36,4 @@ public function register(): void
     {
         $this->mergeConfigFrom(__DIR__ . '/../config/sguard.php', 'sguard');
     }
-
-
 }

src/Tests/Concerns/GenerateJwtToken.php

@@ -4,10 +4,14 @@
 
 use Firebase\JWT\JWT;
 use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Foundation\Testing\Concerns\MakesHttpRequests;
+use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\File;
 
 trait GenerateJwtToken
 {
+    use MakesHttpRequests;
+
     public function withAccessTokenFor(Authenticatable $user, array $payload = []): string
     {
         $accessToken = $this->generateTestingJwtToken($payload + [
@@ -18,6 +22,8 @@ public function withAccessTokenFor(Authenticatable $user, array $payload = []):
             'Authorization' => "Bearer {$accessToken}"
         ]);
 
+        $this->withToken($accessToken);
+
         return $accessToken;
     }
 
@@ -42,4 +48,9 @@ public function generateTestingJwtToken(array $payload = []): string
             File::get(__DIR__ . '/../../../tests/keys/algo')
         );
     }
+
+    public function setAuthServerUrl()
+    {
+        Config::set('sguard.auth_server_url', __DIR__ . '/../../../tests');
+    }
 }

tests/TestCase.php

@@ -11,7 +11,8 @@
 
 class TestCase extends BaseTestCase
 {
-    use RefreshDatabase, GenerateJwtToken;
+    use RefreshDatabase;
+    use GenerateJwtToken;
 
     protected function getPackageProviders($app)
     {
@@ -27,7 +28,8 @@ protected function getEnvironmentSetUp($app)
             'driver' => 'supaapps-guard',
             'provider' => 'users',
         ]);
-        $app['config']->set('sguard.auth_server_url', __DIR__);
+
+        $this->setAuthServerUrl();
 
         $app->afterResolving('migrator', static function ($migrator) {
             $migrator->path(laravel_migration_path());