package octez-libs

  1. Overview
  2. Docs
A package that contains multiple base libraries used by the Octez suite

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.0.tar.gz
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a

doc/octez-libs.test-helpers/Tezos_test_helpers/Assert/index.html

Module Tezos_test_helpers.AssertSource

module Assert contains Alcotest convenience assertions.

Type definitions

Sourcetype ('ty, 'res) t = ?loc:string -> ?msg:string -> 'ty -> 'ty -> 'res

An assertion that a relation between two elements of 'ty holds true. This assertion returns a value of type 'res when it succeeds, typically unit, as in check2. *

Sourcetype ('ty, 'res) assertion = ('ty, 'res) t

Alias for t used in EQUALITIES.

Sourcetype 'ty check2 = ('ty, unit) t

A 'a check2 is an assertion over two elements of type 'a returning unit when it holds.

Sourcetype 'ty check1 = ?loc:string -> ?msg:string -> 'ty -> unit

A 'a check1 defines the check of a property of a single element of type 'a.

See is_none or is_true for examples.

Sourcetype ('base_ty, 'container_ty) equality_check = ?eq:('base_ty -> 'base_ty -> bool) -> ?pp:(Format.formatter -> 'base_ty -> unit) -> 'container_ty check2

An equality_check is an assertion that the boolean relation defined by eq holds on two series -- of type 'container_ty -- of elements of 'base_ty,

This typically defines the type of assertions on lists (see equal_list), or arrays, but it is also used to defined new checks based on an equality function.

Sourcetype ('base_ty, 'container_ty) comparison_check = ?cmp:('base_ty -> 'base_ty -> int) -> ?pp:(Format.formatter -> 'base_ty -> unit) -> 'container_ty check2

A comparison_check is similar to a equality_check except the assertion is based on the optional comparison function cmp.

Base definitions

Failures

Sourceval fail : ?loc:string -> ?msg:string -> (Format.formatter -> 'a -> unit) -> 'a -> 'a -> 'b

fail ?loc ?msg pp x y fails after printing message "<loc> <msg>: expected <x> got <y>".

  • when msg is omitted "<msg:> " is not printed
  • when loc is omitted "<loc> " is not printed
Sourceval fail_msg : ('a, Format.formatter, unit, 'b) format4 -> 'a

fail_msg fmt fails after pretty-printing fmt

Assertions based on (un)equalities

Sourceval equal : ('a, 'a) equality_check

equal ?eq ?pp ?msg ?loc a b checks that eq a b and if not calls fail pp a b msg loc

  • parameter msg

    is not set by default

  • parameter loc

    is not set by default

  • parameter eq

    defaults to Stdlib.( = )

  • parameter pp

    is the pretty-printer for type 'a, defaults to printing nothing

  • raises Failure

    when eq a b is false

Sourceval unequal : ('a, 'a) equality_check

unequal ?eq ?pp ?msg ?loc a b checks that eq a b does not hold. See equal for the rest of the documentation.

Sourceval equal_list : ('a, 'a list) equality_check

equal_list ?eq ?pp ?msg ?loc l1 l2 is like equal but for polymorphic lists 'a list.

  • parameter msg

    is not set by default

  • parameter loc

    is not set by default

  • parameter eq

    defaults to Stdlib.( = )

  • parameter pp

    is the pretty-printer for type 'a, defaults to printing nothing

  • raises Failure

    when List.equal eq a b is false

Sourceval equal_list_list : ('a, 'a list list) equality_check

equal_list_list is like equal but for polymorphic lists of lists 'a list list.

  • parameter msg

    is not set by default

  • parameter loc

    is not set by default

  • parameter eq

    defaults to Stdlib.( = )

  • parameter pp

    is the pretty-printer for type 'a, defaults to printing nothing

  • raises Failure

    when List.equal (List.equal eq) a b is false

Assertions based on comparisons

Sourceval leq : ('a, 'a) comparison_check

leq ?cmp ?pp ?loc ?msg a b checks that cmp a b <= 0.

  • parameter msg

    is not set by default

  • parameter loc

    is not set by default

  • parameter cmd

    defaults to Stdlib.compare

  • parameter pp

    is the pretty-printer for type 'a, defaults to printing nothing

Sourceval lt : ('a, 'a) comparison_check

lt ?cmp ?pp ?loc ?msg a b checks that cmp a b < 0.

See leq for details of the parameters.

Sourceval geq : ('a, 'a) comparison_check

geq ?cmp ?pp ?loc ?msg a b checks that cmp a b >= 0.

See leq for details of the parameters.

Sourceval gt : ('a, 'a) comparison_check

gt ?cmp ?pp ?loc ?msg a b checks that cmp a b > 0.

See leq for details of the parameters.

Miscellaneous assertions

Sourceval assert_true : string -> bool -> unit

Alcotest check that b is true.

Sourceval assert_false : string -> bool -> unit

Alcotest check that b is false.

Sourceval impossible : string -> unit

Alcotest version of assert false.

Sourceval check_any : ?msg:string -> ('a -> bool) -> 'a list -> unit

Assert that at least one value in l satisfies f.

contains m msg x ls asserts that one testable in ls equals x, and otherwise fails with msg

Sourceval contains : 'a Alcotest.testable -> string -> 'a -> 'a list -> unit

Monomorphic equality checks

Sourceval is_none : ?loc:string -> ?msg:string -> ?pp:(Format.formatter -> 'a -> unit) -> 'a option -> unit

Check that an option value is None.

  • parameter msg

    is not set by default

  • parameter loc

    is not set by default

  • parameter eq

    defaults to Stdlib.( = )

  • parameter pp

    is the pretty-printer for type 'a, defaults to printing "Some _" as a placeholder for non-None value.

Module type signatures

Sourcemodule type EQUALITIES = sig ... end

Assertions for equality/disequality

Sourcemodule type COMPARISONS = sig ... end

Checks for extra binary relations

Predefined modules for base types

Sourcemodule Bytes : COMPARISONS with type t = bytes
Sourcemodule Bool : COMPARISONS with type t = bool
Sourceval is_true : bool check1
Sourceval is_false : bool check1
Sourcemodule String : sig ... end
Sourcemodule Int32 : sig ... end
Sourcemodule Int64 : sig ... end
Sourcemodule Int : sig ... end

Functors

Sourcemodule type COMPARABLE = sig ... end
Sourcemodule type EQUALABLE = sig ... end
Sourcemodule Make_equalities (X : EQUALABLE) : EQUALITIES with type t = X.t

Provide equality-based assertions for type X.t

Provide all comparisons assertions for type X.t