-
Notifications
You must be signed in to change notification settings - Fork 80
/
alcotest-help.txt
110 lines (77 loc) · 3.24 KB
/
alcotest-help.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
NAME
test.exe - Run all the tests.
SYNOPSIS
test.exe [COMMAND] …
COMMANDS
list [--color=WHEN] [OPTION]…
List all available tests.
test [OPTION]… [NAME_REGEX] [TESTCASES]
Run a subset of the tests.
ARGUMENTS
NAME_REGEX
A regular expression matching the names of tests to run
TESTCASES
A comma-separated list of test case numbers (and ranges of
numbers) to run, e.g: '4,6-10,19'. When specifying ranges, both
'-' and '..' are accepted as valid separators.
OPTIONS
--bail (absent ALCOTEST_BAIL env)
Stop running tests after the first failure.
-c, --compact (absent ALCOTEST_COMPACT env)
Compact the output of the tests.
--color=WHEN (absent ALCOTEST_COLOR env)
Colorize the output. WHEN must be one of auto, always or never.
Defaults to 'always' when running inside Dune, otherwise defaults
to 'auto'.
-e, --show-errors (absent ALCOTEST_SHOW_ERRORS env)
Display the test errors.
--json
Display JSON for the results, to be used by a script.
-o DIR
Where to store the log files of the tests.
-q, --quick-tests (absent ALCOTEST_QUICK_TESTS env)
Run only the quick tests.
--tail-errors=N (absent ALCOTEST_TAIL_ERRORS env)
Show only the last N lines of output in case of an error.
-v, --verbose (absent ALCOTEST_VERBOSE env)
Display the test outputs. WARNING: when using this option the
output logs will not be available for further inspection.
COMMON OPTIONS
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of auto,
pager, groff or plain. With auto, the format is pager or plain
whenever the TERM env var is dumb or undefined.
EXIT STATUS
test.exe exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
125 on unexpected internal errors (bugs).
ENVIRONMENT
These environment variables affect the execution of test.exe:
ALCOTEST_BAIL
See option --bail.
ALCOTEST_COLOR
See option --color.
ALCOTEST_COLUMNS
Number of columns after which Alcotest truncates or splits written
lines. Default is to auto-detect using the terminal's dimensions,
or fallback to 80 columns.
ALCOTEST_COMPACT
See option --compact.
ALCOTEST_QUICK_TESTS
See option --quick-tests.
ALCOTEST_SHOW_ERRORS
See option --show-errors.
ALCOTEST_SOURCE_CODE_POSITION
Whether Alcotest should guess the source code position of test
failures, if any. Defaults to true, set to a falsy value to
disable.
ALCOTEST_TAIL_ERRORS
See option --tail-errors.
ALCOTEST_VERBOSE
See option --verbose.
CI Whether Alcotest is running in a CI system, if set to 'true'.
GITHUB_ACTIONS
Whether Alcotest is running in GitHub Actions, if set to 'true'.
Display tests errors and outputs GitHub Actions annotations.