Module QCheck2.TestResult

Result of running a test

type 'a counter_ex = {
instance : 'a;

The counter-example

shrink_steps : int;

How many shrinking steps for this counter-example

msg_l : string list;

Messages of the test. Currently only populated by Test.fail_report and Test.fail_reportf.

since
0.7
}

A counter-example when a test fails.

type 'a state =
| Success

If the test passed.

| Failed of {
instances : 'a counter_ex list;

Failed instance(s)

}

If the test failed "normally", i.e. a test returned false.

| Failed_other of {
msg : string;
}

If the test failed for an unusual reason:

  • an exception was raised by a generator
  • too many assumptions failed and Test.if_assumptions_fail was set to `Fatal
| Error of {
instance : 'a counter_ex;

Instance that triggered the exception in the test

exn : exn;

The raised exception

backtrace : string;

A best-effort backtrace of the exception

}

If the test failed "exceptionally" (an exception was raised by the test).

Result state.

changed in 0.10 (move to inline records, add Fail_other)

type 'a t
val get_state : 'a t -> 'a state

get_state t returns the final state after a test execution.

val get_count : _ t -> int

get_count t returns the number of tests executed.

val get_count_gen : _ t -> int

get_count_gen t returns the number of generated cases.

val get_collect : _ t -> (string, int) Stdlib.Hashtbl.t option

get_collect t returns the repartition of generated values.

since
0.18
val get_stats : 'a t -> ('a stat * (int, int) Stdlib.Hashtbl.t) list

get_stats t returns the statistics captured by the test.

since
0.18
val get_warnings : _ t -> string list

get_warnings t returns the list of warnings emitted during the test.

since
0.18
val get_instances : 'a t -> 'a list

get_instances t returns the generated instances, with no guarantee on the order.

since
0.18
val is_success : _ t -> bool

Returns true iff the state if Success

since
0.9
val stats : 'a t -> ('a stat * (int, int) Stdlib.Hashtbl.t) list

Obtain statistics

since
0.6
deprecated

use get_stats instead

val warnings : _ t -> string list

Obtain list of warnings

since
0.10
deprecated

use get_warnings instead

val collect : _ t -> (string, int) Stdlib.Hashtbl.t option

Obtain statistics

since
0.6
deprecated

use get_collect instead