forked from airbytehq/airbyte
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🎉 New source: SFTP Bulk [python cdk] (airbytehq#17691)
* [INIT] setup source-ftp Signed-off-by: Henri Blancke <[email protected]> * [ADD] add logic Signed-off-by: Henri Blancke <[email protected]> * [ADD] unit, integration, acceptance tests Signed-off-by: Henri Blancke <[email protected]> * [UPD] update docs Signed-off-by: Henri Blancke <[email protected]> * [UPD] clean up crew Signed-off-by: Henri Blancke <[email protected]> * [UPD] update host to localhost Signed-off-by: Henri Blancke <[email protected]> * [UPD] rename from ftp to sftp bulk Signed-off-by: Henri Blancke <[email protected]> * [INIT] setup source-ftp Signed-off-by: Henri Blancke <[email protected]> * [ADD] add logic Signed-off-by: Henri Blancke <[email protected]> * [ADD] unit, integration, acceptance tests Signed-off-by: Henri Blancke <[email protected]> * [UPD] update docs Signed-off-by: Henri Blancke <[email protected]> * [UPD] clean up crew Signed-off-by: Henri Blancke <[email protected]> * [UPD] update host to localhost Signed-off-by: Henri Blancke <[email protected]> * [UPD] rename from ftp to sftp bulk Signed-off-by: Henri Blancke <[email protected]> * update branch * [FIX] integration tests Signed-off-by: Henri Blancke <[email protected]> * [FIX] acceptance test fixture Signed-off-by: Henri Blancke <[email protected]> * [UPD] change ftp port Signed-off-by: Henri Blancke <[email protected]> * add uuid to image build * add source def * [FIX] generate ssh keys Signed-off-by: Henri Blancke <[email protected]> * auto-bump connector version Signed-off-by: Henri Blancke <[email protected]> Co-authored-by: marcosmarxm <[email protected]> Co-authored-by: Octavia Squidington III <[email protected]>
- Loading branch information
1 parent
3c9e268
commit e2a13a6
Showing
34 changed files
with
1,426 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
airbyte-integrations/connectors/source-sftp-bulk/.dockerignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| * | ||
| !Dockerfile | ||
| !main.py | ||
| !source_sftp_bulk | ||
| !setup.py | ||
| !secrets |
17 changes: 17 additions & 0 deletions
17
airbyte-integrations/connectors/source-sftp-bulk/Dockerfile
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| FROM python:3.9-slim | ||
| # FROM python:3.9.11-alpine3.15 | ||
|
|
||
| # Bash is installed for more convenient debugging. | ||
| # RUN apt-get update && apt-get install -y bash && rm -rf /var/lib/apt/lists/* | ||
|
|
||
| WORKDIR /airbyte/integration_code | ||
| COPY source_sftp_bulk ./source_sftp_bulk | ||
| COPY main.py ./ | ||
| COPY setup.py ./ | ||
| RUN pip install . | ||
|
|
||
| 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.name=airbyte/source-sftp-bulk |
129 changes: 129 additions & 0 deletions
129
airbyte-integrations/connectors/source-sftp-bulk/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| # SFTP Bulk Source | ||
|
|
||
| This is the repository for the FTP source connector, written in Python, that helps you bulk ingest files with the same data format from an FTP server into a single stream. | ||
| For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/sftp-bulk). | ||
|
|
||
| ## Local development | ||
|
|
||
| ### Prerequisites | ||
| **To iterate on this connector, make sure to complete this prerequisites section.** | ||
|
|
||
| #### Minimum Python version required `= 3.9.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: | ||
| ``` | ||
| 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. | ||
|
|
||
| #### Building via Gradle | ||
| From the Airbyte repository root, run: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-sftp-bulk:build | ||
| ``` | ||
|
|
||
| #### Create credentials | ||
| **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/sftp-bulk) | ||
| to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_sftp_bulk/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. | ||
|
|
||
| **If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source ftp 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 | ||
| ``` | ||
|
|
||
| ### Locally running the connector docker image | ||
|
|
||
| #### Build | ||
| First, make sure you build the latest Docker image: | ||
| ``` | ||
| docker build . -t airbyte/source-sftp-bulk:dev | ||
| ``` | ||
|
|
||
| You can also build the connector image via Gradle: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-sftp-bulk:airbyteDocker | ||
| ``` | ||
| When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in | ||
| the Dockerfile. | ||
|
|
||
| #### Run | ||
| Then run any of the connector commands as follows: | ||
| ``` | ||
| docker run --rm airbyte/source-sftp-bulk:dev spec | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-sftp-bulk:dev check --config /secrets/config.json | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-sftp-bulk:dev discover --config /secrets/config.json | ||
| docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-sftp-bulk:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
| ``` | ||
| ## Testing | ||
| Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named. | ||
| First install test dependencies into your virtual environment: | ||
| ``` | ||
| pip install .[tests] | ||
| ``` | ||
| ### Unit Tests | ||
| To run unit tests locally, from the connector directory run: | ||
| ``` | ||
| python -m pytest unit_tests | ||
| ``` | ||
|
|
||
| ### Integration Tests | ||
| There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all source connectors) and custom integration tests (which are specific to this connector). | ||
| #### Custom Integration tests | ||
| Place custom tests inside `integration_tests/` folder, then, from the connector root, run | ||
| ``` | ||
| python -m pytest integration_tests | ||
| ``` | ||
| #### Acceptance Tests | ||
| Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-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. | ||
| To run your integration tests with acceptance tests, from the connector root, run | ||
| ``` | ||
| python -m pytest integration_tests -p integration_tests.acceptance | ||
| ``` | ||
| To run your integration tests with docker | ||
|
|
||
| ### Using gradle to run tests | ||
| All commands should be run from airbyte project root. | ||
| To run unit tests: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-sftp-bulk:unitTest | ||
| ``` | ||
| To run acceptance and custom integration tests: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-sftp-bulk:integrationTest | ||
| ``` | ||
|
|
||
| ## 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 | ||
|
|
||
| ### 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 unit and integration tests. | ||
| 1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)). | ||
| 1. Create a Pull Request. | ||
| 1. Pat yourself on the back for being an awesome contributor. | ||
| 1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. |
27 changes: 27 additions & 0 deletions
27
airbyte-integrations/connectors/source-sftp-bulk/acceptance-test-config.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference) | ||
| # for more information about how to configure these tests | ||
| connector_image: airbyte/source-sftp-bulk:dev | ||
| tests: | ||
| spec: | ||
| - spec_path: "source_sftp_bulk/spec.json" | ||
| timeout_seconds: 60 | ||
| connection: | ||
| - config_path: "integration_tests/valid_config.json" | ||
| status: "succeed" | ||
| timeout_seconds: 60 | ||
| - config_path: "integration_tests/invalid_config.json" | ||
| status: "failed" | ||
| timeout_seconds: 60 | ||
| discovery: | ||
| - config_path: "integration_tests/valid_config.json" | ||
| basic_read: | ||
| - config_path: "integration_tests/valid_config.json" | ||
| configured_catalog_path: "integration_tests/configured_catalog.json" | ||
| empty_streams: [] | ||
| incremental: | ||
| - config_path: "integration_tests/valid_config.json" | ||
| configured_catalog_path: "integration_tests/configured_catalog.json" | ||
| future_state_path: "integration_tests/abnormal_state.json" | ||
| full_refresh: | ||
| - config_path: "integration_tests/valid_config.json" | ||
| configured_catalog_path: "integration_tests/configured_catalog.json" |
16 changes: 16 additions & 0 deletions
16
airbyte-integrations/connectors/source-sftp-bulk/acceptance-test-docker.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| #!/usr/bin/env sh | ||
|
|
||
| # Build latest connector image | ||
| docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2-) | ||
|
|
||
| # Pull latest acctest image | ||
| docker pull airbyte/source-acceptance-test:latest | ||
|
|
||
| # Run | ||
| docker run --rm -it \ | ||
| -v /var/run/docker.sock:/var/run/docker.sock \ | ||
| -v /tmp:/tmp \ | ||
| -v $(pwd):/test_input \ | ||
| airbyte/source-acceptance-test \ | ||
| --acceptance-test-config /test_input | ||
|
|
9 changes: 9 additions & 0 deletions
9
airbyte-integrations/connectors/source-sftp-bulk/build.gradle
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| plugins { | ||
| id 'airbyte-python' | ||
| id 'airbyte-docker' | ||
| id 'airbyte-source-acceptance-test' | ||
| } | ||
|
|
||
| airbytePython { | ||
| moduleDirectory 'source_sftp_bulk' | ||
| } |
3 changes: 3 additions & 0 deletions
3
airbyte-integrations/connectors/source-sftp-bulk/integration_tests/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # | ||
| # Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
| # |
9 changes: 9 additions & 0 deletions
9
airbyte-integrations/connectors/source-sftp-bulk/integration_tests/abnormal_state.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| [ | ||
| { | ||
| "type": "STREAM", | ||
| "stream": { | ||
| "stream_state": { "last_modified": "2522-10-04T13:31:15" }, | ||
| "stream_descriptor": { "name": "test_stream" } | ||
| } | ||
| } | ||
| ] |
Oops, something went wrong.