Skip to content

Commit d59275d

Browse files
leilaballouardVincent Kocvincentkococtavia-squidington-iii
authored
🎉 New Source: Qonto [python cdk] (#17452)
* Creation of the new Qonto source connector * Update setup.py * Support production and mocked server endpoints * finalise mocked api calls * Update source_definitions.yaml * lint * auto-bump connector version Co-authored-by: Vincent Koc <[email protected]> Co-authored-by: Vincent Koc <[email protected]> Co-authored-by: Vincent Koc <[email protected]> Co-authored-by: Octavia Squidington III <[email protected]>
1 parent d5b66e9 commit d59275d

29 files changed

+1218
-0
lines changed

‎airbyte-config/init/src/main/resources/seed/source_definitions.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1198,6 +1198,13 @@
11981198
documentationUrl: https://docs.airbyte.com/integrations/sources/pypi
11991199
sourceType: api
12001200
releaseStage: alpha
1201+
- name: Qonto
1202+
sourceDefinitionId: f7c0b910-5f66-11ed-9b6a-0242ac120002
1203+
dockerRepository: airbyte/source-qonto
1204+
dockerImageTag: 0.1.0
1205+
documentationUrl: https://docs.airbyte.com/integrations/sources/public-qonto
1206+
sourceType: api
1207+
releaseStage: alpha
12011208
- name: Qualaroo
12021209
sourceDefinitionId: b08e4776-d1de-4e80-ab5c-1e51dad934a2
12031210
dockerRepository: airbyte/source-qualaroo

‎airbyte-config/init/src/main/resources/seed/source_specs.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11326,6 +11326,51 @@
1132611326
supportsNormalization: false
1132711327
supportsDBT: false
1132811328
supported_destination_sync_modes: []
11329+
- dockerImage: "airbyte/source-qonto:0.1.0"
11330+
spec:
11331+
documentationUrl: "https://docsurl.com"
11332+
connectionSpecification:
11333+
$schema: "http://json-schema.org/draft-07/schema#"
11334+
title: "Qonto Spec"
11335+
type: "object"
11336+
required:
11337+
- "endpoint"
11338+
- "organization_slug"
11339+
- "secret_key"
11340+
- "iban"
11341+
properties:
11342+
endpoint:
11343+
title: "Endpoint"
11344+
type: "string"
11345+
description: "Please choose the right endpoint to use in this connection"
11346+
enum:
11347+
- "Production"
11348+
- "Test Mocked API Server"
11349+
organization_slug:
11350+
title: "Organization slug"
11351+
type: "string"
11352+
description: "Organization slug used in Qonto"
11353+
secret_key:
11354+
title: "Secret Key"
11355+
type: "string"
11356+
description: "Secret key of the Qonto account"
11357+
airbyte_secret: true
11358+
iban:
11359+
title: "IBAN"
11360+
type: "string"
11361+
description: "International Bank Account Number linked used with your Qonto\
11362+
\ Account"
11363+
pattern: "^[A-Z0-9]*$"
11364+
start_date:
11365+
title: "Start date"
11366+
type: "string"
11367+
description: "Start getting data from that date."
11368+
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
11369+
examples:
11370+
- "YYYY-MM-DD"
11371+
supportsNormalization: false
11372+
supportsDBT: false
11373+
supported_destination_sync_modes: []
1132911374
- dockerImage: "airbyte/source-qualaroo:0.1.2"
1133011375
spec:
1133111376
documentationUrl: "https://docs.airbyte.com/integrations/sources/qualaroo"

‎airbyte-integrations/connectors/source-qonto/.dockerignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*
2+
!Dockerfile
3+
!main.py
4+
!source_qonto
5+
!setup.py
6+
!secrets

‎airbyte-integrations/connectors/source-qonto/Dockerfile

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
FROM python:3.9.13-alpine3.15 as base
2+
3+
# build and load all requirements
4+
FROM base as builder
5+
WORKDIR /airbyte/integration_code
6+
7+
# upgrade pip to the latest version
8+
RUN apk --no-cache upgrade \
9+
&& pip install --upgrade pip \
10+
&& apk --no-cache add tzdata build-base
11+
12+
13+
COPY setup.py ./
14+
# install necessary packages to a temporary folder
15+
RUN pip install --prefix=/install .
16+
17+
# build a clean environment
18+
FROM base
19+
WORKDIR /airbyte/integration_code
20+
21+
# copy all loaded and built libraries to a pure basic image
22+
COPY --from=builder /install /usr/local
23+
# add default timezone settings
24+
COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime
25+
RUN echo "Etc/UTC" > /etc/timezone
26+
27+
# bash is installed for more convenient debugging.
28+
RUN apk --no-cache add bash
29+
30+
# copy payload code only
31+
COPY main.py ./
32+
COPY source_qonto ./source_qonto
33+
34+
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
35+
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
36+
37+
LABEL io.airbyte.version=0.1.0
38+
LABEL io.airbyte.name=airbyte/source-qonto

‎airbyte-integrations/connectors/source-qonto/README.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Qonto Source
2+
3+
This is the repository for the Qonto source connector, written in Python.
4+
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/qonto).
5+
6+
## Local development
7+
8+
### Prerequisites
9+
**To iterate on this connector, make sure to complete this prerequisites section.**
10+
11+
#### Minimum Python version required `= 3.9.0`
12+
13+
#### Build & Activate Virtual Environment and install dependencies
14+
From this connector directory, create a virtual environment:
15+
```
16+
python -m venv .venv
17+
```
18+
19+
This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
20+
development environment of choice. To activate it from the terminal, run:
21+
```
22+
source .venv/bin/activate
23+
pip install -r requirements.txt
24+
pip install '.[tests]'
25+
```
26+
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
27+
28+
Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
29+
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
30+
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
31+
should work as you expect.
32+
33+
#### Building via Gradle
34+
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.
35+
36+
To build using Gradle, from the Airbyte repository root, run:
37+
```
38+
./gradlew :airbyte-integrations:connectors:source-qonto:build
39+
```
40+
41+
#### Create credentials
42+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/qonto)
43+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_qonto/spec.yaml` file.
44+
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
45+
See `integration_tests/sample_config.json` for a sample config file.
46+
47+
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source qonto test creds`
48+
and place them into `secrets/config.json`.
49+
50+
### Locally running the connector
51+
```
52+
python main.py spec
53+
python main.py check --config secrets/config.json
54+
python main.py discover --config secrets/config.json
55+
python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
56+
```
57+
58+
### Locally running the connector docker image
59+
60+
#### Build
61+
First, make sure you build the latest Docker image:
62+
```
63+
docker build . -t airbyte/source-qonto:dev
64+
```
65+
66+
You can also build the connector image via Gradle:
67+
```
68+
./gradlew :airbyte-integrations:connectors:source-qonto:airbyteDocker
69+
```
70+
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
71+
the Dockerfile.
72+
73+
#### Run
74+
Then run any of the connector commands as follows:
75+
```
76+
docker run --rm airbyte/source-qonto:dev spec
77+
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-qonto:dev check --config /secrets/config.json
78+
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-qonto:dev discover --config /secrets/config.json
79+
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-qonto:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
80+
```
81+
## Testing
82+
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.
83+
First install test dependencies into your virtual environment:
84+
```
85+
pip install .[tests]
86+
```
87+
### Unit Tests
88+
To run unit tests locally, from the connector directory run:
89+
```
90+
python -m pytest unit_tests
91+
```
92+
93+
### Integration Tests
94+
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).
95+
#### Custom Integration tests
96+
Place custom tests inside `integration_tests/` folder, then, from the connector root, run
97+
```
98+
python -m pytest integration_tests
99+
```
100+
#### Acceptance Tests
101+
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.
102+
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.
103+
To run your integration tests with acceptance tests, from the connector root, run
104+
```
105+
python -m pytest integration_tests -p integration_tests.acceptance
106+
```
107+
To run your integration tests with docker
108+
109+
### Using gradle to run tests
110+
All commands should be run from airbyte project root.
111+
To run unit tests:
112+
```
113+
./gradlew :airbyte-integrations:connectors:source-qonto:unitTest
114+
```
115+
To run acceptance and custom integration tests:
116+
```
117+
./gradlew :airbyte-integrations:connectors:source-qonto:integrationTest
118+
```
119+
120+
## Dependency Management
121+
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.
122+
We split dependencies between two groups, dependencies that are:
123+
* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
124+
* required for the testing need to go to `TEST_REQUIREMENTS` list
125+
126+
### Publishing a new version of the connector
127+
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
128+
1. Make sure your changes are passing unit and integration tests.
129+
1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
130+
1. Create a Pull Request.
131+
1. Pat yourself on the back for being an awesome contributor.
132+
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.

‎airbyte-integrations/connectors/source-qonto/acceptance-test-config.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference)
2+
# for more information about how to configure these tests
3+
connector_image: airbyte/source-qonto:dev
4+
tests:
5+
spec:
6+
- spec_path: "source_qonto/spec.yaml"
7+
connection:
8+
- config_path: "secrets/config.json"
9+
status: "succeed"
10+
- config_path: "integration_tests/invalid_config.json"
11+
status: "failed"
12+
discovery:
13+
- config_path: "secrets/config.json"
14+
basic_read:
15+
- config_path: "secrets/config.json"
16+
configured_catalog_path: "integration_tests/configured_catalog.json"
17+
empty_streams: []
18+
full_refresh:
19+
- config_path: "secrets/config.json"
20+
configured_catalog_path: "integration_tests/configured_catalog.json"

‎airbyte-integrations/connectors/source-qonto/acceptance-test-docker.sh

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#!/usr/bin/env sh
2+
3+
# Build latest connector image
4+
docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2-)
5+
6+
# Pull latest acctest image
7+
docker pull airbyte/source-acceptance-test:latest
8+
9+
# Run
10+
docker run --rm -it \
11+
-v /var/run/docker.sock:/var/run/docker.sock \
12+
-v /tmp:/tmp \
13+
-v $(pwd):/test_input \
14+
airbyte/source-acceptance-test \
15+
--acceptance-test-config /test_input
16+

‎airbyte-integrations/connectors/source-qonto/build.gradle

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
plugins {
2+
id 'airbyte-python'
3+
id 'airbyte-docker'
4+
id 'airbyte-source-acceptance-test'
5+
}
6+
7+
airbytePython {
8+
moduleDirectory 'source_qonto'
9+
}

‎airbyte-integrations/connectors/source-qonto/integration_tests/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#
2+
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
3+
#

‎airbyte-integrations/connectors/source-qonto/integration_tests/acceptance.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#
2+
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
3+
#
4+
5+
6+
import pytest
7+
8+
pytest_plugins = ("source_acceptance_test.plugin",)
9+
10+
11+
@pytest.fixture(scope="session", autouse=True)
12+
def connector_setup():
13+
"""This fixture is a placeholder for external resources that acceptance test might require."""
14+
yield

‎airbyte-integrations/connectors/source-qonto/integration_tests/configured_catalog.json

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"streams": [
3+
{
4+
"stream": {
5+
"name": "memberships",
6+
"json_schema": {},
7+
"supported_sync_modes": [
8+
"full_refresh"
9+
]
10+
},
11+
"sync_mode": "full_refresh",
12+
"destination_sync_mode": "overwrite"
13+
},
14+
{
15+
"stream": {
16+
"name": "labels",
17+
"json_schema": {},
18+
"supported_sync_modes": [
19+
"full_refresh"
20+
]
21+
},
22+
"sync_mode": "full_refresh",
23+
"destination_sync_mode": "overwrite"
24+
},
25+
{
26+
"stream": {
27+
"name": "transactions",
28+
"json_schema": {},
29+
"supported_sync_modes": [
30+
"full_refresh"
31+
]
32+
},
33+
"sync_mode": "full_refresh",
34+
"destination_sync_mode": "overwrite"
35+
}
36+
]
37+
}

‎airbyte-integrations/connectors/source-qonto/integration_tests/invalid_config.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"endpoint" : "fake-endpoint",
3+
"iban": "fake_iban",
4+
"organization_slug": "fake_organization",
5+
"secret_key": "fake_secret",
6+
"start_date": "9999-99-99"
7+
}

‎airbyte-integrations/connectors/source-qonto/integration_tests/sample_config.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"endpoint" : "Test Mocked API Server",
3+
"iban": "REPLACEME",
4+
"organization_slug": "REPLACEME",
5+
"secret_key": "REPLACEME",
6+
"start_date": "2022-11-04"
7+
}

‎airbyte-integrations/connectors/source-qonto/main.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#
2+
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
3+
#
4+
5+
6+
import sys
7+
8+
from airbyte_cdk.entrypoint import launch
9+
from source_qonto import SourceQonto
10+
11+
if __name__ == "__main__":
12+
source = SourceQonto()
13+
launch(source, sys.argv[1:])

‎airbyte-integrations/connectors/source-qonto/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
-e ../../bases/source-acceptance-test
2+
-e .

0 commit comments

Comments
 (0)