Merge pull request #67 from OpenClassrooms/authenticate_specific_user

feat(api tester): enable specific user authentication for given endpoint
OpenClassrooms · Nov 19, 2024 · 2f54edb · 2f54edb
2 parents 189326d + 614c0e1
commit 2f54edb
Show file tree

Hide file tree

Showing 9 changed files with 189 additions and 72 deletions.
diff --git a/src/Authenticator/Authenticator.php b/src/Authenticator/Authenticator.php
@@ -47,6 +47,7 @@ public function authenticate(Auth $config, Api $api, Requester $requester): Toke
             $body['access_token'],
             explode(' ', $config->getBody()['scope'] ?? ''),
             $body['refresh_token'] ?? null,
+            $config->getFilters(),
             $body['token_type'] ?? null,
             $body['expires_in'] ?? null,
         );

diff --git a/src/Config/Auth.php b/src/Config/Auth.php
@@ -16,6 +16,8 @@ final class Auth
      */
     private array $body = [];
 
+    private ?Filters $filters = null;
+
     public function __construct(
         private readonly string $name
     ) {
@@ -57,4 +59,14 @@ public function setBody(array $body): void
     {
         $this->body = $body;
     }
+
+    public function getFilters(): ?Filters
+    {
+        return $this->filters;
+    }
+
+    public function setFilters(Filters $filters): void
+    {
+        $this->filters = $filters;
+    }
 }
diff --git a/src/Config/Filters.php b/src/Config/Filters.php
@@ -4,6 +4,8 @@
 
 namespace APITester\Config;
 
+use APITester\Util\Filterable;
+use Symfony\Component\Yaml\Tag\TaggedValue;
 use Symfony\Component\Yaml\Yaml;
 
 final class Filters
@@ -108,6 +110,39 @@ public function writeBaseline(array $exclude): void
         );
     }
 
+    public function includes(Filterable $object): bool
+    {
+        $include = true;
+        foreach ($this->getInclude() as $item) {
+            $include = true;
+            foreach ($item as $key => $value) {
+                [$operator, $value] = $this->handleTags($value);
+                if (!$object->has($key, $value, $operator)) {
+                    $include = false;
+                    continue 2;
+                }
+            }
+            break;
+        }
+
+        if (!$include) {
+            return false;
+        }
+
+        foreach ($this->getExclude() as $item) {
+            foreach ($item as $key => $value) {
+                [$operator, $value] = $this->handleTags($value);
+                if (!$object->has($key, $value, $operator)) {
+                    continue 2;
+                }
+            }
+            $include = false;
+            break;
+        }
+
+        return $include;
+    }
+
     /**
      * @return array{'exclude': ?array<int, array<string, string>>}
      */
@@ -116,4 +151,21 @@ private function getBaseLineData(): array
         /** @var array{'exclude': ?array<int, array<string, string>>} */
         return Yaml::parseFile($this->getBaseline());
     }
+
+    /**
+     * @return array{0: string, 1: string|int}
+     */
+    private function handleTags(string|int|TaggedValue $value): array
+    {
+        $operator = '=';
+
+        if ($value instanceof TaggedValue) {
+            if ($value->getTag() === 'NOT') {
+                $operator = '!=';
+            }
+            $value = (string) $value->getValue();
+        }
+
+        return [$operator, $value];
+    }
 }
diff --git a/src/Definition/Example/OperationExample.php b/src/Definition/Example/OperationExample.php
@@ -96,6 +96,7 @@ public function setParameter(
             foreach ($value as $attribute => $attributeValue) {
                 $this->{$paramProp}[$name][$attribute] = (string) $attributeValue;
             }
+
             return $this;
         }
 
@@ -388,11 +389,12 @@ public function setAuthenticationHeaders(Tokens $tokens, bool $ignoreScope = fal
                 $token = $tokens->first();
             } else {
                 /** @var Token|null $token */
-                $token = $tokens->where(
-                    'scopes',
-                    'includes',
-                    $scopes
-                )->first();
+                $token = $tokens->filter(
+                    static fn (Token $token) => $token->getFilters()?->includes($operation) ?? false
+                )
+                    ->first() ?? $tokens->where('scopes', 'includes', $scopes)
+                    ->first()
+                ;
             }
 
             if ($token !== null) {

diff --git a/src/Definition/Token.php b/src/Definition/Token.php
@@ -4,6 +4,8 @@
 
 namespace APITester\Definition;
 
+use APITester\Config\Filters;
+
 final class Token
 {
     private readonly string $type;
@@ -19,13 +21,19 @@ public function __construct(
         private readonly string $accessToken,
         private readonly array $scopes = [],
         private readonly ?string $refreshToken = null,
+        private readonly ?Filters $filters = null,
         ?string $type = null,
         ?int $expiresIn = null
     ) {
         $this->type = $type ?? 'Bearer';
         $this->expiresIn = $expiresIn ?? 3600;
     }
 
+    public function getFilters(): ?Filters
+    {
+        return $this->filters;
+    }
+
     public function getAccessToken(): string
     {
         return $this->accessToken;

diff --git a/src/Test/Suite.php b/src/Test/Suite.php
@@ -11,14 +11,12 @@
 use APITester\Preparator\Exception\PreparatorLoadingException;
 use APITester\Preparator\TestCasesPreparator;
 use APITester\Requester\Requester;
-use APITester\Util\Filterable;
 use APITester\Util\Traits\TimeBoundTrait;
 use Illuminate\Support\Collection;
 use PHPUnit\Framework\TestResult;
 use PHPUnit\Framework\TestSuite;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
-use Symfony\Component\Yaml\Tag\TaggedValue;
 
 /**
  * @internal
@@ -87,43 +85,6 @@ public function setLogger(LoggerInterface $logger): void
         $this->logger = $logger;
     }
 
-    /**
-     * @param array<array<string, string>> $includeFilters
-     * @param array<array<string, string>> $excludeFilters
-     */
-    public function includes(Filterable $object, array $includeFilters = [], array $excludeFilters = []): bool
-    {
-        $include = true;
-        foreach ($includeFilters as $item) {
-            $include = true;
-            foreach ($item as $key => $value) {
-                [$operator, $value] = $this->handleTags($value);
-                if (!$object->has($key, $value, $operator)) {
-                    $include = false;
-                    continue 2;
-                }
-            }
-            break;
-        }
-
-        if (!$include) {
-            return false;
-        }
-
-        foreach ($excludeFilters as $item) {
-            foreach ($item as $key => $value) {
-                [$operator, $value] = $this->handleTags($value);
-                if (!$object->has($key, $value, $operator)) {
-                    continue 2;
-                }
-            }
-            $include = false;
-            break;
-        }
-
-        return $include;
-    }
-
     /**
      * @param array<array<string, string>> $filter
      *
@@ -233,13 +194,7 @@ private function prepareTestCases(): void
 
     private function filterOperation(Operations $operations): Operations
     {
-        return $operations->filter(
-            fn (Operation $operation) => $this->includes(
-                $operation,
-                $this->filters->getInclude(),
-                $this->filters->getExclude(),
-            )
-        );
+        return $operations->filter(fn (Operation $operation) => $this->filters->includes($operation));
     }
 
     /**
@@ -301,21 +256,4 @@ private function indexInPart(?string $part, int $index, int $total): bool
 
         return false;
     }
-
-    /**
-     * @return array{0: string, 1: string|int}
-     */
-    private function handleTags(string|int|\Symfony\Component\Yaml\Tag\TaggedValue $value): array
-    {
-        $operator = '=';
-
-        if ($value instanceof TaggedValue) {
-            if ($value->getTag() === 'NOT') {
-                $operator = '!=';
-            }
-            $value = (string) $value->getValue();
-        }
-
-        return [$operator, $value];
-    }
 }
diff --git a/src/Test/TestCase.php b/src/Test/TestCase.php
@@ -72,7 +72,7 @@ final class TestCase implements \JsonSerializable, Filterable
 
     private ?string $operation;
 
-    private ?string $preparator;
+    private string $preparator;
 
     private Validator $validator;
 
@@ -238,7 +238,7 @@ public function setOperation(string $operation): void
         $this->operation = $operation;
     }
 
-    public function getPreparator(): ?string
+    public function getPreparator(): string
     {
         return $this->preparator;
     }