Merge pull request #70 from OpenClassrooms/update_400_preparator_excl…

…usion feat(api tester): use filters to exclude openapi endpoints
OpenClassrooms · Nov 29, 2024 · ac5b414 · ac5b414
2 parents 699dcda + 101e337
commit ac5b414
Show file tree

Hide file tree

Showing 8 changed files with 7 additions and 92 deletions.
diff --git a/src/Config/Filters.php b/src/Config/Filters.php
@@ -160,9 +160,11 @@ private function handleTags(string|int|TaggedValue $value): array
         $operator = '=';
 
         if ($value instanceof TaggedValue) {
-            if ($value->getTag() === 'NOT') {
-                $operator = '!=';
-            }
+            match ($value->getTag()) {
+                'NOT' => $operator = '!=',
+                'IN' => $operator = 'contains',
+                default => $operator,
+            };
             $value = (string) $value->getValue();
         }
 

diff --git a/src/Preparator/Config/Error400BadFormatsPreparatorConfig.php b/src/Preparator/Config/Error400BadFormatsPreparatorConfig.php
diff --git a/src/Preparator/Config/Error400BadTypesPreparatorConfig.php b/src/Preparator/Config/Error400BadTypesPreparatorConfig.php
diff --git a/src/Preparator/Config/Error400MissingRequiredFieldsPreparatorConfig.php b/src/Preparator/Config/Error400MissingRequiredFieldsPreparatorConfig.php
diff --git a/src/Preparator/Config/Error400PreparatorConfig.php b/src/Preparator/Config/Error400PreparatorConfig.php
diff --git a/src/Preparator/Error400Preparator.php b/src/Preparator/Error400Preparator.php
@@ -12,12 +12,8 @@
 use APITester\Definition\Example\ResponseExample;
 use APITester\Definition\Operation;
 use APITester\Definition\Parameter;
-use APITester\Preparator\Config\Error400PreparatorConfig;
 use APITester\Test\TestCase;
 
-/**
- * @property Error400PreparatorConfig $config
- */
 abstract class Error400Preparator extends TestCasesPreparator
 {
     /**
@@ -122,10 +118,6 @@ protected function getStatusCode(): string
      */
     private function prepareTestCases(Operation $operation): array
     {
-        if ($this->config->excludeOpenApiEndpoints
-            && isset($operation->getExtensions()['x-usecase'])) {
-            return [];
-        }
         $requiredParams = $operation->getParameters(true);
 
         return array_merge(

diff --git a/src/Util/Traits/FilterableTrait.php b/src/Util/Traits/FilterableTrait.php
@@ -9,6 +9,7 @@ trait FilterableTrait
     public function has(string $prop, $value, string $operator = '='): bool
     {
         $self = collect([$this]);
+
         if (str_contains($prop, '*')) {
             $operator = 'contains';
         }

diff --git a/tests/Preparator/Error400MissingRequiredFieldsPreparatorTest.php b/tests/Preparator/Error400MissingRequiredFieldsPreparatorTest.php
@@ -22,7 +22,7 @@ final class Error400MissingRequiredFieldsPreparatorTest extends \PHPUnit\Framewo
      * @dataProvider getData
      *
      * @param array<string, array<mixed>> $config
-     * @param TestCase[] $expected
+     * @param TestCase[]                  $expected
      */
     public function test(Api $api, array $expected, array $config = []): void
     {
@@ -165,48 +165,5 @@ public function getData(): iterable
                 ),
             ],
         ];
-
-        yield 'openapi endpoint is ignored' => [
-            Api::create()
-                ->addOperation(
-                    Operation::create(
-                        'test',
-                        '/test',
-                        'POST'
-                    )
-                        ->addRequestBody(
-                            (new Body(
-                                new Schema([
-                                    'type' => 'object',
-                                    'properties' => [
-                                        'foo' => [
-                                            'type' => 'string',
-                                        ],
-                                        'bar' => [
-                                            'type' => 'string',
-                                        ],
-                                    ],
-                                    'required' => ['foo'],
-                                ]),
-                                'application/json'
-                            ))
-                        )
-                        ->addExample(
-                            OperationExample::create('foo')
-                                ->setBodyContent([
-                                    'foo' => 'foo_body1',
-                                    'bar' => 'bar_body1',
-                                ])
-                                ->setQueryParameter('foo_query', 'foo1')
-                        )->setExtensions([
-                            'x-usecase' => 'UseCaseName',
-                        ])
-                ),
-            [
-            ],
-            [
-                'excludeOpenApiEndpoints' => true,
-            ],
-        ];
     }
 }