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

🎉 Migrate Confluence Source Connector to Low Code #29125

Merged
merged 20 commits into from
Aug 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
e587bc4
migrate confluence to low code
topefolorunso Aug 5, 2023
629093e
Merge branch 'master' of https://github.com/topefolorunso/airbyte int…
topefolorunso Aug 14, 2023
c24be6c
fix metadata and spec
topefolorunso Aug 14, 2023
0e824ad
set uniform page size
topefolorunso Aug 14, 2023
80f3020
Merge branch 'master' into confluence-low-code
sajarin Aug 14, 2023
0796054
fix:(docs): add changelog entry for low-code migration
sajarin Aug 14, 2023
47bd1cf
Merge branch 'master' of https://github.com/topefolorunso/airbyte int…
topefolorunso Aug 14, 2023
e298d7a
Merge branch 'master' of https://github.com/topefolorunso/airbyte int…
topefolorunso Aug 14, 2023
6adcec3
set schema additional properties to true
topefolorunso Aug 14, 2023
45a3aae
Merge branch 'confluence-low-code' of https://github.com/topefoloruns…
topefolorunso Aug 14, 2023
f803585
fix manifest validation errors
topefolorunso Aug 14, 2023
f6b1600
Merge branch 'master' of https://github.com/topefolorunso/airbyte int…
topefolorunso Aug 14, 2023
4a39c8d
Merge branch 'master' into confluence-low-code
sajarin Aug 15, 2023
ef111bf
Merge branch 'master' of https://github.com/topefolorunso/airbyte int…
topefolorunso Aug 16, 2023
0037f02
fix audit stream schema and pk
topefolorunso Aug 16, 2023
5f53b3d
Merge branch 'confluence-low-code' of https://github.com/topefoloruns…
topefolorunso Aug 16, 2023
6e471dc
Merge branch 'master' into confluence-low-code
sajarin Aug 17, 2023
f1750f5
Merge branch 'master' into confluence-low-code
sajarin Aug 17, 2023
b1a1527
fix(spec): correct primary ids in manifest and configured_catalog.json
sajarin Aug 18, 2023
d2a72d8
fix: update expected records
sajarin Aug 18, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
*
!Dockerfile
!Dockerfile.test
!main.py
!source_confluence
!setup.py
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ COPY source_confluence ./source_confluence
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

LABEL io.airbyte.version=0.1.3
LABEL io.airbyte.version=0.2.0
LABEL io.airbyte.name=airbyte/source-confluence
66 changes: 8 additions & 58 deletions airbyte-integrations/connectors/source-confluence/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,10 @@
# Confluence Source

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.io/integrations/sources/confluence).
This is the repository for the Confluence configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/confluence).

## 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
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.

Expand All @@ -39,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/confluence)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_confluence/spec.json` file.
**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 `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 confluence 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 @@ -79,32 +46,15 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-confluence:dev discove
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
```
## 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-confluence/__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,7 +4,7 @@ connector_image: airbyte/source-confluence:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_confluence/spec.json"
- spec_path: "source_confluence/spec.yaml"
connection:
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
@@ -1,3 +1,3 @@
#
# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"name": "audit",
"json_schema": {},
"supported_sync_modes": ["full_refresh"],
"source_defined_primary_key": [["author"]]
"source_defined_primary_key": [["creationDate"]]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
Expand Down