1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
|
# -*- coding: utf-8 -*-
""" Unit test for pyKwalify - Rule """
# python std lib
import unittest
# 3rd party imports
import pytest
# pyKwalify imports
import pykwalify
from pykwalify.errors import RuleError, SchemaConflict
from pykwalify.rule import Rule
from pykwalify.compat import unicode
class TestRule(unittest.TestCase):
def setUp(self):
pykwalify.partial_schemas = {}
def test_schema(self):
# Test that when using both schema; and include tag that it throw an error because schema; tags should be parsed via Core()
with pytest.raises(RuleError) as r:
Rule(schema={"schema;str": {"type": "map", "mapping": {"foo": {"type": "str"}}}, "type": "map", "mapping": {"foo": {"include": "str"}}})
assert str(r.value) == "<RuleError: error code 4: Schema is only allowed on top level of schema file: Path: '/'>"
assert r.value.error_key == 'schema.not.toplevel'
def test_unkknown_key(self):
# Test that providing an unknown key raises exception
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "foobar": True})
assert str(r.value) == "<RuleError: error code 4: Unknown key: foobar found: Path: '/'>"
assert r.value.error_key == 'key.unknown'
def test_matching_rule(self):
# Test that exception is raised when a invalid matching rule is used
with pytest.raises(RuleError) as r:
Rule(schema={"type": "map", "matching-rule": "foobar", "mapping": {"regex;(.+)": {"type": "seq", "sequence": [{"type": "str"}]}}})
assert str(r.value) == "<RuleError: error code 4: Specified rule in key: foobar is not part of allowed rule set : ['any', 'all']: Path: '/'>"
assert r.value.error_key == 'matching_rule.not_allowed'
def test_allow_empty_map(self):
r = Rule(schema={"type": "map", "allowempty": True, "mapping": {"name": {"type": "str"}}})
assert r.allowempty_map is True
def test_type_value(self):
# TODO: This test is currently semi broken, partial schemas might be somewhat broken possibly
# # Test that when only having a schema; rule it should throw error
# with pytest.raises(RuleError) as r:
# Rule(schema={"schema;fooone": {"type": "map", "mapping": {"foo": {"type": "str"}}}})
# assert str(r.value) == "<RuleError: error code 4: Key 'type' not found in schema rule: Path: '/'>"
# assert r.value.error_key == 'type.missing'
# Test a valid rule with both "str" and "unicode" types work
r = Rule(schema={"type": str("str")})
r = Rule(schema={"type": unicode("str")})
# Test that type key must be string otherwise exception is raised
with pytest.raises(RuleError) as r:
Rule(schema={"type": 1})
assert str(r.value) == "<RuleError: error code 4: Key 'type' in schema rule is not a string type (found int): Path: '/'>"
assert r.value.error_key == 'type.not_string'
# this tests that the type key must be a string
with pytest.raises(RuleError) as r:
Rule(schema={"type": 1}, parent=None)
assert str(r.value) == "<RuleError: error code 4: Key 'type' in schema rule is not a string type (found int): Path: '/'>"
assert r.value.error_key == 'type.not_string'
def test_name_value(self):
with pytest.raises(RuleError) as r:
Rule(schema={'type': 'str', 'name': {}})
assert str(r.value) == "<RuleError: error code 4: Value: {} for keyword name must be a string: Path: '/'>"
def test_nullable_value(self):
# Test that nullable value must be bool otherwise exception is raised
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "nullable": "foobar"})
assert str(r.value) == "<RuleError: error code 4: Value: 'foobar' for nullable keyword must be a boolean: Path: '/'>"
assert r.value.error_key == 'nullable.not_bool'
def test_desc_value(self):
with pytest.raises(RuleError) as r:
Rule(schema={'type': 'str', 'desc': []})
assert str(r.value) == "<RuleError: error code 4: Value: [] for keyword desc must be a string: Path: '/'>"
def test_example_value(self):
with pytest.raises(RuleError) as r:
Rule(schema={'type': 'str', 'example': []})
assert str(r.value) == "<RuleError: error code 4: Value: [] for keyword example must be a string: Path: '/'>"
def test_required_value(self):
# Test that required value must be bool otherwise exception is raised
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "required": "foobar"})
assert str(r.value) == "<RuleError: error code 4: Value: 'foobar' for required keyword must be a boolean: Path: '/'>"
assert r.value.error_key == 'required.not_bool'
def test_pattern_value(self):
# this tests a invalid regexp pattern
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "pattern": "/@/\\"})
assert str(r.value) == "<RuleError: error code 4: Syntax error when compiling regex pattern: None: Path: '/'>"
assert r.value.error_key == 'pattern.syntax_error'
# Test that pattern keyword is not allowed when using a map
# with self.assertRaisesRegexp(RuleError, ".+map\.pattern.+"):
with pytest.raises(RuleError) as r:
Rule(schema={"type": "map", "pattern": "^[a-z]+$", "allowempty": True, "mapping": {"name": {"type": "str"}}})
assert str(r.value) == "<RuleError: error code 4: Keyword pattern is not allowed inside map: Path: '/'>"
assert r.value.error_key == 'pattern.not_allowed_in_map'
# Test that pattern value must be string otherwise exception is raised
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "pattern": 1})
assert str(r.value) == "<RuleError: error code 4: Value of pattern keyword: '1' is not a string: Path: '/'>"
assert r.value.error_key == 'pattern.not_string'
def test_date_and_format_value(self):
r = Rule(schema={"type": "date", "format": "%y"})
assert r.format is not None, "date var not set proper"
assert isinstance(r.format, list), "date format should be a list"
with pytest.raises(RuleError) as r:
Rule(schema={"type": "date", "format": 1})
assert str(r.value) == "<RuleError: error code 4: Value of format keyword: '1' must be a string or list or string values: Path: '/'>"
with pytest.raises(RuleError) as r:
Rule(schema={"type": "map", "format": "%y"})
assert str(r.value) == "<RuleError: error code 4: Keyword format is only allowed when used with the following types: ('date',): Path: '/'>"
def test_enum_value(self):
# this tests the various valid enum types
Rule(schema={"type": "int", "enum": [1, 2, 3]})
Rule(schema={"type": "bool", "enum": [True, False]})
r = Rule(schema={"type": "str", "enum": ["a", "b", "c"]})
assert r.enum is not None, "enum var is not set proper"
assert isinstance(r.enum, list), "enum is not set to a list"
assert len(r.enum) == 3, "invalid length of enum entries"
# this tests the missmatch between the type and the data inside a enum
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "enum": [1, 2, 3]})
assert str(r.value).startswith("<RuleError: error code 4: Item: '1' in enum is not of correct class type:")
assert r.value.error_key == 'enum.type.unmatch'
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "enum": True})
assert str(r.value) == "<RuleError: error code 4: Enum is not a sequence: Path: '/'>"
assert r.value.error_key == 'enum.not_seq'
def test_assert_value(self):
with pytest.raises(RuleError) as r:
Rule(schema={"type": "seq", "sequence": [{"type": "str", "assert": 1}]})
assert str(r.value) == "<RuleError: error code 4: Value: '1' for keyword 'assert' is not a string: Path: '/sequence/0'>"
assert r.value.error_key == 'assert.not_str'
# Test that invalid characters is not present
with pytest.raises(RuleError) as r:
Rule(schema={"type": "seq", "sequence": [{"type": "str", "assert": "__import__"}]})
assert str(r.value) == "<RuleError: error code 4: Value: '__import__' contain invalid content that is not allowed to be present in assertion keyword: Path: '/sequence/0'>" # NOQA: E501
assert r.value.error_key == 'assert.unsupported_content'
def test_length(self):
r = Rule(schema={"type": "int", "length": {"max": 10, "min": 1}})
assert r.length is not None, "length var not set proper"
assert isinstance(r.length, dict), "range var is not of dict type"
# this tests that the range key must be a dict
with pytest.raises(RuleError) as r:
Rule(schema={"type": "int", "length": []})
assert str(r.value) == "<RuleError: error code 4: Length value is not a dict type: '[]': Path: '/'>"
assert r.value.error_key == 'length.not_map'
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "length": {"max": "z"}})
assert str(r.value) == "<RuleError: error code 4: Value: 'z' for 'max' keyword is not a number: Path: '/'>"
assert r.value.error_key == 'length.max.not_number'
# this tests that min is bigger then max that should not be possible
with pytest.raises(RuleError) as r:
Rule(schema={"type": "int", "length": {"max": 10, "min": 11}})
assert str(r.value) == "<RuleError: error code 4: Value for 'max' can't be less then value for 'min'. 10 < 11: Path: '/'>"
assert r.value.error_key == 'length.max_lt_min'
# test that min-ex is bigger then max-ex, that should not be possible
with pytest.raises(RuleError) as r:
Rule(schema={"type": "int", "length": {"max-ex": 10, "min-ex": 11}})
assert str(r.value) == "<RuleError: error code 4: Value for 'max-ex' can't be less then value for 'min-ex'. 10 <= 11: Path: '/'>"
assert r.value.error_key == 'length.max-ex_le_min-ex'
# test that a string has non negative boundaries
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "length": {"max": -1, "min": -2}})
assert str(r.value) == "<RuleError: error code 4: Value for 'min' can't be negative in case of type str.: Path: '/'>"
assert r.value.error_key == 'length.min_negative'
# test that a seq has non negative boundaries
with pytest.raises(RuleError) as r:
Rule(schema={"type": "seq", "length": {"max": 3, "min": -2}})
assert str(r.value) == "<RuleError: error code 4: Value for 'min' can't be negative in case of type seq.: Path: '/'>"
assert r.value.error_key == 'length.min_negative'
def test_range_value(self):
r = Rule(schema={"type": "int", "range": {"max": 10, "min": 1}})
assert r.range is not None, "range var not set proper"
assert isinstance(r.range, dict), "range var is not of dict type"
# this tests that the range key must be a dict
with pytest.raises(RuleError) as r:
Rule(schema={"type": "int", "range": []})
assert str(r.value) == "<RuleError: error code 4: Range value is not a dict type: '[]': Path: '/'>"
assert r.value.error_key == 'range.not_map'
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "range": {"max": "z"}})
assert str(r.value) == "<RuleError: error code 4: Value: 'z' for 'max' keyword is not a number: Path: '/'>"
assert r.value.error_key == 'range.max.not_number'
# this tests that min is bigger then max that should not be possible
with pytest.raises(RuleError) as r:
Rule(schema={"type": "int", "range": {"max": 10, "min": 11}})
assert str(r.value) == "<RuleError: error code 4: Value for 'max' can't be less then value for 'min'. 10 < 11: Path: '/'>"
assert r.value.error_key == 'range.max_lt_min'
# test that min-ex is bigger then max-ex, that should not be possible
with pytest.raises(RuleError) as r:
Rule(schema={"type": "int", "range": {"max-ex": 10, "min-ex": 11}})
assert str(r.value) == "<RuleError: error code 4: Value for 'max-ex' can't be less then value for 'min-ex'. 10 <= 11: Path: '/'>"
assert r.value.error_key == 'range.max-ex_le_min-ex'
# test that a string has non negative boundaries
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "range": {"max": -1, "min": -2}})
assert str(r.value) == "<RuleError: error code 4: Value for 'min' can't be negative in case of type str.: Path: '/'>"
assert r.value.error_key == 'range.min_negative'
# test that a seq has non negative boundaries
with pytest.raises(RuleError) as r:
Rule(schema={"type": "seq", "range": {"max": 3, "min": -2}})
assert str(r.value) == "<RuleError: error code 4: Value for 'min' can't be negative in case of type seq.: Path: '/'>"
assert r.value.error_key == 'range.min_negative'
def test_ident_value(self):
pass
def test_unique_value(self):
# this tests that this cannot be used in the root level
with pytest.raises(RuleError) as r:
Rule(schema={"type": "str", "unique": True})
assert str(r.value) == "<RuleError: error code 4: Keyword 'unique' can't be on root level of schema: Path: '/'>"
assert r.value.error_key == 'unique.not_on_root_level'
# this tests that unique cannot be used at root level
with pytest.raises(RuleError) as r:
Rule(schema={"type": "seq", "unique": True})
assert str(r.value) == "<RuleError: error code 4: Type of the value: 'seq' for 'unique' keyword is not a scalar type: Path: '/'>"
assert r.value.error_key == 'unique.not_scalar'
def test_sequence(self):
# this tests seq type with a internal type of str
r = Rule(schema={"type": "seq", "sequence": [{"type": "str"}]})
assert r.type is not None, "rule not contain type var"
assert r.type == "seq", "type not 'seq'"
assert r.sequence is not None, "rule not contain sequence var"
assert isinstance(r.sequence, list), "rule is not a list"
# Test basic sequence rule
r = Rule(schema={"type": "seq", "sequence": [{"type": "str"}]})
assert r.type == "seq"
assert isinstance(r.sequence, list)
assert isinstance(r.sequence[0], Rule)
assert r.sequence[0].type == "str"
# Test sequence without explicit type
r = Rule(schema={"sequence": [{"type": "str"}]})
assert r.type == "seq"
assert isinstance(r.sequence, list)
assert isinstance(r.sequence[0], Rule)
assert r.sequence[0].type == "str"
# Test short name 'seq'
r = Rule(schema={"seq": [{"type": "str"}]})
assert r.type == "seq"
assert isinstance(r.sequence, list)
assert isinstance(r.sequence[0], Rule)
assert r.sequence[0].type == "str"
# Test error is raised when sequence key is missing
with pytest.raises(SchemaConflict) as ex:
Rule(schema={"type": "seq"})
assert str(ex.value) == "<SchemaConflict: error code 5: Type is sequence but no sequence alias found on same level: Path: '/'>"
# sequence and pattern can't be used at same time
with pytest.raises(SchemaConflict) as ex:
Rule(schema={"type": "seq", "sequence": [{"type": "str"}], "pattern": "..."})
assert str(ex.value) == "<SchemaConflict: error code 5: Sequence and pattern can't be on the same level in the schema: Path: '/'>"
def test_build_sequence_multiple_values(self):
"""
Test with multiple values.
"""
# Test basic sequence rule
r = Rule(schema={'type': 'seq', 'sequence': [{'type': 'str'}, {'type': 'int'}]})
assert r.type == "seq"
assert r.matching == "any"
assert len(r.sequence) == 2
assert isinstance(r.sequence, list)
assert all(isinstance(r.sequence[i], Rule) for i in range(len(r.sequence)))
assert r.sequence[0].type == "str"
assert r.sequence[1].type == "int"
# Test sequence without explicit type
r = Rule(schema={'sequence': [{'type': 'str'}, {'type': 'int'}]})
assert r.type == "seq"
assert r.matching == "any"
assert len(r.sequence) == 2
assert isinstance(r.sequence, list)
assert all(isinstance(r.sequence[i], Rule) for i in range(len(r.sequence)))
assert r.sequence[0].type == "str"
assert r.sequence[1].type == "int"
# Test adding matchin rules
def test_mapping(self):
# This tests mapping with a nested type and pattern
r = Rule(schema={"type": "map", "mapping": {"name": {"type": "str", "pattern": ".+@.+"}}})
assert r.type == "map", "rule type is not map"
assert isinstance(r.mapping, dict), "mapping is not dict"
assert r.mapping["name"].type == "str", "nested mapping is not of string type"
assert r.mapping["name"].pattern is not None, "nested mapping has no pattern var set"
assert r.mapping["name"].pattern == ".+@.+", "pattern is not set to correct value"
# when type is specefied, 'mapping' key must be present
with pytest.raises(SchemaConflict) as ex:
Rule(schema={"type": "map"})
assert str(ex.value) == "<SchemaConflict: error code 5: Type is mapping but no mapping alias found on same level: Path: '/'>"
# 'map' and 'enum' can't be used at same time
# TODO: This do not work because it currently raises RuleError: <RuleError: error code 4: enum.notscalar>
# with pytest.raises(SchemaConflict):
# r = Rule(schema={"type": "map", "enum": [1, 2, 3]})
# Test that 'map' and 'mapping' can't be at the same level
with pytest.raises(RuleError) as r:
Rule(schema={"map": {"stream": {"type": "any"}}, "mapping": {"seams": {"type": "any"}}})
assert str(r.value) == "<RuleError: error code 4: Keywords 'map' and 'mapping' can't be used on the same level: Path: '/'>"
assert r.value.error_key == 'mapping.duplicate_keywords'
# This will test that a invalid regex will throw error when parsing rules
with pytest.raises(RuleError) as r:
Rule(schema={"type": "map", "matching-rule": "any", "mapping": {"regex;(+)": {"type": "seq", "sequence": [{"type": "str"}]}}})
assert str(r.value) == "<RuleError: error code 4: Unable to compile regex '(+)': Path: '/'>"
assert r.value.error_key == 'mapping.regex.compile_error'
# this tests map/dict but with no elements
with pytest.raises(RuleError) as r:
Rule(schema={"type": "map", "mapping": {}})
assert str(r.value) == "<RuleError: error code 4: Mapping do not contain any elements: Path: '/'>"
assert r.value.error_key == 'mapping.no_elements'
# Test that regex with missing parentheses are correctly detected.
with pytest.raises(RuleError) as r:
Rule(schema={"type": "map", "matching-rule": "any", "mapping": {"regex;[a-z]": {"type": "seq", "sequence": [{"type": "str"}]}}})
assert str(r.value) == "<RuleError: Regex '[a-z]' should start and end with parentheses: Path: '/'>"
assert r.value.error_key == 'mapping.regex.missing_parentheses'
def test_default_value(self):
pass
def test_check_conflicts(self):
# TODO: This do not work and enum schema conflict is not raised... RuleError: <RuleError: error code 4: enum.notscalar>
# with pytest.raises(SchemaConflict) as ex:
# r = Rule(schema={"type": "seq", "sequence": [{"type": "str"}], "enum": [1, 2, 3]})
# assert ex.value.msg.startswith("seq.conflict :: enum"), "Wrong exception was raised"
# Test sequence and mapping can't be used at same level
with pytest.raises(SchemaConflict) as ex:
Rule(schema={"type": "seq", "sequence": [{"type": "str"}], "mapping": {"name": {"type": "str", "pattern": ".+@.+"}}})
assert str(ex.value) == "<SchemaConflict: error code 5: Sequence and mapping can't be on the same level in the schema: Path: '/'>"
assert ex.value.error_key == 'seq.conflict.mapping'
# Mapping and sequence can't used at same time
with pytest.raises(SchemaConflict) as ex:
Rule(schema={"type": "map", "mapping": {"foo": {"type": "str"}}, "sequence": [{"type": "str"}]})
assert str(ex.value) == "<SchemaConflict: error code 5: Mapping and sequence can't be on the same level in the schema: Path: '/'>"
assert ex.value.error_key == 'map.conflict.sequence'
# scalar type and sequence can't be used at same time
with pytest.raises(SchemaConflict) as ex:
Rule(schema={"type": "int", "sequence": [{"type": "str"}]})
assert str(ex.value) == "<SchemaConflict: error code 5: Scalar and sequence can't be on the same level in the schema: Path: '/'>"
assert ex.value.error_key == 'scalar.conflict.sequence'
# scalar type and mapping can't be used at same time
with pytest.raises(SchemaConflict) as ex:
Rule(schema={"type": "int", "mapping": {"foo": {"type": "str"}}})
assert str(ex.value) == "<SchemaConflict: error code 5: Scalar and mapping can't be on the same level in the schema: Path: '/'>"
assert ex.value.error_key == 'scalar.conflict.mapping'
# scalar type and enum can't be used at same time
with pytest.raises(SchemaConflict) as ex:
Rule(schema={"type": "int", "enum": [1, 2, 3], "range": {"max": 10, "min": 1}})
assert str(ex.value) == "<SchemaConflict: error code 5: Enum and range can't be on the same level in the schema: Path: '/'>"
assert ex.value.error_key == 'enum.conflict.range'
|
