Source Kyriba: Updates CDK, Increases Testing Coverage, Fixes Acceptance Test Config, Adds Expected Records

airbyte-integrations/connectors/source-kyriba/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.7.11-alpine3.14 as base
+FROM python:3.9.11-alpine3.15 as base
 
 # build and load all requirements
 FROM base as builder
@@ -34,5 +34,5 @@ COPY source_kyriba ./source_kyriba
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.0
+LABEL io.airbyte.version=0.1.1
 LABEL io.airbyte.name=airbyte/source-kyriba

airbyte-integrations/connectors/source-kyriba/README.md

@@ -8,7 +8,7 @@ For information about how to use this connector within Airbyte, see [the documen
 ### Prerequisites
 **To iterate on this connector, make sure to complete this prerequisites section.**
 
-#### Minimum Python version required `= 3.7.0`
+#### Minimum Python version required `= 3.10.0`
 
 #### Build & Activate Virtual Environment and install dependencies
 From this connector directory, create a virtual environment:

airbyte-integrations/connectors/source-kyriba/acceptance-test-config.yml

@@ -1,30 +1,37 @@
 # See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
 # for more information about how to configure these tests
 connector_image: airbyte/source-kyriba:dev
-tests:
+acceptance_tests:
   spec:
-    - spec_path: "source_kyriba/spec.json"
+    tests:
+      - spec_path: "source_kyriba/spec.json"
   connection:
-    - config_path: "secrets/config.json"
-      status: "succeed"
-    - config_path: "integration_tests/invalid_config.json"
-      status: "failed"
+    tests:
+      - config_path: "secrets/config.json"
+        status: "succeed"
+      - config_path: "integration_tests/invalid_config.json"
+        status: "failed"
   discovery:
-    - config_path: "secrets/config.json"
+    tests:
+      - config_path: "secrets/config.json"
   basic_read:
-    - config_path: "secrets/config.json"
-      configured_catalog_path: "integration_tests/configured_catalog.json"
-      empty_streams: []
-  # TODO uncomment this block to specify that the tests should assert the connector outputs the records provided in the input file a file
-  #      expect_records:
-  #        path: "integration_tests/expected_records.jsonl"
-  #        extra_fields: no
-  #        exact_order: no
-  #        extra_records: yes
-  incremental: # TODO if your connector does not implement incremental sync, remove this block
-    - config_path: "secrets/config.json"
-      configured_catalog_path: "integration_tests/configured_catalog.json"
-      future_state_path: "integration_tests/abnormal_state.json"
+    tests:
+      - config_path: "secrets/config.json"
+        timeout_seconds: 1200
+        expect_records:
+          path: "integration_tests/expected_records.jsonl"
+          extra_fields: no
+          exact_order: no
+          extra_records: yes
+  incremental:
+    tests:
+      - config_path: "secrets/config.json"
+        timeout_seconds: 2400
+        configured_catalog_path: "integration_tests/configured_catalog.json"
+        future_state:
+          future_state_path: "integration_tests/abnormal_state.json"
   full_refresh:
-    - config_path: "secrets/config.json"
-      configured_catalog_path: "integration_tests/configured_catalog.json"
+    tests:
+      - config_path: "secrets/config.json"
+        timeout_seconds: 2400
+        configured_catalog_path: "integration_tests/configured_catalog.json"

airbyte-integrations/connectors/source-kyriba/metadata.yaml

@@ -2,7 +2,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: 547dc08e-ab51-421d-953b-8f3745201a8c
-  dockerImageTag: 0.1.0
+  dockerImageTag: 0.1.1
   dockerRepository: airbyte/source-kyriba
   githubIssueLabel: source-kyriba
   icon: kyriba.svg

airbyte-integrations/connectors/source-kyriba/setup.py

@@ -6,7 +6,7 @@
 from setuptools import find_packages, setup
 
 MAIN_REQUIREMENTS = [
-    "airbyte-cdk~=0.1",
+    "airbyte-cdk",
 ]
 
 TEST_REQUIREMENTS = [

airbyte-integrations/connectors/source-kyriba/source_kyriba/schemas/accounts.json

@@ -1,5 +1,8 @@
 {
   "type": "object",
+  "title": "AccountSearchModel",
+  "description": "Account search",
+  "$schema": "http://json-schema.org/schema#",
   "required": [
     "bank",
     "branch",
@@ -454,8 +457,5 @@
       "type": ["null", "string"],
       "description": "Account ZBA identifier"
     }
-  },
-  "title": "AccountSearchModel",
-  "description": "Account search",
-  "$schema": "http://json-schema.org/schema#"
+  }
 }

airbyte-integrations/connectors/source-kyriba/source_kyriba/schemas/bank_balances_eod.json

@@ -1,6 +1,7 @@
 {
   "type": "object",
   "required": ["account", "bankBalance"],
+  "additionalProperties": true,
   "properties": {
     "account": {
       "type": "object",

airbyte-integrations/connectors/source-kyriba/source_kyriba/schemas/bank_balances_intraday.json

@@ -1,6 +1,7 @@
 {
   "type": "object",
   "required": ["account", "bankBalance"],
+  "additionalProperties": true,
   "properties": {
     "account": {
       "type": "object",

airbyte-integrations/connectors/source-kyriba/source_kyriba/schemas/cash_balances_eod.json

@@ -1,5 +1,6 @@
 {
   "type": "object",
+  "additionalProperties": true,
   "properties": {
     "account": {
       "type": "object",

airbyte-integrations/connectors/source-kyriba/source_kyriba/schemas/cash_balances_intraday.json

@@ -1,5 +1,6 @@
 {
   "type": "object",
+  "additionalProperties": true,
   "properties": {
     "account": {
       "type": "object",

airbyte-integrations/connectors/source-kyriba/source_kyriba/schemas/cash_flows.json

@@ -1,6 +1,7 @@
 {
   "type": "object",
   "required": ["uuid", "account", "flowAmount", "flowCode", "status"],
+  "additionalProperties": true,
   "properties": {
     "uuid": {
       "type": "string",

airbyte-integrations/connectors/source-kyriba/source_kyriba/source.py

@@ -270,9 +270,15 @@ def gateway_url(self, config: Mapping[str, Any]) -> str:
         return f"https://{config['domain']}/gateway"
 
     def check_connection(self, logger, config) -> Tuple[bool, any]:
-        client = KyribaClient(config["username"], config["password"], self.gateway_url(config))
-        client.login()
-        return True, None
+        try:
+            client = KyribaClient(config["username"], config["password"], self.gateway_url(config))
+            client.login()
+            return True, None
+        except Exception as e:
+            if isinstance(e, requests.exceptions.HTTPError) and e.response.status_code == 401:
+                err_message = f"Please check your `username` and `password`. Error: {repr(e)}"
+                return False, err_message
+            return False, repr(e)
 
     def streams(self, config: Mapping[str, Any]) -> List[Stream]:
         gateway_url = self.gateway_url(config)

airbyte-integrations/connectors/source-kyriba/source_kyriba/spec.json

@@ -5,7 +5,7 @@
     "title": "Kyriba Spec",
     "type": "object",
     "required": ["domain", "username", "password", "start_date"],
-    "additionalProperties": false,
+    "additionalProperties": true,
     "properties": {
       "domain": {
         "type": "string",

airbyte-integrations/connectors/source-kyriba/unit_tests/test_bank_balances_stream.py

@@ -6,72 +6,66 @@
 from unittest.mock import MagicMock
 
 import pytest
-from source_kyriba.source import CashBalancesStream
+from source_kyriba.source import BankBalancesStream
 
 from .test_streams import config
 
 
 @pytest.fixture
 def patch_base_class(mocker):
     # Mock abstract methods to enable instantiating abstract class
-    mocker.patch.object(CashBalancesStream, "primary_key", "test_primary_key")
-    mocker.patch.object(CashBalancesStream, "__abstractmethods__", set())
+    mocker.patch.object(BankBalancesStream, "primary_key", "test_primary_key")
+    mocker.patch.object(BankBalancesStream, "__abstractmethods__", set())
 
 
 def test_stream_slices(patch_base_class):
-    stream = CashBalancesStream(**config())
-    account_uuids = [{"account_uuid": "first"}, {"account_uuid": "second"}]
+    stream = BankBalancesStream(**config())
+    account_uuids = [
+        {"account_uuid": "first"},
+        {"account_uuid": "second"}
+    ]
     stream.get_account_uuids = MagicMock(return_value=account_uuids)
     stream.start_date = date(2022, 1, 1)
-    stream.end_date = date(2022, 3, 1)
+    stream.end_date = date(2022, 1, 2)
     expected = [
         {
             "account_uuid": "first",
-            "startDate": "2022-01-01",
-            "endDate": "2022-02-01",
+            "date": "2022-01-01",
         },
         {
             "account_uuid": "second",
-            "startDate": "2022-01-01",
-            "endDate": "2022-02-01",
+            "date": "2022-01-01",
         },
         {
             "account_uuid": "first",
-            "startDate": "2022-02-02",
-            "endDate": "2022-03-01",
+            "date": "2022-01-02",
         },
         {
             "account_uuid": "second",
-            "startDate": "2022-02-02",
-            "endDate": "2022-03-01",
-        },
+            "date": "2022-01-02",
+        }
     ]
     slices = stream.stream_slices()
     assert slices == expected
 
 
 def test_path(patch_base_class):
-    stream = CashBalancesStream(**config())
+    stream = BankBalancesStream(**config())
     inputs = {"stream_slice": {"account_uuid": "uuid"}}
     path = stream.path(**inputs)
-    assert path == "cash-balances/accounts/uuid/balances"
+    assert path == "bank-balances/accounts/uuid/balances"
 
 
 def test_request_params(patch_base_class):
-    stream = CashBalancesStream(**config())
+    stream = BankBalancesStream(**config())
     inputs = {
-        "stream_slice": {"account_uuid": "uuid", "endDate": "2022-02-01", "startDate": "2022-01-01"},
+        "stream_slice": {"account_uuid": "uuid", "date": "2022-02-01"},
         "stream_state": {},
     }
-    stream.intraday = False
+    stream.balance_type = "END_OF_DAY"
     params = stream.request_params(**inputs)
     expected = {
-        "endDate": "2022-02-01",
-        "startDate": "2022-01-01",
-        "intraday": False,
-        "actual": True,
-        "estimatedForecasts": False,
-        "confirmedForecasts": False,
-        "dateType": "VALUE",
+        "date": inputs["stream_slice"]["date"],
+        "type": stream.balance_type,
     }
     assert params == expected

airbyte-integrations/connectors/source-kyriba/unit_tests/test_source.py

@@ -13,14 +13,6 @@
     "start_date": "2022-01-01",
 }
 
-config = {
-    "username": "username",
-    "password": "password",
-    "domain": "demo.kyriba.com",
-    "start_date": "2022-01-01",
-}
-
-
 def test_check_connection(mocker):
     source = SourceKyriba()
     KyribaClient.login = MagicMock()