Skip to content

Commit fc08765

Browse files
SmetDenisSmetDenis
authored
Update SchemaValidator to cast example to string (#63)
This commit modifies the SchemaValidator code, ensuring that values used for examples are cast as strings before validation. This change addresses potential issues with non-string values, improving the robustness and accuracy of the schema validation process. Updates have also been made to the associated tests and documentation.
1 parent 75d77c4 commit fc08765

File tree

4 files changed

+35
-24
lines changed

4 files changed

+35
-24
lines changed

‎README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -517,11 +517,12 @@ Schema: ./tests/schemas/demo_invalid.yml
517517
Found CSV files: 1
518518
519519
Schema is invalid: ./tests/schemas/demo_invalid.yml
520-
+-------+-----------+----- demo_invalid.yml --------------------------+
521-
| Line | id:Column | Rule | Message |
522-
+-------+-----------+----------+--------------------------------------+
523-
| undef | 2:Float | is_float | Value "Qwerty" is not a float number |
524-
+-------+-----------+----- demo_invalid.yml --------------------------+
520+
+-------+------------------+--------------+----- demo_invalid.yml -----------------------------------------------+
521+
| Line | id:Column | Rule | Message |
522+
+-------+------------------+--------------+----------------------------------------------------------------------+
523+
| undef | 2:Float | is_float | Value "Qwerty" is not a float number |
524+
| undef | 4:Favorite color | allow_values | Value "123" is not allowed. Allowed values: ["red", "green", "Blue"] |
525+
+-------+------------------+--------------+----- demo_invalid.yml -----------------------------------------------+
525526
526527
(1/1) Invalid file: ./tests/fixtures/demo.csv
527528
+------+------------------+------------------+----------------------- demo.csv ---------------------------------------------------------------------+
@@ -543,7 +544,7 @@ Schema is invalid: ./tests/schemas/demo_invalid.yml
543544
544545
545546
Found 9 issues in CSV file.
546-
Found 1 issues in schema.
547+
Found 2 issues in schema.
547548
548549
```
549550
<!-- /output-table -->

‎src/Validators/SchemaValidator.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ private static function validateColumnExample(array $actualColumn, int $columnKe
107107
];
108108

109109
if (isset($actualColumn['example']) && !\in_array($actualColumn['example'], $exclude, true)) {
110-
return (new Column($columnKey, $actualColumn))->validateCell($actualColumn['example']);
110+
return (new Column($columnKey, $actualColumn))->validateCell((string)$actualColumn['example']);
111111
}
112112

113113
return null;

‎tests/Commands/ValidateCsvTest.php

+26-17
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,12 @@ public function testValidateOneFileNegativeTable(): void
6363
Found CSV files: 1
6464
6565
Schema is invalid: ./tests/schemas/demo_invalid.yml
66-
+-------+-----------+----- demo_invalid.yml --------------------------+
67-
| Line | id:Column | Rule | Message |
68-
+-------+-----------+----------+--------------------------------------+
69-
| undef | 2:Float | is_float | Value "Qwerty" is not a float number |
70-
+-------+-----------+----- demo_invalid.yml --------------------------+
66+
+-------+------------------+--------------+----- demo_invalid.yml -----------------------------------------------+
67+
| Line | id:Column | Rule | Message |
68+
+-------+------------------+--------------+----------------------------------------------------------------------+
69+
| undef | 2:Float | is_float | Value "Qwerty" is not a float number |
70+
| undef | 4:Favorite color | allow_values | Value "123" is not allowed. Allowed values: ["red", "green", "Blue"] |
71+
+-------+------------------+--------------+----- demo_invalid.yml -----------------------------------------------+
7172
7273
(1/1) Invalid file: ./tests/fixtures/demo.csv
7374
+------+------------------+------------------+----------------------- demo.csv ---------------------------------------------------------------------+
@@ -89,7 +90,7 @@ public function testValidateOneFileNegativeTable(): void
8990
9091
9192
Found 9 issues in CSV file.
92-
Found 1 issues in schema.
93+
Found 2 issues in schema.
9394

9495
TXT;
9596

@@ -111,11 +112,12 @@ public function testValidateManyFileNegativeTable(): void
111112
Found CSV files: 3
112113
113114
Schema is invalid: ./tests/schemas/demo_invalid.yml
114-
+-------+-----------+----- demo_invalid.yml --------------------------+
115-
| Line | id:Column | Rule | Message |
116-
+-------+-----------+----------+--------------------------------------+
117-
| undef | 2:Float | is_float | Value "Qwerty" is not a float number |
118-
+-------+-----------+----- demo_invalid.yml --------------------------+
115+
+-------+------------------+--------------+----- demo_invalid.yml -----------------------------------------------+
116+
| Line | id:Column | Rule | Message |
117+
+-------+------------------+--------------+----------------------------------------------------------------------+
118+
| undef | 2:Float | is_float | Value "Qwerty" is not a float number |
119+
| undef | 4:Favorite color | allow_values | Value "123" is not allowed. Allowed values: ["red", "green", "Blue"] |
120+
+-------+------------------+--------------+----- demo_invalid.yml -----------------------------------------------+
119121
120122
(1/3) Invalid file: ./tests/fixtures/batch/demo-1.csv
121123
+------+------------------+--------------+--------- demo-1.csv --------------------------------------------------+
@@ -148,7 +150,7 @@ public function testValidateManyFileNegativeTable(): void
148150
149151
150152
Found 8 issues in 3 out of 3 CSV files.
151-
Found 1 issues in schema.
153+
Found 2 issues in schema.
152154

153155
TXT;
154156

@@ -170,6 +172,7 @@ public function testValidateOneFileNegativeText(): void
170172
171173
Schema is invalid: ./tests/schemas/demo_invalid.yml
172174
"is_float", column "2:Float". Value "Qwerty" is not a float number.
175+
"allow_values", column "4:Favorite color". Value "123" is not allowed. Allowed values: ["red", "green", "Blue"].
173176
174177
(1/1) Invalid file: ./tests/fixtures/demo.csv
175178
"filename_pattern" at line 1, column "". Filename "./tests/fixtures/demo.csv" does not match pattern: "/demo-[12].csv$/i".
@@ -184,7 +187,7 @@ public function testValidateOneFileNegativeText(): void
184187
185188
186189
Found 9 issues in CSV file.
187-
Found 1 issues in schema.
190+
Found 2 issues in schema.
188191

189192
TXT;
190193

@@ -200,6 +203,7 @@ public function testValidateManyFilesNegativeTextQuick(): void
200203
201204
Schema is invalid: ./tests/schemas/demo_invalid.yml
202205
"is_float", column "2:Float". Value "Qwerty" is not a float number.
206+
"allow_values", column "4:Favorite color". Value "123" is not allowed. Allowed values: ["red", "green", "Blue"].
203207
204208
(1/3) Invalid file: ./tests/fixtures/batch/demo-1.csv
205209
"ag:is_unique" at line 1, column "1:City". Column has non-unique values. Unique: 1, total: 2.
@@ -208,7 +212,7 @@ public function testValidateManyFilesNegativeTextQuick(): void
208212
(3/3) Skipped: ./tests/fixtures/batch/sub/demo-3.csv
209213
210214
Found 1 issues in 1 out of 3 CSV files.
211-
Found 1 issues in schema.
215+
Found 2 issues in schema.
212216

213217
TXT;
214218

@@ -267,6 +271,7 @@ public function testValidateManyFilesNegativeTextQuick(): void
267271
268272
Schema is invalid: ./tests/schemas/demo_invalid.yml
269273
"is_float", column "2:Float". Value "Qwerty" is not a float number.
274+
"allow_values", column "4:Favorite color". Value "123" is not allowed. Allowed values: ["red", "green", "Blue"].
270275
271276
(1/3) Invalid file: ./tests/fixtures/batch/demo-1.csv
272277
"ag:is_unique" at line 1, column "1:City". Column has non-unique values. Unique: 1, total: 2.
@@ -284,7 +289,7 @@ public function testValidateManyFilesNegativeTextQuick(): void
284289
285290
286291
Found 8 issues in 3 out of 3 CSV files.
287-
Found 1 issues in schema.
292+
Found 2 issues in schema.
288293

289294
TXT;
290295

@@ -308,14 +313,18 @@ public function testCreateValidateNegativeTeamcity(): void
308313
309314
Schema is invalid: ./tests/schemas/demo_invalid.yml
310315
311-
##teamcity[testCount count='1' flowId='42']
316+
##teamcity[testCount count='2' flowId='42']
312317
313318
##teamcity[testSuiteStarted name='demo_invalid.yml' flowId='42']
314319
315320
##teamcity[testStarted name='is_float at column 2:Float' locationHint='php_qn://./tests/schemas/demo_invalid.yml' flowId='42']
316321
"is_float", column "2:Float". Value "Qwerty" is not a float number.
317322
##teamcity[testFinished name='is_float at column 2:Float' flowId='42']
318323
324+
##teamcity[testStarted name='allow_values at column 4:Favorite color' locationHint='php_qn://./tests/schemas/demo_invalid.yml' flowId='42']
325+
"allow_values", column "4:Favorite color". Value "123" is not allowed. Allowed values: ["red", "green", "Blue"].
326+
##teamcity[testFinished name='allow_values at column 4:Favorite color' flowId='42']
327+
319328
##teamcity[testSuiteFinished name='demo_invalid.yml' flowId='42']
320329
321330
(1/3) Invalid file: ./tests/fixtures/batch/demo-1.csv
@@ -376,7 +385,7 @@ public function testCreateValidateNegativeTeamcity(): void
376385
377386
378387
Found 8 issues in 3 out of 3 CSV files.
379-
Found 1 issues in schema.
388+
Found 2 issues in schema.
380389

381390
TXT;
382391

‎tests/schemas/demo_invalid.yml

+1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ columns:
4444
date_max: "2009-01-01"
4545

4646
- name: Favorite color
47+
example: 123
4748
rules:
4849
not_empty: true
4950
allow_values: [ red, green, Blue ]

0 commit comments

Comments
 (0)