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
|
import pytest
from common import (
DOCS_SCHEMAS_PATH,
MANIFEST_ID_PREFIX,
MANIFESTS_PATH,
METASCHEMA_ID,
SCHEMA_ID_PREFIX,
SCHEMAS_PATH,
VALID_SCHEMA_FILENAME_RE,
YAML_SCHEMA_PATH,
assert_yaml_header_and_footer,
is_deprecated,
list_description_ids,
list_example_ids,
list_latest_schema_paths,
list_legacy_schema_paths,
list_refs,
list_schema_paths,
load_yaml,
path_to_id,
path_to_tag,
ref_to_id,
split_id,
)
@pytest.fixture(scope="session")
def schemas():
return [load_yaml(p) for p in list_schema_paths(SCHEMAS_PATH)]
@pytest.fixture(scope="session")
def manifests():
return [load_yaml(p) for p in list_schema_paths(MANIFESTS_PATH)]
@pytest.fixture(scope="session")
def yaml_schemas():
return [load_yaml(p) for p in list_schema_paths(YAML_SCHEMA_PATH)]
@pytest.fixture(scope="session")
def latest_schemas():
return [load_yaml(p) for p in list_latest_schema_paths(SCHEMAS_PATH)]
@pytest.fixture(scope="session")
def legacy_schemas():
return [load_yaml(p) for p in list_legacy_schema_paths(SCHEMAS_PATH)]
def get_schema_ids(schemas):
result = set()
for schema in schemas:
if "id" in schema:
result.add(schema["id"])
return result
@pytest.fixture(scope="session")
def latest_schema_ids(latest_schemas):
return get_schema_ids(latest_schemas)
@pytest.fixture(scope="session")
def legacy_schema_ids(legacy_schemas):
return get_schema_ids(legacy_schemas)
@pytest.fixture(scope="session")
def manifest_ids(manifests):
return get_schema_ids(manifests)
def add_schemas(path, prefix, result):
with open(path) as f:
content = f.read()
lines = content.split("\n")
i = 0
while i < len(lines):
if lines[i].startswith(".. asdf-autoschemas::"):
i += 1
while i < len(lines) and (lines[i].strip() == "" or lines[i].startswith(" ")):
possible_id = lines[i].strip()
if len(possible_id) > 0:
result.append(f"{prefix}{possible_id}")
i += 1
else:
i += 1
@pytest.fixture(scope="session")
def docs_schema_ids():
result = []
for path in DOCS_SCHEMAS_PATH.glob("**/*.rst"):
if path != DOCS_SCHEMAS_PATH / "manifest.rst":
add_schemas(path, SCHEMA_ID_PREFIX, result)
return result
@pytest.fixture(scope="session")
def docs_legacy_schema_ids():
result = []
for path in DOCS_SCHEMAS_PATH.glob("**/legacy.rst"):
add_schemas(path, SCHEMA_ID_PREFIX, result)
return result
@pytest.fixture(scope="session")
def docs_manifest_ids():
result = []
for path in DOCS_SCHEMAS_PATH.glob("**/manifest.rst"):
add_schemas(path, MANIFEST_ID_PREFIX, result)
return result
@pytest.fixture(scope="session")
def id_to_schema(schemas):
result = {}
for schema in schemas:
if "id" in schema:
if schema["id"] not in result:
result[schema["id"]] = []
result[schema["id"]].append(schema)
return result
@pytest.fixture(scope="session")
def assert_schema_correct(id_to_schema):
def _assert_schema_correct(path):
__tracebackhide__ = True
assert VALID_SCHEMA_FILENAME_RE.match(path.name) is not None, f"{path.name} is an invalid schema filename"
assert_yaml_header_and_footer(path)
schema = load_yaml(path)
assert "$schema" in schema, f"{path.name} is missing $schema key"
assert schema["$schema"] == METASCHEMA_ID, f"{path.name} has wrong $schema value (expected {METASCHEMA_ID})"
expected_id = path_to_id(path)
expected_tag = path_to_tag(path)
assert "id" in schema, f"{path.name} is missing id key (expected {expected_id})"
assert schema["id"] == expected_id, f"{path.name} id doesn't match filename (expected {expected_id})"
if "tag" in schema:
assert schema["tag"] == expected_tag, f"{path.name} tag doesn't match filename (expected {expected_tag})"
assert "title" in schema, f"{path.name} is missing title key"
assert len(schema["title"].strip()) > 0, f"{path.name} title must have content"
assert "description" in schema, f"{path.name} is missing description key"
assert len(schema["description"].strip()) > 0, f"{path.name} description must have content"
assert len(id_to_schema[schema["id"]]) == 1, f"{path.name} does not have a unique id"
id_base, _ = split_id(schema["id"])
for example_id in list_example_ids(schema):
example_id_base, _ = split_id(example_id)
if example_id_base == id_base and example_id != schema["id"]:
assert False, f"{path.name} contains an example with an outdated tag"
for description_id in list_description_ids(schema):
if len(description_id.rsplit("-", 1)) > 1:
description_id_base, _ = split_id(description_id)
if description_id_base == id_base and description_id != schema["id"]:
assert False, f"{path.name} descriptioon contains an outdated ref"
return _assert_schema_correct
@pytest.fixture(scope="session")
def assert_latest_schema_correct(latest_schema_ids):
def _assert_latest_schema_correct(path):
__tracebackhide__ = True
schema = load_yaml(path)
if is_deprecated(schema["id"]):
return
refs = [r.split("#")[0] for r in list_refs(schema) if not r.startswith("#") and not r == METASCHEMA_ID]
for ref in refs:
ref_id = ref_to_id(schema["id"], ref)
assert ref_id in latest_schema_ids, (
f"{path.name} is the latest version of a schema, " f"but references {ref}, which is not latest"
)
for example_id in list_example_ids(schema):
assert example_id in latest_schema_ids, (
f"{path.name} is the latest version of a schema, "
f"but its examples include {example_id}, which is not latest"
)
for description_id in list_description_ids(schema):
if len(description_id.rsplit("-", 1)) > 1:
assert description_id in latest_schema_ids, (
f"{path.name} is the latest version of a schema, "
f"but its description includes a ref to {description_id}, "
"which is not latest"
)
return _assert_latest_schema_correct
|
