Mark tests as expected to fail

[daniel-vergien-bdr]

It would be nice to have a way to mark a test a expected to fail. This would come in handy if you write a test for a bug before the bug is fixed.
Junit-pioneer has such a feature: https://junit-pioneer.org/docs/expected-to-fail-tests/

[ptrthomas]

interesting - will need to think about this a bit and how it would co-exist with soft assertions: #1446

maybe we should introduce a @mustfail or @fail built-in tag

[daniel-vergien-bdr]

I think a build-in tag would be nice. My idea would be to evaluate this as the last step after a test is finished. If the tag is present the result is inverted. This way it would not interfere with any other stuff.

[daniel-vergien-bdr]

On a first look in the source code I did not find a place where e.g. the other build-in tags are evaluated. If you give me a hint I might prepare a MR.

[ptrthomas]

@daniel-vergien-bdr ScenarioRuntime should be it, there is an afterRun() method: https://github.com/karatelabs/karate/blob/v1.5.1/karate-core/src/main/java/com/intuit/karate/core/ScenarioRuntime.java#L500

the isSelectedForExecution() method has examples of inspecting tags: https://github.com/karatelabs/karate/blob/v1.5.1/karate-core/src/main/java/com/intuit/karate/core/ScenarioRuntime.java#L313