Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🎉 New Source: Dremio #19912

Merged
merged 23 commits into from
Jan 13, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
0e330f5
Source Dremio: add initial stream and configuration
arsenlosenko Nov 30, 2022
ba0173a
Add documentation and security checks
arsenlosenko Dec 2, 2022
68dea48
Add changes requested during review
arsenlosenko Dec 9, 2022
c360ae2
Add primary key to configured catalog as well
arsenlosenko Dec 9, 2022
182afdc
Merge branch 'master' into arsenlosenko/new-source-dremio-yaml
arsenlosenko Dec 9, 2022
0995c41
Specify correct types values in schema
arsenlosenko Dec 14, 2022
9368bdb
Specify spec and primary key properly
arsenlosenko Dec 14, 2022
381d31f
Fix SAT
arsenlosenko Dec 15, 2022
84e55f8
Add seperate spec.yaml for SAT
arsenlosenko Dec 15, 2022
8d3666b
Temporary remove base_url check
arsenlosenko Jan 6, 2023
bd6e86b
Add changes requested during review
arsenlosenko Jan 10, 2023
de63371
Merge branch 'master' into arsenlosenko/new-source-dremio-yaml
arsenlosenko Jan 10, 2023
670a1e0
Specify check stream, edit invalid config
arsenlosenko Jan 11, 2023
5b824e4
Fix SAT
lazebnyi Jan 12, 2023
8c3fdc2
Remove sample state
arsenlosenko Jan 12, 2023
0d9582d
Update source_definitions.yaml
arsenlosenko Jan 12, 2023
b2f1101
auto-bump connector version
octavia-squidington-iii Jan 12, 2023
92e0c06
Merge branch 'master' into arsenlosenko/new-source-dremio-yaml
lazebnyi Jan 12, 2023
282d867
Merge branch 'master' into arsenlosenko/new-source-dremio-yaml
lazebnyi Jan 12, 2023
c0498d8
Added icon
lazebnyi Jan 12, 2023
f648e5f
Merge branch 'master' into arsenlosenko/new-source-dremio-yaml
arsenlosenko Jan 13, 2023
00bd5b3
Merge branch 'master' into arsenlosenko/new-source-dremio-yaml
arsenlosenko Jan 13, 2023
96539b3
Update source readme file
arsenlosenko Jan 13, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions airbyte-integrations/connectors/source-dremio/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*
!Dockerfile
!main.py
!source_dremio
!setup.py
!secrets
38 changes: 38 additions & 0 deletions airbyte-integrations/connectors/source-dremio/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
FROM python:3.9.11-alpine3.15 as base

# build and load all requirements
FROM base as builder
WORKDIR /airbyte/integration_code

# upgrade pip to the latest version
RUN apk --no-cache upgrade \
&& pip install --upgrade pip \
&& apk --no-cache add tzdata build-base


COPY setup.py ./
# install necessary packages to a temporary folder
RUN pip install --prefix=/install .

# build a clean environment
FROM base
WORKDIR /airbyte/integration_code

# copy all loaded and built libraries to a pure basic image
COPY --from=builder /install /usr/local
# add default timezone settings
COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime
RUN echo "Etc/UTC" > /etc/timezone

# bash is installed for more convenient debugging.
RUN apk --no-cache add bash

# copy payload code only
COPY main.py ./
COPY source_dremio ./source_dremio

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-dremio
79 changes: 79 additions & 0 deletions airbyte-integrations/connectors/source-dremio/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Dremio Source

This is the repository for the Dremio configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/dremio).

## Local development

#### Building via Gradle
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.

To build using Gradle, from the Airbyte repository root, run:
```
./gradlew :airbyte-integrations:connectors:source-dremio:build
```

#### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/dremio)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_dremio/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 dremio test creds`
and place them into `secrets/config.json`.

### Locally running the connector docker image

#### Build
First, make sure you build the latest Docker image:
```
docker build . -t airbyte/source-dremio:dev
```

You can also build the connector image via Gradle:
```
./gradlew :airbyte-integrations:connectors:source-dremio: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-dremio:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-dremio:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-dremio:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-dremio:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
## Testing

#### 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 docker

### Using gradle to run tests
All commands should be run from airbyte project root.
To run unit tests:
```
./gradlew :airbyte-integrations:connectors:source-dremio:unitTest
```
To run acceptance and custom integration tests:
```
./gradlew :airbyte-integrations:connectors:source-dremio: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.
3 changes: 3 additions & 0 deletions airbyte-integrations/connectors/source-dremio/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference)
# for more information about how to configure these tests
connector_image: airbyte/source-dremio:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_dremio/spec.yaml"
connection:
tests:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
tests:
- config_path: "secrets/config.json"
basic_read:
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
# TODO uncomment this block to specify that the tests should assert the connector outputs the records provided in the input file a file
# expect_records:
# path: "integration_tests/expected_records.txt"
# extra_fields: no
# exact_order: no
# extra_records: yes
incremental:
bypass_reason: "This connector does not implement incremental sync"
# TODO uncomment this block this block if your connector implements incremental sync:
# tests:
# - config_path: "secrets/config.json"
# configured_catalog_path: "integration_tests/configured_catalog.json"
# future_state_path: "integration_tests/abnormal_state.json"
full_refresh:
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
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 airbyte-integrations/connectors/source-dremio/build.gradle
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_dremio'
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"catalogs": {
"entityType": "dataset",
"id": "28bb8400-6f7f-4807-9e7f-cbf0bb21d204",
"type": "VIRTUAL_DATASET",
"createdAt": "2019-01-10T16:44:05.323Z",
"tag": "0",
"accessControlList": {
"version": 0
},
"fields": [
{
"name": "four_passenger_count",
"type": {
"name": "BIGINT"
}
}
]
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#


import pytest

pytest_plugins = ("source_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 if needed. otherwise remove the TODO comments
yield
# TODO: clean up test dependencies
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"streams": [
{
"name": "catalogs",
"supported_sync_modes": ["full_refresh", "incremental"],
"source_defined_cursor": true,
"default_cursor_field": "",
"json_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"entityType": {
"type": "string"
},
"id": {
"type": "string"
},
"type":{
"type": "string"
},
"path": {
"type": "array"
},
"createdAt":{
"type": "string"
},
"tag": {
"type": "string"
},
"sql": {
"type": "array"
},
"sqlContext": {
"type": "array"
},
"accessControlList": {
"type": "object"
},
"fields": {
"type": "array"
}
}
}
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"streams": [
{
"stream": {
"name": "catalogs",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the primary key is missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

primary key is defined in source_defined_primary_key on line 6, or should there be a different name for this field?

}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"base_url": "http://invalid.dremio.cloud/",
"api_key": "invalid_api_key"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"base_url": "https://app.dremio.cloud/",
"api_key": "vqld6ia6lb5dqvq5knlcd9r9dd"
}


Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"catalogs": {
"entityType": "dataset",
"id": "28bb8400-6f7f-4807-9e7f-cbf0bb21d204",
"type": "VIRTUAL_DATASET",
"path": [
"sandbox",
"taxi_queries",
"passenger_counts"
],
"createdAt": "2019-01-10T16:44:05.323Z",
"tag": "0",
"sql": "SELECT COUNT(*) as four_passenger_count\nFROM \"DEV HDFS\".data.nyctaxi.\"yellow_tripdata_2009-01.csv\"\nWHERE \"Passenger_Count\" >= 4",
"sqlContext": [
"sandbox",
"taxi_queries"
],
"accessControlList": {
"version": 0
},
"fields": [
{
"name": "four_passenger_count",
"type": {
"name": "BIGINT"
}
}
]
}
}
13 changes: 13 additions & 0 deletions airbyte-integrations/connectors/source-dremio/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#


import sys

from airbyte_cdk.entrypoint import launch
from source_dremio import SourceDremio

if __name__ == "__main__":
source = SourceDremio()
launch(source, sys.argv[1:])
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
-e ../../bases/source-acceptance-test
-e .
29 changes: 29 additions & 0 deletions airbyte-integrations/connectors/source-dremio/setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#


from setuptools import find_packages, setup

MAIN_REQUIREMENTS = [
"airbyte-cdk~=0.1",
]

TEST_REQUIREMENTS = [
"pytest~=6.1",
"pytest-mock~=3.6.1",
"source-acceptance-test",
]

setup(
name="source_dremio",
description="Source implementation for Dremio.",
author="Airbyte",
author_email="[email protected]",
packages=find_packages(),
install_requires=MAIN_REQUIREMENTS,
package_data={"": ["*.json", "*.yaml", "schemas/*.json", "schemas/shared/*.json"]},
extras_require={
"tests": TEST_REQUIREMENTS,
},
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#


from .source import SourceDremio

__all__ = ["SourceDremio"]
Loading