-
Notifications
You must be signed in to change notification settings - Fork 221
/
doctor.go
262 lines (211 loc) · 6.15 KB
/
doctor.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
// Package doctor implements the doctor command chain.
package doctor
import (
"context"
"fmt"
dockerclient "github.com/docker/docker/client"
"github.com/spf13/cobra"
fly "github.com/superfly/fly-go"
"github.com/superfly/flyctl/internal/flag/completion"
"github.com/superfly/flyctl/agent"
"github.com/superfly/flyctl/iostreams"
"github.com/superfly/flyctl/internal/build/imgsrc"
"github.com/superfly/flyctl/internal/command"
"github.com/superfly/flyctl/internal/command/doctor/diag"
"github.com/superfly/flyctl/internal/config"
"github.com/superfly/flyctl/internal/flag"
"github.com/superfly/flyctl/internal/render"
)
// New initializes and returns a new doctor Command.
func New() (cmd *cobra.Command) {
const (
short = `The DOCTOR command allows you to debug your Fly environment`
long = short + "\n"
)
cmd = command.New("doctor", short, long, run,
command.RequireSession,
command.LoadAppNameIfPresent,
)
cmd.Args = cobra.NoArgs
flag.Add(cmd,
flag.App(),
flag.AppConfig(),
flag.JSONOutput(),
flag.Bool{
Name: "verbose",
Shorthand: "v",
Default: false,
Description: "Print extra diagnostic information.",
},
flag.String{
Name: "org",
Shorthand: "o",
Description: "The name of the organization to use for WireGuard tests.",
Default: "personal",
CompletionFn: completion.CompleteOrgs,
},
)
cmd.AddCommand(diag.New())
return
}
func run(ctx context.Context) (err error) {
var (
isJson = config.FromContext(ctx).JSONOutput
isVerbose = flag.GetBool(ctx, "verbose")
io = iostreams.FromContext(ctx)
color = io.ColorScheme()
checks = map[string]string{}
)
lprint := func(color func(string) string, fmtstr string, args ...interface{}) {
if isJson {
return
}
if color != nil {
fmt.Print(color(fmt.Sprintf(fmtstr, args...)))
} else {
fmt.Printf(fmtstr, args...)
}
}
check := func(name string, err error) bool {
if err != nil {
lprint(color.Red, "FAILED\n(Error: %s)\n", err)
checks[name] = err.Error()
return false
}
lprint(color.Green, "PASSED\n")
checks[name] = "ok"
return true
}
// This JSON output is (unfortunately) depended on in production.
// Adding to it is perfectly safe, but double-check WGCI before changing or removing anything :)
defer func() {
if isJson {
render.JSON(iostreams.FromContext(ctx).Out, checks)
}
}()
// ------------------------------------------------------------
lprint(nil, "Testing authentication token... ")
err = runAuth(ctx)
if !check("auth", err) {
lprint(nil, `
We can't authenticate you with your current authentication token.
Run 'flyctl auth login' to get a working token, or 'flyctl auth signup' if you've
never signed up before.
`)
return nil
}
// ------------------------------------------------------------
lprint(nil, "Testing flyctl agent... ")
err = runAgent(ctx)
if !check("agent", err) {
lprint(nil, `
Can't communicate with flyctl's background agent.
Run 'flyctl agent restart'.
`)
return nil
}
// ------------------------------------------------------------
lprint(nil, "Testing local Docker instance... ")
err = runLocalDocker(ctx)
if err != nil {
checks["docker"] = err.Error()
if isVerbose {
lprint(nil, `Nope
(We got: %s)
This is fine, we'll use a remote builder.
`, err.Error())
} else {
lprint(nil, "Nope\n")
}
} else {
lprint(color.Green, "PASSED\n")
checks["docker"] = "ok"
}
// ------------------------------------------------------------
wgOrgSlug := flag.GetString(ctx, "org")
lprint(nil, "Pinging WireGuard gateway (give us a sec)... ")
err = runPersonalOrgPing(ctx, wgOrgSlug)
if !check("ping", err) {
lprint(nil, `
We can't establish connectivity with WireGuard for your personal organization.
WireGuard runs on 51820/udp, which your local network may block.
If this is the first time you've ever used 'flyctl' on this machine, you
can try running 'flyctl doctor' again.
If this was working before, you can ask 'flyctl' to create a new peer for
you by running 'flyctl wireguard reset'.
If your network might be blocking UDP, you can run 'flyctl wireguard websockets enable',
followed by 'flyctl agent restart', and we'll run WireGuard over HTTPS.
`)
return nil
}
// ------------------------------------------------------------
// Check if we can access DNS and Flaps via WireGuard
// ------------------------------------------------------------
lprint(nil, "Testing WireGuard DNS... ")
err = runPersonalOrgCheckDns(ctx, wgOrgSlug)
if !check("wgdns", err) {
lprint(nil, `
We can't resolve internal DNS for your personal organization.
This is likely a platform issue, please contact support.
`)
return nil
}
lprint(nil, "Testing WireGuard Flaps... ")
err = runPersonalOrgCheckFlaps(ctx, wgOrgSlug)
if !check("wgflaps", err) {
lprint(nil, `
We can't access Flaps via a WireGuard tunnel into your personal organization.
This is likely a platform issue, please contact support.
`)
return nil
}
// ------------------------------------------------------------
// App specific checks below here
// ------------------------------------------------------------
appChecker, err := NewAppChecker(ctx, isJson, color)
if err != nil {
return err
}
if appChecker == nil {
return nil
}
appChecks := appChecker.checkAll()
for k, v := range appChecks {
checks[k] = v
}
// ------------------------------------------------------------
return nil
}
func runAuth(ctx context.Context) (err error) {
client := fly.ClientFromContext(ctx)
if _, err = client.GetCurrentUser(ctx); err != nil {
err = fmt.Errorf("can't verify access token: %w", err)
}
return
}
func runAgent(ctx context.Context) (err error) {
defer func() {
if err == nil {
return
}
err = fmt.Errorf("couldn't ping agent: %w", err)
}()
var ac *agent.Client
if ac, err = agent.DefaultClient(ctx); err == nil {
_, err = ac.Ping(ctx)
}
return
}
func runLocalDocker(ctx context.Context) (err error) {
defer func() {
if err == nil {
return
}
err = fmt.Errorf("failed pinging docker instance: %w", err)
}()
var client *dockerclient.Client
if client, err = imgsrc.NewLocalDockerClient(); err == nil {
_, err = client.Ping(ctx)
}
return
}