feat(api tester): handle new baseline for response schema validation

Author: Dzov

src/Config/Filters.php

@@ -10,6 +10,8 @@
 
 final class Filters
 {
+    public string $schemaValidationBaseline = 'api-tester.schema-baseline.yaml';
+
     /**
      * @var array<array<string, string>>
      */
@@ -26,11 +28,16 @@ final class Filters
      * @param array<array<string, string>> $include
      * @param array<array<string, string>> $exclude
      */
-    public function __construct(?array $include = null, ?array $exclude = null, string $baseline = null)
-    {
+    public function __construct(
+        ?array $include = null,
+        ?array $exclude = null,
+        string $baseline = null,
+        string $schemaValidationBaseline = null
+    ) {
         $this->include = $include ?? [];
         $this->exclude = $exclude ?? [];
         $this->baseline = $baseline ?? $this->baseline;
+        $this->schemaValidationBaseline = $schemaValidationBaseline ?? $this->schemaValidationBaseline;
     }
 
     /**
@@ -68,6 +75,26 @@ public function getBaseLineExclude(): array
         return $baseline['exclude'];
     }
 
+    /**
+     * @return array<string>
+     */
+    public function getSchemaValidationBaseline(): array
+    {
+        if (!file_exists($this->schemaValidationBaseline)) {
+            return [];
+        }
+
+        /** @var array{'exclude': ?array<string>} */
+        $baseline = Yaml::parseFile($this->schemaValidationBaseline);
+
+        if (!isset($baseline['exclude'])) {
+            return [];
+        }
+
+        /** @var array<string> */
+        return $baseline['exclude'];
+    }
+
     public function getBaseline(): string
     {
         return $this->baseline;

src/Preparator/TestCasesPreparator.php

@@ -30,11 +30,17 @@ abstract class TestCasesPreparator
 
     protected LoggerInterface $logger;
 
+    /**
+     * @var array<string>
+     */
+    protected array $schemaValidationBaseline;
+
     public function __construct()
     {
         $this->tokens = new Tokens();
         $this->config = $this->newConfigInstance(static::getConfigFQCN());
         $this->logger = new NullLogger();
+        $this->schemaValidationBaseline = [];
     }
 
     /**
@@ -85,7 +91,10 @@ final public function doPrepare(Operations $operations): iterable
         $testCases = $this->prepare($operations);
         foreach ($testCases as $testCase) {
             $testCase->addExcludedFields($this->config->excludedFields);
-            $testCase->setSchemaValidation($this->config->schemaValidation);
+            if (!$this->config->schemaValidation
+                || in_array($testCase->getOperation(), $this->schemaValidationBaseline, true)) {
+                $testCase->setSchemaValidation(false);
+            }
         }
 
         return $testCases;
@@ -130,6 +139,14 @@ final public function setLogger(LoggerInterface $logger): void
         $this->logger = $logger;
     }
 
+    /**
+     * @param array<string> $schemaValidationBaseline
+     */
+    final public function setSchemaValidationBaseline(array $schemaValidationBaseline): void
+    {
+        $this->schemaValidationBaseline = $schemaValidationBaseline;
+    }
+
     /**
      * @return class-string<PreparatorConfig>
      */

src/Test/Suite.php

@@ -148,6 +148,7 @@ private function prepareTestCases(): void
         $allTests = collect();
         foreach ($this->preparators as $preparator) {
             $preparator->setLogger($this->logger);
+            $preparator->setSchemaValidationBaseline($this->filters->getSchemaValidationBaseline());
             $operations = $this->api->getOperations()
                 ->map(
                     static fn (Operation $op) => $op->setPreparator($preparator::getName())

tests/Fixtures/Config/schema-validation-baseline.yaml

@@ -0,0 +1,2 @@
+exclude:
+    - 'operationIdInBaseline'

tests/Preparator/ExamplesPreparatorTest.php

@@ -441,6 +441,54 @@ public function getExpectedTestSuites(): iterable
         ];
     }
 
+    public function testSchemaValidationDisabledForBaselineOperation(): void
+    {
+        $preparator = new ExamplesPreparator();
+
+        $preparator->configure([
+            'schemaValidation' => true,
+        ]);
+
+        $api = Api::create()->addOperation(
+            Operation::create('operationIdInBaseline', '/test')
+                ->addQueryParameter(
+                    Parameter::create('foo')
+                        ->setSchema(
+                            new Schema([
+                                'type' => 'string',
+                            ])
+                        )
+                )
+                ->addResponse(DefinitionResponse::create(200))
+                ->addExample(
+                    OperationExample::create('200.default')
+                        ->setQueryParameters([
+                            'foo' => 'bar',
+                        ])
+                        ->setResponse(new ResponseExample())
+                )
+        );
+        $filters = new Filters(
+            schemaValidationBaseline: __DIR__ . '/../../tests/Fixtures/Config/schema-validation-baseline.yaml'
+        );
+        $preparator->setSchemaValidationBaseline($filters->getSchemaValidationBaseline());
+
+        Assert::objectsEqual(
+            [
+                new TestCase(
+                    ExamplesPreparator::getName() . ' - operationIdInBaseline - 200.default',
+                    OperationExample::create('operationIdInBaseline')
+                        ->setPath('/test')
+                        ->setQueryParameter('foo', 'bar')
+                        ->setResponse(ResponseExample::create('200')),
+                    schemaValidation: false
+                ),
+            ],
+            $preparator->doPrepare($api->getOperations()),
+            ['parent']
+        );
+    }
+
     private function addTokens(ExamplesPreparator $preparator): void
     {
         $preparator->addToken(