Skip to content

Commit

Permalink
source-unleash: [autopull] base image + poetry + up_to_date (#38378)
Browse files Browse the repository at this point in the history
Co-authored-by: Danylo Jablonski <[email protected]>
Co-authored-by: Augustin <[email protected]>
Co-authored-by: Serhii Lazebnyi <[email protected]>
Co-authored-by: Serhii Lazebnyi <[email protected]>
  • Loading branch information
5 people authored Jun 11, 2024
1 parent ed7953a commit 00e037b
Show file tree
Hide file tree
Showing 10 changed files with 1,119 additions and 128 deletions.
38 changes: 0 additions & 38 deletions airbyte-integrations/connectors/source-unleash/Dockerfile

This file was deleted.

87 changes: 50 additions & 37 deletions airbyte-integrations/connectors/source-unleash/README.md
Original file line number Diff line number Diff line change
@@ -1,78 +1,91 @@
# Unleash Source
# Unleash source connector

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

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

## Local development

#### Create credentials
### Prerequisites
* Python (~=3.9)
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/unleash)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_unleash/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 unleash test creds`
and place them into `secrets/config.json`.
### Installing the connector
From this connector directory, run:
```bash
poetry install --with dev
```

### Locally running the connector docker image

#### Build
### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/unleash)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_unleash/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.

**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**

```bash
airbyte-ci connectors --name=source-unleash build
### Locally running the connector
```
poetry run source-unleash spec
poetry run source-unleash check --config secrets/config.json
poetry run source-unleash discover --config secrets/config.json
poetry run source-unleash read --config secrets/config.json --catalog sample_files/configured_catalog.json
```

An image will be built with the tag `airbyte/source-unleash:dev`.

**Via `docker build`:**
### Running unit tests
To run unit tests locally, from the connector directory run:
```
poetry run pytest unit_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
docker build -t airbyte/source-unleash:dev .
airbyte-ci connectors --name=source-unleash build
```

#### Run
An image will be available on your host with the tag `airbyte/source-unleash:dev`.

Then run any of the connector commands as follows:

### Running as a docker container
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-unleash:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-unleash:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-unleash:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-unleash:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```

## Testing

### 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-unleash test
```

### Customizing acceptance Tests

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.
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 go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
We split dependencies between two groups, dependencies that are:

- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
- required for the testing need to go to `TEST_REQUIREMENTS` list
### Dependency Management
All of your dependencies should be managed via Poetry.
To add a new dependency, run:
```bash
poetry add <package-name>
```

### Publishing a new version of the connector
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-unleash test`
2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).
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 the connector documentation and its changelog is up to date (`docs/integrations/sources/unleash.md`).
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/unleash.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.
7 changes: 4 additions & 3 deletions airbyte-integrations/connectors/source-unleash/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@ data:
connectorSubtype: api
connectorType: source
definitionId: f77914a1-442b-4195-9355-8810a1f4ed3f
dockerImageTag: 0.1.0
dockerImageTag: 0.1.1
dockerRepository: airbyte/source-unleash
githubIssueLabel: source-unleash
icon: unleash.svg
license: MIT
name: Unleash
remoteRegistries:
pypi:
enabled: false
# TODO: Set enabled=true after `airbyte-lib-validate-source` is passing.
enabled: true
packageName: airbyte-source-unleash
registries:
cloud:
Expand All @@ -35,4 +34,6 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
metadataSpecVersion: "1.0"
Loading

0 comments on commit 00e037b

Please sign in to comment.