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
|
import logging
from inspect import cleandoc
import pytest
from fastjsonschema import validate
from validate_pyproject.api import FORMAT_FUNCTIONS
from validate_pyproject.error_reporting import ValidationError, detailed_errors
EXAMPLES = {
"const": {
"schema": {"const": 42},
"value": 13,
"message": "`data` must be 42",
"debug_info": "**SKIP-TEST**",
},
"container": {
"schema": {"type": "array", "contains": True},
"value": [],
"message": "`data` must not be empty",
"debug_info": "**SKIP-TEST**",
},
"type": {
"schema": {"anyOf": [{"not": {"type": ["string", "number"]}}]},
"value": 42,
"message": """
`data` cannot be validated by any definition:
- (*NOT* the following):
type: [string, number]
""",
"debug_info": "**SKIP-TEST**",
},
"oneOf": {
"schema": {
"oneOf": [{"type": "string", "format": "pep440"}, {"type": "integer"}]
},
"value": {"use_scm": True},
"message": """
`data` must be valid exactly by one definition (0 matches found):
- {type: string, format: 'pep440'}
- {type: integer}
""",
"debug_info": """
GIVEN VALUE:
{
"use_scm": true
}
OFFENDING RULE: 'oneOf'
DEFINITION:
{
"oneOf": [
{
"type": "string",
"format": "pep440"
},
{
"type": "integer"
}
]
}
For more details about `format` see
""",
},
"description": {
"schema": {"type": "string", "description": "Lorem ipsum dolor sit amet"},
"value": {"name": 42},
"message": "`data` must be string",
"debug_info": """
DESCRIPTION:
Lorem ipsum dolor sit amet
""",
},
"$$description": {
"schema": {
"properties": {
"name": {
"type": "string",
"$$description": [
"Lorem ipsum dolor sit amet, consectetur adipiscing elit,",
"sed do eiusmod tempor incididunt ut labore et dolore magna",
"aliqua. Ut enim ad minim veniam, quis nostrud exercitation",
"ullamco laboris nisi ut aliquip ex ea commodo consequat.",
],
}
}
},
"value": {"name": 42},
"message": "`name` must be string",
"debug_info": """
DESCRIPTION:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat.
GIVEN VALUE:
42
OFFENDING RULE: 'type'
DEFINITION:
{
"type": "string"
}
""",
},
}
@pytest.mark.parametrize("example", EXAMPLES.keys())
def test_error_reporting(caplog, example):
schema = EXAMPLES[example]["schema"]
value = EXAMPLES[example]["value"]
message = cleandoc(EXAMPLES[example]["message"])
debug_info = cleandoc(EXAMPLES[example]["debug_info"])
try:
with caplog.at_level(logging.CRITICAL), detailed_errors():
validate(schema, value, formats=FORMAT_FUNCTIONS)
except ValidationError as ex:
assert ex.message.strip() == message
assert ex.message == ex.summary
assert "GIVEN VALUE:" in ex.details
assert "DEFINITION:" in ex.details
try:
with caplog.at_level(logging.DEBUG), detailed_errors():
validate(schema, value, formats=FORMAT_FUNCTIONS)
except ValidationError as ex:
assert "GIVEN VALUE:" in ex.message
assert "DEFINITION:" in ex.message
assert ex.summary in ex.message
if debug_info != "**SKIP-TEST**":
assert debug_info in ex.details
|
