🎉 New Destination: AWS Datalake (airbytehq#10760)

* Implementation of a destination connector for AWS Datalake (governed tables)

* refactor

* state message

* correct source config

* add connector spec config

* update docs

* modify spec json

* run seed config

Co-authored-by: marcosmarxm <[email protected]>

airbyte-config/init/src/main/resources/seed/destination_definitions.yaml

@@ -16,6 +16,11 @@
   dockerImageTag: 0.1.0
   documentationUrl: https://docs.airbyte.io/integrations/destinations/amazonsqs
   icon: amazonsqs.svg
+- name: AWS Datalake
+  destinationDefinitionId: 99878c90-0fbd-46d3-9d98-ffde879d17fc
+  dockerRepository: airbyte/destination-aws-datalake
+  dockerImageTag: 0.1.0
+  documentationUrl: https://docs.airbyte.io/integrations/destinations/aws-datalake
 - name: BigQuery
   destinationDefinitionId: 22f6c74f-5699-40ff-833c-4a879ea40133
   dockerRepository: airbyte/destination-bigquery

airbyte-config/init/src/main/resources/seed/destination_specs.yaml

@@ -188,6 +188,103 @@
     supportsDBT: false
     supported_destination_sync_modes:
     - "append"
+- dockerImage: "airbyte/destination-aws-datalake:0.1.0"
+  spec:
+    documentationUrl: "https://docs.airbyte.io/integrations/destinations/aws-datalake"
+    connectionSpecification:
+      $schema: "http://json-schema.org/draft-07/schema#"
+      title: "AWS Datalake Destination Spec"
+      type: "object"
+      required:
+      - "credentials"
+      - "region"
+      - "bucket_name"
+      - "bucket_prefix"
+      additionalProperties: false
+      properties:
+        aws_account_id:
+          type: "string"
+          title: "AWS Account Id"
+          description: "target aws account id"
+          examples:
+          - "111111111111"
+        region:
+          title: "AWS Region"
+          type: "string"
+          description: "Region name"
+          airbyte_secret: false
+        credentials:
+          title: "Authentication mode"
+          description: "Choose How to Authenticate to AWS."
+          type: "object"
+          oneOf:
+          - type: "object"
+            title: "IAM Role"
+            required:
+            - "role_arn"
+            - "credentials_title"
+            properties:
+              credentials_title:
+                type: "string"
+                title: "Credentials Title"
+                description: "Name of the credentials"
+                const: "IAM Role"
+                enum:
+                - "IAM Role"
+                default: "IAM Role"
+                order: 0
+              role_arn:
+                title: "Target Role Arn"
+                type: "string"
+                description: "Will assume this role to write data to s3"
+                airbyte_secret: false
+          - type: "object"
+            title: "IAM User"
+            required:
+            - "credentials_title"
+            - "aws_access_key_id"
+            - "aws_secret_access_key_id"
+            properties:
+              credentials_title:
+                type: "string"
+                title: "Credentials Title"
+                description: "Name of the credentials"
+                const: "IAM User"
+                enum:
+                - "IAM User"
+                default: "IAM User"
+                order: 0
+              aws_access_key_id:
+                title: "Access Key Id"
+                type: "string"
+                description: "AWS User Access Key Id"
+                airbyte_secret: true
+              aws_secret_access_key:
+                title: "Secret Access Key"
+                type: "string"
+                description: "Secret Access Key"
+                airbyte_secret: true
+        bucket_name:
+          title: "S3 Bucket Name"
+          type: "string"
+          description: "Name of the bucket"
+          airbyte_secret: false
+        bucket_prefix:
+          title: "Target S3 Bucket Prefix"
+          type: "string"
+          description: "S3 prefix"
+          airbyte_secret: false
+        lakeformation_database_name:
+          title: "Lakeformation Database Name"
+          type: "string"
+          description: "Which database to use"
+          airbyte_secret: false
+    supportsIncremental: true
+    supportsNormalization: false
+    supportsDBT: false
+    supported_destination_sync_modes:
+    - "overwrite"
+    - "append"
 - dockerImage: "airbyte/destination-bigquery:1.0.2"
   spec:
     documentationUrl: "https://docs.airbyte.io/integrations/destinations/bigquery"

airbyte-integrations/connectors/destination-aws-datalake/.dockerignore

@@ -0,0 +1,6 @@
+*
+!Dockerfile
+!main.py
+!destination_aws_datalake
+!setup.py
+!boto3-preview

airbyte-integrations/connectors/destination-aws-datalake/Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.7-slim
+# FROM python:3.7.11-alpine3.14
+
+# 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 destination_aws_datalake ./destination_aws_datalake
+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/destination-aws-datalake

airbyte-integrations/connectors/destination-aws-datalake/README.md

@@ -0,0 +1,160 @@
+# Aws Datalake Destination
+
+This is the repository for the Aws Datalake destination connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/destinations/aws-datalake).
+
+## Local development
+
+### Prerequisites
+
+**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:
+
+```bash
+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:
+
+```bash
+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:
+
+```bash
+./gradlew :airbyte-integrations:connectors:destination-aws-datalake:build
+```
+
+#### Create credentials
+
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/destinations/aws-datalake)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `destination_aws_datalake/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 `destination aws-datalake test creds`
+and place them into `secrets/config.json`.
+
+### Locally running the connector
+
+```bash
+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:
+
+```bash
+docker build . -t airbyte/destination-aws-datalake:dev
+```
+
+You can also build the connector image via Gradle:
+
+```bash
+./gradlew :airbyte-integrations:connectors:destination-aws-datalake: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:
+
+```bash
+docker run --rm airbyte/destination-aws-datalake:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-aws-datalake: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-aws-datalake:dev write --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:
+
+```bash
+pip install .[tests]
+```
+
+### Unit Tests
+
+To run unit tests locally, from the connector directory run:
+
+```bash
+python -m pytest unit_tests
+```
+
+### Integration Tests
+
+There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all destination 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
+
+```bash
+python -m pytest integration_tests
+```
+
+#### Acceptance Tests
+
+Coming soon:
+
+### Using gradle to run tests
+
+All commands should be run from airbyte project root.
+To run unit tests:
+
+```bash
+./gradlew :airbyte-integrations:connectors:destination-aws-datalake:unitTest
+```
+
+To run acceptance and custom integration tests:
+
+```bash
+./gradlew :airbyte-integrations:connectors:destination-aws-datalake: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.

airbyte-integrations/connectors/destination-aws-datalake/build.gradle

@@ -0,0 +1,20 @@
+plugins {
+    id 'application'
+    id 'airbyte-docker'
+    id 'airbyte-integration-test-java'
+}
+
+dependencies {
+    // https://mvnrepository.com/artifact/com.google.guava/guava
+    implementation 'com.google.guava:guava:30.1.1-jre'
+
+    // https://mvnrepository.com/artifact/software.amazon.awssdk/athena
+    implementation 'software.amazon.awssdk:athena:2.17.42'
+
+    // https://mvnrepository.com/artifact/software.amazon.awssdk/glue
+    implementation 'software.amazon.awssdk:glue:2.17.42'
+
+
+    integrationTestJavaImplementation project(':airbyte-integrations:bases:standard-destination-test')
+    integrationTestJavaImplementation project(':airbyte-integrations:connectors:destination-aws-datalake')
+}

airbyte-integrations/connectors/destination-aws-datalake/destination_aws_datalake/__init__.py

@@ -0,0 +1,26 @@
+# MIT License
+#
+# Copyright (c) 2020 Airbyte
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+from .destination import DestinationAwsDatalake
+
+__all__ = ["DestinationAwsDatalake"]