-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added validation for
example, refactoring and new error reporting i…
…n tests (#62) This update enhances the testing suite by adding schema validation and reporting associated errors. Specifically, the 'ValidateCsvTest' now validates the schema and shows detailed error messages if a schema is found invalid. This makes debugging easier and improves the overall reliability of the tests.
- Loading branch information
Showing
7 changed files
with
204 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * JBZoo Toolbox - Csv-Blueprint. | ||
| * | ||
| * This file is part of the JBZoo Toolbox project. | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| * | ||
| * @license MIT | ||
| * @copyright Copyright (C) JBZoo.com, All rights reserved. | ||
| * @see https://github.com/JBZoo/Csv-Blueprint | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace JBZoo\CsvBlueprint\Validators; | ||
|
|
||
| use JBZoo\CsvBlueprint\Csv\Column; | ||
| use JBZoo\CsvBlueprint\Schema; | ||
| use JBZoo\CsvBlueprint\Utils; | ||
| use JBZoo\Data\AbstractData; | ||
|
|
||
| use function JBZoo\Data\phpArray; | ||
|
|
||
| final class SchemaValidator | ||
| { | ||
| private ?string $filename; | ||
| private bool $isHeader; | ||
| private AbstractData $data; | ||
|
|
||
| public function __construct(Schema $schema) | ||
| { | ||
| $this->filename = $schema->getFilename(); | ||
| $this->data = $schema->getData(); | ||
| $this->isHeader = $schema->getCsvStructure()->isHeader(); | ||
| } | ||
|
|
||
| public function validate(): ErrorSuite | ||
| { | ||
| [$expectedMeta, $expectedColumn] = self::getExpected(); | ||
| [$actualMeta, $actualColumns] = $this->getActual(); | ||
|
|
||
| return (new ErrorSuite($this->filename)) | ||
| ->addErrorSuit(self::validateMeta($expectedMeta, $actualMeta)) | ||
| ->addErrorSuit($this->validateColumns($expectedColumn, $actualColumns)); | ||
| } | ||
|
|
||
| private function getActual(): array | ||
| { | ||
| $actualColumns = $this->data->findSelf('columns'); | ||
| $actualMeta = $this->data->remove('columns'); | ||
|
|
||
| return [$actualMeta, $actualColumns]; | ||
| } | ||
|
|
||
| private function validateColumns(array $expectedColumn, AbstractData $actualColumns): ErrorSuite | ||
| { | ||
| $errors = new ErrorSuite(); | ||
|
|
||
| foreach ($actualColumns->getArrayCopy() as $columnKey => $actualColumn) { | ||
| $columnId = "{$columnKey}:" . ($actualColumn['name'] ?? ''); | ||
|
|
||
| // Validate column names | ||
| $errors->addErrorSuit($this->validateColumn($actualColumn, $columnId, (int)$columnKey)); | ||
|
|
||
| // Validate column schema | ||
| $columnErrors = Utils::compareArray( | ||
| $expectedColumn, | ||
| $actualColumn, | ||
| $columnId, | ||
| "columns.{$columnKey}", | ||
| ); | ||
|
|
||
| foreach ($columnErrors as $columnError) { | ||
| $errors->addError(new Error('schema', $columnError[1], $columnError[0])); | ||
| } | ||
| } | ||
|
|
||
| return $errors; | ||
| } | ||
|
|
||
| private function validateColumn(array $actualColumn, string $columnId, int $columnKey): ErrorSuite | ||
| { | ||
| return (new ErrorSuite()) | ||
| ->addError($this->validateColumnName($actualColumn, $columnId)) | ||
| ->addErrorSuit(self::validateColumnExample($actualColumn, $columnKey)); | ||
| } | ||
|
|
||
| private function validateColumnName(array $actualColumn, string $columnId): ?Error | ||
| { | ||
| if ($this->isHeader && (!isset($actualColumn['name']) || $actualColumn['name'] === '')) { | ||
| return new Error( | ||
| 'schema', | ||
| 'The key "<c>name</c>" must be non-empty because the option "<green>csv.header</green>" = true', | ||
| $columnId, | ||
| ); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| private static function validateColumnExample(array $actualColumn, int $columnKey): ?ErrorSuite | ||
| { | ||
| $exclude = [ | ||
| 'Some example', // I.e. this value is taken from full.yml, then it will be invalid in advance. | ||
| ]; | ||
|
|
||
| if (isset($actualColumn['example']) && !\in_array($actualColumn['example'], $exclude, true)) { | ||
| return (new Column($columnKey, $actualColumn))->validateCell($actualColumn['example']); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| private static function validateMeta(array $expectedMeta, AbstractData $actualMeta): ErrorSuite | ||
| { | ||
| $errors = new ErrorSuite(); | ||
| $metaErrors = Utils::compareArray($expectedMeta, $actualMeta->getArrayCopy(), 'meta', '.'); | ||
|
|
||
| foreach ($metaErrors as $metaError) { | ||
| $errors->addError(new Error('schema', $metaError[1], $metaError[0])); | ||
| } | ||
|
|
||
| return $errors; | ||
| } | ||
|
|
||
| private static function getExpected(): array | ||
| { | ||
| $referenceFile = __DIR__ . '/../../schema-examples/full.php'; | ||
| if (!\file_exists($referenceFile)) { | ||
| throw new Exception("Reference schema not found: {$referenceFile}"); | ||
| } | ||
|
|
||
| $expected = phpArray($referenceFile); | ||
| $expectedColumn = $expected->findArray('columns.0'); | ||
| $expectedMeta = $expected->remove('columns')->getArrayCopy(); | ||
|
|
||
| return [$expectedMeta, $expectedColumn]; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.