Merge branch '15759-deploy-crunch-run'
[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 // Version is a Handler that prints the package version (set at build
32 // time using -ldflags) and Go runtime version to stdout, and returns
33 // 0.
34 var Version versionCommand
35
36 var version = "dev"
37
38 type versionCommand struct{}
39
40 func (versionCommand) String() string {
41         return fmt.Sprintf("%s (%s)", version, runtime.Version())
42 }
43
44 func (versionCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
45         prog = regexp.MustCompile(` -*version$`).ReplaceAllLiteralString(prog, "")
46         fmt.Fprintf(stdout, "%s %s (%s)\n", prog, version, runtime.Version())
47         return 0
48 }
49
50 // Multi is a Handler that looks up its first argument in a map (after
51 // stripping any "arvados-" or "crunch-" prefix), and invokes the
52 // resulting Handler with the remaining args.
53 //
54 // Example:
55 //
56 //     os.Exit(Multi(map[string]Handler{
57 //             "foobar": HandlerFunc(func(prog string, args []string) int {
58 //                     fmt.Println(args[0])
59 //                     return 2
60 //             }),
61 //     })("/usr/bin/multi", []string{"foobar", "baz"}))
62 //
63 // ...prints "baz" and exits 2.
64 type Multi map[string]Handler
65
66 func (m Multi) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
67         _, basename := filepath.Split(prog)
68         if i := strings.Index(basename, "~"); i >= 0 {
69                 // drop "~anything" suffix (arvados-dispatch-cloud's
70                 // DeployRunnerBinary feature relies on this)
71                 basename = basename[:i]
72         }
73         cmd, ok := m[basename]
74         if !ok {
75                 // "controller" command exists, and binary is named "arvados-controller"
76                 cmd, ok = m[strings.TrimPrefix(basename, "arvados-")]
77         }
78         if !ok {
79                 // "dispatch-slurm" command exists, and binary is named "crunch-dispatch-slurm"
80                 cmd, ok = m[strings.TrimPrefix(basename, "crunch-")]
81         }
82         if ok {
83                 return cmd.RunCommand(prog, args, stdin, stdout, stderr)
84         } else if len(args) < 1 {
85                 fmt.Fprintf(stderr, "usage: %s command [args]\n", prog)
86                 m.Usage(stderr)
87                 return 2
88         } else if cmd, ok = m[args[0]]; ok {
89                 return cmd.RunCommand(prog+" "+args[0], args[1:], stdin, stdout, stderr)
90         } else {
91                 fmt.Fprintf(stderr, "%s: unrecognized command %q\n", prog, args[0])
92                 m.Usage(stderr)
93                 return 2
94         }
95 }
96
97 func (m Multi) Usage(stderr io.Writer) {
98         fmt.Fprintf(stderr, "\nAvailable commands:\n")
99         m.listSubcommands(stderr, "")
100 }
101
102 func (m Multi) listSubcommands(out io.Writer, prefix string) {
103         var subcommands []string
104         for sc := range m {
105                 if strings.HasPrefix(sc, "-") {
106                         // Some subcommands have alternate versions
107                         // like "--version" for compatibility. Don't
108                         // clutter the subcommand summary with those.
109                         continue
110                 }
111                 subcommands = append(subcommands, sc)
112         }
113         sort.Strings(subcommands)
114         for _, sc := range subcommands {
115                 switch cmd := m[sc].(type) {
116                 case Multi:
117                         cmd.listSubcommands(out, prefix+sc+" ")
118                 default:
119                         fmt.Fprintf(out, "    %s%s\n", prefix, sc)
120                 }
121         }
122 }
123
124 type FlagSet interface {
125         Init(string, flag.ErrorHandling)
126         Args() []string
127         NArg() int
128         Parse([]string) error
129         SetOutput(io.Writer)
130         PrintDefaults()
131 }
132
133 // SubcommandToFront silently parses args using flagset, and returns a
134 // copy of args with the first non-flag argument moved to the
135 // front. If parsing fails or consumes all of args, args is returned
136 // unchanged.
137 //
138 // SubcommandToFront invokes methods on flagset that have side
139 // effects, including Parse. In typical usage, flagset will not used
140 // for anything else after being passed to SubcommandToFront.
141 func SubcommandToFront(args []string, flagset FlagSet) []string {
142         flagset.Init("", flag.ContinueOnError)
143         flagset.SetOutput(ioutil.Discard)
144         if err := flagset.Parse(args); err != nil || flagset.NArg() == 0 {
145                 // No subcommand found.
146                 return args
147         }
148         // Move subcommand to the front.
149         flagargs := len(args) - flagset.NArg()
150         newargs := make([]string, len(args))
151         newargs[0] = args[flagargs]
152         copy(newargs[1:flagargs+1], args[:flagargs])
153         copy(newargs[flagargs+1:], args[flagargs+1:])
154         return newargs
155 }