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

docs(readme): add cargo test instructions #760

Closed
wants to merge 1 commit into from

Conversation

n0toose
Copy link
Member

@n0toose n0toose commented Sep 20, 2024

I came across a mysterious error that affected fs-test.

As I was experimenting with code affecting file reads and writes, I falsely assumed that the issue was isolated to this test in particular. I forgot that the rest of the tests would not get executed if the first one were to fail.

@n0toose
Copy link
Member Author

n0toose commented Sep 20, 2024

A similar error appeared during the CI runs of #748, which caused some confirmation bias: I thought that only fs-test would fail on some environments, and not the integration tests as a whole. I'm trying to use that mistake to improve the docs for the "next person".

I can also modify the CI pipelines so as to use the --no-fail-fast flag after discussing and getting a positive signal on this PR.

@n0toose
Copy link
Member Author

n0toose commented Sep 20, 2024

Related: #726 (comment)

Copy link

codecov bot commented Sep 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.45%. Comparing base (f407069) to head (188a96e).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #760   +/-   ##
=======================================
  Coverage   67.45%   67.45%           
=======================================
  Files          20       20           
  Lines        2338     2338           
=======================================
  Hits         1577     1577           
  Misses        761      761           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

I came across a mysterious error that affected fs-test.

As I was experimenting with code affecting file reads and writes, I
falsely assumed that the issue was isolated to this test in particular.
I forgot that the rest of the tests would not get executed if the first
one were to fail.
@n0toose n0toose changed the title docs(README): add cargo test instructions docs(readme): add cargo test instructions Sep 20, 2024
@n0toose n0toose force-pushed the readme-integration-tests branch from 8a6f13f to 188a96e Compare September 20, 2024 14:35
@jounathaen
Copy link
Member

Hmm, honestly: I think this is rather verbose. The essence of this change is the --no-fail-fast flag, but this is nothing special to uhyve and also often not necessary. I think we should rather keep the README short. If there is a need for these kinds of information, we might consider adding a wiki.

If you think the --no-fail-fast information is of major importance, you can add a single sentence to the previous paragraph.

Please don't hesitate to re-open if you disagree.

@jounathaen jounathaen closed this Sep 23, 2024
@jounathaen
Copy link
Member

You can also add that flag to the CI. That might be of value.

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.

2 participants