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: Auth0 [python cdk] #18338

Merged
merged 4 commits into from
Oct 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@
icon: asana.svg
sourceType: api
releaseStage: beta
- name: Auth0
sourceDefinitionId: 6c504e48-14aa-4221-9a72-19cf5ff1ae78
dockerRepository: airbyte/source-auth0
dockerImageTag: 0.1.0
documentationUrl: https://docs.airbyte.com/integrations/sources/auth0
sourceType: api
releaseStage: alpha
- name: Azure Table Storage
sourceDefinitionId: 798ae795-5189-42b6-b64e-3cb91db93338
dockerRepository: airbyte/source-azure-table
Expand Down
83 changes: 83 additions & 0 deletions airbyte-config/init/src/main/resources/seed/source_specs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1333,6 +1333,89 @@
- - "client_secret"
oauthFlowOutputParameters:
- - "refresh_token"
- dockerImage: "airbyte/source-auth0:0.1.0"
spec:
documentationUrl: "https://auth0.com/docs/api/management/v2/"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Auth0 Management API Spec"
type: "object"
required:
- "base_url"
- "credentials"
additionalProperties: true
properties:
base_url:
type: "string"
title: "Base URL"
examples:
- "https://dev-yourOrg.us.auth0.com/"
description: "The Authentication API is served over HTTPS. All URLs referenced\
\ in the documentation have the following base `https://YOUR_DOMAIN`"
credentials:
title: "Authentication Method"
type: "object"
oneOf:
- type: "object"
title: "OAuth2 Confidential Application"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "audience"
properties:
auth_type:
type: "string"
title: "Authentication Method"
const: "oauth2_confidential_application"
order: 0
client_id:
title: "Client ID"
description: "Your application's Client ID. You can find this value\
\ on the <a href=\"https://manage.auth0.com/#/applications\">application's\
\ settings tab</a> after you login the admin portal."
type: "string"
examples:
- "Client_ID"
client_secret:
title: "Client Secret"
description: "Your application's Client Secret. You can find this\
\ value on the <a href=\"https://manage.auth0.com/#/applications\"\
>application's settings tab</a> after you login the admin portal."
type: "string"
examples:
- "Client_Secret"
airbyte_secret: true
audience:
title: "Audience"
description: "The audience for the token, which is your API. You can\
\ find this in the Identifier field on your <a href=\"https://manage.auth0.com/#/apis\"\
>API's settings tab</a>"
type: "string"
examples:
- "https://dev-yourOrg.us.auth0.com/api/v2/"
- type: "object"
title: "OAuth2 Access Token"
required:
- "access_token"
- "auth_type"
properties:
auth_type:
type: "string"
title: "Authentication Method"
const: "oauth2_access_token"
order: 0
access_token:
title: "OAuth2 Access Token"
description: "Also called <a href=\"https://auth0.com/docs/secure/tokens/access-tokens/get-management-api-access-tokens-for-testing\"\
>API Access Token </a> The access token used to call the Auth0 Management\
\ API Token. It's a JWT that contains specific grant permissions\
\ knowns as scopes."
type: "string"
airbyte_secret: true
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-azure-table:0.1.3"
spec:
documentationUrl: "https://docsurl.com"
Expand Down
6 changes: 6 additions & 0 deletions airbyte-integrations/connectors/source-auth0/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*
!Dockerfile
!main.py
!source_auth0
!setup.py
!secrets
38 changes: 38 additions & 0 deletions airbyte-integrations/connectors/source-auth0/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
FROM python:3.9.13-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_auth0 ./source_auth0

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

This is the repository for the Auth0 source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/auth0).

## 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
pip install '.[tests]'
```
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
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-auth0:build
```

#### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/auth0)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_auth0/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_access-token.json` for a sample config file.

**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source auth0 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-auth0:dev
```

You can also build the connector image via Gradle:
```
./gradlew :airbyte-integrations:connectors:source-auth0: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-auth0:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-auth0:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-auth0:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-auth0: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-auth0:unitTest
```
To run acceptance and custom integration tests:
```
./gradlew :airbyte-integrations:connectors:source-auth0: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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
connector_image: airbyte/source-auth0:dev
tests:
spec:
- spec_path: "source_auth0/spec.yaml"
connection:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
- config_path: "secrets/config.json"
basic_read:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
incremental:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
future_state_path: "integration_tests/abnormal_state.json"
full_refresh:
- 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-auth0/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_auth0'
}
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,3 @@
{
"users": { "updated_at": "3021-09-08T07:04:28.000Z" }
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#
# 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."""
yield
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"streams": [
{
"stream": {
"name": "users",
"json_schema": {}
},
"sync_mode": "incremental",
"destination_sync_mode": "overwrite",
"cursor_field": ["updated_at"],
"primary_key": [["user_id"]]
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"streams": [
{
"stream": {
"name": "users",
"json_schema": {},
"supported_sync_modes": ["full_refresh", "incremental"]
},
"sync_mode": "incremental",
"destination_sync_mode": "overwrite",
"cursor_field": ["updated_at"],
"primary_key": [["user_id"]]
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"base_url": "https://dev-kxzbr15d.us.auth0.com/",
"credentials": {
"auth_type": "oauth2_access_token",
"access_token": "Invalid-token"
}
}
Loading