Merge branch 'main' into hostname-format-check-empty-string

Author: sirosen

.github/workflows/pr-dependencies.yml

@@ -0,0 +1,12 @@
+name: Check PR Dependencies
+
+on: pull_request
+
+jobs:
+  check_dependencies:
+    runs-on: ubuntu-latest
+    name: Check Dependencies
+    steps:
+    - uses: gregsdennis/dependencies-action@main
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/show_specification_annotations.yml

@@ -0,0 +1,21 @@
+name: Show Specification Annotations
+
+on:
+  pull_request:
+    paths:
+      - 'tests/**'
+
+jobs:
+  annotate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Generate Annotations
+        run: pip install uritemplate && bin/annotate-specification-links

README.md

@@ -109,7 +109,7 @@ To test a specific version:
 
 * For 2019-09 and later published drafts, implementations that are able to detect the draft of each schema via `$schema` SHOULD be configured to do so
 * For draft-07 and earlier, draft-next, and implementations unable to detect via `$schema`, implementations MUST be configured to expect the draft matching the test directory name
-* Load any remote references [described below](additional-assumptions) and configure your implementation to retrieve them via their URIs
+* Load any remote references [described below](#additional-assumptions) and configure your implementation to retrieve them via their URIs
 * Walk the filesystem tree for that version's subdirectory and for each `.json` file found:
 
     * if the file is located in the root of the version directory:
@@ -159,7 +159,7 @@ If your implementation supports multiple versions, run the above procedure for e
     ```
 
 2. Test cases found within [special subdirectories](#subdirectories-within-each-draft) may require additional configuration to run.
-   In particular, tests within the `optional/format` subdirectory may require implementations to change the way they treat the `"format"`keyword (particularly on older drafts which did not have a notion of vocabularies).
+   In particular, when running tests within the `optional/format` subdirectory, test runners should configure implementations to enable format validation, where the implementation supports it.
 
 ### Invariants & Guarantees
 
@@ -254,12 +254,14 @@ This suite is being used by:
 
 ### Java
 
+* [json-schema-validation-comparison](https://www.creekservice.org/json-schema-validation-comparison/functional) (Comparison site for JVM-based validator implementations)
 * [json-schema-validator](https://github.com/daveclayton/json-schema-validator)
 * [everit-org/json-schema](https://github.com/everit-org/json-schema)
 * [networknt/json-schema-validator](https://github.com/networknt/json-schema-validator)
 * [Justify](https://github.com/leadpony/justify)
 * [Snow](https://github.com/ssilverman/snowy-json)
 * [jsonschemafriend](https://github.com/jimblackler/jsonschemafriend)
+* [OpenAPI JSON Schema Generator](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator)
 
 ### JavaScript
 
@@ -279,6 +281,10 @@ This suite is being used by:
 * [ajv](https://github.com/epoberezkin/ajv)
 * [djv](https://github.com/korzio/djv)
 
+### Kotlin
+
+* [json-schema-validation-comparison](https://www.creekservice.org/json-schema-validation-comparison/functional) (Comparison site for JVM-based validator implementations)
+
 ### Node.js
 
 For node.js developers, the suite is also available as an [npm](https://www.npmjs.com/package/@json-schema-org/tests) package.
@@ -313,7 +319,7 @@ Node-specific support is maintained in a [separate repository](https://github.co
 * [fastjsonschema](https://github.com/seznam/python-fastjsonschema)
 * [hypothesis-jsonschema](https://github.com/Zac-HD/hypothesis-jsonschema)
 * [jschon](https://github.com/marksparkza/jschon)
-* [python-experimental, OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/python-experimental.md)
+* [OpenAPI JSON Schema Generator](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator)
 
 ### Ruby
 
@@ -327,6 +333,7 @@ Node-specific support is maintained in a [separate repository](https://github.co
 
 ### Scala
 
+* [json-schema-validation-comparison](https://www.creekservice.org/json-schema-validation-comparison/functional) (Comparison site for JVM-based validator implementations)
 * [typed-json](https://github.com/frawa/typed-json)
 
 ### Swift

bin/annotate-specification-links

@@ -0,0 +1,115 @@
+#!/usr/bin/env python3
+"""
+Annotate pull requests to the GitHub repository with links to specifications.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+import json
+import re
+import sys
+
+from uritemplate import URITemplate
+
+
+BIN_DIR = Path(__file__).parent
+TESTS = BIN_DIR.parent / "tests"
+URLS = json.loads(BIN_DIR.joinpath("specification_urls.json").read_text())
+
+
+def urls(version: str) -> dict[str, URITemplate]:
+    """
+    Retrieve the version-specific URLs for specifications.
+    """
+    for_version = {**URLS["json-schema"][version], **URLS["external"]}
+    return {k: URITemplate(v) for k, v in for_version.items()}
+
+
+def annotation(
+    path: Path,
+    message: str,
+    line: int = 1,
+    level: str = "notice",
+    **kwargs: Any,
+) -> str:
+    """
+    Format a GitHub annotation.
+
+    See https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
+    for full syntax.
+    """
+
+    if kwargs:
+        additional = "," + ",".join(f"{k}={v}" for k, v in kwargs.items())
+    else:
+        additional = ""
+
+    relative = path.relative_to(TESTS.parent)
+    return f"::{level} file={relative},line={line}{additional}::{message}\n"
+
+
+def line_number_of(path: Path, case: dict[str, Any]) -> int:
+    """
+    Crudely find the line number of a test case.
+    """
+    with path.open() as file:
+        description = case["description"]
+        return next(
+            (i + 1 for i, line in enumerate(file, 1) if description in line),
+            1,
+        )
+
+
+def main():
+    # Clear annotations which may have been emitted by a previous run.
+    sys.stdout.write("::remove-matcher owner=me::\n")
+
+    for version in TESTS.iterdir():
+        if version.name in {"draft-next", "latest"}:
+            continue
+
+        version_urls = urls(version.name)
+
+        for path in version.rglob("*.json"):
+            try:
+                contents = json.loads(path.read_text())
+            except json.JSONDecodeError as error:
+                error = annotation(
+                    level="error",
+                    path=path,
+                    line=error.lineno,
+                    col=error.pos + 1,
+                    title=str(error),
+                )
+                sys.stdout.write(error)
+
+            for test_case in contents:
+                specifications = test_case.get("specification")
+                if specifications is not None:
+                    for each in specifications:
+                        quote = each.pop("quote", "")
+                        (kind, section), = each.items()
+
+                        number = re.search(r"\d+", kind)
+                        spec = "" if number is None else number.group(0)
+
+                        url = version_urls[kind].expand(
+                            spec=spec,
+                            section=section,
+                        )
+
+                        message = f"{url}\n\n{quote}" if quote else url
+                        sys.stdout.write(
+                            annotation(
+                                path=path,
+                                line=line_number_of(path, test_case),
+                                title="Specification Link",
+                                message=message,
+                            ),
+                        )
+
+
+if __name__ == "__main__":
+    main()

bin/jsonschema_suite

@@ -14,9 +14,11 @@ import warnings
 try:
     import jsonschema.validators
 except ImportError:
-    jsonschema = None
+    jsonschema = Unresolvable = None
     VALIDATORS = {}
 else:
+    from referencing.exceptions import Unresolvable
+
     VALIDATORS = {
         "draft3": jsonschema.validators.Draft3Validator,
         "draft4": jsonschema.validators.Draft4Validator,
@@ -587,7 +589,7 @@ class SanityTests(unittest.TestCase):
                 with self.subTest(case=case, version=version.name):
                     try:
                         Validator(case["schema"]).is_valid(12)
-                    except jsonschema.exceptions.RefResolutionError:
+                    except Unresolvable:
                         pass
 
     @unittest.skipIf(jsonschema is None, "Validation library not present!")
@@ -615,9 +617,6 @@ class SanityTests(unittest.TestCase):
             with self.subTest(path=path):
                 try:
                     validator.validate(cases)
-                except jsonschema.exceptions.RefResolutionError:
-                    # python-jsonschema/jsonschema#884
-                    pass
                 except jsonschema.ValidationError as error:
                     self.fail(str(error))
 

bin/specification_urls.json

@@ -0,0 +1,34 @@
+{
+  "json-schema": {
+    "draft2020-12": {
+      "core": "https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-01#section-{section}",
+      "validation": "https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validation-01#section-{section}"
+    },
+    "draft2019-09": {
+      "core": "https://json-schema.org/draft/2019-09/draft-handrews-json-schema-02#rfc.section.{section}",
+      "validation": "https://json-schema.org/draft/2019-09/draft-handrews-json-schema-validation-02#rfc.section.{section}"
+    },
+    "draft7": {
+      "core": "https://json-schema.org/draft-07/draft-handrews-json-schema-01#rfc.section.{section}",
+      "validation": "https://json-schema.org/draft-07/draft-handrews-json-schema-validation-01#rfc.section.{section}"
+    },
+    "draft6": {
+      "core": "https://json-schema.org/draft-06/draft-wright-json-schema-01#rfc.section.{section}",
+      "validation": "https://json-schema.org/draft-06/draft-wright-json-schema-validation-01#rfc.section.{section}"
+    },
+    "draft4": {
+      "core": "https://json-schema.org/draft-04/draft-zyp-json-schema-04#rfc.section.{section}",
+      "validation": "https://json-schema.org/draft-04/draft-fge-json-schema-validation-00#rfc.section.{section}"
+    },
+    "draft3": {
+      "core": "https://json-schema.org/draft-03/draft-zyp-json-schema-03.pdf"
+    }
+  },
+
+  "external": {
+    "ecma262": "https://262.ecma-international.org/{section}",
+    "perl5": "https://perldoc.perl.org/perlre#{section}",
+    "rfc": "https://www.rfc-editor.org/rfc/{spec}.txt#{section}",
+    "iso": "https://www.iso.org/obp/ui"
+  }
+}

output-tests/draft2019-09/content/type.json

@@ -31,32 +31,6 @@
                         "required": ["errors"]
                     }
                 }
-            },
-            {
-                "description": "correct type yields an output unit",
-                "data": "a string",
-                "output": {
-                    "basic": {
-                        "$id": "https://json-schema.org/tests/content/draft2019-09/type/0/tests/1/basic",
-                        "$ref": "/draft/2019-09/output/schema",
-                        "properties": {
-                            "annotations": {
-                                "contains": {
-                                    "properties": {
-                                        "valid": {"const": true},
-                                        "keywordLocation": {"const": "/type"},
-                                        "absoluteKeywordLocation": {"const": "https://json-schema.org/tests/content/draft2019-09/type/0#/type"},
-                                        "instanceLocation": {"const": ""},
-                                        "annotation": false,
-                                        "error": false
-                                    },
-                                    "required": ["keywordLocation", "instanceLocation"]
-                                }
-                            }
-                        },
-                        "required": ["annotations"]
-                    }
-                }
             }
         ]
     }

output-tests/draft2020-12/content/type.json

@@ -31,32 +31,6 @@
                         "required": ["errors"]
                     }
                 }
-            },
-            {
-                "description": "correct type yields an output unit",
-                "data": "a string",
-                "output": {
-                    "basic": {
-                        "$id": "https://json-schema.org/tests/content/draft2020-12/type/0/tests/1/basic",
-                        "$ref": "/draft/2020-12/output/schema",
-                        "properties": {
-                            "annotations": {
-                                "contains": {
-                                    "properties": {
-                                        "valid": {"const": true},
-                                        "keywordLocation": {"const": "/type"},
-                                        "absoluteKeywordLocation": {"const": "https://json-schema.org/tests/content/draft2020-12/type/0#/type"},
-                                        "instanceLocation": {"const": ""},
-                                        "annotation": false,
-                                        "error": false
-                                    },
-                                    "required": ["keywordLocation", "instanceLocation"]
-                                }
-                            }
-                        },
-                        "required": ["annotations"]
-                    }
-                }
             }
         ]
     }

remotes/draft-next/detached-dynamicref.json

@@ -0,0 +1,13 @@
+{
+  "$id": "http://localhost:1234/draft-next/detached-dynamicref.json",
+  "$schema": "https://json-schema.org/draft/next/schema",
+  "$defs": {
+    "foo": {
+      "$dynamicRef": "#detached"
+    },
+    "detached": {
+      "$dynamicAnchor": "detached",
+      "type": "integer"
+    }
+  }
+}

remotes/draft-next/detached-ref.json

@@ -0,0 +1,13 @@
+{
+  "$id": "http://localhost:1234/draft-next/detached-ref.json",
+  "$schema": "https://json-schema.org/draft/next/schema",
+  "$defs": {
+    "foo": {
+      "$ref": "#detached"
+    },
+    "detached": {
+      "$anchor": "detached",
+      "type": "integer"
+    }
+  }
+}