chore(destination-sftp-json): migrate to poetry and base image (#46873)

Co-authored-by: ChristoGrab <[email protected]>
Co-authored-by: Octavia Squidington III <[email protected]>

Author: 3 people

airbyte-integrations/connectors/destination-sftp-json/.dockerignore

@@ -1,118 +1,90 @@
-# Sftp Json Destination
+# Sftp-Json source connector
 
-This is the repository for the SFTP JSON destination connector, written in Python.
-Data received by this destination will be written to a JSON lines file at the path and filename supplied in the configuration.
-
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/destinations/sftp-json).
+This is the repository for the SFTP-JSON destination connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/destinations/sftp-json).
 
 ## Local development
 
 ### Prerequisites
+* Python (~=3.9)
+* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
-**To iterate on this connector, make sure to complete this prerequisites section.**
-
-#### Minimum Python version required `= 3.7.0`
-
-#### Build & Activate Virtual Environment and install dependencies
-
-From this connector directory, create a virtual environment:
-
-```
-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:
 
+### Installing the connector
+From this connector directory, run:
+```bash
+poetry install --with dev
 ```
-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
 
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/destinations/sftp-json)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `destination_sftp_json/spec.json` file.
-Note that the `secrets` directory is gitignored by default, so there is no danger of accidentally checking in sensitive information.
-See `integration_tests/sample_config.json` for a sample config file.
+### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/destinations/sftp-json)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `destination_sftp_json/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 `sample_files/sample_config.json` for a sample config file.
 
-**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `destination sftp-json 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 destination-sftp-json spec
+poetry run destination-sftp-json check --config secrets/config.json
+poetry run destination-sftp-json discover --config secrets/config.json
+poetry run destination-sftp-json read --config secrets/config.json --catalog sample_files/configured_catalog.json
 ```
 
-### Locally running the connector docker image
-
-#### Build
-
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+### Running unit tests
+To run unit tests locally, from the connector directory run:
+```
+poetry run pytest unit_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=destination-sftp-json build
 ```
 
-An image will be built with the tag `airbyte/destination-sftp-json:dev`.
-
-**Via `docker build`:**
-
-```bash
-docker build -t airbyte/destination-sftp-json:dev .
-```
+An image will be available on your host with the tag `airbyte/destination-sftp-json:dev`.
 
-#### Run
 
+### Running as a docker container
 Then run any of the connector commands as follows:
-
 ```
 docker run --rm airbyte/destination-sftp-json:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-sftp-json:dev check --config /secrets/config.json
-# messages.jsonl is a file containing line-separated JSON representing AirbyteMessages
-cat messages.jsonl | docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/destination-sftp-json:dev write --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-sftp-json:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/destination-sftp-json: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=destination-sftp-json 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
-
-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:
-
-- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
-- required for the testing need to go to `TEST_REQUIREMENTS` list
+### Dependency Management
+All of your dependencies should be managed via Poetry.
+To add a new dependency, run:
+```bash
+poetry add <package-name>
+```
 
-### Publishing a new version of the connector
+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=destination-sftp-json 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/destinations/sftp-json.md`).
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/destinations/sftp-json.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.

airbyte-integrations/connectors/destination-sftp-json/Dockerfile

@@ -0,0 +1,22 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+
+if TYPE_CHECKING:
+    from dagger import Container
+
+
+async def pre_connector_install(base_image_container: Container) -> Container:
+    """
+    Docker compose is required to run the integration tests so we install Docker on top of the base image.
+    """
+    return (
+        base_image_container.with_exec(["sh", "-c", "apt-get update && apt-get install -y curl"], use_entrypoint=True)
+        .with_exec(["curl", "-fsSL", "https://get.docker.com", "-o", "/tmp/install-docker.sh"], use_entrypoint=True)
+        .with_exec(["sh", "/tmp/install-docker.sh", "--version", "23.0"], use_entrypoint=True)
+        .with_exec(["rm", "/tmp/install-docker.sh"], use_entrypoint=True)
+    )

airbyte-integrations/connectors/destination-sftp-json/README.md

@@ -2,7 +2,6 @@
 # Copyright (c) 2023 Airbyte, Inc., all rights reserved.
 #
 
-
 import contextlib
 import errno
 import json

airbyte-integrations/connectors/destination-sftp-json/build_customization.py

@@ -3,11 +3,11 @@
 #
 
 
+import logging
 import traceback
 import uuid
 from typing import Any, Iterable, Mapping
 
-from airbyte_cdk import AirbyteLogger
 from airbyte_cdk.destinations import Destination
 from airbyte_cdk.models import AirbyteConnectionStatus, AirbyteMessage, ConfiguredAirbyteCatalog, DestinationSyncMode, Status, Type
 from destination_sftp_json.client import SftpClient
@@ -47,12 +47,13 @@ def write(
                     yield message
                 elif message.type == Type.RECORD:
                     record = message.record
-                    writer.write(record.stream, record.data)
+                    if record is not None:
+                        writer.write(record.stream, record.data)
                 else:
                     # ignore other message types for now
                     continue
 
-    def check(self, logger: AirbyteLogger, config: Mapping[str, Any]) -> AirbyteConnectionStatus:
+    def check(self, logger: logging.Logger, config: Mapping[str, Any]) -> AirbyteConnectionStatus:
         """
         Tests if the input configuration can be used to successfully connect to the destination with the needed permissions
             e.g: if a provided API token or password can be used to connect and write to the destination.

airbyte-integrations/connectors/destination-sftp-json/destination_sftp_json/client.py

@@ -0,0 +1,17 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+from __future__ import annotations
+
+import pytest
+
+
+pytest_plugins = ("connector_acceptance_test.plugin",)
+
+
+@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
+    yield
+    # TODO: clean up test dependencies

airbyte-integrations/connectors/destination-sftp-json/destination_sftp_json/destination.py

@@ -0,0 +1,49 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+import socket
+from pathlib import Path
+from typing import Mapping
+
+import paramiko
+import paramiko.client
+import pytest
+from paramiko.ssh_exception import SSHException
+
+
+HERE = Path(__file__).parent.absolute()
+
+
+@pytest.fixture(scope="session")
+def docker_compose_file() -> Path:
+    return HERE / "docker-compose.yml"
+
+
+def is_sftp_ready(ip: str, config: Mapping) -> bool:
+    """Helper function that checks if sftp is served on provided ip address and port."""
+    try:
+        with paramiko.client.SSHClient() as ssh:
+            ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy)
+            # hardcoding the credentials is okay here, we're not testing them explicitly.
+            ssh.connect(
+                ip,
+                port=config["port"],
+                username=config["username"],
+                password=config["password"],
+            )
+        return True
+    except (SSHException, socket.error):
+        return False
+
+
+@pytest.fixture(scope="module")
+def config(docker_ip, docker_services) -> Mapping:
+    """
+    Provides the SFTP configuration using docker_services.
+    Waits for the docker container to become available before returning the config.
+    """
+    port = docker_services.port_for("sftp", 22)
+    config_data = {"host": docker_ip, "port": port, "username": "user1", "password": "abc123", "destination_path": "upload"}
+    docker_services.wait_until_responsive(timeout=30.0, pause=0.1, check=lambda: is_sftp_ready(docker_ip, config_data))
+    return config_data

airbyte-integrations/connectors/destination-sftp-json/integration_tests/acceptance.py

@@ -0,0 +1,12 @@
+version: "3"
+services:
+  sftp:
+    image: atmoz/sftp
+    ports:
+      - "2222:22"
+    command: user1:abc123:1001:1001:upload
+    healthcheck:
+      test: ["CMD", "nc", "-z", "localhost", "22"]
+      interval: 2s
+      timeout: 1s
+      retries: 5