✨Source Xero: Migrate Python CDK to Low-code CDK (#36956)

Co-authored-by: Daryna Ishchenko <[email protected]>
Co-authored-by: katmarkham <[email protected]>

Author: 3 people

airbyte-integrations/connectors/source-xero/.dockerignore

@@ -1,55 +1,66 @@
 # Xero source connector
 
 
-This is the repository for the Xero source connector, written in Python.
+This is the repository for the Xero configuration based source connector.
 For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/xero).
 
 ## Local development
 
 ### Prerequisites
-* Python (~=3.9)
-* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
+
+* Python (`^3.9`)
+* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
+
 
 
 ### Installing the connector
+
 From this connector directory, run:
 ```bash
 poetry install --with dev
 ```
 
 
 ### Create credentials
+
 **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/xero)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_xero/spec.yaml` file.
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` inside `manifest.yaml` file.
 Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
-See `sample_files/sample_config.json` for a sample config file.
+See `integration_tests/sample_config.json` for a sample config file.
 
 
 ### Locally running the connector
+
+
 ```
 poetry run source-xero spec
 poetry run source-xero check --config secrets/config.json
 poetry run source-xero discover --config secrets/config.json
-poetry run source-xero read --config secrets/config.json --catalog sample_files/configured_catalog.json
+poetry run source-xero read --config secrets/config.json --catalog integration_tests/configured_catalog.json
 ```
 
-### Running unit tests
-To run unit tests locally, from the connector directory run:
+### Running tests
+
+To run tests locally, from the connector directory run:
+
 ```
-poetry run pytest unit_tests
+poetry run pytest tests
 ```
 
 ### Building the docker image
+
 1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
 2. Run the following command to build the docker image:
 ```bash
 airbyte-ci connectors --name=source-xero build
 ```
 
 An image will be available on your host with the tag `airbyte/source-xero:dev`.
+An image will be available on your host with the tag `airbyte/source-xero:dev`.
 
 
 ### Running as a docker container
+
 Then run any of the connector commands as follows:
 ```
 docker run --rm airbyte/source-xero:dev spec
@@ -59,16 +70,19 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
 ```
 
 ### Running our CI test suite
+
 You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
 ```bash
 airbyte-ci connectors --name=source-xero test
 ```
 
 ### Customizing acceptance Tests
+
 Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
 If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
 
 ### Dependency Management
+
 All of your dependencies should be managed via Poetry. 
 To add a new dependency, run:
 ```bash
@@ -78,14 +92,20 @@ poetry add <package-name>
 Please commit the changes to `pyproject.toml` and `poetry.lock` files.
 
 ## Publishing a new version of the connector
+
 You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
 1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-xero test`
+2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): 
+    - bump the `dockerImageTag` value in in `metadata.yaml`
+    - bump the `version` value in `pyproject.toml`
 2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): 
     - bump the `dockerImageTag` value in in `metadata.yaml`
     - bump the `version` value in `pyproject.toml`
 3. Make sure the `metadata.yaml` content is up to date.
 4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/xero.md`).
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/xero.md`).
 5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
 6. Pat yourself on the back for being an awesome contributor.
 7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
+8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
 8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

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

@@ -7,7 +7,7 @@ acceptance_tests:
     tests:
       - spec_path: "source_xero/spec.yaml"
         backward_compatibility_tests_config:
-          disable_for_version: "0.1.0"
+          disable_for_version: "0.2.5"
   connection:
     tests:
       - config_path: "secrets/config.json"
@@ -18,7 +18,7 @@ acceptance_tests:
     tests:
       - config_path: "secrets/config.json"
         backward_compatibility_tests_config:
-          disable_for_version: "0.1.0"
+          disable_for_version: "0.2.5"
   basic_read:
     tests:
       - config_path: "secrets/config.json"
@@ -42,6 +42,7 @@ acceptance_tests:
             bypass_reason: "Empty stream, further investigation is required"
         fail_on_extra_columns: false
   incremental:
+    # bypass_reason: "Xero only supports date-precision filtering and our sandbox does not have enough data to properly test incremental reads"
     tests:
       - config_path: "secrets/config.json"
         configured_catalog_path: "integration_tests/configured_catalog.json"

airbyte-integrations/connectors/source-xero/unit_tests/__init__.py airbyte-integrations/connectors/source-xero/__init__.py

@@ -11,4 +11,6 @@
 @pytest.fixture(scope="session", autouse=True)
 def connector_setup():
     """This fixture is a placeholder for external resources that acceptance test might require."""
+    # TODO: setup test dependencies if needed. otherwise remove the TODO comments
     yield
+    # TODO: clean up test dependencies

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

@@ -1,10 +1,5 @@
 {
-  "client_id": "client_id",
-  "client_secret": "client_secret",
-  "tenant_id": "tenant_id",
-  "scopes": "scope1, scope2",
-  "authentication": {
-    "auth_type": null
-  },
-  "start_date": "2020-01-01T00:00:00Z"
+  "access_token": "xxxxxxxxxxxxxxxxxxxx",
+  "tenant_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+  "start_date": "2021-01-01T00:00:00Z"
 }

airbyte-integrations/connectors/source-xero/integration_tests/acceptance.py

@@ -1,10 +1,5 @@
 {
-  "client_id": "389D15E4EE7D4EC09F91F2926EDE5B9B",
-  "client_secret": "rumSF2vR4wGY-bhNOTqo1lttMgi0h_XobxyrKYBzrRUxj9nR",
-  "tenant_id": "22b6dfc8-a47d-4e3d-a4ab-a30f22a5681d",
-  "scopes": "accounting.attachments accounting.contacts accounting.transactions assets.read accounting.attachments.read accounting.contacts.read accounting.settings accounting.settings.read accounting.journals.read accounting.budgets.read accounting.reports.tenninetynine.read accounting.reports.read assets accounting.transactions.read",
-  "authentication": {
-    "auth_type": "custom_connection"
-  },
+  "access_token": "xxxxxxxxxxxxxxxxxxxx",
+  "tenant_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
   "start_date": "2021-01-01T00:00:00Z"
 }

airbyte-integrations/connectors/source-xero/integration_tests/invalid_config.json

@@ -2,33 +2,46 @@ data:
   allowedHosts:
     hosts:
       - api.xero.com
+  registries:
+    oss:
+      enabled: true
+    cloud:
+      enabled: false
+  remoteRegistries:
+    pypi:
+      enabled: true
+      packageName: airbyte-source-xero
+  releases:
+    breakingChanges:
+      1.0.0:
+        upgradeDeadline: "2024-06-30"
+        message:
+          The source Xero connector is being migrated from the Python CDK to our declarative low-code CDK. The authorization method was changed from OAuth 2.0 to Access Token. Due to changes in authorization, users will need to generate an access token within source Xero and reset source configuration. For more information, see our migration documentation for source Xero.
+          Important - The authentication scheme is using access_token instead of Oauth 2.0 from this version.
+  connectorBuildOptions:
+    # Please update to the latest version of the connector base image.
+    # https://hub.docker.com/r/airbyte/python-connector-base
+    # Please use the full address with sha256 hash to guarantee build reproducibility.
+    baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
   connectorSubtype: api
   connectorType: source
   definitionId: 6fd1e833-dd6e-45ec-a727-ab917c5be892
-  dockerImageTag: 0.2.6
+  dockerImageTag: 1.0.0
   dockerRepository: airbyte/source-xero
   githubIssueLabel: source-xero
   icon: xero.svg
   license: MIT
   name: Xero
-  remoteRegistries:
-    pypi:
-      enabled: true
-      packageName: airbyte-source-xero
-  registries:
-    cloud:
-      enabled: false
-    oss:
-      enabled: true
+  releaseDate: 2021-11-11
   releaseStage: beta
+  supportLevel: community
   documentationUrl: https://docs.airbyte.com/integrations/sources/xero
   tags:
     - language:python
-    - cdk:python
+    - cdk:low-code
   ab_internal:
     sl: 100
     ql: 300
-  supportLevel: community
   connectorTestSuitesOptions:
     - suite: unitTests
     - suite: acceptanceTests
@@ -38,6 +51,4 @@ data:
           secretStore:
             type: GSM
             alias: airbyte-connector-testing-secret-store
-  connectorBuildOptions:
-    baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
 metadataSpecVersion: "1.0"