Skip to content

Commit

Permalink
Source twilio-taskrouter: Migrate to manifest-only (#44776)
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristoGrab authored Aug 27, 2024
1 parent bb28fe0 commit 0f6466d
Show file tree
Hide file tree
Showing 12 changed files with 42 additions and 1,205 deletions.
89 changes: 25 additions & 64 deletions airbyte-integrations/connectors/source-twilio-taskrouter/README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,22 @@
# Twilio-Taskrouter source connector
# Twilio Taskrouter source connector

This is the repository for the Twilio-Taskrouter source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/twilio-taskrouter).
This directory contains the manifest-only connector for `source-twilio-taskrouter`.
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.

## 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
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/twilio-taskrouter).

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/twilio-taskrouter)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_twilio_taskrouter/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-twilio-taskrouter spec
poetry run source-twilio-taskrouter check --config secrets/config.json
poetry run source-twilio-taskrouter discover --config secrets/config.json
poetry run source-twilio-taskrouter read --config secrets/config.json --catalog sample_files/configured_catalog.json
```
## Local development

### Running unit tests
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!

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:

Expand All @@ -53,50 +26,38 @@ airbyte-ci connectors --name=source-twilio-taskrouter build

An image will be available on your host with the tag `airbyte/source-twilio-taskrouter:dev`.

### Creating credentials

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/twilio-taskrouter)
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-twilio-taskrouter:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-twilio-taskrouter:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-twilio-taskrouter:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-twilio-taskrouter: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):

```bash
airbyte-ci connectors --name=source-twilio-taskrouter 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-twilio-taskrouter 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-twilio-taskrouter`, 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-twilio-taskrouter 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/twilio-taskrouter.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.
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
connector_image: airbyte/source-twilio-taskrouter:dev
tests:
spec:
- spec_path: "source_twilio_taskrouter/spec.yaml"
- spec_path: "manifest.yaml"
connection:
- config_path: "secrets/config.json"
status: "succeed"
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 0.79.1
version: 4.5.4

type: DeclarativeSource

Expand Down Expand Up @@ -72,13 +72,13 @@ definitions:
page_size: 50
cursor_value: "{{response['meta']['next_page_url']}}"
partition_router:
- type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
parent_key: sid
partition_field: id
stream:
$ref: "#/definitions/streams/workspaces"
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
parent_key: sid
partition_field: id
stream:
$ref: "#/definitions/streams/workspaces"
schema_loader:
type: InlineSchemaLoader
schema:
Expand All @@ -88,8 +88,8 @@ definitions:
url_base: https://taskrouter.twilio.com
authenticator:
type: BasicHttpAuthenticator
username: "{{ config['account_sid'] }}"
password: "{{ config['auth_token'] }}"
username: '{{ config["account_sid"] }}'
password: '{{ config["auth_token"] }}'

streams:
- $ref: "#/definitions/streams/workspaces"
Expand All @@ -106,8 +106,8 @@ spec:
properties:
account_sid:
type: string
title: Account SID
description: Twilio Account ID
title: Account SID
airbyte_secret: true
order: 0
auth_token:
Expand All @@ -118,11 +118,6 @@ spec:
order: 1
additionalProperties: true

metadata:
autoImportSchema:
workspaces: false
workers: false

schemas:
workspaces:
type: object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ data:
ql: 100
sl: 100
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
baseImage: docker.io/airbyte/source-declarative-manifest:4.5.4@sha256:b07a521add11f987c63c0db68c1b57e90bec0c985f1cb6f3c5a1940cde628a70
connectorSubtype: api
connectorType: source
definitionId: 2446953b-b794-429b-a9b3-c821ba992a48
dockerImageTag: 0.1.17
dockerImageTag: 0.2.0
dockerRepository: airbyte/source-twilio-taskrouter
documentationUrl: https://docs.airbyte.com/integrations/sources/twilio-taskrouter
githubIssueLabel: source-twilio-taskrouter
Expand All @@ -22,12 +22,12 @@ data:
releaseStage: alpha
remoteRegistries:
pypi:
enabled: true
enabled: false
packageName: airbyte-source-twilio-taskrouter
supportLevel: community
tags:
- language:python
- cdk:low-code
- language:manifest-only
connectorTestSuitesOptions:
- suite: liveTests
testConnections:
Expand Down
Loading

0 comments on commit 0f6466d

Please sign in to comment.