ArrayValidator: data index validation

Author: doomy

src/Validation/Result/ValidationResultBuilder.php

@@ -131,6 +131,11 @@ public function addOneOfAmbiguousViolation(BreadCrumbPathInterface $breadCrumbPa
         return $this->addViolation($this->validityViolationFactory->createOneOfAmbiguousViolation($breadCrumbPath));
     }
 
+    public function addSequenceViolation(BreadCrumbPathInterface $breadCrumbPath): self
+    {
+        return $this->addViolation($this->validityViolationFactory->createSequenceViolation($breadCrumbPath));
+    }
+
     public function mergeResult(ValidationResultInterface $validationResult): self
     {
         return $this->mergeViolations($validationResult->getViolations());

src/Validation/Result/ValidityViolationFactory.php

@@ -135,4 +135,9 @@ public function createOneOfAmbiguousViolation(BreadCrumbPathInterface $breadCrum
     {
         return new ValidityViolation(1019, 'Value matches more then one schema.', [], $breadCrumbPath);
     }
+
+    public function createSequenceViolation(BreadCrumbPathInterface $breadCrumbPath): ValidityViolationInterface
+    {
+        return new ValidityViolation(1020, 'Sequence violation.', [], $breadCrumbPath);
+    }
 }

src/Validation/Validator/ArrayValidator.php

@@ -55,6 +55,11 @@ protected function doValidation(
         }
 
         $itemsSchema = $this->schema->getItemsSchema();
+
+        if (! $this->validateDataIndex($data, $resultBuilder, $breadCrumbPath)) {
+            return;
+        }
+
         foreach ($data as $itemIndex => $itemData) {
             $propertyValidationResult = $this->valueValidator->validate(
                 $itemsSchema,
@@ -90,4 +95,26 @@ protected function collectPossibleViolationExamples(
             )
         );
     }
+
+    private function validateDataIndex(
+        array $data,
+        ValidationResultBuilder $resultBuilder,
+        BreadCrumbPathInterface $breadCrumbPath
+    ): bool {
+        $expectedIndex = 0;
+        foreach ($data as $itemIndex => $itemData) {
+            if (! is_int($itemIndex)) {
+                $resultBuilder->addTypeViolation('array', $breadCrumbPath);
+                return false;
+            }
+            if ($itemIndex !== $expectedIndex) {
+                $resultBuilder->addSequenceViolation($breadCrumbPath);
+                return false;
+            }
+
+            $expectedIndex++;
+        }
+
+        return true;
+    }
 }

src/Validation/ValidityViolationFactoryInterface.php

@@ -85,4 +85,6 @@ public function createPatternViolation(
     public function createOneOfNoMatchViolation(BreadCrumbPathInterface $breadCrumbPath): ValidityViolationInterface;
 
     public function createOneOfAmbiguousViolation(BreadCrumbPathInterface $breadCrumbPath): ValidityViolationInterface;
+
+    public function createSequenceViolation(BreadCrumbPathInterface $breadCrumbPath): ValidityViolationInterface;
 }

tests/Validation/ArrayValidatorTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace ScrumWorks\OpenApiSchema\Tests\Validation;
+
+use PHPUnit\Framework\TestCase;
+use ScrumWorks\OpenApiSchema\Tests\DiTrait;
+use ScrumWorks\OpenApiSchema\Validation\Result\BreadCrumbPathFactory;
+use ScrumWorks\OpenApiSchema\Validation\Result\ValidationResultBuilderFactory;
+use ScrumWorks\OpenApiSchema\Validation\Validator\ArrayValidator;
+use ScrumWorks\OpenApiSchema\Validation\ValueSchemaValidatorInterface;
+use ScrumWorks\OpenApiSchema\ValueSchema\Data\ArraySchemaData;
+use ScrumWorks\OpenApiSchema\ValueSchema\Data\StringSchemaData;
+
+final class ArrayValidatorTest extends TestCase
+{
+    use DiTrait;
+
+    public function testArrayValidation(): void
+    {
+        $arraySchema = new ArraySchemaData(itemsSchema: new StringSchemaData());
+
+        $validator = new ArrayValidator(
+            $this->getServiceFromContainerByType(BreadCrumbPathFactory::class),
+            $this->getServiceFromContainerByType(ValidationResultBuilderFactory::class),
+            $arraySchema,
+            $this->getServiceFromContainerByType(ValueSchemaValidatorInterface::class)
+        );
+
+        self::assertCount(0, $validator->validate(['asd', 'qwe'])->getViolations());
+        self::assertCount(0, $validator->validate([
+            0 => 'asd',
+            1 => 'qwe',
+        ])->getViolations());
+
+        $violations = $validator->validate([
+            'asd' => 'qwe',
+        ])->getViolations();
+        self::assertEquals(1002, reset($violations)->getViolationCode());
+
+        self::assertCount(1, $validator->validate([
+            'asd' => 'qwe',
+        ])->getViolations());
+        $violations = $validator->validate([
+            1 => 'asd',
+            3 => 'qwe',
+        ])->getViolations();
+        self::assertCount(1, $violations);
+        self::assertEquals(1020, reset($violations)->getViolationCode());
+    }
+}