[feat] Add support for marking tests as expected failures #3481
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.
The main elements introduced by this PR are:
@xfail
decorator to mark a test as an expected sanity failure.xfail()
builtin to mark reference tuples as expected performance failures.Two new test states are introduced which are also logged:
XFAIL
for expected failures andXPASS
for unexpected passes.Design-wise the concept is the same as the one explained in #2378.
Implementation-wise there are two major changes:
reference_bounds()
is introduced which is used to validate and calculate the absolute lower/upper bounds. This used to be internal toassert_reference()
and now it's made public (maybe the docs there need a slight reorganization).pass
,fail
,xpass
orxfail
.For more details on how feature works macroscopically check the tutorial and the reference docs.
Closes #2378.