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

NAME

6       ct_cover - Common Test framework code coverage support module.
7
8

DESCRIPTION

10       Common Test framework code coverage support module.
11
12       This  module exports help functions for performing code coverage analy‐
13       sis.
14

EXPORTS

16       add_nodes(Nodes) -> {ok, StartedNodes} | {error, Reason}
17
18              Types:
19
20                 Nodes = [atom()]
21                 StartedNodes = [atom()]
22                 Reason = cover_not_running | not_main_node
23
24              Adds nodes to current cover test. Notice that this only works if
25              cover support is active.
26
27              To   have   effect,   this   function   is  to  be  called  from
28              init_per_suite/1 (see common_test) before  any  tests  are  per‐
29              formed.
30
31       cross_cover_analyse(Level, Tests) -> ok
32
33              Types:
34
35                 Level = overview | details
36                 Tests = [{Tag, Dir}]
37                 Tag = atom()
38                 Dir = string()
39
40              Accumulates cover results over multiple tests. See section Cross
41              Cover Analysis in the Users's Guide.
42
43       remove_nodes(Nodes) -> ok | {error, Reason}
44
45              Types:
46
47                 Nodes = [atom()]
48                 Reason = cover_not_running | not_main_node
49
50              Removes nodes from the current cover test.
51
52              Call this function to stop cover test on nodes previously  added
53              with ct_cover:add_nodes/1. Results on the remote node are trans‐
54              ferred to the Common Test node.
55
56
57
58Ericsson AB                   common_test 1.18.2                   ct_cover(3)
Impressum