package async_kernel

  1. Overview
  2. Docs
package async_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Core_kernel.Quickcheck.Quickcheck_configured
include Core_kernel.Quickcheck_intf.Quickcheck_config

default_seed is used initialize the pseudo-random generator that chooses random values from generators, in each test that is not provided its own seed.

default_sizes determines the default sequence of sizes used in generating values.

val default_trial_count : Base.Int.t

default_trial_count determines the number of trials per test, except in tests that explicitly override it.

val default_can_generate_trial_count : Base.Int.t

default_can_generate_trial_count determines the number of trials used in attempts to generate satisfying values, except in tests that explicitly override it.

val default_attempts_per_trial : Base.Float.t

default_attempts_per_trial determines the maximum number of attempts to generate inputs for trials, as a multiplier for the number of trials, except in tests that explicitly override it.

val default_shrink_attempts : Core_kernel.Quickcheck_intf.shrink_attempts

default_shrink_attempts determines the number of attempts at shrinking when running test or iter with ~shrinker and without ~shrink_attempts

random_value ~seed gen produces a single value chosen from gen using seed.

iter ~seed ~trials ~attempts ~filter gen ~f runs f on up to trials different values generated by gen. It stops successfully after trials successful trials or if gen runs out of values. It raises an exception if f raises an exception or if it fails to produce trials inputs from gen after attempts attempts. If filter is provided, iteration proceeds over Generator.filter gen ~f:filter.

val test : ?seed:Core_kernel.Quickcheck_intf.seed -> ?sizes:Base.Int.t Core_kernel.Sequence.t -> ?trials:Base.Int.t -> ?attempts:Base.Int.t -> ?filter:('a -> Base.Bool.t) -> ?shrinker:'a Core_kernel.Quickcheck.Shrinker.t -> ?shrink_attempts:Core_kernel.Quickcheck_intf.shrink_attempts -> ?sexp_of:('a -> Base.Sexp.t) -> ?examples:'a Base.List.t -> 'a Core_kernel.Quickcheck.Generator.t -> f:('a -> Base.Unit.t) -> Base.Unit.t

test ~seed ~trials ~attempts ~sexp_of ~examples gen ~f is like iter, with optional concrete examples that are tested before values from gen, and additional information provided on failure. If f raises an exception and sexp_of is provided, the exception is re-raised with a description of the random input that triggered the failure. If f raises an exception and shrinker is provided, it will be used to attempt to shrink the value that caused the exception with re-raising behaving the same as for unshrunk inputs.

test_or_error is like test, except failure is determined using Or_error.t. Any exceptions raised by f are not caught.

val test_can_generate : ?seed:Core_kernel.Quickcheck_intf.seed -> ?sizes:Base.Int.t Core_kernel.Sequence.t -> ?trials:Base.Int.t -> ?attempts:Base.Int.t -> ?filter:('a -> Base.Bool.t) -> ?sexp_of:('a -> Base.Sexp.t) -> 'a Core_kernel.Quickcheck.Generator.t -> f:('a -> Base.Bool.t) -> Base.Unit.t

test_can_generate ~seed ~trials ~attempts ~sexp_of gen ~f is useful for testing gen values, to make sure they can generate useful examples. It tests gen by generating up to trials values and passing them to f. Once a value satisfies f, the iteration stops. If no values satisfy f, test_can_generate raises an exception. If sexp_of is provided, the exception includes all of the generated values.

val test_distinct_values : ?seed:Core_kernel.Quickcheck_intf.seed -> ?sizes:Base.Int.t Core_kernel.Sequence.t -> ?attempts:Base.Int.t -> ?filter:('a -> Base.Bool.t) -> ?sexp_of:('a -> Base.Sexp.t) -> 'a Core_kernel.Quickcheck.Generator.t -> trials:Base.Int.t -> distinct_values:Base.Int.t -> compare:('a -> 'a -> Base.Int.t) -> Base.Unit.t

test_distinct_values gen ~compare ~trials ~distinct_values is useful for testing gen values, to make sure they create sufficient distinct values. It tests gen by generating up to trials values and making sure at least distinct_values of the resulting values are unique with respect to compare. If too few distinct values are generated, test_distinct_values raises an exception. If sexp_of is provided, the exception includes the values generated.

random_sequence ~seed gen produces a sequence of values chosen from gen.

val async_test : ?seed:Core_kernel.Quickcheck.seed -> ?trials:int -> ?sexp_of:('a -> Core_kernel.Sexp.t) -> 'a Core_kernel.Quickcheck.Generator.t -> f:('a -> unit Deferred.t) -> unit Deferred.t

Like test, but for asynchronous tests.