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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
(*---------------------------------------------------------------------------
Copyright (c) 2025 The cmdliner programmers. All rights reserved.
SPDX-License-Identifier: ISC
---------------------------------------------------------------------------*)
open B0_std
open B0_testing
open Cmdliner
open Cmdliner.Term.Syntax
(* The tests have the following structure:
let test =
let cmd = … (* A command definition *) in
(* A few snapshots of valid cli parses *)
parse …
(* A few snapshots of invalid cli parses *)
error …
(* A snapshot of a plain text version of the manual *)
Testing_cmdliner.snap_man … *)
let test_groups =
Test.test "Cmd.group" @@ fun () ->
let cmd = Testing_cmdliner.sample_group_cmd in
let parse = Testing_cmdliner.snap_parse Test.T.unit cmd in
let error err = Testing_cmdliner.snap_eval_error err cmd in
let warning = Testing_cmdliner.snap_parse_warnings cmd in
parse ["birds"] @@ __POS_OF__ ();
parse ["birds"] @@ __POS_OF__ ();
parse ["birds"; "fly"] @@ __POS_OF__ ();
parse ["birds"; "land"] @@ __POS_OF__ ();
parse ["mammals"] @@ __POS_OF__ ();
(**)
warning ["camels"] @@ __POS_OF__
"test_group: \u{001B}[33mdeprecated\u{001B}[m command \u{001B}[01mcamels\u{001B}[m: Use \u{001B}[01mmammals\u{001B}[m instead.\n";
(**)
error `Term [] @@ __POS_OF__
"Usage: \u{001B}[01mtest_group\u{001B}[m [\u{001B}[01m--help\u{001B}[m] \u{001B}[04mCOMMAND\u{001B}[m …\n\
test_group: required \u{001B}[04mCOMMAND\u{001B}[m name is \u{001B}[31mmissing\u{001B}[m, must be one of \u{001B}[01mbirds\u{001B}[m, \u{001B}[01mcamels\u{001B}[m,\n\
\ \u{001B}[01mfishs\u{001B}[m, \u{001B}[01mlookup\u{001B}[m or \u{001B}[01mmammals\u{001B}[m\n";
error `Term ["bla"] @@ __POS_OF__ "Usage: \u{001B}[01mtest_group\u{001B}[m [\u{001B}[01m--help\u{001B}[m] \u{001B}[04mCOMMAND\u{001B}[m …\n\
test_group: \u{001B}[31munknown\u{001B}[m command \u{001B}[01mbla\u{001B}[m. Must be one of \u{001B}[01mbirds\u{001B}[m, \u{001B}[01mcamels\u{001B}[m, \u{001B}[01mfishs\u{001B}[m, \u{001B}[01mlookup\u{001B}[m\n\
\ or \u{001B}[01mmammals\u{001B}[m\n";
error `Parse ["birds"; "-k"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_group birds\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[04mCOMMAND\u{001B}[m] …\n\
test_group: option \u{001B}[01m-k\u{001B}[m \u{001B}[31mneeds an argument\u{001B}[m\n";
error `Term ["mammals"; "land"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_group mammals\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]…\n\
test_group: \u{001B}[31mtoo many arguments\u{001B}[m, don't know what to do with \u{001B}[01mland\u{001B}[m\n";
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_group
SYNOPSIS
test_group COMMAND …
Invoke command with test_group, the command name is test_group, the
parent is test_group and the tool name is test_group.
COMMANDS
birds [COMMAND] …
Operate on birds.
fishs [OPTION]… [NAME]
Operate on fishs.
lookup [--kind=ENUM] [OPTION]… NAME
Lookup animal by name.
mammals [OPTION]…
Operate on mammals.
(Deprecated) camels [--bactrian] [OPTION]… [HERD]
Use mammals instead. Operate on camels.
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.
--version
Show version information.
EXIT STATUS
test_group exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|};
Testing_cmdliner.snap_man ~args:["birds"; "--help=plain"] cmd @@ __POS_OF__
{|NAME
test_group-birds - Operate on birds.
SYNOPSIS
test_group birds [COMMAND] …
Invoke command with test_group birds, the command name is birds, the
parent is test_group and the tool name is test_group.
COMMANDS
fly [--speed=SPEED] [OPTION]… [BIRD]
Fly birds.
land [OPTION]… [BIRD]
Land birds.
OPTIONS
--can-fly=BOOL (absent=false)
BOOL indicates if the entity can fly.
-k VAL, --kind=VAL
Kind of entity
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.
--version
Show version information.
EXIT STATUS
test_group birds 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).
SEE ALSO|};
();
Testing_cmdliner.snap_man ~args:["birds"; "fly"; "--help=plain"] cmd @@
__POS_OF__
{|NAME
test_group-birds-fly - Fly birds.
SYNOPSIS
test_group birds fly [--speed=SPEED] [OPTION]… [BIRD]
Invoke command with test_group birds fly, the command name is fly, the
parent is test_group birds and the tool name is test_group.
ARGUMENTS
BIRD (absent=pigeon)
Use BIRD specie.
OPTIONS
--speed=SPEED (absent=2)
Movement SPEED in m/s
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.
--version
Show version information.
EXIT STATUS
test_group birds fly 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).
SEE ALSO|};
Testing_cmdliner.snap_man ~args:["birds"; "land"; "--help=plain"] cmd @@
__POS_OF__
{|NAME
test_group-birds-land - Land birds.
SYNOPSIS
test_group birds land [OPTION]… [BIRD]
Invoke command with test_group birds land, the command name is land,
the parent is test_group birds and the tool name is test_group.
ARGUMENTS
BIRD (absent=pigeon)
Use BIRD specie.
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.
--version
Show version information.
EXIT STATUS
test_group birds land 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).
SEE ALSO|};
();
Testing_cmdliner.snap_man ~args:["fishs"; "--help=plain"] cmd @@
__POS_OF__
{|NAME
test_group-fishs - Operate on fishs.
SYNOPSIS
test_group fishs [OPTION]… [NAME]
Invoke command with test_group fishs, the command name is fishs, the
parent is test_group and the tool name is test_group.
ARGUMENTS
NAME
Use fish named NAME.
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.
--version
Show version information.
EXIT STATUS
test_group fishs 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).
SEE ALSO|};
Testing_cmdliner.snap_man ~args:["mammals"; "--help=plain"] cmd @@
__POS_OF__
{|NAME
test_group-mammals - Operate on mammals.
SYNOPSIS
test_group mammals [OPTION]…
Invoke command with test_group mammals, the command name is mammals,
the parent is test_group and the tool name is test_group.
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.
--version
Show version information.
EXIT STATUS
test_group mammals 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).
SEE ALSO|};
Testing_cmdliner.snap_man ~args:["camels"; "--help=plain"] cmd @@
__POS_OF__
{|NAME
(Deprecated) test_group-camels - Use mammals instead. Operate on
camels.
SYNOPSIS
(Deprecated) test_group camels [--bactrian] [OPTION]… [HERD]
Invoke command with test_group camels, the command name is camels, the
parent is test_group and the tool name is test_group.
ARGUMENTS
(Deprecated) HERD
Herds HERD are ignored. Find in herd HERD.
OPTIONS
(Deprecated) -b, --bactrian (absent BACTRIAN env)
Use nothing instead of BACTRIAN, HA!. Specify a bactrian camel.
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.
--version
Show version information.
EXIT STATUS
test_group camels 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_group camels:
(Deprecated) BACTRIAN
Use nothing instead of BACTRIAN, HA!. See option --bactrian.
SEE ALSO|};
()
let test_std_opts =
Test.test "Standard options" @@ fun () ->
let cmd = Testing_cmdliner.sample_group_cmd in
let snap_version = Testing_cmdliner.snap_help (Ok `Version) cmd in
let ret ?__POS__ =
let env = Testing_cmdliner.env_dumb_term in
Testing_cmdliner.test_eval_result ?__POS__ ~env Test.T.unit cmd
in
snap_version ["--version"] @@ __POS_OF__ "X.Y.Z\n";
snap_version ["--version"; "birds"] @@ __POS_OF__ "X.Y.Z\n";
snap_version ["fishs"; "--version"; "birds"] @@ __POS_OF__ "X.Y.Z\n";
ret ["--help"; "--version"] (Ok `Help) ~__POS__;
ret ["--help"; "--version"] (Ok `Help) ~__POS__;
ret ["fishs"; "--version"; "birds"; "--help"] (Ok `Help) ~__POS__;
ret ["--help"; "crow"] (Ok `Help) ~__POS__;
ret ["birds"; "--help"; "crow"] (Ok `Help) ~__POS__;
ret ["fishs"; "--"; "--help"] (Ok (`Ok ())) ~__POS__;
()
let main () =
let doc = "Test command specifications" in
Test.main ~doc @@ fun () -> Test.autorun ()
let () = if !Sys.interactive then () else exit (main ())
|
