Source confluence: Migrate to manifest-only (#44162)
This commit is contained in:
Christo Grabowski
committed by
GitHub
GitHub
parent
e507a5e22f
commit
caa4977a49
@@ -1,49 +1,22 @@
|
||||
# Confluence source connector
|
||||
|
||||
This is the repository for the Confluence source connector, written in Python.
|
||||
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/confluence).
|
||||
This directory contains the manifest-only connector for `source-confluence`.
|
||||
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
|
||||
|
||||
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/confluence).
|
||||
|
||||
## Local development
|
||||
|
||||
### Prerequisites
|
||||
We recommend using the Connector Builder to edit this connector.
|
||||
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
|
||||
Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector!
|
||||
|
||||
- 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/confluence)
|
||||
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_confluence/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-confluence spec
|
||||
poetry run source-confluence check --config secrets/config.json
|
||||
poetry run source-confluence discover --config secrets/config.json
|
||||
poetry run source-confluence read --config secrets/config.json --catalog sample_files/configured_catalog.json
|
||||
```
|
||||
|
||||
### Running unit tests
|
||||
|
||||
To run unit tests locally, from the connector directory run:
|
||||
|
||||
```
|
||||
poetry run pytest unit_tests
|
||||
```
|
||||
If you prefer to develop locally, you can follow the instructions below.
|
||||
|
||||
### Building the docker image
|
||||
|
||||
You can build any manifest-only connector with `airbyte-ci`:
|
||||
|
||||
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:
|
||||
|
||||
@@ -53,18 +26,24 @@ airbyte-ci connectors --name=source-confluence build
|
||||
|
||||
An image will be available on your host with the tag `airbyte/source-confluence:dev`.
|
||||
|
||||
### Creating credentials
|
||||
|
||||
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/confluence)
|
||||
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.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.
|
||||
|
||||
### Running as a docker container
|
||||
|
||||
Then run any of the connector commands as follows:
|
||||
Then run any of the standard source connector commands:
|
||||
|
||||
```
|
||||
```bash
|
||||
docker run --rm airbyte/source-confluence:dev spec
|
||||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-confluence:dev check --config /secrets/config.json
|
||||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-confluence:dev discover --config /secrets/config.json
|
||||
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-confluence:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
|
||||
```
|
||||
|
||||
### Running our CI test suite
|
||||
### Running the 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):
|
||||
|
||||
@@ -72,33 +51,15 @@ You can run our full test suite locally using [`airbyte-ci`](https://github.com/
|
||||
airbyte-ci connectors --name=source-confluence 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-confluence 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.
|
||||
If you want to contribute changes to `source-confluence`, here's how you can do that:
|
||||
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
|
||||
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-confluence test`
|
||||
3. 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`
|
||||
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/confluence.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.
|
||||
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
|
||||
@@ -1,3 +0,0 @@
|
||||
#
|
||||
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
|
||||
#
|
||||
@@ -5,7 +5,7 @@ test_strictness_level: low
|
||||
acceptance_tests:
|
||||
spec:
|
||||
tests:
|
||||
- spec_path: "source_confluence/spec.yaml"
|
||||
- spec_path: "manifest.yaml"
|
||||
connection:
|
||||
tests:
|
||||
- config_path: "secrets/config.json"
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
#
|
||||
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
|
||||
#
|
||||
|
||||
from source_confluence.run import run
|
||||
|
||||
if __name__ == "__main__":
|
||||
run()
|
||||
2853
airbyte-integrations/connectors/source-confluence/manifest.yaml
Normal file
2853
airbyte-integrations/connectors/source-confluence/manifest.yaml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -6,11 +6,11 @@ data:
|
||||
hosts:
|
||||
- ${subdomain}.atlassian.net
|
||||
connectorBuildOptions:
|
||||
baseImage: docker.io/airbyte/python-connector-base:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
|
||||
baseImage: docker.io/airbyte/source-declarative-manifest:4.4.1@sha256:a8c0f0d32782957beef2c65bac98756b04fff2f3ffc4568a6676d3c83a422a5b
|
||||
connectorSubtype: api
|
||||
connectorType: source
|
||||
definitionId: cf40a7f8-71f8-45ce-a7fa-fca053e4028c
|
||||
dockerImageTag: 0.2.16
|
||||
dockerImageTag: 0.3.0
|
||||
dockerRepository: airbyte/source-confluence
|
||||
documentationUrl: https://docs.airbyte.com/integrations/sources/confluence
|
||||
githubIssueLabel: source-confluence
|
||||
@@ -26,12 +26,12 @@ data:
|
||||
releaseStage: beta
|
||||
remoteRegistries:
|
||||
pypi:
|
||||
enabled: true
|
||||
enabled: false
|
||||
packageName: airbyte-source-confluence
|
||||
supportLevel: community
|
||||
tags:
|
||||
- language:python
|
||||
- cdk:low-code
|
||||
- language:manifest-only
|
||||
connectorTestSuitesOptions:
|
||||
- suite: liveTests
|
||||
testConnections:
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,29 +0,0 @@
|
||||
[build-system]
|
||||
requires = [ "poetry-core>=1.0.0",]
|
||||
build-backend = "poetry.core.masonry.api"
|
||||
|
||||
[tool.poetry]
|
||||
version = "0.2.16"
|
||||
name = "source-confluence"
|
||||
description = "Source implementation for Confluence."
|
||||
authors = [ "Airbyte <contact@airbyte.io>",]
|
||||
license = "MIT"
|
||||
readme = "README.md"
|
||||
documentation = "https://docs.airbyte.com/integrations/sources/confluence"
|
||||
homepage = "https://airbyte.com"
|
||||
repository = "https://github.com/airbytehq/airbyte"
|
||||
[[tool.poetry.packages]]
|
||||
include = "source_confluence"
|
||||
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.9,<3.12"
|
||||
airbyte-cdk = "0.80.0"
|
||||
|
||||
[tool.poetry.scripts]
|
||||
source-confluence = "source_confluence.run:run"
|
||||
|
||||
[tool.poetry.group.dev.dependencies]
|
||||
requests-mock = "^1.9.3"
|
||||
pytest-mock = "^3.6.1"
|
||||
pytest = "^6.1"
|
||||
responses = "^0.13.3"
|
||||
@@ -1,8 +0,0 @@
|
||||
#
|
||||
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
|
||||
#
|
||||
|
||||
|
||||
from .source import SourceConfluence
|
||||
|
||||
__all__ = ["SourceConfluence"]
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,14 +0,0 @@
|
||||
#
|
||||
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
|
||||
#
|
||||
|
||||
|
||||
import sys
|
||||
|
||||
from airbyte_cdk.entrypoint import launch
|
||||
from source_confluence import SourceConfluence
|
||||
|
||||
|
||||
def run():
|
||||
source = SourceConfluence()
|
||||
launch(source, sys.argv[1:])
|
||||
@@ -1,18 +0,0 @@
|
||||
#
|
||||
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
|
||||
#
|
||||
|
||||
from airbyte_cdk.sources.declarative.yaml_declarative_source import YamlDeclarativeSource
|
||||
|
||||
"""
|
||||
This file provides the necessary constructs to interpret a provided declarative YAML configuration file into
|
||||
source connector.
|
||||
|
||||
WARNING: Do not modify this file.
|
||||
"""
|
||||
|
||||
|
||||
# Declarative Source
|
||||
class SourceConfluence(YamlDeclarativeSource):
|
||||
def __init__(self):
|
||||
super().__init__(**{"path_to_yaml": "manifest.yaml"})
|
||||
Reference in New Issue
Block a user