-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Initial commit * Add streams * Simplify using options in request_parameters * Address comments * Add examples to query * Add docs * Change authenticator to ApiKeyAuthenticator * add seed config * remove icon * auto-bump connector version Co-authored-by: marcosmarxm <[email protected]> Co-authored-by: Octavia Squidington III <[email protected]>
- Loading branch information
3 people
authored
Oct 27, 2022
1 parent
05b7399
commit 84c7ff9
Showing
27 changed files
with
895 additions
and
1 deletion.
There are no files selected for viewing
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
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
6 changes: 6 additions & 0 deletions
6
airbyte-integrations/connectors/source-news-api/.dockerignore
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,6 @@ | ||
| * | ||
| !Dockerfile | ||
| !main.py | ||
| !source_news_api | ||
| !setup.py | ||
| !secrets |
38 changes: 38 additions & 0 deletions
38
airbyte-integrations/connectors/source-news-api/Dockerfile
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,38 @@ | ||
| FROM python:3.9.11-alpine3.15 as base | ||
|
|
||
| # build and load all requirements | ||
| FROM base as builder | ||
| WORKDIR /airbyte/integration_code | ||
|
|
||
| # upgrade pip to the latest version | ||
| RUN apk --no-cache upgrade \ | ||
| && pip install --upgrade pip \ | ||
| && apk --no-cache add tzdata build-base | ||
|
|
||
|
|
||
| COPY setup.py ./ | ||
| # install necessary packages to a temporary folder | ||
| RUN pip install --prefix=/install . | ||
|
|
||
| # build a clean environment | ||
| FROM base | ||
| WORKDIR /airbyte/integration_code | ||
|
|
||
| # copy all loaded and built libraries to a pure basic image | ||
| COPY --from=builder /install /usr/local | ||
| # add default timezone settings | ||
| COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime | ||
| RUN echo "Etc/UTC" > /etc/timezone | ||
|
|
||
| # bash is installed for more convenient debugging. | ||
| RUN apk --no-cache add bash | ||
|
|
||
| # copy payload code only | ||
| COPY main.py ./ | ||
| COPY source_news_api ./source_news_api | ||
|
|
||
| ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py" | ||
| ENTRYPOINT ["python", "/airbyte/integration_code/main.py"] | ||
|
|
||
| LABEL io.airbyte.version=0.1.0 | ||
| LABEL io.airbyte.name=airbyte/source-news-api |
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,79 @@ | ||
| # News Api Source | ||
|
|
||
| This is the repository for the News Api configuration based source connector. | ||
| For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/news-api). | ||
|
|
||
| ## Local development | ||
|
|
||
| #### Building via Gradle | ||
| You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow. | ||
|
|
||
| To build using Gradle, from the Airbyte repository root, run: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-news-api:build | ||
| ``` | ||
|
|
||
| #### Create credentials | ||
| **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/news-api) | ||
| to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_news_api/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 news-api test creds` | ||
| and place them into `secrets/config.json`. | ||
|
|
||
| ### Locally running the connector docker image | ||
|
|
||
| #### Build | ||
| First, make sure you build the latest Docker image: | ||
| ``` | ||
| docker build . -t airbyte/source-news-api:dev | ||
| ``` | ||
|
|
||
| You can also build the connector image via Gradle: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-news-api:airbyteDocker | ||
| ``` | ||
| When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in | ||
| the Dockerfile. | ||
|
|
||
| #### Run | ||
| Then run any of the connector commands as follows: | ||
| ``` | ||
| docker run --rm airbyte/source-news-api:dev spec | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-news-api:dev check --config /secrets/config.json | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-news-api:dev discover --config /secrets/config.json | ||
| docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-news-api:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
| ``` | ||
| ## Testing | ||
|
|
||
| #### Acceptance Tests | ||
| Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-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 docker | ||
|
|
||
| ### Using gradle to run tests | ||
| All commands should be run from airbyte project root. | ||
| To run unit tests: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-news-api:unitTest | ||
| ``` | ||
| To run acceptance and custom integration tests: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-news-api:integrationTest | ||
| ``` | ||
|
|
||
| ## 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 | ||
|
|
||
| ### 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 unit and integration tests. | ||
| 1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)). | ||
| 1. Create a Pull Request. | ||
| 1. Pat yourself on the back for being an awesome contributor. | ||
| 1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. |
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) 2022 Airbyte, Inc., all rights reserved. | ||
| # |
20 changes: 20 additions & 0 deletions
20
airbyte-integrations/connectors/source-news-api/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,20 @@ | ||
| # See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference) | ||
| # for more information about how to configure these tests | ||
| connector_image: airbyte/source-news-api:dev | ||
| tests: | ||
| spec: | ||
| - spec_path: "source_news_api/spec.yaml" | ||
| connection: | ||
| - config_path: "secrets/config.json" | ||
| status: "succeed" | ||
| - config_path: "integration_tests/invalid_config.json" | ||
| status: "failed" | ||
| discovery: | ||
| - config_path: "secrets/config.json" | ||
| basic_read: | ||
| - config_path: "secrets/config.json" | ||
| configured_catalog_path: "integration_tests/configured_catalog.json" | ||
| empty_streams: [] | ||
| full_refresh: | ||
| - config_path: "secrets/config.json" | ||
| configured_catalog_path: "integration_tests/configured_catalog.json" |
16 changes: 16 additions & 0 deletions
16
airbyte-integrations/connectors/source-news-api/acceptance-test-docker.sh
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,16 @@ | ||
| #!/usr/bin/env sh | ||
|
|
||
| # Build latest connector image | ||
| docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2-) | ||
|
|
||
| # Pull latest acctest image | ||
| docker pull airbyte/source-acceptance-test:latest | ||
|
|
||
| # Run | ||
| docker run --rm -it \ | ||
| -v /var/run/docker.sock:/var/run/docker.sock \ | ||
| -v /tmp:/tmp \ | ||
| -v $(pwd):/test_input \ | ||
| airbyte/source-acceptance-test \ | ||
| --acceptance-test-config /test_input | ||
|
|
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,9 @@ | ||
| plugins { | ||
| id 'airbyte-python' | ||
| id 'airbyte-docker' | ||
| id 'airbyte-source-acceptance-test' | ||
| } | ||
|
|
||
| airbytePython { | ||
| moduleDirectory 'source_news_api' | ||
| } |
3 changes: 3 additions & 0 deletions
3
airbyte-integrations/connectors/source-news-api/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) 2022 Airbyte, Inc., all rights reserved. | ||
| # |
5 changes: 5 additions & 0 deletions
5
airbyte-integrations/connectors/source-news-api/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" | ||
| } | ||
| } |
Oops, something went wrong.