Improve the "expected failures" experience #178
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jku
commented
Aug 28, 2024
|
|
||
| try: | ||
| with open(xfail_file) as f: | ||
| return f.read().splitlines() |
There was a problem hiding this comment.
it might be useful to parse the content a bit -- e.g. allow comments so you could do something like this
# RSA PSS not yet supported https://github.com/theupdateframework/go-tuf/pull/625
test_keytype_and_scheme[rsa/rsassa-pss-sha256]in the .xfails file... but maybe we add that when someone actually wants it
If we add more tests that we consider more or less optional features, we need a way for clients to manage them. xfails seems like it should work for that: Make it possible to write the expected failures to a file next to the client-under-test executable. This should make managing a longer xfail list reasonable. This also means we don't need to repeat the xfails for go-tuf in two places. Signed-off-by: Jussi Kukkonen <[email protected]>
|
rebased on main |
AdamKorcz
approved these changes
Aug 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If we add more tests that we consider more or less optional features, we need a way for clients to manage them."xfails" seems like it should work for that: Make it possible to write the expected failures to a file next to the client-under-test executable
I'm happy to get other opinions on this too: I have no idea if there are best practices for this sort of thing, I just made this up...
This is a change in the GitHub Action API (since I removed the
expected-failuresinput) so we should bump major version. That said, I don't think any outside user was using the input yet.Should make #33 more feasible