From c2b9ce22735b7c9fcc3150bf9ee3bdf39314516e Mon Sep 17 00:00:00 2001 From: alafanechere Date: Wed, 22 May 2024 15:57:02 +0200 Subject: [PATCH 1/2] doc: update metadata documentation following CI change --- .../connector-metadata-file.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/connector-development/connector-metadata-file.md b/docs/connector-development/connector-metadata-file.md index 38518cecfc8c..956af2137d75 100644 --- a/docs/connector-development/connector-metadata-file.md +++ b/docs/connector-development/connector-metadata-file.md @@ -172,3 +172,27 @@ remoteRegistries: The `packageName` property of the `pypi` section is the name of the installable package in the PyPi registry. If not specified, all remote registry configurations are disabled by default. + +## The `connectorTestSuitesOptions` section + +The `connectorTestSuitesOptions` contains a list of test suite options for a connector. +The list of declared test suites affects which suite will run in CI. +We currently accept three value for the `suite` field: +* `unitTests` +* `integrationTests` +* `acceptanceTests` + +Each list entry can also declare a `testSecrets` object which will enable our CI to fetch connector specific secret credentials which are required to run the `suite`. + +### The `testSecrets` object +The `testSecrets` object has three properties: +* `name` (required `string`): it's the name of the secret in the secret store. +* `secretStore` (required `secretStore` object): It's where the secret is stored (more details on the object structure below). +* `fileName` (optional `string`): The name of the file in which our CI will persist the secret (inside the connector's `secrets` directory). + +**If you are a community contributor please note that addition of a new secret to our secret store requires manual intervention from an Airbyter. Please reach out to your PR reviewers if you want to add a test secret to our CI.** + +#### The `secretStore` object +This object has three properties: +* `type`: Defines the secret store type, only `GSM` (Google Secret Manager) is currently supported +* `alias`: The alias of this secret store in our system, which is resolved into an actual secret store address by our CI. We currently have a single alias to store our connector test secrets: `airbyte-connector-testing-secret-store` . From 535f50598077a9dc5e40aabfbcaac1e19fbb6eee Mon Sep 17 00:00:00 2001 From: Augustin Date: Fri, 24 May 2024 10:49:43 +0200 Subject: [PATCH 2/2] Update docs/connector-development/connector-metadata-file.md Co-authored-by: Ella Rohm-Ensing --- docs/connector-development/connector-metadata-file.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/connector-development/connector-metadata-file.md b/docs/connector-development/connector-metadata-file.md index 956af2137d75..fecc76273fe7 100644 --- a/docs/connector-development/connector-metadata-file.md +++ b/docs/connector-development/connector-metadata-file.md @@ -186,8 +186,8 @@ Each list entry can also declare a `testSecrets` object which will enable our CI ### The `testSecrets` object The `testSecrets` object has three properties: -* `name` (required `string`): it's the name of the secret in the secret store. -* `secretStore` (required `secretStore` object): It's where the secret is stored (more details on the object structure below). +* `name` (required `string`): The name of the secret in the secret store. +* `secretStore` (required `secretStore` object): Where the secret is stored (more details on the object structure below). * `fileName` (optional `string`): The name of the file in which our CI will persist the secret (inside the connector's `secrets` directory). **If you are a community contributor please note that addition of a new secret to our secret store requires manual intervention from an Airbyter. Please reach out to your PR reviewers if you want to add a test secret to our CI.**