-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add initial template for couchdb connector
- Loading branch information
Showing
21 changed files
with
1,514 additions
and
0 deletions.
There are no files selected for viewing
103 changes: 103 additions & 0 deletions
103
airbyte-integrations/connectors/source-couchdb/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
# Couchdb Source | ||
|
||
This is the repository for the Couchdb configuration based source connector. | ||
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/couchdb). | ||
|
||
## Local development | ||
|
||
### Prerequisites | ||
|
||
* Python (`^3.9`) | ||
* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation) | ||
|
||
|
||
|
||
### Installing the connector | ||
|
||
From this connector directory, run: | ||
```bash | ||
poetry install --with dev | ||
``` | ||
|
||
|
||
### Create credentials | ||
|
||
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/couchdb) | ||
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_couchdb/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 `sample_files/sample_config.json` for a sample config file. | ||
|
||
|
||
### Locally running the connector | ||
|
||
``` | ||
poetry run source-couchdb spec | ||
poetry run source-couchdb check --config secrets/config.json | ||
poetry run source-couchdb discover --config secrets/config.json | ||
poetry run source-couchdb read --config secrets/config.json --catalog sample_files/configured_catalog.json | ||
``` | ||
|
||
### Running tests | ||
|
||
To run tests locally, from the connector directory run: | ||
|
||
``` | ||
poetry run pytest tests | ||
``` | ||
|
||
### Building the docker image | ||
|
||
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) | ||
2. Run the following command to build the docker image: | ||
```bash | ||
airbyte-ci connectors --name=source-couchdb build | ||
``` | ||
|
||
An image will be available on your host with the tag `airbyte/source-couchdb:dev`. | ||
|
||
|
||
### Running as a docker container | ||
|
||
Then run any of the connector commands as follows: | ||
``` | ||
docker run --rm airbyte/source-couchdb:dev spec | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-couchdb:dev check --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-couchdb:dev discover --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-couchdb:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
``` | ||
|
||
### Running our CI test suite | ||
|
||
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md): | ||
```bash | ||
airbyte-ci connectors --name=source-couchdb test | ||
``` | ||
|
||
### Customizing acceptance Tests | ||
|
||
Customize `acceptance-test-config.yml` file to configure acceptance 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. | ||
|
||
### Dependency Management | ||
|
||
All of your dependencies should be managed via Poetry. | ||
To add a new dependency, run: | ||
```bash | ||
poetry add <package-name> | ||
``` | ||
|
||
Please commit the changes to `pyproject.toml` and `poetry.lock` files. | ||
|
||
## 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 our test suite: `airbyte-ci connectors --name=source-couchdb test` | ||
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): | ||
- bump the `dockerImageTag` value in in `metadata.yaml` | ||
- bump the `version` value in `pyproject.toml` | ||
3. Make sure the `metadata.yaml` content is up to date. | ||
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/couchdb.md`). | ||
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention). | ||
6. Pat yourself on the back for being an awesome contributor. | ||
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. | ||
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2025 Airbyte, Inc., all rights reserved. | ||
# |
37 changes: 37 additions & 0 deletions
37
airbyte-integrations/connectors/source-couchdb/acceptance-test-config.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) | ||
# for more information about how to configure these tests | ||
connector_image: airbyte/source-couchdb:dev | ||
acceptance_tests: | ||
spec: | ||
tests: | ||
- spec_path: "source_couchdb/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.jsonl" | ||
# exact_order: no | ||
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: | ||
# future_state_path: "integration_tests/abnormal_state.json" | ||
full_refresh: | ||
tests: | ||
- config_path: "secrets/config.json" | ||
configured_catalog_path: "integration_tests/configured_catalog.json" |
3 changes: 3 additions & 0 deletions
3
airbyte-integrations/connectors/source-couchdb/integration_tests/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2025 Airbyte, Inc., all rights reserved. | ||
# |
5 changes: 5 additions & 0 deletions
5
airbyte-integrations/connectors/source-couchdb/integration_tests/abnormal_state.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"todo-stream-name": { | ||
"todo-field-name": "todo-abnormal-value" | ||
} | ||
} |
17 changes: 17 additions & 0 deletions
17
airbyte-integrations/connectors/source-couchdb/integration_tests/acceptance.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# | ||
# Copyright (c) 2025 Airbyte, Inc., all rights reserved. | ||
# | ||
|
||
|
||
import pytest | ||
|
||
|
||
pytest_plugins = ("connector_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 |
22 changes: 22 additions & 0 deletions
22
airbyte-integrations/connectors/source-couchdb/integration_tests/configured_catalog.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"streams": [ | ||
{ | ||
"stream": { | ||
"name": "customers", | ||
"json_schema": {}, | ||
"supported_sync_modes": ["full_refresh"] | ||
}, | ||
"sync_mode": "full_refresh", | ||
"destination_sync_mode": "overwrite" | ||
}, | ||
{ | ||
"stream": { | ||
"name": "employees", | ||
"json_schema": {}, | ||
"supported_sync_modes": ["full_refresh", "incremental"] | ||
}, | ||
"sync_mode": "incremental", | ||
"destination_sync_mode": "append" | ||
} | ||
] | ||
} |
3 changes: 3 additions & 0 deletions
3
airbyte-integrations/connectors/source-couchdb/integration_tests/invalid_config.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"todo-wrong-field": "this should be an incomplete config file, used in standard tests" | ||
} |
3 changes: 3 additions & 0 deletions
3
airbyte-integrations/connectors/source-couchdb/integration_tests/sample_config.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"fix-me": "TODO" | ||
} |
5 changes: 5 additions & 0 deletions
5
airbyte-integrations/connectors/source-couchdb/integration_tests/sample_state.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"todo-stream-name": { | ||
"todo-field-name": "value" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# | ||
# Copyright (c) 2025 Airbyte, Inc., all rights reserved. | ||
# | ||
|
||
|
||
import sys | ||
|
||
from source_couchdb import SourceCouchdb | ||
|
||
from airbyte_cdk.entrypoint import launch | ||
|
||
|
||
if __name__ == "__main__": | ||
source = SourceCouchdb() | ||
launch(source, sys.argv[1:]) |
35 changes: 35 additions & 0 deletions
35
airbyte-integrations/connectors/source-couchdb/metadata.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
data: | ||
allowedHosts: | ||
hosts: | ||
- TODO # Please change to the hostname of the source. | ||
registries: | ||
oss: | ||
enabled: true | ||
cloud: | ||
enabled: false | ||
remoteRegistries: | ||
pypi: | ||
enabled: true | ||
packageName: airbyte-source-couchdb | ||
connectorBuildOptions: | ||
# Please update to the latest version of the connector base image. | ||
# https://hub.docker.com/r/airbyte/python-connector-base | ||
# Please use the full address with sha256 hash to guarantee build reproducibility. | ||
baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9 | ||
connectorSubtype: api | ||
connectorType: source | ||
definitionId: b80addaf-99f4-494c-b933-82ae0af150ef | ||
dockerImageTag: 0.1.0 | ||
dockerRepository: airbyte/source-couchdb | ||
githubIssueLabel: source-couchdb | ||
icon: couchdb.svg | ||
license: MIT | ||
name: Couchdb | ||
releaseDate: TODO | ||
releaseStage: alpha | ||
supportLevel: community | ||
documentationUrl: https://docs.airbyte.com/integrations/sources/couchdb | ||
tags: | ||
- language:python | ||
- cdk:low-code | ||
metadataSpecVersion: "1.0" |
Oops, something went wrong.