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.

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

Jump to bottom

README: make it a bit clearer how to get regression tests running #4885

Merged
merged 2 commits into from
Aug 3, 2023
Merged

README: make it a bit clearer how to get regression tests running #4885

merged 2 commits into from
Aug 3, 2023

Conversation

jcsp
Copy link
Collaborator

@jcsp jcsp commented Aug 3, 2023

Problem

When setting up for the first time I hit a couple of nits running tests:

  • It wasn't obvious that openssl and poetry were needed (poetry is mentioned kind of obliquely via "dependency installation notes" rather than being in the list of rpm/deb packages to install.
  • It wasn't obvious how to get the tests to run for just particular parameters (e.g. just release mode)

Summary of changes

Add openssl and poetry to the package lists.

Add an example of how to run pytest for just a particular build type and postgres version.

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.
  • Do we need to implement analytics? if so did you add the relevant metrics to the dashboard?
  • If this PR requires public announcement, mark it with /release-notes label and add several sentences in this section.

Checklist before merging

  • Do not forget to reformat commit message to not include the above checklist

jcsp added 2 commits August 3, 2023 10:47
@jcsp
README: add test dependencies to package lists
375fe0e 
- It's not obvious that `openssl` is needed for some
  auth tests in test_runner/ to work.
- Poetry is already mentioned elsewhere in the readme,
  but it's easy to miss and simpler to just install it
  along with other dependencies.
@jcsp
README: note how to specify test params
9bef057 
For typical local workflows, they would probably like
to just run through one representative set of params, not
all postgres versions + debug/release.
@jcsp jcsp added a/documentation Area: related to documentation a/tech_debt Area: related to tech debt labels Aug 3, 2023
@hlinnaka hlinnaka requested a review from MMeent August 3, 2023 11:02
@hlinnaka
Copy link
Contributor

hlinnaka commented Aug 3, 2023

It wasn't obvious how to get the tests to run for just particular parameters (e.g. just release mode)

We just talked about that with @MMeent this morning :-)

@github-actions
Copy link

github-actions bot commented Aug 3, 2023

1264 tests run: 1212 passed, 0 failed, 52 skipped (full report)

Flaky tests (1)

Postgres 14

  • test_ondemand_download_large_rel[real_s3]: debug

@jcsp jcsp marked this pull request as ready for review August 3, 2023 12:40
@jcsp jcsp merged commit e71d809 into main Aug 3, 2023
@jcsp jcsp deleted the jcsp/update-readme branch August 3, 2023 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MMeent MMeent MMeent approved these changes

Assignees
No one assigned
Labels
a/documentation Area: related to documentation a/tech_debt Area: related to tech debt
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jcsp @hlinnaka @MMeent