package qcheck-stm

  1. Overview
  2. Docs
State-machine testing library for sequential and parallel model-based tests

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (3)

Authors

  1. J
    Jan Midtgaard
  2. O
    Olivier Nicole
  3. N
    Nicolas Osborne
  4. S
    Samuel Hym

Maintainers

  1. J
    Jan Midtgaard <mail@janmidtgaard.dk>

Sources

0.8.tar.gz
md5=8e7634814a61bf765ac6989f7fdc49cb
sha512=dfa53117ecbf2e466f6ecddfa91d8eb63a3156fe9e1c5a68fd0da26a4c810312581d9ace4c00c4ab1947614f7fb1d6b686003a09da418d2940ac79a7b744a8eb

doc/qcheck-stm.stm/STM/index.html

Module STMSource

Module with combinators and definitions to specify an STM test

Sourcetype 'a ty = ..

Extensible type to represent result values

Sourcetype ty +=
  1. | Unit : unit ty
  2. | Bool : bool ty
  3. | Char : char ty
  4. | Int : int ty
  5. | Int32 : int32 ty
  6. | Int64 : int64 ty
  7. | Float : float ty
  8. | String : string ty
  9. | Bytes : bytes ty
  10. | Exn : exn ty
  11. | Option : 'a ty -> 'a option ty
  12. | Result : 'a ty * 'b ty -> ('a, 'b) result ty
  13. | List : 'a ty -> 'a list ty
  14. | Array : 'a ty -> 'a array ty
  15. | Seq : 'a ty -> 'a Seq.t ty

A range of constructors to represent built-in types

Sourcetype 'a ty_show = 'a ty * ('a -> string)

Combinator type to represent an OCaml type along with an associated to_string function

Sourceval unit : unit ty_show

Combinator to represent the unit type

Sourceval bool : bool ty_show

Combinator to represent the bool type

Sourceval char : char ty_show

Combinator to represent the char type

Sourceval int : int ty_show

Combinator to represent the int type

Sourceval int32 : int32 ty_show

Combinator to represent the int32 type

Sourceval int64 : int64 ty_show

Combinator to represent the int64 type

Sourceval float : float ty_show

Combinator to represent the float type

Sourceval string : string ty_show

Combinator to represent the string type

Sourceval bytes : bytes ty_show

Combinator to represent the bytes type

Sourceval option : 'a ty_show -> 'a option ty_show

option t builds a t option type representation

Sourceval exn : exn ty_show

Combinator to represent the exception type

Sourceval result : 'a ty_show -> 'b ty_show -> ('a, 'b) Result.t ty_show

result a b builds an (a,b) result type representation

Sourceval list : 'a ty_show -> 'a list ty_show

list t builds a t list type representation

Sourceval array : 'a ty_show -> 'a array ty_show

array t builds a t array type representation

Sourceval seq : 'a ty_show -> 'a Seq.t ty_show

seq t builds a t Seq.t type representation

Sourcetype res =
  1. | Res : 'a ty_show * 'a -> res
Sourceval show_res : res -> string
Sourcemodule type Spec = sig ... end

The specification of a state machine.

Sourcemodule type SpecExt = sig ... end

Extended specification of a state machine.

Sourcemodule SpecDefaults : sig ... end

Default implementations for state machine specifications that can be given useful defaults.

Sourcemodule Internal : sig ... end
Sourceval protect : ('a -> 'b) -> 'a -> ('b, exn) result

protect f turns an exception-throwing function into a result-returning function.