forked from sourcegraph/srclib
/
toolchain_cmd.go
538 lines (457 loc) · 15.2 KB
/
toolchain_cmd.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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
package src
import (
"errors"
"fmt"
"log"
"os"
"os/exec"
"path/filepath"
"strings"
"sync"
"github.com/aybabtme/color/brush"
"sourcegraph.com/sourcegraph/go-flags"
"sourcegraph.com/sourcegraph/srclib"
"sourcegraph.com/sourcegraph/srclib/toolchain"
)
func init() {
c, err := CLI.AddCommand("toolchain",
"manage toolchains",
"Manage srclib toolchains.",
&toolchainCmd,
)
if err != nil {
log.Fatal(err)
}
c.Aliases = []string{"tc"}
_, err = c.AddCommand("list",
"list available toolchains",
"List available toolchains.",
&toolchainListCmd,
)
if err != nil {
log.Fatal(err)
}
_, err = c.AddCommand("list-tools",
"list tools in toolchains",
"List available tools in all toolchains.",
&toolchainListToolsCmd,
)
if err != nil {
log.Fatal(err)
}
_, err = c.AddCommand("build",
"build a toolchain",
"Build a toolchain's Docker image.",
&toolchainBuildCmd,
)
if err != nil {
log.Fatal(err)
}
_, err = c.AddCommand("get",
"download a toolchain",
"Download a toolchain's repository to the SRCLIBPATH.",
&toolchainGetCmd,
)
if err != nil {
log.Fatal(err)
}
_, err = c.AddCommand("add",
"add a local toolchain",
"Add a local directory as a toolchain in SRCLIBPATH.",
&toolchainAddCmd,
)
if err != nil {
log.Fatal(err)
}
_, err = c.AddCommand("install",
"install toolchains",
"Download and install toolchains",
&toolchainInstallCmd,
)
if err != nil {
log.Fatal(err)
}
_, err = c.AddCommand("install-std",
"install standard toolchains",
"Install standard toolchains (sourcegraph.com/sourcegraph/srclib-* toolchains).",
&toolchainInstallStdCmd,
)
if err != nil {
log.Fatal(err)
}
}
type ToolchainPath string
func (t ToolchainPath) Complete(match string) []flags.Completion {
toolchains, err := toolchain.List()
if err != nil {
log.Println(err)
return nil
}
var comps []flags.Completion
for _, tc := range toolchains {
if strings.HasPrefix(tc.Path, match) {
comps = append(comps, flags.Completion{Item: tc.Path})
}
}
return comps
}
type ToolchainExecOpt struct {
ExeMethods string `short:"m" long:"methods" default:"program,docker" description:"toolchain execution methods" value-name:"METHODS"`
}
func (o *ToolchainExecOpt) ToolchainMode() toolchain.Mode {
// TODO(sqs): make this a go-flags type
methods := strings.Split(o.ExeMethods, ",")
var mode toolchain.Mode
for _, method := range methods {
if method == "program" {
mode |= toolchain.AsProgram
}
if method == "docker" {
mode |= toolchain.AsDockerContainer
}
}
return mode
}
type ToolchainCmd struct{}
var toolchainCmd ToolchainCmd
func (c *ToolchainCmd) Execute(args []string) error { return nil }
type ToolchainListCmd struct {
}
var toolchainListCmd ToolchainListCmd
func (c *ToolchainListCmd) Execute(args []string) error {
toolchains, err := toolchain.List()
if err != nil {
return err
}
fmtStr := "%-40s %s\n"
fmt.Printf(fmtStr, "PATH", "TYPE")
for _, t := range toolchains {
var exes []string
if t.Program != "" {
exes = append(exes, "program")
}
if t.Dockerfile != "" {
exes = append(exes, "docker")
}
fmt.Printf(fmtStr, t.Path, strings.Join(exes, ", "))
}
return nil
}
type ToolchainListToolsCmd struct {
Op string `short:"p" long:"op" description:"only list tools that perform these operations only" value-name:"OP"`
SourceUnitType string `short:"u" long:"source-unit-type" description:"only list tools that operate on this source unit type" value-name:"TYPE"`
Args struct {
Toolchains []ToolchainPath `name:"TOOLCHAINS" description:"only list tools in these toolchains"`
} `positional-args:"yes" required:"yes"`
}
var toolchainListToolsCmd ToolchainListToolsCmd
func (c *ToolchainListToolsCmd) Execute(args []string) error {
tcs, err := toolchain.List()
if err != nil {
log.Fatal(err)
}
fmtStr := "%-40s %-18s %-15s %-25s\n"
fmt.Printf(fmtStr, "TOOLCHAIN", "TOOL", "OP", "SOURCE UNIT TYPES")
for _, tc := range tcs {
if len(c.Args.Toolchains) > 0 {
found := false
for _, tc2 := range c.Args.Toolchains {
if string(tc2) == tc.Path {
found = true
break
}
}
if !found {
continue
}
}
cfg, err := tc.ReadConfig()
if err != nil {
log.Fatal(err)
}
for _, t := range cfg.Tools {
if c.Op != "" && c.Op != t.Op {
continue
}
if c.SourceUnitType != "" {
found := false
for _, u := range t.SourceUnitTypes {
if c.SourceUnitType == u {
found = true
break
}
}
if !found {
continue
}
}
fmt.Printf(fmtStr, tc.Path, t.Subcmd, t.Op, strings.Join(t.SourceUnitTypes, " "))
}
}
return nil
}
type ToolchainBuildCmd struct {
Args struct {
Toolchains []ToolchainPath `name:"TOOLCHAINS" description:"toolchain paths of toolchains to build"`
} `positional-args:"yes" required:"yes"`
}
var toolchainBuildCmd ToolchainBuildCmd
func (c *ToolchainBuildCmd) Execute(args []string) error {
var wg sync.WaitGroup
for _, tc := range c.Args.Toolchains {
tc, err := toolchain.Open(string(tc), toolchain.AsDockerContainer)
if err != nil {
log.Fatal(err)
}
wg.Add(1)
go func() {
defer wg.Done()
if err := tc.Build(); err != nil {
log.Fatal(err)
}
}()
}
wg.Wait()
return nil
}
type ToolchainGetCmd struct {
Update bool `short:"u" long:"update" description:"use the network to update the toolchain"`
Args struct {
Toolchains []ToolchainPath `name:"TOOLCHAINS" description:"toolchain paths of toolchains to get"`
} `positional-args:"yes" required:"yes"`
}
var toolchainGetCmd ToolchainGetCmd
func (c *ToolchainGetCmd) Execute(args []string) error {
for _, tc := range c.Args.Toolchains {
if GlobalOpt.Verbose {
fmt.Println(tc)
}
_, err := toolchain.Get(string(tc), c.Update)
if err != nil {
return err
}
}
return nil
}
type ToolchainAddCmd struct {
Dir string `long:"dir" description:"directory containing toolchain to add" value-name:"DIR"`
Args struct {
ToolchainPath string `name:"TOOLCHAIN" default:"." description:"toolchain path to use for toolchain directory"`
} `positional-args:"yes" required:"yes"`
}
var toolchainAddCmd ToolchainAddCmd
func (c *ToolchainAddCmd) Execute(args []string) error {
return toolchain.Add(c.Dir, c.Args.ToolchainPath)
}
type toolchainInstaller struct {
name string
fn func() error
}
type toolchainMap map[string]toolchainInstaller
var stdToolchains = toolchainMap{
"go": toolchainInstaller{"Go (sourcegraph.com/sourcegraph/srclib-go)", installGoToolchain},
"python": toolchainInstaller{"Python (sourcegraph.com/sourcegraph/srclib-python)", installPythonToolchain},
"ruby": toolchainInstaller{"Ruby (sourcegraph.com/sourcegraph/srclib-ruby)", installRubyToolchain},
"javascript": toolchainInstaller{"JavaScript (sourcegraph.com/sourcegraph/srclib-javascript)", installJavaScriptToolchain},
}
func (m toolchainMap) listKeys() string {
var langs string
for i, _ := range m {
langs += i + ", "
}
// Remove the last comma from langs before returning it.
return strings.TrimSuffix(langs, ", ")
}
type ToolchainInstallCmd struct {
// Args are not required so we can print out a more detailed
// error message inside (*ToolchainInstallCmd).Execute.
Args struct {
Languages []string `value-name:"LANG" description:"language toolchains to install"`
} `positional-args:"yes"`
}
var toolchainInstallCmd ToolchainInstallCmd
func (c *ToolchainInstallCmd) Execute(args []string) error {
if len(c.Args.Languages) == 0 {
return errors.New(brush.Red(fmt.Sprintf("No languages specified. Standard languages include: %s", stdToolchains.listKeys())).String())
}
var is []toolchainInstaller
for _, l := range c.Args.Languages {
i, ok := stdToolchains[l]
if !ok {
return errors.New(brush.Red(fmt.Sprintf("Language %s unrecognized. Standard languages include: %s", l, stdToolchains.listKeys())).String())
}
is = append(is, i)
}
return installToolchains(is)
}
func installToolchains(langs []toolchainInstaller) error {
var notInstalled []string
for _, l := range langs {
fmt.Println(brush.Cyan(l.name + " " + strings.Repeat("=", 78-len(l.name))).String())
if err := l.fn(); err != nil {
if err, ok := err.(skippedToolchain); ok {
fmt.Printf("%s\n", brush.Yellow(err.Error()))
} else {
fmt.Printf("%s\n", brush.Red(fmt.Sprintf("failed to install/upgrade %s toolchain: %s", l.name, err)))
}
notInstalled = append(notInstalled, l.name)
// Continue here because we attempt to install
// all the toolchains.
continue
}
fmt.Println(brush.Green("OK! Installed/upgraded " + l.name + " toolchain").String())
fmt.Println(brush.Cyan(strings.Repeat("=", 80)).String())
fmt.Println()
}
if len(notInstalled) != 0 {
return errors.New(brush.Red(fmt.Sprintf("The following toolchains were not installed:\n%s", strings.Join(notInstalled, "\n"))).String())
}
return nil
}
type ToolchainInstallStdCmd struct {
Skip []string `long:"skip" description:"skip installing matching toolchains (can be specified multiple times; e.g., --skip go --skip ruby)" value-name:"NAME"`
}
var toolchainInstallStdCmd ToolchainInstallStdCmd
func (c *ToolchainInstallStdCmd) Execute(args []string) error {
fmt.Println(brush.Cyan("Installing/upgrading standard toolchains..."))
fmt.Println()
var is []toolchainInstaller
OuterLoop:
for name, installer := range stdToolchains {
for _, skip := range c.Skip {
if strings.EqualFold(name, skip) {
fmt.Println(brush.Yellow(fmt.Sprintf("Skipping installation of %s", installer.name)))
continue OuterLoop
}
}
is = append(is, installer)
}
return installToolchains(is)
}
func installGoToolchain() error {
const toolchain = "sourcegraph.com/sourcegraph/srclib-go"
gopath := os.Getenv("GOPATH")
if gopath == "" {
return skippedToolchain{toolchain, "no GOPATH set (assuming Go is not installed and you don't want the Go toolchain)"}
}
srclibpathDir := filepath.Join(strings.Split(srclib.Path, ":")[0], toolchain) // toolchain dir under SRCLIBPATH
if err := os.MkdirAll(filepath.Dir(srclibpathDir), 0700); err != nil {
return err
}
if skipmsg, err := symlinkToGopath(toolchain); err != nil {
return err
} else if skipmsg != "" {
return skippedToolchain{toolchain, skipmsg}
}
log.Println("Downloading or updating Go toolchain in", srclibpathDir)
if err := execCmd("src", "toolchain", "get", "-u", toolchain); err != nil {
return err
}
log.Println("Building Go toolchain program")
if err := execCmd("make", "-C", srclibpathDir); err != nil {
return err
}
return nil
}
func installRubyToolchain() error {
const toolchain = "sourcegraph.com/sourcegraph/srclib-ruby"
srclibpathDir := filepath.Join(strings.Split(srclib.Path, ":")[0], toolchain) // toolchain dir under SRCLIBPATH
if _, err := exec.LookPath("ruby"); isExecErrNotFound(err) {
return skippedToolchain{toolchain, "no `ruby` in PATH (assuming you don't have Ruby installed and you don't want the Ruby toolchain)"}
}
if _, err := exec.LookPath("bundle"); isExecErrNotFound(err) {
return fmt.Errorf("found `ruby` in PATH but did not find `bundle` in PATH; Ruby toolchain requires bundler (run `gem install bundler` to install it)")
}
log.Println("Downloading or updating Ruby toolchain in", srclibpathDir)
if err := execCmd("src", "toolchain", "get", "-u", toolchain); err != nil {
return err
}
log.Println("Installing deps for Ruby toolchain in", srclibpathDir)
if err := execCmd("make", "-C", srclibpathDir); err != nil {
return fmt.Errorf("%s\n\nTip: If you are using a version of Ruby other than 2.1.2 (the default for srclib), or if you are using your system Ruby, try using a Ruby version manager (such as https://rvm.io) to install a more standard Ruby, and try Ruby 2.1.2.\n\nIf you are still having problems, post an issue at https://github.com/sourcegraph/srclib-ruby/issues with the full log output and information about your OS and Ruby version.\n\nIf you don't care about Ruby, skip this installation by running `src toolchain install-std --skip ruby`.", err)
}
return nil
}
func installJavaScriptToolchain() error {
const toolchain = "sourcegraph.com/sourcegraph/srclib-javascript"
srclibpathDir := filepath.Join(strings.Split(srclib.Path, ":")[0], toolchain) // toolchain dir under SRCLIBPATH
if _, err := exec.LookPath("node"); isExecErrNotFound(err) {
return skippedToolchain{toolchain, "no `node` in PATH (assuming you don't have Node.js installed and you don't want the JavaScript toolchain)"}
}
if _, err := exec.LookPath("npm"); isExecErrNotFound(err) {
return fmt.Errorf("no `npm` in PATH; JavaScript toolchain requires npm")
}
log.Println("Downloading or updating JavaScript toolchain in", srclibpathDir)
if err := execCmd("src", "toolchain", "get", "-u", toolchain); err != nil {
return err
}
return nil
}
func installPythonToolchain() error {
const toolchain = "sourcegraph.com/sourcegraph/srclib-python"
requiredCmds := map[string]string{
"go": "visit https://golang.org/doc/install",
"python": "visit https://www.python.org/downloads/",
"pip": "visit http://pip.readthedocs.org/en/latest/installing.html",
"virtualenv": "run `[sudo] pip install virtualenv`",
}
for requiredCmd, instructions := range requiredCmds {
if _, err := exec.LookPath(requiredCmd); isExecErrNotFound(err) {
return skippedToolchain{toolchain, fmt.Sprintf("no `%s` found in PATH; to install, %s", requiredCmd, instructions)}
}
}
srclibpathDir := filepath.Join(strings.Split(srclib.Path, ":")[0], toolchain) // toolchain dir under SRCLIBPATH
log.Println("Downloading or updating Python toolchain in", srclibpathDir)
if err := execCmd("src", "toolchain", "get", "-u", toolchain); err != nil {
return err
}
// Add symlink to GOPATH so install succeeds (necessary as long as there's a Go dependency in this toolchain)
if skipmsg, err := symlinkToGopath(toolchain); err != nil {
return err
} else if skipmsg != "" {
return skippedToolchain{toolchain, skipmsg}
}
log.Println("Installing deps for Python toolchain in", srclibpathDir)
if err := execCmd("make", "-C", srclibpathDir, "install"); err != nil {
return err
}
return nil
}
type skippedToolchain struct {
toolchain string
why string
}
func (e skippedToolchain) Error() string {
return fmt.Sprintf("skipped %s: %s", e.toolchain, e.why)
}
func isExecErrNotFound(err error) bool {
if e, ok := err.(*exec.Error); ok && e.Err == exec.ErrNotFound {
return true
}
return false
}
func symlinkToGopath(toolchain string) (skip string, err error) {
gopath := os.Getenv("GOPATH")
if gopath == "" {
return "", fmt.Errorf("GOPATH not set")
}
srcDir := filepath.Join(strings.Split(gopath, ":")[0], "src")
gopathDir := filepath.Join(srcDir, toolchain)
srclibpathDir := filepath.Join(strings.Split(srclib.Path, ":")[0], toolchain)
if fi, err := os.Lstat(gopathDir); os.IsNotExist(err) {
log.Printf("mkdir -p %s", filepath.Dir(gopathDir))
if err := os.MkdirAll(filepath.Dir(gopathDir), 0700); err != nil {
return "", err
}
log.Printf("ln -s %s %s", srclibpathDir, gopathDir)
if err := os.Symlink(srclibpathDir, gopathDir); err != nil {
return "", err
}
} else if err != nil {
return "", err
} else if fi.Mode()&os.ModeSymlink == 0 {
return fmt.Sprintf("toolchain dir in GOPATH (%s) is not a symlink (assuming you intentionally cloned the toolchain repo to your GOPATH; not modifying it)", gopathDir), nil
}
log.Printf("Symlinked toolchain %s into your GOPATH at", toolchain, gopathDir)
return "", nil
}