Skip to content
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.

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

Live tests: update README #37512

Merged
merged 2 commits into from Apr 24, 2024
Merged

Live tests: update README #37512

merged 2 commits into from Apr 24, 2024

Conversation

clnoll
Copy link
Contributor

@clnoll clnoll commented Apr 23, 2024

Updates the live-tests README to indicate that poetry should be used to install the virtual environment, and that a connection ID is required for regression tests.

@clnoll clnoll requested a review from a team as a code owner April 23, 2024 21:01
Copy link

vercel bot commented Apr 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Apr 24, 2024 3:16pm

@clnoll clnoll requested review from strosek and maxi297 April 23, 2024 21:02
@@ -119,7 +119,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.

Copy link
Contributor

@alafanechere alafanechere left a comment

Choose a reason for hiding this comment

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

I'd prefer completely removing pipx from the install instructions as it's confusing and less reliable than poetry (which we must use to run the pytest suite)

IMO install should just be:

poetry install

To run debug you'd then run:

poetry run live-tests debug

To run the regression test suite:

poetry run pytest src/live_tests/regression_tests ...

@clnoll
Copy link
Contributor Author

clnoll commented Apr 24, 2024

Thanks @alafanechere I made these updates.

@clnoll clnoll merged commit b5fef4e into master Apr 24, 2024
30 of 32 checks passed
@clnoll clnoll deleted the live-tests-readme-updates branch April 24, 2024 15:53
strosek pushed a commit that referenced this pull request Apr 24, 2024
FVidalCarneiro pushed a commit to AgiData/airbyte that referenced this pull request May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants