generated from brevdev/seed
-
Notifications
You must be signed in to change notification settings - Fork 10
/
envsetup.go
429 lines (375 loc) · 11.5 KB
/
envsetup.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
package envsetup
import (
"encoding/json"
"fmt"
"io"
"io/ioutil"
"log"
"os"
"os/user"
"path/filepath"
"time"
"github.com/hashicorp/go-multierror"
"github.com/spf13/afero"
"github.com/spf13/cobra"
"github.com/brevdev/brev-cli/pkg/autostartconf"
"github.com/brevdev/brev-cli/pkg/cmd/version"
"github.com/brevdev/brev-cli/pkg/entity"
breverrors "github.com/brevdev/brev-cli/pkg/errors"
"github.com/brevdev/brev-cli/pkg/featureflag"
"github.com/brevdev/brev-cli/pkg/setupworkspace"
"github.com/brevdev/brev-cli/pkg/store"
"github.com/brevdev/brev-cli/pkg/util"
)
type envsetupStore interface {
GetEnvSetupParams(wsid string) (*store.SetupParamsV0, error)
WriteSetupScript(script string) error
GetSetupScriptPath() string
GetCurrentUser() (*entity.User, error)
GetCurrentWorkspaceID() (string, error)
GetOSUser() string
GetOrCreateSetupLogFile(path string) (afero.File, error)
GetBrevHomePath() (string, error)
BuildBrevHome() error
CopyBin(targetBin string) error
WriteString(path, data string) error
UserHomeDir() (string, error)
Remove(target string) error
FileExists(target string) (bool, error)
DownloadBinary(url string, target string) error
}
type nologinEnvStore interface {
LoginWithToken(token string) error
}
const name = "envsetup"
func NewCmdEnvSetup(store envsetupStore, noLoginStore nologinEnvStore) *cobra.Command {
var forceEnableSetup bool
// add debugger flag to toggle features when running command through a debugger
// this is useful for debugging setup scripts
debugger := false
configureSystemSSHConfig := true
// if a token flag is supplied, log in with it
var token string
cmd := &cobra.Command{
Use: name,
DisableFlagsInUseLine: true,
Short: "TODO",
Long: "TODO",
Example: "TODO",
RunE: func(cmd *cobra.Command, args []string) error {
var errors error
for _, arg := range args {
err := RunEnvSetup(
store,
name,
forceEnableSetup,
debugger,
configureSystemSSHConfig,
arg,
token,
noLoginStore,
)
if err != nil {
errors = multierror.Append(err)
}
}
if errors != nil {
return breverrors.WrapAndTrace(errors)
}
return nil
},
}
cmd.PersistentFlags().BoolVar(&forceEnableSetup, "force-enable", false, "force the setup script to run despite params")
cmd.PersistentFlags().BoolVar(&debugger, "debugger", debugger, "toggle features that don't play well with debuggers")
cmd.PersistentFlags().BoolVar(&configureSystemSSHConfig, "configure-system-ssh-config", configureSystemSSHConfig, "configure system ssh config")
cmd.PersistentFlags().StringVar(&token, "token", "", "token to use for login")
return cmd
}
func RunEnvSetup(
store envsetupStore,
name string,
forceEnableSetup, debugger, configureSystemSSHConfig bool,
workspaceid, token string,
noLoginStore nologinEnvStore,
) error {
if token != "" {
err := noLoginStore.LoginWithToken(token)
if err != nil {
return breverrors.WrapAndTrace(err)
}
}
breverrors.GetDefaultErrorReporter().AddTag("command", name)
_, err := store.GetCurrentWorkspaceID() // do this to error reporting
if err != nil {
return breverrors.WrapAndTrace(err)
}
fmt.Println("setting up dev environment")
params, err := store.GetEnvSetupParams(workspaceid)
if err != nil {
return breverrors.WrapAndTrace(err)
}
res, err := json.MarshalIndent(params, "", "")
if err != nil {
return breverrors.WrapAndTrace(err)
}
fmt.Println(string(res))
if !featureflag.IsDev() && !debugger {
_, err = store.GetCurrentUser() // do this to set error user reporting
if err != nil {
fmt.Println(err)
if !params.DisableSetup {
breverrors.GetDefaultErrorReporter().ReportError(breverrors.WrapAndTrace(err, "setup continued"))
}
}
}
if !forceEnableSetup && params.DisableSetup {
fmt.Printf("WARNING: setup script not running [params.DisableSetup=%v, forceEnableSetup=%v]", params.DisableSetup, forceEnableSetup)
return nil
}
err = setupEnv(store, params, configureSystemSSHConfig)
if err != nil {
return breverrors.WrapAndTrace(err)
}
fmt.Println("done setting up dev environment")
return nil
}
type envInitier struct {
setupworkspace.WorkspaceIniter
ConfigureSystemSSHConfig bool
brevMonConfigurer autostartconf.DaemonConfigurer
}
func (e envInitier) Setup() error {
cmd := setupworkspace.CmdStringBuilder("echo user: $(whoami) && echo pwd: $(pwd)")
err := cmd.Run()
if err != nil {
return breverrors.WrapAndTrace(err)
}
postPrepare := util.RunEAsync(
func() error {
err0 := e.SetupVsCodeExtensions(e.VscodeExtensionIDs)
if err0 != nil {
fmt.Println(err0)
}
return nil
},
)
err = e.brevMonConfigurer.Install()
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = e.SetupSSH(e.Params.WorkspaceKeyPair)
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = e.SetupGit(e.Params.WorkspaceUsername, e.Params.WorkspaceEmail)
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = e.RunApplicationScripts(e.Params.WorkspaceApplicationStartScripts)
if err != nil {
return breverrors.WrapAndTrace(err)
}
var setupErr error
err = e.SetupRepos()
if err != nil {
setupErr = multierror.Append(breverrors.WrapAndTrace(err))
}
fmt.Println("------ Git repo cloned ------")
err = e.RunExecs()
if err != nil {
setupErr = multierror.Append(breverrors.WrapAndTrace(err))
}
if setupErr != nil {
return breverrors.WrapAndTrace(setupErr)
}
err = postPrepare.Await()
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
}
func (e envInitier) SetupSSH(keys *store.KeyPair) error {
cmd := setupworkspace.CmdBuilder("mkdir", "-p", e.BuildHomePath(".ssh"))
err := cmd.Run()
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = createPrivateKey(e, keys)
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = createPublicKey(e, keys)
if err != nil {
return breverrors.WrapAndTrace(err)
}
c := fmt.Sprintf(`eval "$(ssh-agent -s)" && ssh-add %s`, e.BuildHomePath(".ssh", "id_rsa"))
cmd = setupworkspace.CmdStringBuilder(c)
err = cmd.Run()
if err != nil {
return breverrors.WrapAndTrace(err)
}
authorizedKeyPath := e.BuildHomePath(".ssh", "authorized_keys")
err = appendToAuthorizedKeys(e, keys, authorizedKeyPath)
if err != nil {
return breverrors.WrapAndTrace(err)
}
if e.ConfigureSystemSSHConfig {
err = configureSystemSSHConfig(e, authorizedKeyPath)
if err != nil {
return breverrors.WrapAndTrace(err)
}
}
return nil
}
// extract creating private key to function
func createPrivateKey(e envInitier, keys *store.KeyPair) error {
idRsa, err := os.Create(e.BuildHomePath(".ssh", "id_rsa"))
if err != nil {
return breverrors.WrapAndTrace(err)
}
defer setupworkspace.PrintErrFromFunc(idRsa.Close)
_, err = idRsa.Write([]byte(keys.PrivateKeyData))
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = idRsa.Chmod(0o400)
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = e.ChownFileToUser(idRsa)
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
}
func createPublicKey(e envInitier, keys *store.KeyPair) error {
idRsaPub, err := os.Create(e.BuildHomePath(".ssh", "id_rsa.pub"))
if err != nil {
return breverrors.WrapAndTrace(err)
}
defer setupworkspace.PrintErrFromFunc(idRsaPub.Close)
_, err = idRsaPub.Write([]byte(keys.PublicKeyData))
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = idRsaPub.Chmod(0o400)
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = e.ChownFileToUser(idRsaPub)
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
}
func appendToAuthorizedKeys(e envInitier, keys *store.KeyPair, authorizedKeyPath string) error {
//nolint:gosec //todo is this a prob?
authorizedKeyFile, err := os.OpenFile(authorizedKeyPath, os.O_APPEND|os.O_WRONLY, 0o600)
if err != nil {
return breverrors.WrapAndTrace(err)
}
defer setupworkspace.PrintErrFromFunc(authorizedKeyFile.Close)
_, err = authorizedKeyFile.Write([]byte(keys.PublicKeyData))
if err != nil {
return breverrors.WrapAndTrace(err)
}
// chown to user
err = e.ChownFileToUser(authorizedKeyFile)
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
}
func configureSystemSSHConfig(e envInitier, authorizedKeyPath string) error {
sshConfigPath := filepath.Join("/etc", "ssh", "sshd_config.d", fmt.Sprintf("%s.conf", e.User.Username))
sshConfMod := fmt.Sprintf(`PubkeyAuthentication yes
AuthorizedKeysFile %s
PasswordAuthentication no`, authorizedKeyPath)
err := os.WriteFile(sshConfigPath, []byte(sshConfMod), 0o644) //nolint:gosec // verified based on curr env
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
}
func newEnvIniter(user *user.User, params *store.SetupParamsV0, configureSystemSSHConfig bool, store autostartconf.AutoStartStore) *envInitier {
workspaceIniter := setupworkspace.NewWorkspaceIniter(user.HomeDir, user, params)
return &envInitier{
*workspaceIniter,
configureSystemSSHConfig,
autostartconf.NewBrevMonConfigure(store),
}
}
func setupEnv(store envsetupStore, params *store.SetupParamsV0, configureSystemSSHConfig bool) error {
err := store.BuildBrevHome()
if err != nil {
return breverrors.WrapAndTrace(err)
}
user, err := setupworkspace.GetUserFromUserStr(store.GetOSUser())
if err != nil {
return breverrors.WrapAndTrace(err)
}
wi := newEnvIniter(user, params, configureSystemSSHConfig, store)
// set logfile path to ~/.brev/envsetup.log
logFilePath := filepath.Join(user.HomeDir, ".brev", "envsetup.log")
done, err := mirrorPipesToFile(store, logFilePath)
if err != nil {
return breverrors.WrapAndTrace(err)
}
defer done()
fmt.Printf("brev %s\n", version.Version)
fmt.Println("------ Setup Begin ------")
err = wi.Setup()
fmt.Println("------ Setup End ------")
if err != nil {
fmt.Println("------ Failure ------")
time.Sleep(time.Millisecond * 100) // wait for buffer to be written
//nolint:gosec // constant
logFile, errF := ioutil.ReadFile(logFilePath)
if errF != nil {
return multierror.Append(err, errF)
}
breverrors.GetDefaultErrorReporter().AddBreadCrumb(breverrors.ErrReportBreadCrumb{Type: "log-file", Message: string(logFile)})
return breverrors.WrapAndTrace(err)
} else {
fmt.Println("------ Success ------")
}
return nil
}
func mirrorPipesToFile(store envsetupStore, logFile string) (func(), error) {
f, err := store.GetOrCreateSetupLogFile(logFile)
if err != nil {
return nil, breverrors.WrapAndTrace(err)
}
// save existing stdout | MultiWriter writes to saved stdout and file
stdOut := os.Stdout
stdErr := os.Stderr
mw := io.MultiWriter(stdOut, f)
// get pipe reader and writer | writes to pipe writer come out pipe reader
r, w, err := os.Pipe()
if err != nil {
return nil, breverrors.WrapAndTrace(err)
}
// replace stdout,stderr with pipe writer | all writes to stdout, stderr will go through pipe instead (fmt.print, log)
os.Stdout = w
os.Stderr = w
// writes with log.Print should also write to mw
log.SetOutput(mw)
// create channel to control exit | will block until all copies are finished
exit := make(chan bool)
go func() {
// copy all reads from pipe to multiwriter, which writes to stdout and file
_, _ = io.Copy(mw, r)
// when r or w is closed copy will finish and true will be sent to channel
exit <- true
}()
// function to be deferred in main until program exits
return func() {
// close writer then block on exit channel | this will let mw finish writing before the program exits
_ = w.Close()
<-exit
// close file after all writes have finished
_ = f.Close()
os.Stdout = stdOut
os.Stderr = stdErr
}, nil
}