(*--------------------------------------------------------------------------- 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 ())