✨Source Outreach: Migrate Python CDK to Low-code CDK (#36954)

Co-authored-by: Alexandre Girard <[email protected]>

Author: btkcodedev

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

@@ -1,58 +1,67 @@
 # Outreach source connector
 
-This is the repository for the Outreach source connector, written in Python.
+This is the repository for the Outreach configuration based source connector.
 For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/outreach).
 
 ## 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/outreach)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_outreach/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.
 
+
 ### Locally running the connector
 
+
 ```
 poetry run source-outreach spec
 poetry run source-outreach check --config secrets/config.json
 poetry run source-outreach discover --config secrets/config.json
 poetry run source-outreach read --config secrets/config.json --catalog sample_files/configured_catalog.json
+poetry run source-outreach spec
+poetry run source-outreach check --config secrets/config.json
+poetry run source-outreach discover --config secrets/config.json
+poetry run source-outreach read --config secrets/config.json --catalog sample_files/configured_catalog.json
 ```
 
-### Running unit tests
+### Running tests
 
-To run unit tests locally, from the connector directory run:
+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-outreach build
 ```
 
 An image will be available on your host with the tag `airbyte/source-outreach:dev`.
 
+
+### Running as a docker container
 ### Running as a docker container
 
 Then run any of the connector commands as follows:
@@ -66,6 +75,8 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
 
 ### Running our CI test suite
 
+### 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
@@ -74,14 +85,15 @@ airbyte-ci connectors --name=source-outreach 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.
+
 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.
+All of your dependencies should be managed via Poetry. 
 To add a new dependency, run:
-
 ```bash
 poetry add <package-name>
 ```
@@ -93,12 +105,13 @@ Please commit the changes to `pyproject.toml` and `poetry.lock` files.
 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-outreach 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/outreach.md`).
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/outreach.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-outreach/README.md

@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
+#

airbyte-integrations/connectors/source-outreach/__init__.py

@@ -4,7 +4,7 @@ connector_image: airbyte/source-outreach:dev
 acceptance_tests:
   spec:
     tests:
-      - spec_path: "source_outreach/spec.json"
+      - spec_path: "source_outreach/spec.yaml"
   connection:
     tests:
       - config_path: "secrets/config.json"
@@ -14,7 +14,8 @@ acceptance_tests:
   discovery:
     tests:
       - config_path: "secrets/config.json"
-  # https://github.com/airbytehq/airbyte/issues/8180
+        backward_compatibility_tests_config:
+          disable_for_version: 0.5.0 # The sequence_steps changed its ['properties']['creator']['items']['type'] field to include integers
   basic_read:
     tests:
       - config_path: "secrets/config.json"
@@ -28,6 +29,9 @@ acceptance_tests:
             bypass_reason: "Sandbox account cannot seed the stream"
           - name: "templates"
             bypass_reason: "Sandbox account cannot seed the stream"
+        expect_records:
+          path: "integration_tests/expected_records.jsonl"
+          exact_order: no
   incremental:
     tests:
       - config_path: "secrets/config.json"

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

@@ -1,3 +1,3 @@
 #
-# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 #

airbyte-integrations/connectors/source-outreach/integration_tests/__init__.py

@@ -1,53 +1,53 @@
 {
   "prospects": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "sequences": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "sequence_states": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "sequence_steps": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "accounts": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "opportunities": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "personas": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "mailings": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "mailboxes": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "stages": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "calls": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "call_purposes": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "call_dispositions": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "users": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "tasks": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "templates": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   },
   "snippets": {
-    "updatedAt": "2040-11-16T00:00:00Z"
+    "updatedAt": "2040-11-16T00:00:00.000Z"
   }
 }

airbyte-integrations/connectors/source-outreach/integration_tests/abnormal_state.json

@@ -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