From a0b2998266b92b7a365c18e52cb56973b4002dad Mon Sep 17 00:00:00 2001 From: Ben Church Date: Wed, 1 Feb 2023 19:08:26 -0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Add=20run=20one=20test=20example?= =?UTF-8?q?=20to=20SAT=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../bases/connector-acceptance-test/README.md | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/airbyte-integrations/bases/connector-acceptance-test/README.md b/airbyte-integrations/bases/connector-acceptance-test/README.md index 029784bed582..6dec2cf411b1 100644 --- a/airbyte-integrations/bases/connector-acceptance-test/README.md +++ b/airbyte-integrations/bases/connector-acceptance-test/README.md @@ -1,27 +1,35 @@ # Connector Acceptance Tests -This package gathers multiple test suites to assess the sanity of any Airbyte connector. +This package gathers multiple test suites to assess the sanity of any Airbyte connector. It is shipped as a [pytest](https://docs.pytest.org/en/7.1.x/) plugin and relies on pytest to discover, configure and execute tests. Test-specific documentation can be found [here](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference/)). ## Running the acceptance tests on a source connector: -1. `cd` into your connector project (e.g. `airbyte-integrations/connectors/source-pokeapi`) +1. `cd` into your connector project (e.g. `airbyte-integrations/connectors/source-pokeapi`) 2. Edit `acceptance-test-config.yml` according to your need. Please refer to our [Connector Acceptance Test Reference](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference/) if you need details about the available options. 3. Build the connector docker image ( e.g.: `docker build . -t airbyte/source-pokeapi:dev`) 4. Use one of the following ways to run tests (**from your connector project directory**) -**Using python** +### Using python +_Note: these will assume that docker image for connector is already built_ + +**Running the whole suite** ```bash python -m pytest integration_tests -p integration_tests.acceptance ``` -_Note: this will assume that docker image for connector is already built_ -**Using Gradle** +**Running a specific test** +```bash +python -m pytest integration_tests -p integration_tests.acceptance -k "" +``` + + +### Using Gradle ```bash ./gradlew :airbyte-integrations:connectors:source-:connectorAcceptanceTest ``` _Note: this way will also build docker image for the connector_ -**Using Bash** +### Using Bash ```bash ./acceptance-test-docker.sh ``` @@ -67,4 +75,4 @@ To migrate a legacy configuration to the latest configuration format please run: python -m venv .venv # If you don't have a virtualenv already source ./.venv/bin/activate # If you're not in your virtualenv already python connector_acceptance_test/tools/strictness_level_migration/config_migration.py ../../connectors/source-to-migrate/acceptance-test-config.yml -``` \ No newline at end of file +```