Skip to content

Commit

Permalink
Live tests: update README (#37512)
Browse files Browse the repository at this point in the history
  • Loading branch information
clnoll committed Apr 24, 2024
1 parent c05c70b commit b5fef4e
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions airbyte-ci/connectors/live-tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,16 @@ 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

### `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.
Expand Down Expand Up @@ -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 \
Expand Down Expand Up @@ -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=<CONNECTION-ID>
Expand All @@ -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=<CONNECTION-ID> \
--config-path=<path-to-config-path> \
--catalog-path=<path-to-catalog-path> \
--target-version=dev \
Expand Down

0 comments on commit b5fef4e

Please sign in to comment.