1
0
mirror of synced 2025-12-25 20:04:10 -05:00
Files
airbyte/airbyte-cdk/python/unit_tests/test_connector.py

134 lines
4.0 KiB
Python

#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
import json
import logging
import os
import sys
import tempfile
from pathlib import Path
from typing import Any, Mapping
import pytest
import yaml
from airbyte_cdk import Connector
from airbyte_cdk.models import AirbyteConnectionStatus
logger = logging.getLogger("airbyte")
MODULE = sys.modules[__name__]
MODULE_PATH = os.path.abspath(MODULE.__file__)
SPEC_ROOT = os.path.dirname(MODULE_PATH)
class MockConnector(Connector):
def check(self, logger: logging.Logger, config: Mapping[str, Any]) -> AirbyteConnectionStatus:
pass
@pytest.fixture()
def mock_config():
return {"bogus": "file"}
@pytest.fixture
def nonempty_file(mock_config):
with tempfile.NamedTemporaryFile("w") as file:
file.write(json.dumps(mock_config))
file.flush()
yield file
@pytest.fixture
def nonjson_file(mock_config):
with tempfile.NamedTemporaryFile("w") as file:
file.write("the content of this file is not JSON")
file.flush()
yield file
@pytest.fixture
def integration():
return MockConnector()
def test_read_config(nonempty_file, integration: Connector, mock_config):
actual = integration.read_config(nonempty_file.name)
assert actual == mock_config
def test_read_non_json_config(nonjson_file, integration: Connector):
with pytest.raises(ValueError, match="Could not read json file"):
integration.read_config(nonjson_file.name)
def test_write_config(integration, mock_config):
config_path = Path(tempfile.gettempdir()) / "config.json"
integration.write_config(mock_config, str(config_path))
with open(config_path, "r") as actual:
assert json.loads(actual.read()) == mock_config
class TestConnectorSpec:
CONNECTION_SPECIFICATION = {
"type": "object",
"required": ["api_token"],
"additionalProperties": False,
"properties": {"api_token": {"type": "string"}},
}
@pytest.fixture
def use_json_spec(self):
spec = {
"documentationUrl": "https://airbyte.com/#json",
"connectionSpecification": self.CONNECTION_SPECIFICATION,
}
json_path = os.path.join(SPEC_ROOT, "spec.json")
with open(json_path, "w") as f:
f.write(json.dumps(spec))
yield
os.remove(json_path)
@pytest.fixture
def use_invalid_json_spec(self):
json_path = os.path.join(SPEC_ROOT, "spec.json")
with open(json_path, "w") as f:
f.write("the content of this file is not JSON")
yield
os.remove(json_path)
@pytest.fixture
def use_yaml_spec(self):
spec = {"documentationUrl": "https://airbyte.com/#yaml", "connectionSpecification": self.CONNECTION_SPECIFICATION}
yaml_path = os.path.join(SPEC_ROOT, "spec.yaml")
with open(yaml_path, "w") as f:
f.write(yaml.dump(spec))
yield
os.remove(yaml_path)
def test_spec_from_json_file(self, integration, use_json_spec):
connector_spec = integration.spec(logger)
assert connector_spec.documentationUrl == "https://airbyte.com/#json"
assert connector_spec.connectionSpecification == self.CONNECTION_SPECIFICATION
def test_spec_from_improperly_formatted_json_file(self, integration, use_invalid_json_spec):
with pytest.raises(ValueError, match="Could not read json spec file"):
integration.spec(logger)
def test_spec_from_yaml_file(self, integration, use_yaml_spec):
connector_spec = integration.spec(logger)
assert connector_spec.documentationUrl == "https://airbyte.com/#yaml"
assert connector_spec.connectionSpecification == self.CONNECTION_SPECIFICATION
def test_multiple_spec_files_raises_exception(self, integration, use_yaml_spec, use_json_spec):
with pytest.raises(RuntimeError, match="spec.yaml or spec.json"):
integration.spec(logger)
def test_no_spec_file_raises_exception(self, integration):
with pytest.raises(FileNotFoundError, match="Unable to find spec."):
integration.spec(logger)