Next step is to change that getAuthorizationHeadersForApiKey(string $role) to getAuthorizationHeadersForApiKey(Role $role)

Author: tarlepp

tests/E2E/Controller/v1/Profile/GroupsControllerTest.php

@@ -142,11 +142,11 @@ static function (stdClass $userGroup): string {
      */
     #[DataProvider('dataProviderTestThatGroupsActionReturnExpectedWithValidApiKey')]
     #[TestDox(
-        'Test that `GET /v1/profile/groups` request returns `401` with valid `$token` API key token ($role - ROLE)'
+        'Test that `GET /v1/profile/groups` request returns `401` with valid `$token` API key token ($role - role)'
     )]
     public function testThatGroupsActionReturnExpectedWithValidApiKey(string $token, string $role): void
     {
-        $client = $this->getApiKeyClient($token);
+        $client = $this->getApiKeyClient($role);
         $client->request('GET', $this->baseUrl);
 
         $response = $client->getResponse();
@@ -165,7 +165,7 @@ public function testThatGroupsActionReturnExpectedWithValidApiKey(string $token,
         self::assertSame(401, $responseContent->code, 'Response code was not expected' . $info);
         self::assertTrue(property_exists($responseContent, 'message'), 'Response does not contain "message"' . $info);
         self::assertSame(
-            'JWT Token not found',
+            'Invalid API key',
             $responseContent->message,
             'Response message was not expected' . $info,
         );
@@ -202,13 +202,13 @@ public static function dataProviderTestThatGroupsActionReturnExpectedWithValidAp
     {
         $rolesService = self::getRolesService();
 
-        if (getenv('USE_ALL_USER_COMBINATIONS') === 'yes') {
+        #if (getenv('USE_ALL_USER_COMBINATIONS') === 'yes') {
             foreach ($rolesService->getRoles() as $role) {
                 yield [str_pad($rolesService->getShort($role), 40, '_'), $role];
             }
-        } else {
+        #} else {
             yield [str_pad($rolesService->getShort(Role::LOGGED->value), 40, '_'), Role::LOGGED->value];
-        }
+        #}
     }
 
     /**

tests/E2E/Controller/v1/Profile/IndexControllerTest.php

@@ -112,10 +112,11 @@ public function testThatProfileActionReturns401WithInvalidApiKey(): void
      * @throws JsonException
      */
     #[DataProvider('dataProviderTestThatProfileActionReturnsExpectedWithValidApiKeyToken')]
-    #[TestDox('Test that `GET /v1/profile` request returns `401` with valid `$token` API key token')]
-    public function testThatProfileActionReturnsExpectedWithValidApiKeyToken(string $token): void
+    #[TestDox('Test that `GET /v1/profile` request returns `401` with valid `$token` API key token ($role - role)')]
+    public function testThatProfileActionReturnsExpectedWithValidApiKeyToken(string $token, string $role): void
     {
-        $client = $this->getApiKeyClient($token);
+
+        $client = $this->getApiKeyClient($role);
         $client->request('GET', $this->baseUrl);
 
         $response = $client->getResponse();
@@ -134,7 +135,7 @@ public function testThatProfileActionReturnsExpectedWithValidApiKeyToken(string
         self::assertSame(401, $responseContent->code, 'Response code was not expected' . $info);
         self::assertTrue(property_exists($responseContent, 'message'), 'Response does not contain "message"' . $info);
         self::assertSame(
-            'JWT Token not found',
+            'Invalid API key',
             $responseContent->message,
             'Response message was not expected' . $info,
         );
@@ -175,13 +176,13 @@ public static function dataProviderTestThatProfileActionReturnsExpectedWithValid
     {
         $rolesService = self::getRolesService();
 
-        if (getenv('USE_ALL_USER_COMBINATIONS') === 'yes') {
+        #if (getenv('USE_ALL_USER_COMBINATIONS') === 'yes') {
             foreach ($rolesService->getRoles() as $role) {
-                yield [str_pad($rolesService->getShort($role), 40, '_')];
+                yield [str_pad($rolesService->getShort($role), 40, '_'), $role];
             }
-        } else {
-            yield [str_pad($rolesService->getShort(Role::LOGGED->value), 40, '_')];
-        }
+        #} else {
+            yield [str_pad($rolesService->getShort(Role::LOGGED->value), 40, '_'), Role::LOGGED->value];
+        #}
     }
 
     /**

tests/E2E/Controller/v1/Profile/RolesControllerTest.php

@@ -113,10 +113,12 @@ public function testThatRolesActionReturnsExpected(string $u, string $p, Stringa
      * @throws JsonException
      */
     #[DataProvider('dataProviderTestThatRolesActionReturnsExpectedWithValidApiKey')]
-    #[TestDox('Test that `GET /v1/profile/roles` request returns `401` with valid API key `$token` token')]
-    public function testThatRolesActionReturnsExpectedWithValidApiKey(string $token): void
+    #[TestDox(
+        'Test that `GET /v1/profile/roles` request returns `401` with valid API key `$token` token ($role - role)'
+    )]
+    public function testThatRolesActionReturnsExpectedWithValidApiKey(string $token, string $role): void
     {
-        $client = $this->getApiKeyClient($token);
+        $client = $this->getApiKeyClient($role);
         $client->request('GET', $this->baseUrl);
 
         $response = $client->getResponse();
@@ -135,7 +137,7 @@ public function testThatRolesActionReturnsExpectedWithValidApiKey(string $token)
         self::assertSame(401, $responseContent->code, 'Response code was not expected' . $info);
         self::assertTrue(property_exists($responseContent, 'message'), 'Response does not contain "message"' . $info);
         self::assertSame(
-            'JWT Token not found',
+            'Invalid API key',
             $responseContent->message,
             'Response message was not expected' . $info,
         );
@@ -212,7 +214,7 @@ public static function dataProviderTestThatRolesActionReturnsExpected(): Generat
     }
 
     /**
-     * @return Generator<array-key, array{0: string}>
+     * @return Generator<array-key, array{0: string, 1: string}>
      *
      * @throws Throwable
      */
@@ -222,10 +224,10 @@ public static function dataProviderTestThatRolesActionReturnsExpectedWithValidAp
 
         if (getenv('USE_ALL_USER_COMBINATIONS') === 'yes') {
             foreach ($rolesService->getRoles() as $role) {
-                yield [str_pad($rolesService->getShort($role), 40, '_')];
+                yield [str_pad($rolesService->getShort($role), 40, '_'), $role];
             }
         } else {
-            yield [str_pad($rolesService->getShort(Role::LOGGED->value), 40, '_')];
+            yield [str_pad($rolesService->getShort(Role::LOGGED->value), 40, '_'), Role::LOGGED->value];
         }
     }
 

tests/E2E/TestCase/Auth.php

@@ -59,13 +59,10 @@ public function getAuthorizationHeadersForUser(string $username, string $passwor
      */
     public function getAuthorizationHeadersForApiKey(string $role): array
     {
-        // If role is not valid role enum value then we assume that it's API key token
-        $token = (Role::tryFrom($role) === null ? $role : str_pad($role, 40, '_'));
-
         return [
             ...$this->getContentTypeHeader(),
             ...[
-                'HTTP_AUTHORIZATION' => 'ApiKey ' . $token,
+                'HTTP_AUTHORIZATION' => 'ApiKey ' . str_pad($role, 40, '_'),
             ],
         ];
     }