Skip to content

Live tests: update README #37512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 24, 2024
+7 −8
Merged

Live tests: update README #37512

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a34d465
Live tests: update README
clnoll Apr 23, 2024
f999c5a
use poetry
clnoll Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions airbyte-ci/connectors/live-tests/README.md
View file
Open in desktop
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> \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we provide a way to easily get a working connection-id for this command? I think this would be great because the users going through the readme.md will probably be complete beginners

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll have some tooling for automatically picking a connection ID merged soon. But I think that people should really still be using the onboarding doc. Explanation here.

--config-path=<path-to-config-path> \
--catalog-path=<path-to-catalog-path> \
--target-version=dev \
Expand Down
Loading