Skip to content

Commit

Permalink
SAT: update reference about backward compatibility tests (#15588)
Browse files Browse the repository at this point in the history
* update sat reference

* Update docs/connector-development/testing-connectors/source-acceptance-tests-reference.md

* Update docs/connector-development/testing-connectors/source-acceptance-tests-reference.md

Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
  • Loading branch information
alafanechere and sherifnada authored Aug 17, 2022
1 parent d3cefac commit efc9ac1
Showing 1 changed file with 6 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ tests: # Tests configuration
## Test Spec
Verify that a spec operation issued to the connector returns a valid spec.
Verify that a `spec` operation issued to the connector returns a valid connector specification.
Additional tests are validating the backward compatibility of the current specification compared to the specification of the previous connector version. If no previous connector version is found (by default the test looks for a docker image with the same name but with the `latest` tag), this test is skipped.
These backward compatibility tests can be bypassed by changing the value of the `backward_compatibility_tests_config.disable_for_version` input in `acceptance-test-config.yml` (see below).

| Input | Type | Default | Note |
| :--- | :--- | :--- |:-------------------------------------------------------------------------------------------------|
Expand All @@ -114,7 +116,9 @@ Verify that a check operation issued to the connector with the input config file

## Test Discovery

Verifies when a discover operation is run on the connector using the given config file, a valid catalog is produced by the connector.
Verifies when a `discover` operation is run on the connector using the given config file, a valid catalog is produced by the connector.
Additional tests are validating the backward compatibility of the discovered catalog compared to the catalog of the previous connector version. If no previous connector version is found (by default the test looks for a docker image with the same name but with the `latest` tag), this test is skipped.
These backward compatibility tests can be bypassed by changing the value of the `backward_compatibility_tests_config.disable_for_version` input in `acceptance-test-config.yml` (see below).

| Input | Type | Default | Note |
| :--- | :--- | :--- | :--- |
Expand Down

0 comments on commit efc9ac1

Please sign in to comment.