package ppx_inline_test

You can search for identifiers within the package.

in-package search v0.2.0

Syntax extension for writing in-line tests in ocaml code

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (11)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

ppx_inline_test-v0.12.0.tar.gz

sha256=a0aaf350cfbe64638770e1afa61c492e47b233ba97ec50e40a476a22aae1cf6e

md5=b9d2642f627b9b72b13a14ae33ec7c2f

doc/ppx_inline_test.runtime-lib/Ppx_inline_test_lib/Runtime/index.html

Module `Ppx_inline_test_lib.Runtime`

module Test_result : sig ... end

type config = (module Inline_test_config.S)

type 'a test_function_args =
  config:config ->
  descr:string ->
  tags:string list ->
  filename:string ->
  line_number:int ->
  start_pos:int ->
  end_pos:int ->
  'a

val set_lib_and_partition : string -> string -> unit

val unset_lib : string -> unit

val test : ((unit -> bool) -> unit) test_function_args

val test_unit : ((unit -> unit) -> unit) test_function_args

val test_module : ((unit -> unit) -> unit) test_function_args

val summarize : unit -> Test_result.t

deprecated [since 2016-04] use add_evaluator instead

val collect : (unit -> unit) -> (unit -> unit) list

These values are meant to be used inside a user's tests.

val testing : 
  [ `Not_testing | `Testing of [ `Am_test_runner | `Am_child_of_test_runner ] ]

`Am_test_runner means the ./inline_tests_runner process, whereas `Am_child_of_test_runner means a process descended from the test runner.

val use_color : bool

val in_place : bool

val diff_command : string option

val source_tree_root : string option

val allow_output_patterns : bool

Allow patterns in tests expectation

val am_running_inline_test : bool

am_running_inline_test is true if the code is running inline tests (e.g. let%expect_test, let%test, let%test_unit) or is in an executable invoked from inline tests.

val am_running_inline_test_env_var : string

val add_evaluator : f:(unit -> Test_result.t) -> unit

Record an evaluator for an external set of tests

val exit : unit -> _

Exit with a status based on the combined result of all recorded evaluators