package alcotest-lwt

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Versioned APIs

alcotest-lwt
- Alcotest_lwt
  - V1

Legend:
Library
Module
Module type
Parameter
Class
Class type

Alcotest_lwt enables testing functions which return an Lwt promise. run returns a promise that runs the tests when scheduled, catching any asynchronous exceptions thrown by the tests.

include Alcotest_engine.V1.Cli.S with type return = unit Lwt.t

type return = unit Lwt.t

type speed_level = [

| `Quick
| `Slow

]

type !'a test_case = string * speed_level * ('a -> return)

exception Test_error

type !'a test = string * 'a test_case list

type !'a with_options =
  ?and_exit:bool ->
  ?verbose:bool ->
  ?compact:bool ->
  ?tail_errors:[ `Limit of int | `Unlimited ] ->
  ?quick_only:bool ->
  ?show_errors:bool ->
  ?json:bool ->
  ?filter:(name:string -> index:int -> [ `Run | `Skip ]) ->
  ?log_dir:string ->
  ?bail:bool ->
  ?record_backtrace:bool ->
  'a

val run : 
  (?argv:string array -> string -> unit test list -> return) with_options

val run_with_args : 
  (?argv:string array ->
    string ->
    'a Cmdliner.Term.t ->
    'a test list ->
    return)
    with_options

val test_case : 
  string ->
  Alcotest.speed_level ->
  (Lwt_switch.t -> 'a -> unit Lwt.t) ->
  'a test_case

val test_case_sync : 
  string ->
  Alcotest.speed_level ->
  ('a -> unit) ->
  'a test_case

Versioned APIs

module V1 : sig ... end

An alias of the above API that provides a stability guarantees over major version changes.