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

Add support for “known failures” to transcripts #5394

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from

Conversation

sellout
Copy link
Contributor

@sellout sellout commented Oct 7, 2024

Overview

This allows issues that haven’t yet been resolved to be reflected in the transcripts. This makes it easier to close tickets as soon as issues have been fixed, and avoids having to manually re-try transcripts from a ticket to see if the situation is the same.

Fixes #5350.

Implementation notes

This adds two new transcript tags :failure and :incorrect. They behave similarly to :error and no tag, respectively, except the error messages are different when the results don’t match.

  • :failure represents a stanza that is intended to succeed, but currently fails (whereas :error is intended to fail)
  • :incorrect represents a stanza that is intended to error, but currently doesn’t.

Test coverage

This adds three new transcripts for open tickets exercising the two new tags.

Loose ends

There are lots of open tickets that should also get transcripts added.

This is basically the opposite of `:failure` – it indicates that a
successful result is incorrect. The correct result may either be an
error (which will be caught by the transcript runner) or a different
result then what is currently expected (which won’t be caught by the
runner, but the appearance of `:incorrect` conveys to the programmer
that the output.md diff may be an improvement from the previous state).
@aryairani
Copy link
Contributor

I wanna think a little more about what the label names should be, because I think error failure and incorrect are hard to distinguish; but otherwise this looks great.

@sellout
Copy link
Contributor Author

sellout commented Oct 7, 2024

I agree. It might be worth doing #5214 before this.

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.

support “known failures” in transcripts
2 participants