add more tests to schema tool

scripts/lookup_extensions.py

@@ -1,3 +1,5 @@
+import os
+
 import asdf
 
 cfg = asdf.get_config()
@@ -11,27 +13,92 @@
 manifests_by_extension_uri = {}
 schema_uris_by_package_name = {}
 schema_links_by_uri = {}
+schema_versions_by_base_uri = {}
+errors = []
+
+
+def error(**kwargs):
+    errors.append(kwargs)
+    if "msg" in kwargs:
+        print(f"ERROR: {kwargs['msg']}")
+
+
+def split_uri_base_and_version(uri):
+    parts = asdf.util._patched_urllib_parse.urlparse(uri)
+    basename = os.path.basename(parts.path)
+    if "-" in basename:
+        version = basename.split("-", maxsplit=1)[1]
+        base = uri.rstrip(f"-{version}")
+    else:
+        version = ""
+        base = uri
+    if len(version) and not version[0].isdigit():
+        version = ""
+        base = uri
+    return base, version
+
+
+def join_uri_base_and_version(base, version):
+    if not version:
+        return base
+    return "-".join((base, version))
+
+
+def latest_version(base):
+    versions = schema_versions_by_base_uri[base]
+    if len(versions) == 1:
+        version = versions[0]
+    else:
+        version = sorted(versions)[-1]
+    if not version:
+        return base
+    return "-".join((base, version))
+
 
 for uri in resource_manager:
     schema = asdf.schema.load_schema(uri)
     if "id" not in schema:
         # FIXME version maps don't have id
         assert "FILE_FORMAT" in schema
     else:
-        # FIXME not sure why the uri/id here has a fragment
+        # FIXME not sure why the json-schema uri/id here has a fragment
         if not uri.startswith("http://json-schema.org/draft-04/schema"):
-            assert uri == schema["id"], (uri, schema["id"])  # sanity check
+            if uri != schema["id"]:
+                msg = f"id[{schema['id']}] does not match uri[{uri}]"
+                error(msg=msg, uri=uri, schema_id=schema["id"])
     if uri in all_schemas:
         # don't duplicate uris
-        raise Exception
+        msg = f"uri[{uri}] is registered >1 time"
+        error(msg=msg, uri=uri)
+
     all_schemas[uri] = schema
+
+    if not uri.startswith("http://json-schema.org/draft-04/schema"):
+        parts = asdf.util._patched_urllib_parse.urlparse(uri)
+        base_name = os.path.basename(parts.path)
+        if "-" not in base_name:
+            # jwst datamodel schemas are not versioned
+            if not uri.startswith("http://stsci.edu/schemas/jwst_datamodel"):
+                msg = f"uri[{uri}] is not versioned"
+                error(msg=msg, uri=uri)
+            base = uri
+            version = ""
+        else:
+            base, version = split_uri_base_and_version(uri)
+        if base not in schema_versions_by_base_uri:
+            schema_versions_by_base_uri[base] = []
+        if version in schema_versions_by_base_uri:
+            raise Exception
+        schema_versions_by_base_uri[base].append(version)
+
     if "extension_uri" in schema:
         all_manifests[uri] = schema
         extension_uri = schema["extension_uri"]
         # 2 manifests should not share uris
         if extension_uri in manifests_by_extension_uri:
-            # TODO helpful error
-            raise Exception
+            uri2 = manifests_by_extension_uri[extension_uri]["id"]
+            msg = f"two manifests [{uri}, {uri2}] share the extension_uri[{extension_uri}]"
+            error(msg=msg, uri=uri, extension_uri=extension_uri)
         manifests_by_extension_uri[extension_uri] = schema
 
     # record what packages provide schemas (so we can check if this changes)
@@ -55,10 +122,26 @@
                 links.append({"schema": item["$schema"], "path": path})
 
             if "$ref" in item:
-                links.append({"ref": item["$ref"], "path": path})
+                ref = item["$ref"]
+                resolved = asdf.util._patched_urllib_parse.urljoin(uri, item["$ref"])
+                # remove fragment
+                resolved = asdf.util._patched_urllib_parse.urlunparse(
+                    asdf.util._patched_urllib_parse.urlparse(resolved)._replace(fragment="")
+                )
+                local = resolved.startswith(uri)
+                links.append(
+                    {
+                        "ref": ref,
+                        "path": path,
+                        "resolved": resolved,
+                        "local": local,
+                    }
+                )
                 children = []
             elif "tag" in item:
-                links.append({"tag": item["tag"], "path": path})
+                # the yaml-schema defines tag, so don't treat it as a link
+                if not uri.startswith("http://stsci.edu/schemas/yaml-schema/draft-01"):
+                    links.append({"tag": item["tag"], "path": path})
                 children = []
             else:
                 children = item.items()
@@ -70,6 +153,48 @@
                     search.append((child, path + (key,)))
     schema_links_by_uri[uri] = links
 
+# TODO check schemas with out-of-date (or missing) '$schema'
+
+# check that all refs and schemas point to known schemas
+for uri, links in schema_links_by_uri.items():
+    for link in links:
+        if "ref" in link:
+            other_uri = link["resolved"]
+        elif "schema" in link:
+            other_uri = link["schema"]
+        if other_uri.startswith("http://json-schema.org/draft-04/schema"):
+            continue
+        if other_uri not in all_schemas:
+            msg = f"schema[{uri}] refers to unknown schema[{other_uri}]"
+            error(msg=msg, uri=uri, other_uri=other_uri)
+
+# check that the latest version of all schemas refer to the latest version of other schemas
+# checking both '$ref' and '$schema'
+for base_uri in schema_versions_by_base_uri:
+    latest_uri = latest_version(base_uri)
+    links = schema_links_by_uri[latest_uri]
+    for link in links:
+        if "ref" in link:
+            other_uri = link["resolved"]
+        elif "schema" in link:
+            other_uri = link["schema"]
+        elif "tag" in link:
+            # TODO check tag links
+            continue
+        else:
+            raise Exception(f"unknown link {link}")
+        if other_uri.startswith("http://json-schema.org/draft-04/schema"):
+            continue
+        other_base_uri, _ = split_uri_base_and_version(other_uri)
+        other_latest_uri = latest_version(other_base_uri)
+        if other_uri != other_latest_uri:
+            msg = f"schema [{latest_uri}] refers to out-dated schema [{other_uri}] instead of [{other_latest_uri}]"
+            error(
+                msg=msg,
+                latest_uri=latest_uri,
+                other_uri=other_uri,
+                other_latest_uri=other_latest_uri,
+            )
 
 # we want maps (per version because of the tag use) for
 # - TODO schema to schema (via $ref, $schema, tag)
@@ -125,25 +250,53 @@
                 type_string = asdf.util.get_class_name(typ, False)
             tag_info["types"].append(type_string)
 
-    # extensions and manifests do not have a 1-to-1 mapping because of asdf-astropy CompoundManifest
-    # but that doesn't really matter as long as the extension_uri is unique and all the ones
-    # defined in manifests are used, right? The id is used to load the manifest which defines
-    # the extension_uri. This is 'compounded' in astropy where the core manifest is combined
-    # with a special 'astropy' one (which is the one that should define the extension_uri).
-
-    # extension_by_manifest_id = {}
-    # for ext in all_extensions:
-    #     delegate = ext.delegate
-    #     if hasattr(delegate, '_manifest'):
-    #         manifest_ids = [delegate._manifest['id'],]
-    #     else:
-    #         manifest_ids = [ext._manifest['id'] for ext in delegate._extensions]
-    #     for manifest_id in manifest_ids:
-    #         extension_by_manifest_id[manifest_id] = ext
-
     tag_info_by_version[standard_version] = tag_info_by_uri
 
-# TODO check schemas with out-of-date (or missing) '$schema'
+for standard_version, tag_info in tag_info_by_version.items():
+    if standard_version != "1.5.0":
+        # TODO test against 1.6.0 and older versions?
+        continue
+    # use version info to check tag links
+    for uri, links in schema_links_by_uri.items():
+        if uri.startswith("http://json-schema.org/draft-04/schema"):
+            continue
+        base, _ = split_uri_base_and_version(uri)
+        # only check the latest versions of all schemas
+        # TODO should we update tag directives for old schemas?
+        if uri != latest_version(base):
+            continue
+        for link in links:
+            if "tag" not in link:
+                # schema and ref links were checked above
+                continue
+            tag_pattern = link["tag"]
+            if tag_pattern in tag_info:
+                # this is a direct match with a known tag
+                tags = [
+                    tag_pattern,
+                ]
+            else:
+                # wildcard
+                matches = []
+                for tag in tag_info:
+                    if asdf.util.uri_match(tag_pattern, tag):
+                        matches.append(tag)
+                # it's ok to have multiple tags that match as
+                # multiple extensions might be registered for different tag versions
+                # it's not ok to have no tags match
+                if not len(matches):
+                    msg = f"In ASDF[{standard_version}] no tags match pattern[{tag_pattern}] for schema[{uri}]"
+                    error(msg=msg, standard_version=standard_version, tag_pattern=tag_pattern, uri=uri)
+                tags = matches
+
+            # make sure one matching tag is supported
+            supported = False
+            for tag in tags:
+                info = tag_info[tag]
+                supported |= info["supported"]
+            if not supported:
+                msg = f"In ASDF[{standard_version}] schema[{uri}] does not mach any supported tags [{tags}] with pattern [{tag_pattern}]"
+                error(msg=msg, standard_version=standard_version, uri=uri, tag_pattern=tag_pattern, tags=tags)
 
 asdf.AsdfFile(
     {
@@ -153,6 +306,8 @@
         "manifests_by_extension_uri": manifests_by_extension_uri,
         "schema_links_by_uri": schema_links_by_uri,
         "schema_uris_by_package_name": schema_uris_by_package_name,
+        "schema_versions_by_base_uri": schema_versions_by_base_uri,
         "tag_info_by_version": tag_info_by_version,
+        "errors": errors,
     }
 ).write_to("asdf.asdf")