PropertyHelper¶

Per-sample helper for property-based tests.

Each instance is scoped to a single sample. Classification calls (classify, tabulate, cover) count toward that sample, and complete/expect_action/complete_action complete the sample, not the overall test.

class val PropertyHelper

Public fields¶

let env: Env val¶

[Source]

Public Functions¶

classify¶

[Source]

Tag this sample with label for distribution reporting.

fun box classify(
  label: String val)
: None val

Parameters¶

label: String val

Returns¶

None val

collect¶

[Source]

Classify this sample by the string representation of value.

fun box collect(
  value: Stringable box)
: None val

Parameters¶

value: Stringable box

Returns¶

None val

tabulate¶

[Source]

Record label under heading for cross-tabulation reporting.

fun box tabulate(
  heading: String val,
  label: String val)
: None val

Parameters¶

heading: String val
label: String val

Returns¶

None val

cover¶

[Source]

Record whether condition holds for label. The property fails if fewer than min_pct percent of samples satisfy the condition. The default min_pct of 0.0 reports coverage without enforcing it.

fun box cover(
  condition: Bool val,
  label: String val,
  min_pct: F64 val = 0.0)
: None val

Parameters¶

condition: Bool val
label: String val
min_pct: F64 val = 0.0

Returns¶

None val

log¶

[Source]

Log a message. When verbose is true, the message is only shown in verbose output mode.

fun box log(
  msg: String val,
  verbose: Bool val = false)
: None val

Parameters¶

msg: String val
verbose: Bool val = false

Returns¶

None val

fail¶

[Source]

Flag this sample as having failed.

fun box fail(
  msg: String val = "Test failed")
: None val

Parameters¶

msg: String val = "Test failed"

Returns¶

None val

assert_true¶

[Source]

Assert that actual is true.

fun box assert_true(
  actual: Bool val,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

actual: Bool val
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

assert_false¶

[Source]

Assert that actual is false.

fun box assert_false(
  actual: Bool val,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

actual: Bool val
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

assert_error¶

[Source]

Assert that test throws an error when called.

fun box assert_error(
  test: ITest box,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

test: ITest box
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

assert_no_error¶

[Source]

Assert that test does not throw an error when called.

fun box assert_no_error(
  test: ITest box,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

test: ITest box
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

assert_is[A: A]¶

[Source]

Assert that expect and actual are the same instance.

fun box assert_is[A: A](
  expect: A,
  actual: A,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

expect: A
actual: A
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

assert_isnt[A: A]¶

[Source]

Assert that not_expect and actual are different instances.

fun box assert_isnt[A: A](
  not_expect: A,
  actual: A,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

not_expect: A
actual: A
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

assert_eq[A: (Equatable[A] #read & Stringable #read)]¶

[Source]

Assert that expect and actual are equal.

fun box assert_eq[A: (Equatable[A] #read & Stringable #read)](
  expect: A,
  actual: A,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

expect: A
actual: A
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

assert_ne[A: (Equatable[A] #read & Stringable #read)]¶

[Source]

Assert that not_expect and actual are not equal.

fun box assert_ne[A: (Equatable[A] #read & Stringable #read)](
  not_expect: A,
  actual: A,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

not_expect: A
actual: A
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

assert_array_eq[A: (Equatable[A] #read & Stringable #read)]¶

[Source]

Assert that the contents of expect and actual are equal.

fun box assert_array_eq[A: (Equatable[A] #read & Stringable #read)](
  expect: ReadSeq[A] box,
  actual: ReadSeq[A] box,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

expect: ReadSeq[A] box
actual: ReadSeq[A] box
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

assert_array_eq_unordered[A: (Equatable[A] #read & Stringable #read)]¶

[Source]

Assert that the contents of expect and actual are equal regardless of order.

fun box assert_array_eq_unordered[A: (Equatable[A] #read & Stringable #read)](
  expect: ReadSeq[A] box,
  actual: ReadSeq[A] box,
  msg: String val = "",
  loc: SourceLoc val = __loc)
: Bool val

Parameters¶

expect: ReadSeq[A] box
actual: ReadSeq[A] box
msg: String val = ""
loc: SourceLoc val = __loc

Returns¶

Bool val

long_test¶

[Source]

Switch this property to async mode. Each sample runs until complete is called or timeout nanoseconds elapse.

fun box long_test(
  timeout: U64 val)
: None val

Parameters¶

timeout: U64 val

Returns¶

None val

complete¶

[Source]

Complete this sample. Only needed for async properties (those that call long_test).

fun box complete(
  success: Bool val)
: None val

Parameters¶

success: Bool val

Returns¶

None val

expect_action¶

[Source]

Register an expected action for this sample. All expected actions must complete before the sample finishes.

fun box expect_action(
  name: String val)
: None val

Parameters¶

name: String val

Returns¶

None val

complete_action¶

[Source]

Mark an expected action as successfully completed for this sample.

fun box complete_action(
  name: String val)
: None val

Parameters¶

name: String val

Returns¶

None val

fail_action¶

[Source]

Mark an action as failed for this sample. The sample fails immediately.

fun box fail_action(
  name: String val)
: None val

Parameters¶

name: String val

Returns¶

None val

dispose_when_done¶

[Source]

Pass an actor to be disposed when this sample finishes.

fun box dispose_when_done(
  disposable: DisposableActor tag)
: None val

Parameters¶

disposable: DisposableActor tag

Returns¶

None val