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

[Non-Forked] ✨Source Retently: Migrate Python CDK to Low-code CDK #29164

Merged
merged 17 commits into from
Aug 8, 2023
Merged
Show file tree
Hide file tree
Changes from 16 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
@@ -1,6 +1,5 @@
*
!Dockerfile
!Dockerfile.test
!main.py
!source_retently
!setup.py
Expand Down
3 changes: 0 additions & 3 deletions airbyte-integrations/connectors/source-retently/.gitignore

This file was deleted.

12 changes: 6 additions & 6 deletions airbyte-integrations/connectors/source-retently/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
FROM python:3.9-slim as base
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
RUN apk --no-cache upgrade \
&& pip install --upgrade pip \
&& apk --no-cache add tzdata build-base


COPY setup.py ./
Expand All @@ -25,7 +25,7 @@ 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
RUN apk --no-cache add bash

# copy payload code only
COPY main.py ./
Expand All @@ -34,5 +34,5 @@ COPY source_retently ./source_retently
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

LABEL io.airbyte.version=0.1.6
LABEL io.airbyte.version=1.0.0
LABEL io.airbyte.name=airbyte/source-retently
65 changes: 8 additions & 57 deletions airbyte-integrations/connectors/source-retently/README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,10 @@
# Retently Source

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

## 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:
```
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
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.

Expand All @@ -38,22 +14,14 @@ To build using Gradle, from the Airbyte repository root, run:
```

#### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/retently)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_retently/spec.json` file.
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/retently)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_retently/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 retently 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
Expand All @@ -78,32 +46,15 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-retently:dev discover
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-retently: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 [Connector Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
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.
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

To run your integration tests with Docker, run:
```
python -m pytest integration_tests -p integration_tests.acceptance
./acceptance-test-docker.sh
```
To run your integration tests with docker

### Using gradle to run tests
All commands should be run from airbyte project root.
Expand Down
3 changes: 3 additions & 0 deletions airbyte-integrations/connectors/source-retently/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,26 @@ connector_image: airbyte/source-retently:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_retently/spec.json"
- spec_path: "source_retently/spec.yaml"
connection:
tests:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "secrets/old_config.json"
status: "succeed"
- config_path: "secrets/config_oauth.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
tests:
- config_path: "secrets/config.json"
backward_compatibility_tests_config:
disable_for_version: "0.1.5"
disable_for_version: "0.1.6"
basic_read:
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams:
- name: reports
- name: templates
incremental:
bypass_reason: "This connector does not implement incremental sync"
full_refresh:
tests:
- config_path: "secrets/config.json"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
#!/usr/bin/env sh

source "$(git rev-parse --show-toplevel)/airbyte-integrations/bases/connector-acceptance-test/acceptance-test-docker.sh"
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"stream": {
"name": "campaigns",
"json_schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"supported_sync_modes": ["full_refresh"]
Expand All @@ -16,7 +16,7 @@
"stream": {
"name": "reports",
"json_schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"supported_sync_modes": ["full_refresh"]
Expand All @@ -28,7 +28,7 @@
"stream": {
"name": "customers",
"json_schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"supported_sync_modes": ["full_refresh"]
Expand All @@ -40,7 +40,7 @@
"stream": {
"name": "nps",
"json_schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"supported_sync_modes": ["full_refresh"]
Expand All @@ -52,7 +52,7 @@
"stream": {
"name": "feedback",
"json_schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"supported_sync_modes": ["full_refresh"]
Expand All @@ -64,7 +64,7 @@
"stream": {
"name": "outbox",
"json_schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"supported_sync_modes": ["full_refresh"]
Expand All @@ -76,7 +76,7 @@
"stream": {
"name": "companies",
"json_schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"supported_sync_modes": ["full_refresh"]
Expand All @@ -88,7 +88,7 @@
"stream": {
"name": "templates",
"json_schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"supported_sync_modes": ["full_refresh"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{
"api_key": "invalid-key"
}
"credentials":{
"api_key":"invalid_api_key"
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{
"api_key": "<API-KEY>"
}
"credentials":{
"api_key":"api_key"
}
}
26 changes: 15 additions & 11 deletions airbyte-integrations/connectors/source-retently/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
data:
allowedHosts:
hosts:
- "*" # Please change to the hostname of the source.
registries:
oss:
enabled: true
cloud:
enabled: true
connectorSubtype: api
connectorType: source
definitionId: db04ecd1-42e7-4115-9cec-95812905c626
dockerImageTag: 0.1.6
dockerImageTag: 1.0.0
dockerRepository: airbyte/source-retently
githubIssueLabel: source-retently
icon: retently.svg
license: MIT
name: Retently
registries:
cloud:
enabled: true
oss:
enabled: true
releaseStage: alpha
documentationUrl: https://docs.airbyte.com/integrations/sources/retently
tags:
- language:python
ab_internal:
sl: 100
ql: 200
supportLevel: community
- language:low-code
releases:
breakingChanges:
1.0.0:
message: "Version 1.0.0 was released with the low code version"
upgradeDeadline: "2023-08-31"
metadataSpecVersion: "1.0"

This file was deleted.

Loading