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
|
import collections
import pytest
from common import is_deprecated
EXCEPTIONS = {
"tag:stsci.edu:asdf/asdf-schema-1.0.0",
"asdf://asdf-format.org/core/manifests/:schema_root: ../../resources/manifests",
"asdf://asdf-format.org/core/manifests/:standard_prefix: asdf-format.org/core",
"http://stsci.edu/schemas/asdf/core/column-1.0.0",
"http://stsci.edu/schemas/asdf/core/table-1.0.0",
"http://stsci.edu/schemas/asdf/core/subclass_metadata-1.0.0",
"http://stsci.edu/schemas/asdf/fits/fits-1.1.0",
"http://stsci.edu/schemas/asdf/table/column-1.1.0",
"http://stsci.edu/schemas/asdf/table/table-1.1.0",
"http://stsci.edu/schemas/asdf/time/time-1.2.0",
"http://stsci.edu/schemas/asdf/unit/defunit-1.0.0",
"http://stsci.edu/schemas/asdf/unit/quantity-1.2.0",
"http://stsci.edu/schemas/asdf/unit/unit-1.0.0",
"http://stsci.edu/schemas/asdf/asdf-schema-1.1.0",
}
@pytest.mark.skip(reason="We don't package documentation yet")
def test_docs_schema_links(
latest_schema_ids, legacy_schema_ids, manifest_ids, docs_schema_ids, docs_legacy_schema_ids, docs_manifest_ids
):
"""
Confirm that the latest versions of all non-deprecated schemas
are represented in the documentation.
"""
expected_schema_ids = set()
for schema_id in latest_schema_ids:
if not is_deprecated(schema_id):
expected_schema_ids.add(schema_id)
extra_legacy_docs_ids = set(docs_legacy_schema_ids) - legacy_schema_ids - EXCEPTIONS
if len(extra_legacy_docs_ids) > 0:
remove_list = "\n".join(sorted(list(extra_legacy_docs_ids)))
message = (
"Only the legacy documentation should link to old versions of schemas. "
"Remove or update the following links: \n"
f"{remove_list}"
)
assert False, message
extra_docs_ids = set(docs_schema_ids) - expected_schema_ids - EXCEPTIONS - set(docs_legacy_schema_ids)
if len(extra_docs_ids) > 0:
remove_list = "\n".join(sorted(list(extra_docs_ids)))
message = (
"The main documentation should not link to old versions of schemas. "
"Remove or update the following links to the legacy documentation: \n"
f"{remove_list}"
)
assert False, message
missing_docs_ids = expected_schema_ids - set(docs_schema_ids) - EXCEPTIONS
if len(missing_docs_ids) > 0:
insert_list = "\n".join(sorted(list(missing_docs_ids)))
message = (
"The documentation must include a link to the latest version of "
"every non-deprecated schema with a tag. Update the deprecation "
"list in tests/common.py, or add links to the following missing schemas: \n"
f"{insert_list}"
)
assert False, message
missing_manifest_docs_ids = manifest_ids - set(docs_manifest_ids) - EXCEPTIONS
if len(missing_manifest_docs_ids) > 0:
print(missing_manifest_docs_ids)
insert_list = "\n".join(sorted(list(missing_manifest_docs_ids)))
message = (
"The documentation must include a link to every version of the asdf-standard"
"manifest. Please add the following links to the documentation: \n"
f"{insert_list}"
)
assert False, message
counter = collections.Counter(docs_schema_ids)
if max(counter.values()) > 1:
remove_list = "\n".join(sorted(tag for tag, count in counter.items() if count > 1))
message = "The documentation contains duplicate links to the following schemas: \n" f"{remove_list}"
assert False, message
|
