Module Expect_test_helpers_base
module CR : sig ... end
module Sexp_style : sig ... end
val hide_positions_in_string : Base.string -> Base.string
hide_positions_in_string
does line-based regexp matching to replace line numbers and column numbers that appear in source-code positions with constant textLINE
andCOL
. This can be useful in making displayed test output less fragile.
val sexp_to_string : ?hide_positions:Base.bool -> Base.Sexp.t -> Base.string
Renders an s-expression as a string. With
~hide_positions:true
, patterns in the string that match OCaml-style file positions are modified to hide the line number, column number, and character positions, to make output less fragile.
val print_s : ?hide_positions:Base.bool -> Base.Sexp.t -> Base.unit
For printing an s-expression to stdout.
hide_positions
works as insexp_to_string
.
val print_string : ?hide_positions:Base.bool -> Base.string -> Base.unit
val print_endline : ?hide_positions:Base.bool -> Base.string -> Base.unit
val print_cr : ?cr:CR.t -> ?hide_positions:Base.bool -> Base.Source_code_position.t -> Base.Sexp.t -> Base.unit
print_cr here message
prints aCR require-failed
, which will appear in expect-test output. The CR will appear in the feature owner'sfe todo
, thus preventing release of the feature.print_cr
is an expect-test-friendly version ofassert false
. It works with the normal expect-test workflow because it does not raise, and it prevents mistakenly releasing features that violate a required property. There is no need to 'X' aCR require-failed
; simply fix the property that triggered theprint_cr
and re-run the test to restore the empty output.
val require : ?cr:CR.t -> ?hide_positions:Base.bool -> ?if_false_then_print_s:Base.Sexp.t Base.Lazy.t -> Base.Source_code_position.t -> Base.bool -> Base.unit
require here bool
is a no-op ifbool = true
, but if not, prints aCR require-failed
similarly toprint_cr
, with a message determined by theif_false_then_print_s
argument, if any.if_false_then_print_s
is useful for including information that may help debug the problem, but that would otherwise be too voluminous.if_false_then_print_s
is lazy to avoid construction of the sexp except when needed.
val require_equal : ?cr:CR.t -> ?hide_positions:Base.bool -> ?if_false_then_print_s:Base.Sexp.t Base.Lazy.t -> ?message:Base.string -> Base.Source_code_position.t -> (module With_equal with type t = 'a) -> 'a -> 'a -> Base.unit
require_equal
compares its two arguments using the equality predicate of the provided module. If the comparison fails, prints a message that renders the arguments as sexps.
val require_compare_equal : ?cr:CR.t -> ?hide_positions:Base.bool -> ?message:Base.string -> Base.Source_code_position.t -> (module With_compare with type t = 'a) -> 'a -> 'a -> Base.unit
Like
require_equal
, but derives an equality predicate from a comparison function.
val require_sets_are_equal : ?cr:CR.t -> ?hide_positions:Base.bool -> ?names:(Base.string * Base.string) -> Base.Source_code_position.t -> (module Set with type t = 'a) -> 'a -> 'a -> Base.unit
Like
require_equal
, but when equality fails produces a message including sexps of bothSet.diff first second
andSet.diff second first
to aid in debugging.
val show_raise : ?hide_positions:Base.bool -> ?show_backtrace:Base.bool -> (Base.unit -> _) -> Base.unit
show_raise
callsf ()
and prints the exception that it raises, or, if it doesn't raise, printsdid not raise
.show_raise
ignores the result off
so that one doesn't have to put anignore
inside the body of anf
that is expected to raise.~hide_positions:true
operates as inprint_s
, to make output less fragile. Using~show_backtrace:true
will result in a CR in the expectation, but it's still available here as it is still valuable when initially writing tests and debugging.
val require_does_not_raise : ?cr:CR.t -> ?hide_positions:Base.bool -> ?show_backtrace:Base.bool -> Base.Source_code_position.t -> (Base.unit -> Base.unit) -> Base.unit
require_does_not_raise
is likeshow_raise
, but does not print anything if the function does not raise, and prints a CR along with the exception if it does raise. Unlike forshow_raise
, the supplied function is required to returnunit
to avoid mistakes like incomplete partial application that silently would not raise, but for the wrong reason.
val require_does_raise : ?cr:CR.t -> ?hide_positions:Base.bool -> ?show_backtrace:Base.bool -> Base.Source_code_position.t -> (Base.unit -> _) -> Base.unit
require_does_raise
is likeshow_raise
, but additionally prints a CR if the function does not raise.
val quickcheck : Base.Source_code_position.t -> ?cr:CR.t -> ?hide_positions:Base.bool -> ?seed:Expect_test_helpers_base__.Expect_test_helpers_base_intf.Quickcheck.Test.Config.Seed.t -> ?sizes:Base.int Base.Sequence.t -> ?trials:Base.int -> ?shrinker:'a Expect_test_helpers_base__.Expect_test_helpers_base_intf.Quickcheck.Shrinker.t -> ?shrink_attempts:Base.int -> ?examples:'a Base.list -> sexp_of:('a -> Base.Sexp.t) -> f:('a -> Base.unit) -> 'a Expect_test_helpers_base__.Expect_test_helpers_base_intf.Quickcheck.Generator.t -> Base.unit
quickcheck
is similar toBase_quickcheck.Test.run
. It stops after the first iteration that raises or prints a CR, as detected byon_print_cr
.
val sexp_style : Sexp_style.t Base.ref
sexp_style
determines the sexp format used bysexp_to_string
,print_s
, and other functions in this module. Defaults toSexp_style.default_pretty
.
val on_print_cr : (Base.string -> Base.unit) Base.ref
on_print_cr
determines the behavior of all functions above that print CRs, such asprint_cr
andrequire
. The rendered string form of the CR is passed to!on_print_cr
. The default value isprint_endline
; this can be overridden to replace or extend the default behavior. For example, some testing harnesses may choose to abort a series of tests after the first CR is printed.