Co-authored-by: edgao <5741425+edgao@users.noreply.github.com> Co-authored-by: octavia-bot[bot] <108746235+octavia-bot[bot]@users.noreply.github.com> Co-authored-by: Subodh Kant Chaturvedi <subodh1810@gmail.com>
Dev Null Testing Destination
This is the repository for the Null destination connector in Java. For information about how to use this connector within Airbyte, see the User Documentation.
Local development
Building via Gradle
From the Airbyte repository root, run:
./gradlew :airbyte-integrations:connectors:destination-dev-null: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:destination-dev-null:buildConnectorImage
Once built, the docker image name and tag on your host will be airbyte/destination-dev-null:dev.
the Dockerfile.
Run
Then run any of the connector commands as follows:
docker run --rm airbyte/destination-dev-null:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-dev-null:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-dev-null:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/destination-dev-null:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
Cloud variant
The cloud variant of this connector is Dev Null Destination. It only allows the "silent" mode. When this mode is changed, please make sure that the Dev Null Destination 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/destinations/dev-null.
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/destinations/dev-null/.
Using gradle to run tests
All commands should be run from airbyte project root. To run unit tests:
./gradlew :airbyte-integrations:connectors:destination-dev-null:unitTest
To run acceptance and custom integration tests:
./gradlew :airbyte-integrations:connectors:destination-dev-null: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?
- Make sure your changes are passing our test suite:
airbyte-ci connectors --name=destination-dev-null test - Bump the connector version in
metadata.yaml: increment thedockerImageTagvalue. Please follow semantic versioning for connectors. - Make sure the
metadata.yamlcontent is up to date. - Make the connector documentation and its changelog is up to date (
docs/integrations/destinations/dev-null.md). - Create a Pull Request: use our PR naming conventions.
- Pat yourself on the back for being an awesome contributor.
- Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.