forked from airbytehq/airbyte
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🎉 Source e2e test: support custom catalog (airbytehq#9720)
* Add continuous feed mode to source e2e-test * Update connector catalog doc * Fix sonar qube issues * Add cloud variant * Format code * Add testing source connector to seed
- Loading branch information
Showing
35 changed files
with
1,841 additions
and
95 deletions.
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
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
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
3 changes: 3 additions & 0 deletions
3
airbyte-integrations/connectors/source-e2e-test-cloud/.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,3 @@ | ||
| * | ||
| !Dockerfile | ||
| !build |
20 changes: 20 additions & 0 deletions
20
airbyte-integrations/connectors/source-e2e-test-cloud/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,20 @@ | ||
| FROM airbyte/integration-base-java:dev AS build | ||
|
|
||
| WORKDIR /airbyte | ||
|
|
||
| ENV APPLICATION source-e2e-test-cloud | ||
|
|
||
| COPY build/distributions/${APPLICATION}*.tar ${APPLICATION}.tar | ||
|
|
||
| RUN tar xf ${APPLICATION}.tar --strip-components=1 && rm -rf ${APPLICATION}.tar | ||
|
|
||
| FROM airbyte/integration-base-java:dev | ||
|
|
||
| WORKDIR /airbyte | ||
|
|
||
| ENV APPLICATION source-e2e-test-cloud | ||
|
|
||
| COPY --from=build /airbyte /airbyte | ||
|
|
||
| LABEL io.airbyte.version=1.0.0 | ||
| LABEL io.airbyte.name=airbyte/source-e2e-test-cloud |
67 changes: 67 additions & 0 deletions
67
airbyte-integrations/connectors/source-e2e-test-cloud/README.md
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,67 @@ | ||
| # End-to-End Testing Source Cloud Variant | ||
|
|
||
| This is the Cloud variant of the [E2E Test Source](https://docs.airbyte.io/integrations/sources/e2e-test). It only allows the "continuous feed" mode with finite number of record messages. | ||
|
|
||
| ## Local development | ||
|
|
||
| #### Building via Gradle | ||
| From the Airbyte repository root, run: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-e2e-test-cloud:build | ||
| ``` | ||
|
|
||
| #### Create credentials | ||
| No credential is needed for this connector. | ||
|
|
||
| ### Locally running the connector docker image | ||
|
|
||
| #### Build | ||
| Build the connector image via Gradle: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-e2e-test-cloud: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-e2e-test-cloud:dev spec | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-e2e-test-cloud:dev check --config /secrets/config.json | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-e2e-test-cloud:dev discover --config /secrets/config.json | ||
| docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-e2e-test-cloud:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
| ``` | ||
|
|
||
| #### Cloud variant | ||
| The cloud version of this connector only allows the `CONTINUOUS FEED` mode. When this mode is changed, please make sure that the cloud variant is updated and published accordingly as well. | ||
|
|
||
| ## Testing | ||
| We use `JUnit` for Java tests. | ||
|
|
||
| ### Unit and Integration Tests | ||
| Place unit tests under `src/test/io/airbyte/integrations/sources/e2e-test`. | ||
|
|
||
| #### Acceptance Tests | ||
| Airbyte has a standard test suite that all destination connectors must pass. See example(s) in | ||
| `src/test-integration/java/io/airbyte/integrations/sources/e2e-test/`. | ||
|
|
||
| ### Using gradle to run tests | ||
| All commands should be run from airbyte project root. | ||
| To run unit tests: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:sources-e2e-test:unitTest | ||
| ``` | ||
| To run acceptance and custom integration tests: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:sources-e2e-test:integrationTest | ||
| ``` | ||
|
|
||
| ## Dependency Management | ||
|
|
||
| ### 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. | ||
| 2. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)). | ||
| 3. Create a Pull Request. | ||
| 4. Pat yourself on the back for being an awesome contributor. | ||
| 5. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. |
28 changes: 28 additions & 0 deletions
28
airbyte-integrations/connectors/source-e2e-test-cloud/build.gradle
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,28 @@ | ||
| plugins { | ||
| id 'application' | ||
| id 'airbyte-docker' | ||
| id 'airbyte-integration-test-java' | ||
| } | ||
|
|
||
| application { | ||
| mainClass = 'io.airbyte.integrations.source.e2e_test.CloudTestingSources' | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation project(':airbyte-config:models') | ||
| implementation project(':airbyte-protocol:models') | ||
| implementation project(':airbyte-integrations:bases:base-java') | ||
| implementation project(':airbyte-integrations:connectors:source-e2e-test') | ||
| implementation files(project(':airbyte-integrations:bases:base-java').airbyteDocker.outputs) | ||
|
|
||
| testImplementation project(":airbyte-json-validation") | ||
|
|
||
| integrationTestJavaImplementation project(':airbyte-integrations:bases:standard-source-test') | ||
| integrationTestJavaImplementation project(':airbyte-integrations:connectors:source-e2e-test-cloud') | ||
| } | ||
|
|
||
| allprojects { | ||
| repositories { | ||
| maven { url 'https://jitpack.io' } | ||
| } | ||
| } |
Oops, something went wrong.