This repository has been archived by the owner on Nov 27, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 251
/
main.go
429 lines (374 loc) · 11.3 KB
/
main.go
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
/*
Copyright 2020 Docker Compose CLI authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
import (
"context"
"fmt"
"math/rand"
"os"
"os/signal"
"path/filepath"
"regexp"
"strings"
"syscall"
"time"
"github.com/compose-spec/compose-go/types"
"github.com/docker/cli/cli"
compose2 "github.com/docker/compose/v2/cmd/compose"
"github.com/docker/compose/v2/pkg/api"
"github.com/docker/compose/v2/pkg/compose"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/docker/compose-cli/api/backend"
"github.com/docker/compose-cli/api/config"
apicontext "github.com/docker/compose-cli/api/context"
"github.com/docker/compose-cli/api/context/store"
"github.com/docker/compose-cli/cli/cmd"
contextcmd "github.com/docker/compose-cli/cli/cmd/context"
"github.com/docker/compose-cli/cli/cmd/login"
"github.com/docker/compose-cli/cli/cmd/logout"
"github.com/docker/compose-cli/cli/cmd/run"
"github.com/docker/compose-cli/cli/cmd/volume"
cliconfig "github.com/docker/compose-cli/cli/config"
"github.com/docker/compose-cli/cli/metrics"
"github.com/docker/compose-cli/cli/mobycli"
cliopts "github.com/docker/compose-cli/cli/options"
"github.com/docker/compose-cli/local"
// Backend registrations
_ "github.com/docker/compose-cli/aci"
_ "github.com/docker/compose-cli/ecs"
_ "github.com/docker/compose-cli/ecs/local"
_ "github.com/docker/compose-cli/local"
)
var (
metricsClient metrics.Client
contextAgnosticCommands = map[string]struct{}{
"context": {},
"login": {},
"logout": {},
"serve": {},
"version": {},
"backend-metadata": {},
// Special hidden commands used by cobra for completion
"__complete": {},
"__completeNoDesc": {},
}
unknownCommandRegexp = regexp.MustCompile(`unknown docker command: "([^"]*)"`)
)
func init() {
// initial hack to get the path of the project's bin dir
// into the env of this cli for development
path, err := filepath.Abs(filepath.Dir(os.Args[0]))
if err != nil {
fatal(errors.Wrap(err, "unable to get absolute bin path"))
}
if err := os.Setenv("PATH", appendPaths(os.Getenv("PATH"), path)); err != nil {
panic(err)
}
metricsClient = metrics.NewDefaultClient()
metricsClient.WithCliVersionFunc(func() string {
return mobycli.CliVersion()
})
// Seed random
rand.Seed(time.Now().UnixNano())
}
func appendPaths(envPath string, path string) string {
if envPath == "" {
return path
}
return strings.Join([]string{envPath, path}, string(os.PathListSeparator))
}
func isContextAgnosticCommand(cmd *cobra.Command) bool {
if cmd == nil {
return false
}
if _, ok := contextAgnosticCommands[cmd.Name()]; ok && isFirstLevelCommand(cmd) {
return true
}
return isContextAgnosticCommand(cmd.Parent())
}
func isFirstLevelCommand(cmd *cobra.Command) bool {
return !cmd.HasParent() || !cmd.Parent().HasParent()
}
func main() {
var opts cliopts.GlobalOpts
root := &cobra.Command{
Use: "docker",
SilenceErrors: true,
SilenceUsage: true,
TraverseChildren: true,
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
if !isContextAgnosticCommand(cmd) {
mobycli.ExecIfDefaultCtxType(cmd.Context(), cmd.Root())
}
return nil
},
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) == 0 {
return cmd.Help()
}
return fmt.Errorf("unknown docker command: %q", args[0])
},
}
root.AddCommand(
contextcmd.Command(),
cmd.PsCommand(),
cmd.ServeCommand(),
cmd.ExecCommand(),
cmd.LogsCommand(),
cmd.RmCommand(),
cmd.StartCommand(),
cmd.InspectCommand(),
login.Command(),
logout.Command(),
cmd.VersionCommand(),
cmd.StopCommand(),
cmd.KillCommand(),
cmd.SecretCommand(),
cmd.PruneCommand(),
cmd.MetadataCommand(),
// Place holders
cmd.EcsCommand(),
)
helpFunc := root.HelpFunc()
root.SetHelpFunc(func(cmd *cobra.Command, args []string) {
if !isContextAgnosticCommand(cmd) {
mobycli.ExecIfDefaultCtxType(cmd.Context(), cmd.Root())
}
helpFunc(cmd, args)
})
flags := root.Flags()
opts.InstallFlags(flags)
opts.AddConfigFlags(flags)
flags.BoolVarP(&opts.Version, "version", "v", false, "Print version information and quit")
flags.SetInterspersed(false)
walk(root, func(c *cobra.Command) {
c.Flags().BoolP("help", "h", false, "Help for "+c.Name())
})
// populate the opts with the global flags
flags.Parse(os.Args[1:]) // nolint: errcheck
level, err := logrus.ParseLevel(opts.LogLevel)
if err != nil {
fmt.Fprintf(os.Stderr, "Unable to parse logging level: %s\n", opts.LogLevel)
os.Exit(1)
}
logrus.SetFormatter(&logrus.TextFormatter{
DisableTimestamp: true,
DisableLevelTruncation: true,
})
logrus.SetLevel(level)
if opts.Debug {
logrus.SetLevel(logrus.DebugLevel)
}
ctx, cancel := newSigContext()
defer cancel()
// --version should immediately be forwarded to the original cli
if opts.Version {
mobycli.Exec(root)
}
if opts.Config == "" {
fatal(errors.New("config path cannot be empty"))
}
configDir := opts.Config
config.WithDir(configDir)
currentContext := cliconfig.GetCurrentContext(opts.Context, configDir, opts.Hosts)
apicontext.WithCurrentContext(currentContext)
s, err := store.New(configDir)
if err != nil {
mobycli.Exec(root)
}
store.WithContextStore(s)
ctype := store.DefaultContextType
cc, _ := s.Get(currentContext)
if cc != nil {
ctype = cc.Type()
}
ctx = context.WithValue(ctx, config.ContextTypeKey, ctype)
initLocalFn := func() (backend.Service, error) {
return local.GetLocalBackend(configDir, opts)
}
backend.Register(store.DefaultContextType, store.DefaultContextType, initLocalFn, nil)
backend.Register(store.LocalContextType, store.LocalContextType, initLocalFn, nil)
service, err := backend.Get(ctype)
if err != nil {
fatal(err)
}
backend.WithBackend(service)
root.AddCommand(
run.Command(ctype),
volume.Command(ctype),
)
// On default context, "compose" is implemented by CLI Plugin
proxy := api.NewServiceProxy().WithService(service.ComposeService())
command := compose2.RootCommand(proxy)
if ctype == store.AciContextType {
customizeCliForACI(command, proxy)
}
root.AddCommand(command)
start := time.Now().UTC()
err = root.ExecuteContext(ctx)
duration := time.Since(start)
if err != nil {
handleError(ctx, err, ctype, currentContext, cc, root, start, duration)
}
metricsClient.Track(
metrics.CmdResult{
ContextType: ctype,
Args: os.Args[1:],
Status: metrics.SuccessStatus,
Start: start,
Duration: duration,
})
}
func customizeCliForACI(command *cobra.Command, proxy *api.ServiceProxy) {
var domainName string
for _, c := range command.Commands() {
if c.Name() == "up" {
c.Flags().StringVar(&domainName, "domainname", "", "Container NIS domain name")
proxy.WithInterceptor(func(ctx context.Context, project *types.Project) {
if domainName != "" {
// arbitrarily set the domain name on the first service ; ACI backend will expose the entire project
project.Services[0].DomainName = domainName
}
})
}
}
}
func handleError(
ctx context.Context,
err error,
ctype string,
currentContext string,
cc *store.DockerContext,
root *cobra.Command,
start time.Time,
duration time.Duration,
) {
// if user canceled request, simply exit without any error message
if api.IsErrCanceled(err) || errors.Is(ctx.Err(), context.Canceled) {
metricsClient.Track(
metrics.CmdResult{
ContextType: ctype,
Args: os.Args[1:],
Status: metrics.CanceledStatus,
Start: start,
Duration: duration,
},
)
os.Exit(130)
}
if ctype == store.AwsContextType {
exit(
currentContext,
errors.Errorf(`%q context type has been renamed. Recreate the context by running:
$ docker context create %s <name>`, cc.Type(), store.EcsContextType),
ctype,
start,
duration,
)
}
// Context should always be handled by new CLI
requiredCmd, _, _ := root.Find(os.Args[1:])
if requiredCmd != nil && isContextAgnosticCommand(requiredCmd) {
exit(currentContext, err, ctype, start, duration)
}
mobycli.ExecIfDefaultCtxType(ctx, root)
checkIfUnknownCommandExistInDefaultContext(err, currentContext, ctype)
exit(currentContext, err, ctype, start, duration)
}
func exit(ctx string, err error, ctype string, start time.Time, duration time.Duration) {
if exit, ok := err.(cli.StatusError); ok {
// TODO(milas): shouldn't this use the exit code to determine status?
metricsClient.Track(
metrics.CmdResult{
ContextType: ctype,
Args: os.Args[1:],
Status: metrics.SuccessStatus,
Start: start,
Duration: duration,
},
)
os.Exit(exit.StatusCode)
}
var composeErr compose.Error
metricsStatus := metrics.FailureStatus
exitCode := 1
if errors.As(err, &composeErr) {
metricsStatus = composeErr.GetMetricsFailureCategory().MetricsStatus
exitCode = composeErr.GetMetricsFailureCategory().ExitCode
}
if strings.HasPrefix(err.Error(), "unknown shorthand flag:") || strings.HasPrefix(err.Error(), "unknown flag:") || strings.HasPrefix(err.Error(), "unknown docker command:") {
metricsStatus = metrics.CommandSyntaxFailure.MetricsStatus
exitCode = metrics.CommandSyntaxFailure.ExitCode
}
metricsClient.Track(
metrics.CmdResult{
ContextType: ctype,
Args: os.Args[1:],
Status: metricsStatus,
Start: start,
Duration: duration,
},
)
if errors.Is(err, api.ErrLoginRequired) {
fmt.Fprintln(os.Stderr, err)
os.Exit(api.ExitCodeLoginRequired)
}
if compose2.Warning != "" {
logrus.Warn(err)
fmt.Fprintln(os.Stderr, compose2.Warning)
}
if errors.Is(err, api.ErrNotImplemented) {
name := metrics.GetCommand(os.Args[1:])
fmt.Fprintf(os.Stderr, "Command %q not available in current context (%s). %q\n", name, ctx, err)
os.Exit(1)
}
fmt.Fprintln(os.Stderr, err)
os.Exit(exitCode)
}
func fatal(err error) {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
func checkIfUnknownCommandExistInDefaultContext(err error, currentContext string, contextType string) {
submatch := unknownCommandRegexp.FindSubmatch([]byte(err.Error()))
if len(submatch) == 2 {
dockerCommand := string(submatch[1])
if mobycli.IsDefaultContextCommand(dockerCommand) {
fmt.Fprintf(os.Stderr, "Command %q not available in current context (%s), you can use the \"default\" context to run this command\n", dockerCommand, currentContext)
metricsClient.Track(metrics.CmdResult{
ContextType: contextType,
Args: os.Args[1:],
Status: metrics.FailureStatus,
})
os.Exit(1)
}
}
}
func newSigContext() (context.Context, func()) {
ctx, cancel := context.WithCancel(context.Background())
s := make(chan os.Signal, 1)
signal.Notify(s, syscall.SIGTERM, syscall.SIGINT)
go func() {
<-s
cancel()
}()
return ctx, cancel
}
func walk(c *cobra.Command, f func(*cobra.Command)) {
f(c)
for _, c := range c.Commands() {
walk(c, f)
}
}