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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
|
(*---------------------------------------------------------------------------
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 … *)
(* Positional arguments *)
let test_pos_all =
Test.test "Arg.pos_all" @@ fun () ->
let cmd =
Cmd.make (Cmd.info "test_pos_all" ~doc:"Test pos all") @@
let+ all = Arg.(value & pos_all string [] & info [] ~docv:"THEARG") in
all
in
let parse = Testing_cmdliner.snap_parse Test.T.(list string) cmd in
let error err = Testing_cmdliner.snap_eval_error err cmd in
parse [] @@ __POS_OF__ [];
parse ["0"] @@ __POS_OF__ ["0"];
parse ["--"; "0"] @@ __POS_OF__ ["0"];
parse ["0";"1"] @@ __POS_OF__ ["0"; "1"];
parse ["0";"--"; "1"] @@ __POS_OF__ ["0"; "1"];
(**)
error `Term ["--opt"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_pos_all\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]… [\u{001B}[04mTHEARG\u{001B}[m]…\n\
test_pos_all: \u{001B}[31munknown\u{001B}[m option \u{001B}[01m--opt\u{001B}[m\n";
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_pos_all - Test pos all
SYNOPSIS
test_pos_all [OPTION]… [THEARG]…
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_pos_all exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|};
()
let test_pos_left =
Test.test "Arg.pos_left" @@ fun () ->
let cmd =
Cmd.make (Cmd.info "test_pos_left" ~doc:"Test pos left") @@
let+ left = Arg.(value & pos_left 2 string [] & info [] ~docv:"LEFT") in
left
in
let parse = Testing_cmdliner.snap_parse Test.T.(list string) cmd in
let error err = Testing_cmdliner.snap_eval_error err cmd in
parse [] @@ __POS_OF__ [];
parse ["--"] @@ __POS_OF__ [];
parse ["0"] @@ __POS_OF__ ["0"];
parse ["0"; "--"; "1" ] @@ __POS_OF__ ["0"; "1"];
parse ["0"; "1" ] @@ __POS_OF__ ["0"; "1"];
(**)
error `Term ["0"; "1"; "2"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_pos_left\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]… [\u{001B}[04mLEFT\u{001B}[m] [\u{001B}[04mLEFT\u{001B}[m]\n\
test_pos_left: \u{001B}[31mtoo many arguments\u{001B}[m, don't know what to do with \u{001B}[01m2\u{001B}[m\n";
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_pos_left - Test pos left
SYNOPSIS
test_pos_left [OPTION]… [LEFT] [LEFT]
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_pos_left exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|};
()
let test_pos_req =
Test.test "Arg.required & Arg.pos" @@ fun () ->
let cmd =
Cmd.make (Cmd.info "test_pos_req" ~doc:"Test pos req arguments") @@
let+ r1 = Arg.(required & pos 0 (some string) None & info [] ~docv:"R1")
and+ r2 = Arg.(required & pos 1 (some string) None & info [] ~docv:"R2")
and+ r3 = Arg.(required & pos 2 (some string) None & info [] ~docv:"R3")
and+ right =
Arg.(non_empty & pos_right 2 string [] & info [] ~docv:"RIGHT")
in
r1, r2, r3, right
in
let t = Test.T.(t4 string string string (list string)) in
let parse = Testing_cmdliner.snap_parse t cmd in
parse ["r1"; "r2"; "r3"; "r4"] @@ __POS_OF__ ("r1", "r2", "r3", ["r4"]);
parse ["r1"; "r2"; "r3"; "r4"; "r5"] @@ __POS_OF__
("r1", "r2", "r3", ["r4"; "r5"]);
(**)
let error = Testing_cmdliner.snap_eval_error `Term cmd in
error [] @@ __POS_OF__
"Usage: \u{001B}[01mtest_pos_req\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]… \u{001B}[04mR1\u{001B}[m \u{001B}[04mR2\u{001B}[m \u{001B}[04mR3\u{001B}[m \u{001B}[04mRIGHT\u{001B}[m…\n\
test_pos_req: required arguments \u{001B}[04mR1\u{001B}[m, \u{001B}[04mR2\u{001B}[m, \u{001B}[04mR3\u{001B}[m, \u{001B}[04mRIGHT\u{001B}[m are \u{001B}[31mmissing\u{001B}[m\n";
error ["r1"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_pos_req\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]… \u{001B}[04mR1\u{001B}[m \u{001B}[04mR2\u{001B}[m \u{001B}[04mR3\u{001B}[m \u{001B}[04mRIGHT\u{001B}[m…\n\
test_pos_req: required arguments \u{001B}[04mR2\u{001B}[m, \u{001B}[04mR3\u{001B}[m, \u{001B}[04mRIGHT\u{001B}[m are \u{001B}[31mmissing\u{001B}[m\n";
error ["r1"; "r2"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_pos_req\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]… \u{001B}[04mR1\u{001B}[m \u{001B}[04mR2\u{001B}[m \u{001B}[04mR3\u{001B}[m \u{001B}[04mRIGHT\u{001B}[m…\n\
test_pos_req: required arguments \u{001B}[04mR3\u{001B}[m, \u{001B}[04mRIGHT\u{001B}[m are \u{001B}[31mmissing\u{001B}[m\n";
error ["r1"; "r2"; "r3"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_pos_req\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]… \u{001B}[04mR1\u{001B}[m \u{001B}[04mR2\u{001B}[m \u{001B}[04mR3\u{001B}[m \u{001B}[04mRIGHT\u{001B}[m…\n\
test_pos_req: required argument \u{001B}[04mRIGHT\u{001B}[m is \u{001B}[31mmissing\u{001B}[m\n";
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_pos_req - Test pos req arguments
SYNOPSIS
test_pos_req [OPTION]… R1 R2 R3 RIGHT…
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_pos_req exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|};
()
let test_pos_left_right =
Test.test "Arg.pos_{left,right}" @@ fun () ->
let cmd =
Cmd.make (Cmd.info "test_pos" ~doc:"Test pos arguments") @@
let+ l = Arg.(value & pos_left 2 string [] & info [] ~docv:"LEFT")
and+ t = Arg.(value & pos 2 string "undefined" & info [] ~docv:"TWO")
and+ r = Arg.(value & pos_right 2 string [] & info [] ~docv:"RIGHT") in
(l, t, r)
in
let t = Test.T.(t3 (list string) string (list string)) in
let snap = Testing_cmdliner.snap_parse t cmd in
snap [] @@ __POS_OF__ ([], "undefined", []);
snap ["0"] @@ __POS_OF__ (["0"], "undefined", []);
snap ["0"; "1"] @@ __POS_OF__ (["0"; "1"], "undefined", []);
snap ["0"; "1"; "2"] @@ __POS_OF__ (["0"; "1"], "2", []);
snap ["0"; "1"; "2"; "3"] @@ __POS_OF__ (["0"; "1"], "2", ["3"]);
snap ["0"; "1"; "2"; "3"; "4"] @@ __POS_OF__ (["0"; "1"], "2", ["3"; "4"]);
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_pos - Test pos arguments
SYNOPSIS
test_pos [OPTION]… [LEFT] [LEFT] [TWO] [RIGHT]…
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_pos exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|}
;
()
let test_pos_left_right_rev =
Test.test "Arg.pos_{left,right} ~rev:true" @@ fun () ->
let cmd =
Cmd.make (Cmd.info "test_pos" ~doc:"Test pos arguments") @@
let rev = true in
let+ l = Arg.(value & pos_left 2 ~rev string [] & info [] ~docv:"LEFT")
and+ t = Arg.(value & pos 2 ~rev string "undefined" & info [] ~docv:"TWO")
and+ r = Arg.(value & pos_right 2 ~rev string [] & info [] ~docv:"RIGHT") in
(l, t, r)
in
let t = Test.T.(t3 (list string) string (list string)) in
let snap = Testing_cmdliner.snap_parse t cmd in
snap [] @@ __POS_OF__ ([], "undefined", []);
snap ["0"] @@ __POS_OF__ ([], "undefined", ["0"]);
snap ["0"; "1"] @@ __POS_OF__ ([], "undefined", ["0"; "1"]);
snap ["0"; "1"; "2"] @@ __POS_OF__ ([], "0", ["1"; "2"]);
snap ["0"; "1"; "2"; "3"] @@ __POS_OF__ (["0"], "1", ["2"; "3"]);
snap ["0"; "1"; "2"; "3"; "4"] @@ __POS_OF__ (["0"; "1"], "2", ["3"; "4"]);
snap ["0"; "1"; "2"; "3"; "4"; "5"] @@ __POS_OF__
(["0"; "1"; "2"], "3", ["4"; "5"]);
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_pos - Test pos arguments
SYNOPSIS
test_pos [OPTION]… [LEFT]… [TWO] [RIGHT] [RIGHT]
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_pos exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|};
()
(* Optional arguments *)
let test_opt_required =
Test.test "Arg.required & Arg.opt" @@ fun () ->
let cmd =
let doc = "Test optional required arguments (don't do this)" in
Cmd.make (Cmd.info "test_opt_req" ~doc) @@
let+ req =
Arg.(required & opt (some string) None & info ["r"; "req"] ~docv:"ARG")
in
req
in
let snap = Testing_cmdliner.snap_parse Test.T.string cmd in
snap ["-ra"] @@ __POS_OF__ "a";
snap ["--req"; "a"] @@ __POS_OF__ "a";
(**)
let error err = Testing_cmdliner.snap_eval_error err cmd in
error `Parse [] @@ __POS_OF__
"Usage: \u{001B}[01mtest_opt_req\u{001B}[m [\u{001B}[01m--help\u{001B}[m] \u{001B}[01m--req\u{001B}[m=\u{001B}[04mARG\u{001B}[m [\u{001B}[04mOPTION\u{001B}[m]…\n\
test_opt_req: required option \u{001B}[01m--req\u{001B}[m is \u{001B}[31mmissing\u{001B}[m\n";
error `Term ["a"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_opt_req\u{001B}[m [\u{001B}[01m--help\u{001B}[m] \u{001B}[01m--req\u{001B}[m=\u{001B}[04mARG\u{001B}[m [\u{001B}[04mOPTION\u{001B}[m]…\n\
test_opt_req: \u{001B}[31mtoo many arguments\u{001B}[m, don't know what to do with \u{001B}[01ma\u{001B}[m\n";
error `Term ["-ra"; "a"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_opt_req\u{001B}[m [\u{001B}[01m--help\u{001B}[m] \u{001B}[01m--req\u{001B}[m=\u{001B}[04mARG\u{001B}[m [\u{001B}[04mOPTION\u{001B}[m]…\n\
test_opt_req: \u{001B}[31mtoo many arguments\u{001B}[m, don't know what to do with \u{001B}[01ma\u{001B}[m\n";
error `Parse ["-r"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_opt_req\u{001B}[m [\u{001B}[01m--help\u{001B}[m] \u{001B}[01m--req\u{001B}[m=\u{001B}[04mARG\u{001B}[m [\u{001B}[04mOPTION\u{001B}[m]…\n\
test_opt_req: option \u{001B}[01m-r\u{001B}[m \u{001B}[31mneeds an argument\u{001B}[m\n";
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_opt_req - Test optional required arguments (don't do this)
SYNOPSIS
test_opt_req --req=ARG [OPTION]…
OPTIONS
-r ARG, --req=ARG (required)
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_opt_req exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|};
()
let test_arg_info_docv =
Test.test "Arg.info default's docv on strings" @@ fun () ->
let cmd =
Cmd.make (Cmd.info "test_arg_docv" ~doc:"Test pos all") @@
let+ all = Arg.(value & pos_all string [] & info [])
and+ opt = Arg.(value & opt string "bla" & info ["field"]) in
all, opt
in
let error err = Testing_cmdliner.snap_eval_error err cmd in
(**)
error `Term ["-z"; "a"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_arg_docv\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[01m--field\u{001B}[m=\u{001B}[04mVAL\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]… [\u{001B}[04mARG\u{001B}[m]…\n\
test_arg_docv: \u{001B}[31munknown\u{001B}[m option \u{001B}[01m-z\u{001B}[m\n";
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_arg_docv - Test pos all
SYNOPSIS
test_arg_docv [--field=VAL] [OPTION]… [ARG]…
OPTIONS
--field=VAL (absent=bla)
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_arg_docv exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|};
()
let test_conv_docv =
Test.test "Arg.Conv.docv" @@ fun () ->
let cmd =
let field = Arg.Conv.of_conv Arg.string ~docv:"FIELD" in
Cmd.make (Cmd.info "test_conv_docv" ~doc:"Test conv docv") @@
let+ all = Arg.(value & pos_all field [] & info [])
and+ opt = Arg.(value & opt field "bla" & info ["field"]) in
all, opt
in
let error err = Testing_cmdliner.snap_eval_error err cmd in
(**)
error `Term ["-z"; "a"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_conv_docv\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[01m--field\u{001B}[m=\u{001B}[04mFIELD\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]… [\u{001B}[04mFIELD\u{001B}[m]…\n\
test_conv_docv: \u{001B}[31munknown\u{001B}[m option \u{001B}[01m-z\u{001B}[m\n";
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_conv_docv - Test conv docv
SYNOPSIS
test_conv_docv [--field=FIELD] [OPTION]… [FIELD]…
OPTIONS
--field=FIELD (absent=bla)
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_conv_docv exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|};
()
let test_arg_file =
Test.test "Arg.file" @@ fun () ->
let cmd =
Cmd.make (Cmd.info "test_arg_file" ~doc:"Test conv docv") @@
let+ all = Arg.(value & pos_all file [] & info []) in
all
in
let error err = Testing_cmdliner.snap_eval_error err cmd in
let parse = Testing_cmdliner.snap_parse Test.T.(list string) cmd in
parse ["-"] @@ __POS_OF__ ["-"];
(**)
error `Term ["-z"; "a"] @@ __POS_OF__
"Usage: \u{001B}[01mtest_arg_file\u{001B}[m [\u{001B}[01m--help\u{001B}[m] [\u{001B}[04mOPTION\u{001B}[m]… [\u{001B}[04mPATH\u{001B}[m]…\n\
test_arg_file: \u{001B}[31munknown\u{001B}[m option \u{001B}[01m-z\u{001B}[m\n";
(**)
Testing_cmdliner.snap_man cmd @@ __POS_OF__
{|NAME
test_arg_file - Test conv docv
SYNOPSIS
test_arg_file [OPTION]… [PATH]…
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_arg_file exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
|};
()
let main () =
let doc = "Test argument specifications" in
Test.main ~doc @@ fun () -> Test.autorun ()
let () = if !Sys.interactive then () else exit (main ())
|
