13558: Merge branch 'master' into wtsi-hgi-13558-debug-log-tag-req-id
[arvados.git] / lib / cmd / cmd.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: Apache-2.0
4
5 // package cmd helps define reusable functions that can be exposed as
6 // [subcommands of] command line programs.
7 package cmd
8
9 import (
10         "flag"
11         "fmt"
12         "io"
13         "io/ioutil"
14         "path/filepath"
15         "regexp"
16         "runtime"
17         "sort"
18         "strings"
19 )
20
21 type Handler interface {
22         RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int
23 }
24
25 type HandlerFunc func(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int
26
27 func (f HandlerFunc) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
28         return f(prog, args, stdin, stdout, stderr)
29 }
30
31 type Version string
32
33 func (v Version) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
34         prog = regexp.MustCompile(` -*version$`).ReplaceAllLiteralString(prog, "")
35         fmt.Fprintf(stdout, "%s %s (%s)\n", prog, v, runtime.Version())
36         return 0
37 }
38
39 // Multi is a Handler that looks up its first argument in a map, and
40 // invokes the resulting Handler with the remaining args.
41 //
42 // Example:
43 //
44 //     os.Exit(Multi(map[string]Handler{
45 //             "foobar": HandlerFunc(func(prog string, args []string) int {
46 //                     fmt.Println(args[0])
47 //                     return 2
48 //             }),
49 //     })("/usr/bin/multi", []string{"foobar", "baz"}))
50 //
51 // ...prints "baz" and exits 2.
52 type Multi map[string]Handler
53
54 func (m Multi) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
55         _, basename := filepath.Split(prog)
56         basename = strings.TrimPrefix(basename, "arvados-")
57         basename = strings.TrimPrefix(basename, "crunch-")
58         if cmd, ok := m[basename]; ok {
59                 return cmd.RunCommand(prog, args, stdin, stdout, stderr)
60         } else if len(args) < 1 {
61                 fmt.Fprintf(stderr, "usage: %s command [args]\n", prog)
62                 m.Usage(stderr)
63                 return 2
64         } else if cmd, ok = m[args[0]]; ok {
65                 return cmd.RunCommand(prog+" "+args[0], args[1:], stdin, stdout, stderr)
66         } else {
67                 fmt.Fprintf(stderr, "%s: unrecognized command %q\n", prog, args[0])
68                 m.Usage(stderr)
69                 return 2
70         }
71 }
72
73 func (m Multi) Usage(stderr io.Writer) {
74         fmt.Fprintf(stderr, "\nAvailable commands:\n")
75         m.listSubcommands(stderr, "")
76 }
77
78 func (m Multi) listSubcommands(out io.Writer, prefix string) {
79         var subcommands []string
80         for sc := range m {
81                 if strings.HasPrefix(sc, "-") {
82                         // Some subcommands have alternate versions
83                         // like "--version" for compatibility. Don't
84                         // clutter the subcommand summary with those.
85                         continue
86                 }
87                 subcommands = append(subcommands, sc)
88         }
89         sort.Strings(subcommands)
90         for _, sc := range subcommands {
91                 switch cmd := m[sc].(type) {
92                 case Multi:
93                         cmd.listSubcommands(out, prefix+sc+" ")
94                 default:
95                         fmt.Fprintf(out, "    %s%s\n", prefix, sc)
96                 }
97         }
98 }
99
100 type FlagSet interface {
101         Init(string, flag.ErrorHandling)
102         Args() []string
103         NArg() int
104         Parse([]string) error
105         SetOutput(io.Writer)
106         PrintDefaults()
107 }
108
109 // SubcommandToFront silently parses args using flagset, and returns a
110 // copy of args with the first non-flag argument moved to the
111 // front. If parsing fails or consumes all of args, args is returned
112 // unchanged.
113 //
114 // SubcommandToFront invokes methods on flagset that have side
115 // effects, including Parse. In typical usage, flagset will not used
116 // for anything else after being passed to SubcommandToFront.
117 func SubcommandToFront(args []string, flagset FlagSet) []string {
118         flagset.Init("", flag.ContinueOnError)
119         flagset.SetOutput(ioutil.Discard)
120         if err := flagset.Parse(args); err != nil || flagset.NArg() == 0 {
121                 // No subcommand found.
122                 return args
123         }
124         // Move subcommand to the front.
125         flagargs := len(args) - flagset.NArg()
126         newargs := make([]string, len(args))
127         newargs[0] = args[flagargs]
128         copy(newargs[1:flagargs+1], args[:flagargs])
129         copy(newargs[flagargs+1:], args[flagargs+1:])
130         return newargs
131 }