Skip to content

Docs: update connector test documentation #44126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 16, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions docs/connector-development/testing-connectors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

Multiple tests suites compose the Airbyte connector testing pyramid

## Common to all connectors
## Tests run by our CI pipeline

- [Connectors QA checks](https://docs.airbyte.com/contributing-to-airbyte/resources/qa-checks): Static assets checks that validate that the connector is correctly packaged to be successfully released to production.
- Unit tests: Connector-specific tests written by the connector developer and which don’t require access to the source/destination.
- Integration tests: Connector-specific tests written by the connector developer which may require access to the source/destination.
- [Connector Acceptance tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference/): Connector-agnostic tests that verify that the connector adheres to the Airbyte protocol. Credentials to a source/destination sandbox account are required.
- [Regression tests](https://github.com/airbytehq/airbyte/tree/master/airbyte-ci/connectors/live-tests): Connector-agnostic tests that verify that the behavior of the connector hasn’t changed unexpectedly between connector versions. A sandbox cloud connection is required. Currently only available for API source connectors.

- [Connectors QA checks](https://docs.airbyte.com/contributing-to-airbyte/resources/qa-checks)
- [Connector Acceptance tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference/)

## 🤖 CI

Expand All @@ -15,8 +19,9 @@ If you want to run the global test suite, exactly like what is run in CI, you sh
airbyte-ci connectors --name=<connector_name> test
```

This will run all the tests for the connector, including the QA checks and the Connector Acceptance tests.
Connector Acceptance tests require connector configuration to be provided as a `config.json` file in a `.secrets` folder in the connector code directory.
This will run all the tests that are available for the connector. This can include all of the tests listed above, if we have the appropriate credentials; at a minimum it will include the static asset checks and any tests that exist in a connector's `unit_tests` and `integration_tests` directories.
To run Connector Acceptance tests locally, you must provide connector configuration as a `config.json` file in a `.secrets` folder in the connector code directory.
Regression tests may only be run locally with authorization to our cloud resources.

Our CI infrastructure runs the connector tests with [`airbyte-ci` CLI](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md). Connectors tests are automatically and remotely triggered on your branch according to the changes made in your branch.
**Passing tests are required to merge a connector pull request.**
Expand Down
Loading