✨Source Amazon SQS: Migrate Python CDK to Low code (#41064)

Co-authored-by: Christo Grabowski <[email protected]> Co-authored-by: Natik Gadzhi <[email protected]> Co-authored-by: Octavia Squidington III <[email protected]> Co-authored-by: Danylo Jablonski <[email protected]>
airbytehq · Jan 15, 2025 · 5f8b279 · 5f8b279
1 parent d8220f1
commit 5f8b279
Show file tree

Hide file tree

Showing 28 changed files with 2,319 additions and 688 deletions.
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/.dockerignore b/airbyte-integrations/connectors/source-amazon-sqs/.dockerignore
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/Dockerfile b/airbyte-integrations/connectors/source-amazon-sqs/Dockerfile
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/README.md b/airbyte-integrations/connectors/source-amazon-sqs/README.md
@@ -1,116 +1,103 @@
 # Amazon Sqs Source
 
-This is the repository for the Amazon Sqs source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/amazon-sqs).
+This is the repository for the Amazon Sqs configuration based source connector.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/amazon-sqs).
 
 ## Local development
 
 ### Prerequisites
 
-**To iterate on this connector, make sure to complete this prerequisites section.**
+* Python (`^3.9`)
+* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
-#### Minimum Python version required `= 3.7.0`
 
-#### Build & Activate Virtual Environment and install dependencies
 
-From this connector directory, create a virtual environment:
+### Installing the connector
 
+From this connector directory, run:
+```bash
+poetry install --with dev
 ```
-python -m venv .venv
-```
-
-This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
-development environment of choice. To activate it from the terminal, run:
-
-```
-source .venv/bin/activate
-pip install -r requirements.txt
-```
-
-If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
 
-Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
-used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
-If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
-should work as you expect.
 
-#### Create credentials
+### Create credentials
 
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/amazon-sqs)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_amazon_sqs/spec.json` file.
-Note that the `secrets` directory is gitignored by default, so there is no danger of accidentally checking in sensitive information.
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/amazon-sqs)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_amazon_sqs/spec.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 `integration_tests/sample_config.json` for a sample config file.
 
-**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source amazon-sqs test creds`
-and place them into `secrets/config.json`.
 
 ### Locally running the connector
 
 ```
-python main.py spec
-python main.py check --config secrets/config.json
-python main.py discover --config secrets/config.json
-python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
+poetry run source-amazon-sqs spec
+poetry run source-amazon-sqs check --config secrets/config.json
+poetry run source-amazon-sqs discover --config secrets/config.json
+poetry run source-amazon-sqs read --config secrets/config.json --catalog integration_tests/configured_catalog.json
 ```
 
-### Locally running the connector docker image
+### Running tests
 
-#### Build
+To run tests locally, from the connector directory run:
+
+```
+poetry run pytest tests
+```
 
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+### 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-amazon-sqs build
 ```
 
-An image will be built with the tag `airbyte/source-amazon-sqs:dev`.
+An image will be available on your host with the tag `airbyte/source-amazon-sqs:dev`.
 
-**Via `docker build`:**
 
-```bash
-docker build -t airbyte/source-amazon-sqs:dev .
-```
-
-#### Run
+### Running as a docker container
 
 Then run any of the connector commands as follows:
-
 ```
 docker run --rm airbyte/source-amazon-sqs:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-amazon-sqs:dev check --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-amazon-sqs:dev discover --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-amazon-sqs:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
 ```
 
-## Testing
+### 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-amazon-sqs test
 ```
 
 ### Customizing acceptance Tests
 
-Customize `acceptance-test-config.yml` file to configure 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
+### Dependency Management
 
-All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
-We split dependencies between two groups, dependencies that are:
+All of your dependencies should be managed via Poetry. 
+To add a new dependency, run:
+```bash
+poetry add <package-name>
+```
 
-- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
-- required for the testing need to go to `TEST_REQUIREMENTS` list
+Please commit the changes to `pyproject.toml` and `poetry.lock` files.
 
-### Publishing a new version of the connector
+## 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-amazon-sqs test`
-2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).
+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 the connector documentation and its changelog is up to date (`docs/integrations/sources/amazon-sqs.md`).
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/amazon-sqs.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.
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/__init__.py b/airbyte-integrations/connectors/source-amazon-sqs/__init__.py
@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
+#
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/acceptance-test-config.yml b/airbyte-integrations/connectors/source-amazon-sqs/acceptance-test-config.yml
@@ -3,7 +3,7 @@
 connector_image: airbyte/source-amazon-sqs:dev
 tests:
   spec:
-    - spec_path: "source_amazon_sqs/spec.json"
+    - spec_path: "source_amazon_sqs/spec.yaml"
   connection:
     - config_path: "secrets/config.json"
       status: "succeed"

diff --git a/airbyte-integrations/connectors/source-amazon-sqs/bootstrap.md b/airbyte-integrations/connectors/source-amazon-sqs/bootstrap.md
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/__init__.py b/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/__init__.py
@@ -1,3 +1,3 @@
 #
-# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 #
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/abnormal_state.json b/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/abnormal_state.json
@@ -1,5 +1,5 @@
 {
-  "ab-airbyte-testing": {
+  "QueueMessages": {
     "todo-field-name": "todo-abnormal-value"
   }
 }
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/acceptance.py b/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/acceptance.py
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 #
 
 
@@ -12,6 +12,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
+    # TODO: setup test dependencies if needed. otherwise remove the TODO comments
     yield
     # TODO: clean up test dependencies
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/catalog.json b/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/catalog.json
@@ -1,7 +1,7 @@
 {
   "streams": [
     {
-      "name": "Airbyte",
+      "name": "QueueMessages",
       "supported_sync_modes": ["full_refresh"],
       "source_defined_cursor": false,
       "json_schema": {

diff --git a/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/configured_catalog.json b/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/configured_catalog.json
@@ -1,27 +1,18 @@
 {
   "streams": [
     {
-      "sync_mode": "full_refresh",
-      "destination_sync_mode": "append",
       "stream": {
-        "name": "Airbyte",
-        "supported_sync_modes": ["full_refresh"],
-        "source_defined_cursor": false,
+        "name": "QueueMessages",
         "json_schema": {
+          "$schema": "https://json-schema.org/draft-07/schema#",
           "type": "object",
-          "properties": {
-            "id": {
-              "type": "string"
-            },
-            "body": {
-              "type": "string"
-            },
-            "attributes": {
-              "type": ["null", "object"]
-            }
-          }
-        }
-      }
+          "properties": {}
+        },
+        "supported_sync_modes": ["full_refresh"],
+        "supported_destination_sync_modes": ["overwrite", "append_dedup"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
     }
   ]
 }
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/expected_records.jsonl b/airbyte-integrations/connectors/source-amazon-sqs/integration_tests/expected_records.jsonl
diff --git a/airbyte-integrations/connectors/source-amazon-sqs/main.py b/airbyte-integrations/connectors/source-amazon-sqs/main.py
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 #
 
 from source_amazon_sqs.run import run

diff --git a/airbyte-integrations/connectors/source-amazon-sqs/metadata.yaml b/airbyte-integrations/connectors/source-amazon-sqs/metadata.yaml
@@ -2,16 +2,34 @@ data:
   ab_internal:
     ql: 200
     sl: 100
+  allowedHosts:
+    hosts:
+      - "sqs.*.amazonaws.com"
+  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:3.0.0@sha256:1a0845ff2b30eafa793c6eee4e8f4283c2e52e1bbd44eed6cb9e9abd5d34d844
   connectorSubtype: api
   connectorType: source
   definitionId: 983fd355-6bf3-4709-91b5-37afa391eeb6
-  dockerImageTag: 0.1.1
+  dockerImageTag: 1.0.0
   dockerRepository: airbyte/source-amazon-sqs
   documentationUrl: https://docs.airbyte.com/integrations/sources/amazon-sqs
   githubIssueLabel: source-amazon-sqs
-  icon: awssqs.svg
+  icon: amazon-sqs.svg
   license: MIT
   name: Amazon SQS
+  releaseDate: 2021-10-27
+  releases:
+    breakingChanges:
+      1.0.0:
+        upgradeDeadline: "2025-01-30"
+        message: "The verison migrates the Amazon SQS connector to the low-code
+          framework for greater maintainability. !! Important: The management_events
+          stream changed it's EventTime field from integer to float. The `start_date`
+          parameter is now optional and the connector now takes current date as default
+          start date "
   remoteRegistries:
     pypi:
       enabled: true
@@ -25,7 +43,7 @@ data:
   supportLevel: community
   tags:
     - language:python
-    - cdk:python
+    - cdk:low-code
   connectorTestSuitesOptions:
     - suite: liveTests
       testConnections: