Add expect block to skip tests

[sksamuel]

Closes #3582

This adds the ability to do expect { someboolean() } in a test block, which, if false, marks the test as skipped.

Happy to rename "expect" to something else:

• require(s) clashes with the kotlin sdk method
• assume clashes with property test assumptions.

[Kantis]

I like it. Tried to come up with some naming alternatives but it's hard.. @mickeelm you're pretty good at spitting out names, any thoughts on this one? 😄

[Kantis]

Btw would this be compatible with having a second variant?:

inline fun <reified T> TestScope.expect(thunk: () -> T) = runCatching {
   thunk()
}.mapError {
   ExpectFailureException
}.getOrThrow()

val user = expect { createUser() } 

[sksamuel]

Yeah that's better.

[Kantis]

• assumeSuccess {}
• assumeSuccessful {}
• expectSuccess {}

Might make the intent a bit more obvious?

[sksamuel]

precondition or condition or prereq are other alternatives.

…

On Wed, Aug 2, 2023, 7:20 AM Emil Kantis ***@***.***> wrote: - assumeSuccess {} - assumeSuccessful {} - expectSuccess {} Might make the intent a bit more obvious? — Reply to this email directly, view it on GitHub <#3596 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFVSGWEJDEQQEHTOP3AILLXTJAZTANCNFSM6AAAAAA24RQJRI> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[mickeelm]

I'll try to live up to that introduction :)

I like expect, but I think that a potential problem with expect is the notion of expect a to be b, i.e. all in all the same as shouldBe (or assert) and most importantly, you're likely to expect the test to throw, not to be ignored. There might be a confusion risk here.

I think precondition/condition/prereq are closest to hinting that a false evaluation will result in an ignored test rather than a failed test.

Some other suggestions:

runIf {}
runOnlyIf {}
onlyIf {}
conditional {}
conditionalOn {}
precheck {}

[Kantis]

I think I prefer prereq, but I dont feel very strongly about it.

[sksamuel]

I like onlyIf or runIf

[sksamuel]

I can't get two variants to work, it always wants to resolve to the Boolean one. So we might need another name for the one that returns a value.

[Kantis]

I think we could make this runIf(condition: Boolean), then we can have rhe one taking a function return T