test_nonjson_schema_handling.py

import json

import pytest
import responses

from check_jsonschema.parsers.json5 import ENABLED as JSON5_ENABLED

SIMPLE_SCHEMA = {
    "$schema": "http://json-schema.org/draft-07/schema",
    "properties": {
        "title": {"type": "string"},
    },
    "additionalProperties": False,
}
YAML_REF_MAIN_SCHEMA = {
    "$schema": "http://json-schema.org/draft-07/schema",
    "properties": {
        "title": {"$ref": "./title_schema.yaml"},
    },
    "additionalProperties": False,
}
JSON5_REF_MAIN_SCHEMA = {
    "$schema": "http://json-schema.org/draft-07/schema",
    "properties": {
        "title": {"$ref": "./title_schema.json5"},
    },
    "additionalProperties": False,
}
TITLE_SCHEMA = {"type": "string"}
PASSING_DOCUMENT = {"title": "doc one"}
FAILING_DOCUMENT = {"title": 2}


@pytest.mark.parametrize("passing_data", [True, False])
def test_yaml_reference(run_line, tmp_path, passing_data):
    main_schemafile = tmp_path / "main_schema.json"
    main_schemafile.write_text(json.dumps(YAML_REF_MAIN_SCHEMA))
    # JSON is a subset of YAML, so this works for generated YAML
    ref_schema = tmp_path / "title_schema.yaml"
    ref_schema.write_text(json.dumps(TITLE_SCHEMA))

    doc = tmp_path / "doc.json"
    if passing_data:
        doc.write_text(json.dumps(PASSING_DOCUMENT))
    else:
        doc.write_text(json.dumps(FAILING_DOCUMENT))

    result = run_line(
        ["check-jsonschema", "--schemafile", str(main_schemafile), str(doc)]
    )
    assert result.exit_code == (0 if passing_data else 1)


@pytest.mark.skipif(not JSON5_ENABLED, reason="test requires json5")
@pytest.mark.parametrize("passing_data", [True, False])
def test_json5_reference(run_line, tmp_path, passing_data):
    main_schemafile = tmp_path / "main_schema.json"
    main_schemafile.write_text(json.dumps(JSON5_REF_MAIN_SCHEMA))
    ref_schema = tmp_path / "title_schema.json5"
    ref_schema.write_text(json.dumps(TITLE_SCHEMA))

    doc = tmp_path / "doc.json"
    if passing_data:
        doc.write_text(json.dumps(PASSING_DOCUMENT))
    else:
        doc.write_text(json.dumps(FAILING_DOCUMENT))

    result = run_line(
        ["check-jsonschema", "--schemafile", str(main_schemafile), str(doc)]
    )
    assert result.exit_code == (0 if passing_data else 1)


@pytest.mark.skipif(not JSON5_ENABLED, reason="test requires json5")
@pytest.mark.parametrize("passing_data", [True, False])
def test_can_load_json5_schema(run_line, tmp_path, passing_data):
    # dump JSON to the JSON5 file, this is fine
    main_schemafile = tmp_path / "main_schema.json5"
    main_schemafile.write_text(json.dumps(SIMPLE_SCHEMA))

    doc = tmp_path / "doc.json"
    if passing_data:
        doc.write_text(json.dumps(PASSING_DOCUMENT))
    else:
        doc.write_text(json.dumps(FAILING_DOCUMENT))

    result = run_line(
        ["check-jsonschema", "--schemafile", str(main_schemafile), str(doc)]
    )
    assert result.exit_code == (0 if passing_data else 1)


@pytest.mark.parametrize("passing_data", [True, False])
def test_can_load_remote_yaml_schema(run_line, tmp_path, passing_data):
    retrieval_uri = "https://example.org/retrieval/schemas/main.yaml"
    responses.add(
        "GET",
        retrieval_uri,
        body="""\
"$schema": "http://json-schema.org/draft-07/schema"
properties:
  title: {"type": "string"}
additionalProperties: false
""",
    )

    doc = tmp_path / "doc.json"
    doc.write_text(json.dumps(PASSING_DOCUMENT if passing_data else FAILING_DOCUMENT))

    result = run_line(["check-jsonschema", "--schemafile", retrieval_uri, str(doc)])
    assert result.exit_code == (0 if passing_data else 1)


@pytest.mark.parametrize("passing_data", [True, False])
def test_can_load_remote_yaml_schema_ref(run_line, tmp_path, passing_data):
    retrieval_uri = "https://example.org/retrieval/schemas/main.yaml"
    responses.add(
        "GET",
        retrieval_uri,
        body="""\
"$schema": "http://json-schema.org/draft-07/schema"
properties:
  "title": {"$ref": "./title_schema.yaml"}
additionalProperties: false
""",
    )
    responses.add(
        "GET",
        "https://example.org/retrieval/schemas/title_schema.yaml",
        body="type: string",
    )

    doc = tmp_path / "doc.json"
    doc.write_text(json.dumps(PASSING_DOCUMENT if passing_data else FAILING_DOCUMENT))

    result = run_line(["check-jsonschema", "--schemafile", retrieval_uri, str(doc)])
    assert result.exit_code == (0 if passing_data else 1)


def test_can_load_remote_yaml_schema_ref_from_cache(
    run_line, tmp_path, cacheable_headers
):
    retrieval_uri = "https://example.org/retrieval/schemas/main.yaml"
    ref_loc = "https://example.org/retrieval/schemas/title_schema.yaml"

    # First: add good responses with cache headers
    responses.add(
        "GET",
        retrieval_uri,
        body="""\
"$schema": "http://json-schema.org/draft-07/schema"
properties:
  "title": {"$ref": "./title_schema.yaml"}
additionalProperties: false
""",
        headers=cacheable_headers,
    )
    responses.add("GET", ref_loc, body="type: string", headers=cacheable_headers)

    # Then: add bad responses (used if cache doesn't work)
    responses.add("GET", retrieval_uri, body="error", status=500)
    responses.add("GET", ref_loc, body="error", status=500)

    doc = tmp_path / "doc.json"
    doc.write_text(json.dumps(PASSING_DOCUMENT))

    # First run: populates cache
    result1 = run_line(["check-jsonschema", "--schemafile", retrieval_uri, str(doc)])
    assert result1.exit_code == 0

    # Second run: should use cached data (not the 500 errors)
    result2 = run_line(["check-jsonschema", "--schemafile", retrieval_uri, str(doc)])
    assert result2.exit_code == 0