From b5fef4e58c3dce14427dcb66d07a72ee5285cc64 Mon Sep 17 00:00:00 2001 From: Catherine Noll Date: Wed, 24 Apr 2024 16:53:01 +0100 Subject: [PATCH] Live tests: update README (#37512) --- airbyte-ci/connectors/live-tests/README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/airbyte-ci/connectors/live-tests/README.md b/airbyte-ci/connectors/live-tests/README.md index 5ee3db7241bf..1956e6c93e5d 100644 --- a/airbyte-ci/connectors/live-tests/README.md +++ b/airbyte-ci/connectors/live-tests/README.md @@ -10,10 +10,8 @@ This project contains utilities for running connector tests against live data. ## Install ```bash -# From tools/connectors/live-tests -pipx install . -# To install in editable mode for development -pipx install . --force --editable +# From airbyte-ci/connectors/live-tests +poetry install ``` ## Commands @@ -21,7 +19,7 @@ pipx install . --force --editable ### `debug` ``` -Usage: live-tests debug [OPTIONS] {check|discover|read|read-with-state|spec} +Usage: poetry run live-tests debug [OPTIONS] {check|discover|read|read-with-state|spec} Run a specific command on one or multiple connectors and persists the outputs to local storage. @@ -57,7 +55,7 @@ It will write artifacts to an output directory: Let's run `debug` to check the output of `read` on two different versions of the same connector: ```bash -live-tests debug read \ +poetry run live-tests debug read \ --connection-id=d3bd39cd-6fec-4691-a661-d52c466d8554 --connector-image=airbyte/source-pokeapi:dev \ --connector-image=airbyte/source-pokeapi:latest \ @@ -94,7 +92,7 @@ live_tests_debug_reports You can also run the `debug` command on a live connection by passing the `--connection-id` option: ```bash -live-tests debug read \ +poetry run live-tests debug read \ --connector-image=airbyte/source-pokeapi:dev \ --connector-image=airbyte/source-pokeapi:latest \ --connection-id= @@ -119,7 +117,8 @@ You can run the existing test suites with the following command: #### With local connection objects (`config.json`, `catalog.json`, `state.json`) ```bash poetry run pytest src/live_tests/regression_tests \ ---connector-image=airbyte/source-faker \ + --connector-image=airbyte/source-faker \ + --connection-id= \ --config-path= \ --catalog-path= \ --target-version=dev \