1eunit(3)                   Erlang Module Definition                   eunit(3)
2
3
4

NAME

6       eunit - This module is the main EUnit user interface.
7

DESCRIPTION

9       This module is the main EUnit user interface.
10

EXPORTS

12       start() -> term()
13
14              Starts  the  EUnit server. Normally, you don't need to call this
15              function; it is started automatically.
16
17       stop() -> term()
18
19              Stops the EUnit server. Normally, you don't need  to  call  this
20              function.
21
22       test(Tests) -> term()
23
24              Equivalent to test(Tests, []).
25
26       test(Tests::term(), Options::[term()]) -> ok | {error, term()}
27
28              Runs  a  set  of  tests. The format of Tests is described in the
29              section EUnit test representation of the overview.
30
31              Example:
32
33                eunit:test(fred)
34
35              runs all tests in the module fred and also any tests in the mod‐
36              ule fred_tests, if that module exists.
37
38              Options:
39
40                verbose:
41                  Displays more details about the running tests.
42
43                print_depth:
44                  Maximum depth to which terms are printed in case of error.
45
46                exact_execution:
47                  If this boolean flag is set to true framework will not auto‐
48                  matically execute tests found  in  related  module  suffixed
49                  with "_tests". This behaviour might be unwanted if execution
50                  of modules found in a folder is ordered  while  it  contains
51                  both source and test modules.
52
53              Options in the environment variable EUNIT are also included last
54              in the option list, i.e., have lower precedence  than  those  in
55              Options.
56
57              See also: test/1.
58

AUTHORS

60       Mickaël Rémond <mickael.remond@process-one.net>
61
62       Richard Carlsson <carlsson.richard@gmail.com>
63
64
65
66                                  eunit 2.8.1                         eunit(3)