airbyte/airbyte-cdk/python/unit_tests/sources/utils/test_schema_helpers.py

#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#


import json
import logging
import os
import shutil
import sys
import traceback
from collections.abc import Mapping
from pathlib import Path

import jsonref
from airbyte_cdk.models.airbyte_protocol import ConnectorSpecification, FailureType
from airbyte_cdk.sources.utils.schema_helpers import ResourceSchemaLoader, check_config_against_spec_or_exit
from airbyte_cdk.utils.traced_exception import AirbyteTracedException
from pytest import fixture
from pytest import raises as pytest_raises

logger = logging.getLogger("airbyte")


MODULE = sys.modules[__name__]
MODULE_NAME = MODULE.__name__.split(".")[0]
SCHEMAS_ROOT = "/".join(os.path.abspath(MODULE.__file__).split("/")[:-1]) / Path("schemas")


@fixture(autouse=True, scope="session")
def create_and_teardown_schemas_dir():
    os.mkdir(SCHEMAS_ROOT)
    os.mkdir(SCHEMAS_ROOT / "shared")
    yield
    shutil.rmtree(SCHEMAS_ROOT)


def create_schema(name: str, content: Mapping):
    with open(SCHEMAS_ROOT / f"{name}.json", "w") as f:
        f.write(json.dumps(content))


@fixture
def spec_object():
    spec = {
        "connectionSpecification": {
            "$schema": "http://json-schema.org/draft-07/schema#",
            "type": "object",
            "required": ["api_token"],
            "additionalProperties": False,
            "properties": {
                "api_token": {"title": "API Token", "type": "string"},
            },
        },
    }
    yield ConnectorSpecification.parse_obj(spec)


def test_check_config_against_spec_or_exit_does_not_print_schema(capsys, spec_object):
    config = {"super_secret_token": "really_a_secret"}

    with pytest_raises(AirbyteTracedException) as ex_info:
        check_config_against_spec_or_exit(config, spec_object)

    exc = ex_info.value
    traceback.print_exception(type(exc), exc, exc.__traceback__)
    out, err = capsys.readouterr()
    assert "really_a_secret" not in out + err
    assert exc.failure_type == FailureType.config_error, "failure_type should be config_error"


def test_should_not_fail_validation_for_valid_config(spec_object):
    config = {"api_token": "something"}
    check_config_against_spec_or_exit(config, spec_object)
    assert True, "should pass validation with valid config"


class TestResourceSchemaLoader:
    # Test that a simple schema is loaded correctly
    @staticmethod
    def test_inline_schema_resolves():
        expected_schema = {
            "type": ["null", "object"],
            "properties": {
                "str": {"type": "string"},
                "int": {"type": "integer"},
                "obj": {
                    "type": ["null", "object"],
                    "properties": {"k1": {"type": "string"}},
                },
            },
        }

        create_schema("simple_schema", expected_schema)
        resolver = ResourceSchemaLoader(MODULE_NAME)
        actual_schema = resolver.get_schema("simple_schema")
        assert actual_schema == expected_schema

    @staticmethod
    def test_shared_schemas_resolves():
        expected_schema = {
            "type": ["null", "object"],
            "properties": {
                "str": {"type": "string"},
                "int": {"type": "integer"},
                "obj": {
                    "type": ["null", "object"],
                    "properties": {"k1": {"type": "string"}},
                },
            },
        }

        partial_schema = {
            "type": ["null", "object"],
            "properties": {
                "str": {"type": "string"},
                "int": {"type": "integer"},
                "obj": {"$ref": "shared_schema.json"},
            },
        }

        referenced_schema = {
            "type": ["null", "object"],
            "properties": {"k1": {"type": "string"}},
        }

        create_schema("complex_schema", partial_schema)
        create_schema("shared/shared_schema", referenced_schema)

        resolver = ResourceSchemaLoader(MODULE_NAME)

        actual_schema = resolver.get_schema("complex_schema")
        assert actual_schema == expected_schema

    @staticmethod
    def test_shared_schemas_resolves_nested():
        expected_schema = {
            "type": ["null", "object"],
            "properties": {
                "str": {"type": "string"},
                "int": {"type": "integer"},
                "one_of": {
                    "oneOf": [
                        {"type": "string"},
                        {
                            "type": ["null", "object"],
                            "properties": {"k1": {"type": "string"}},
                        },
                    ]
                },
                "obj": {
                    "type": ["null", "object"],
                    "properties": {"k1": {"type": "string"}},
                },
            },
        }
        partial_schema = {
            "type": ["null", "object"],
            "properties": {
                "str": {"type": "string"},
                "int": {"type": "integer"},
                "one_of": {
                    "oneOf": [
                        {"type": "string"},
                        {"$ref": "shared_schema.json#/definitions/type_one"},
                    ]
                },
                "obj": {"$ref": "shared_schema.json#/definitions/type_one"},
            },
        }

        referenced_schema = {
            "definitions": {
                "type_one": {"$ref": "shared_schema.json#/definitions/type_nested"},
                "type_nested": {
                    "type": ["null", "object"],
                    "properties": {"k1": {"type": "string"}},
                },
            }
        }

        create_schema("complex_schema", partial_schema)
        create_schema("shared/shared_schema", referenced_schema)

        resolver = ResourceSchemaLoader(MODULE_NAME)

        actual_schema = resolver.get_schema("complex_schema")
        assert actual_schema == expected_schema
        # Make sure generated schema is JSON serializable
        assert json.dumps(actual_schema)
        assert jsonref.JsonRef.replace_refs(actual_schema)