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.1.tar.gz
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

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

Module Tezos_test_helpers.Qcheck_helpersSource

Sourceval qcheck_wrap : ?verbose:bool -> ?long:bool -> ?rand:Random.State.t -> QCheck.Test.t list -> unit Alcotest.test_case list

Wrap QCheck tests into Alcotests.

Sourceval qcheck_eq_tests : eq:('a -> 'a -> bool) -> arb:'a QCheck.arbitrary -> eq_name:string -> QCheck.Test.t list

qcheck_eq_tests ~eq ~arb ~eq_name returns * three tests of eq: reflexivity, symmetry, and transitivity. * * eq_name should be the name of the function defining eq. * For example, given an equality function defined as let mytype_eq = ..., * call qcheck_eq_tests mytype_eq arb "mytype_eq". eq_name is * only used for logging.

Sourceval qcheck_eq : ?pp:(Format.formatter -> 'a -> unit) -> ?cmp:('a -> 'a -> int) -> ?eq:('a -> 'a -> bool) -> 'a -> 'a -> bool

qcheck_eq pp cmp eq a b evaluates whether a and b are equal, and if they are not, raises a failure and prints an error message. Equality is evaluated as follows:

  • use a provided eq
  • if no eq is provided, use a provided cmp
  • if neither eq nor cmp is provided, use Stdlib.compare

If pp is provided, use this to print x and y if they are not equal.

Sourceval qcheck_eq' : ?pp:(Format.formatter -> 'a -> unit) -> ?cmp:('a -> 'a -> int) -> ?eq:('a -> 'a -> bool) -> expected:'a -> actual:'a -> unit -> bool

Labeled variant of qcheck_eq. The unit argument is necessary as OCaml requires at least one positional (non-labeled) argument in case of optional arguments.

Sourceval qcheck_neq : ?pp:(Format.formatter -> 'a -> unit) -> ?cmp:('a -> 'a -> int) -> ?eq:('a -> 'a -> bool) -> 'a -> 'a -> bool

Similar to qcheck_eq but tests that two values are not equal.

Sourceval int64_range_gen : int64 -> int64 -> int64 QCheck.Gen.t

int64_range_gen a b generates an int64 between a inclusive and b inclusive.

Poorman's implementation until https://github.com/c-cube/qcheck/issues/105 is done.

This probably spectacularly crashes if (b - a) > Int64.max_int.

Sourceval int64_range : int64 -> int64 -> int64 QCheck.arbitrary
Sourceval int_strictly_positive_gen : int -> int QCheck.Gen.t

int_strictly_positive_gen x generates an int between 1 inclusive and x inclusive.

This will fail if x is not strictly positive.

Sourceval int64_strictly_positive_gen : int64 -> int64 QCheck.Gen.t

int64_strictly_positive_gen x generates an int64 between 1 inclusive and x inclusive.

This will fail if x is not strictly positive.

Sourceval of_option_gen : 'a option QCheck.Gen.t -> 'a QCheck.Gen.t

of_option_gen gen converts a generator gen of optional values into a generator of values by rerunning the generator if the generated value was a None until a Some is generated.

Be careful: if None is always returned, this hangs forever!

Sourceval of_option_arb : 'a option QCheck.arbitrary -> 'a QCheck.arbitrary

of_option_arb arb converts an arbitrary arb of optional values into an arbitrary of values.

  • Generation of values is delegated to of_option_gen (retries on None values until a Some is generated).
  • Shrinking uses the input shrinker but ignores None values.

Be careful: if None is always returned, this hangs forever!

Sourceval uint16 : int QCheck.arbitrary

uint16 is an arbitrary of unsigned int16 arbitrary

Sourceval int16 : int QCheck.arbitrary

int16 is an arbitrary of signed int16 arbitrary

Sourceval uint8 : int QCheck.arbitrary

uint8 is an arbitrary of unsigned int8 values

Sourceval int8 : int QCheck.arbitrary

int8 is an arbitrary of signed int8 values

Sourceval string_fixed : int -> string QCheck.arbitrary

string_fixed n is an arbitrary of string of length n.

Sourceval of_option_shrink : 'a QCheck.Shrink.t option -> 'a QCheck.Shrink.t

of_option_shrink shrink_opt returns a shrinker from an optional one. This is typically useful when extracting a shrinker from an arbitrary to compose a bigger shrinker.

If shrink_opt is None then no shrinking happens.

Sourceval bytes_arb : bytes QCheck.arbitrary

bytes_arb is a QCheck.arbitrary for bytes.

Sourceval endpoint_arb : Uri.t QCheck.arbitrary

endpoint_arb is a QCheck.arbitrary for endpoints (such as octez-client's --endpoint flag). It returns URLs of the form: (http|https)://(string\.)+(:port)?. It is by no means the most general Uri.t generator. Generalize it if needed.

Sourceval sublist : 'a list -> 'a list QCheck.Gen.t

A generator that returns a sublist of the given list. Lists returned by this generator are not in the same order as the given list (they are shuffled). This generator can return a list equal to the input list (this generator does not guarantee to return strict sublists of the input list).

Sourceval holey : 'a list -> 'a list QCheck.Gen.t

A generator that returns lists whose elements are from the given list, preserving the order. For example, given the input list 0, 1, 2, this generator can produce , 0, 0, 2, 1, 2, 1, etc.

Sourcemodule MakeMapArb (Map : Map.S) : sig ... end

Map-related arbitraries/generators.