Repository navigation
Expand file tree
/
Copy pathget.go
More file actions
916 lines (795 loc) · 29.9 KB
/
Copy pathget.go
File metadata and controls
916 lines (795 loc) · 29.9 KB
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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
// Copyright (c) Bartłomiej Płotka @bwplotka
// Licensed under the Apache License 2.0.
package main
import (
"bufio"
"context"
"fmt"
"log"
"os"
"path"
"path/filepath"
"regexp"
"strconv"
"strings"
"time"
"unicode"
"github.com/Masterminds/semver"
"github.com/bwplotka/bingo/pkg/bingo"
"github.com/bwplotka/bingo/pkg/mod"
"github.com/bwplotka/bingo/pkg/runner"
"github.com/bwplotka/bingo/pkg/version"
"github.com/efficientgo/core/errcapture"
"github.com/efficientgo/core/errors"
"golang.org/x/mod/module"
)
var (
goModVersionRegexp = regexp.MustCompile("^v[0-9]*$")
)
func parseTarget(rawTarget string) (name string, pkgPath string, versions []string, err error) {
if rawTarget == "" {
return "", "", nil, errors.New("target is empty, this should be filtered earlier")
}
s := strings.Split(rawTarget, "@")
nameOrPackage := s[0]
if len(s) > 1 {
versions = strings.Split(s[1], ",")
} else {
versions = []string{""}
}
if len(versions) > 1 {
// Check for duplicates or/and none.
dup := map[string]struct{}{}
for _, v := range versions {
if _, ok := dup[v]; ok {
return "", "", nil, errors.Newf("version duplicates are not allowed, got: %v", versions)
}
dup[v] = struct{}{}
if v == "none" {
return "", "", nil, errors.Newf("none is not allowed when there are more than one specified Version, got: %v", versions)
}
}
}
name = nameOrPackage
if strings.Contains(nameOrPackage, "/") {
// Binary referenced by path, get default name from package path.
pkgPath = nameOrPackage
name = path.Base(pkgPath)
if pkgSplit := strings.Split(pkgPath, "/"); len(pkgSplit) > 3 && goModVersionRegexp.MatchString(name) {
// It's common pattern to name urls with versions in go modules. Exclude that.
name = pkgSplit[len(pkgSplit)-2]
}
}
return strings.ToLower(name), pkgPath, versions, nil
}
type installPackageConfig struct {
runner *runner.Runner
modDir string
relModDir string
link bool
verbose bool
}
type getConfig struct {
runner *runner.Runner
modDir string
relModDir string
name string
rename string
link bool
timeOut uint
verbose bool
}
func (c getConfig) forPackage() installPackageConfig {
return installPackageConfig{
modDir: c.modDir,
relModDir: c.relModDir,
runner: c.runner,
verbose: c.verbose,
link: c.link,
}
}
func getAll(ctx context.Context, logger *log.Logger, c getConfig) (err error) {
if c.name != "" {
return errors.New("name cannot by specified if no target was given")
}
if c.rename != "" {
return errors.New("rename cannot by specified if no target was given")
}
pkgs, err := bingo.ListPinnedMainPackages(logger, c.relModDir, false)
if err != nil {
return err
}
for _, p := range pkgs {
for i, targetPkg := range p.ToPackages() {
if err := getPackage(ctx, logger, c.forPackage(), i, p.Name, targetPkg); err != nil {
return errors.Wrapf(err, "%d: getting %s", i, targetPkg.String())
}
}
}
return nil
}
func existingModFiles(modDir string, targetName string) (existingModFiles []string, _ error) {
existingModFiles, err := filepath.Glob(filepath.Join(modDir, targetName+".mod"))
if err != nil {
return nil, err
}
existingModArrFiles, err := filepath.Glob(filepath.Join(modDir, targetName+".*.mod"))
if err != nil {
return nil, err
}
return append(existingModFiles, existingModArrFiles...), nil
}
// get performs bingo get: it's like go get, but package aware, without go source files and on dedicated mod file.
// rawTarget is name or target package path, optionally with module version or array versions.
func get(ctx context.Context, logger *log.Logger, c getConfig, rawTarget string) (err error) {
var cancel context.CancelFunc = func() {}
if c.timeOut > 0 {
ctx, cancel = context.WithTimeout(ctx, time.Duration(c.timeOut)*time.Minute)
}
defer cancel()
// Cleanup all bingo modules' tmp files for fresh start.
if err := cleanGoGetTmpFiles(c.modDir); err != nil {
return err
}
if err := ensureModDirExists(logger, c.relModDir); err != nil {
return errors.Wrap(err, "ensure mod dir")
}
if rawTarget == "" {
// Empty target means to get all. It recursively invokes get for each existing binary.
return getAll(ctx, logger, c)
}
// NOTE: pkgPath can be empty. This means that tool was referenced by name.
name, pkgPath, versions, err := parseTarget(rawTarget)
if err != nil {
return errors.Wrapf(err, "parse %v", rawTarget)
}
if c.rename != "" {
// Treat rename specially.
if pkgPath != "" {
return errors.Newf("-r rename has to reference installed tool by name not path, got: %v", pkgPath)
}
if versions[0] != "" || len(versions) > 1 {
return errors.Newf("-r rename cannot take version arguments (string after @), got %v", versions)
}
if err := validateNewName(versions, name, c.rename); err != nil {
return errors.Wrap(err, "-r")
}
newExisting, err := existingModFiles(c.modDir, c.rename)
if err != nil {
return errors.Wrapf(err, "existing mod files for %v", c.rename)
}
if len(newExisting) > 0 {
return errors.Newf("found existing installed binaries %v under name you want to rename on. Remove target name %s or use different one", newExisting, c.rename)
}
existing, err := existingModFiles(c.modDir, name)
if err != nil {
return errors.Wrapf(err, "existing mod files for %v", name)
}
if len(existing) == 0 {
return errors.Newf("nothing to rename, tool %v not installed", name)
}
targets := make([]bingo.Package, 0, len(existing))
for _, e := range existing {
mf, err := bingo.OpenModFile(e)
if err != nil {
return errors.Wrapf(err, "found unparsable mod file %v. Uninstall it first via get %v@none or fix it manually.", e, name)
}
dpkg := mf.DirectPackage()
if err := mf.Close(); err != nil {
return errors.Wrapf(err, "unable to close mod file %v", e)
}
if dpkg == nil {
return errors.Wrapf(err, "failed to rename tool %v to %v name; found empty mod file %v; Use full path to install tool again", name, c.rename, e)
}
targets = append(targets, *dpkg)
}
for i, t := range targets {
if err := getPackage(ctx, logger, c.forPackage(), i, c.rename, t); err != nil {
return errors.Wrapf(err, "%s.mod: getting %s", c.rename, t)
}
}
// Remove old mod files.
return removeAllGlob(filepath.Join(c.modDir, name+".*"))
}
targetName := name
if c.name != "" {
if err := validateNewName(versions, name, c.name); err != nil {
return errors.Wrap(err, "-n")
}
targetName = c.name
}
existing, err := existingModFiles(c.modDir, targetName)
if err != nil {
return errors.Wrapf(err, "existing mod files for %v", targetName)
}
switch versions[0] {
case "none":
if pkgPath != "" {
return errors.Newf("cannot delete tool by full path. Use just %v@none name instead", targetName)
}
if len(existing) == 0 {
return errors.Newf("nothing to delete, tool %v is not installed", targetName)
}
// None means we no longer want to version this package.
// NOTE: We don't remove binaries.
return removeAllGlob(filepath.Join(c.modDir, name+".*"))
case "":
if len(existing) > 1 {
// Edge case. If no version is specified requested, allow to pull all array versions at once.
versions = make([]string, len(existing))
}
}
targets := make([]bingo.Package, 0, len(versions))
pathWasSpecified := pkgPath != ""
for i, v := range versions {
target := bingo.Package{Module: module.Version{Version: v}, RelPath: pkgPath} // "Unknown" module mode.
if len(existing) > i {
e := existing[i]
mf, err := bingo.OpenModFile(e)
if err != nil {
return errors.Wrapf(err, "found unparsable mod file %v. Uninstall it first via get %v@none or fix it manually.", e, name)
}
dpkg := mf.DirectPackage()
if err := mf.Close(); err != nil {
return errors.Wrapf(err, "unable to close mod file %v", e)
}
if dpkg != nil {
if target.Path() != "" && target.Path() != dpkg.Path() {
if pathWasSpecified {
return errors.Newf("found mod file %v that has different package path %q than given %q"+
"Uninstall existing tool using `%v@none` or use `-n` flag to choose different name", e, dpkg.Path(), target.Path(), targetName)
}
return errors.Newf("found array mod file %v that has different package path %q than previous in array %q. Manual edit?"+
"Uninstall existing tool using `%v@none` or use `-n` flag to choose different name", e, dpkg.Path(), target.Path(), targetName)
}
target.Module.Path = dpkg.Module.Path
if target.Module.Version == "" {
// If no version is requested, use the existing version.
target.Module.Version = dpkg.Module.Version
}
target.RelPath = dpkg.RelPath
// Save for future versions without potentially existing files.
pkgPath = target.Path()
} else if target.Path() == "" {
return errors.Wrapf(err, "failed to install tool %v found empty mod file %v; Use full path to install tool again", targetName, e)
}
}
if target.Path() == "" {
return errors.Newf("tool referenced by name %v that was never installed before; Use full path to install a tool", name)
}
targets = append(targets, target)
}
for i, t := range targets {
if err := getPackage(ctx, logger, c.forPackage(), i, targetName, t); err != nil {
return errors.Wrapf(err, "%s.mod: getting %s", targetName, t)
}
}
// Remove target unused arr mod files based on version file.
existingTargetModArrFiles, gerr := filepath.Glob(filepath.Join(c.modDir, targetName+".*.mod"))
if gerr != nil {
err = gerr
return
}
for _, f := range existingTargetModArrFiles {
i, perr := strconv.ParseInt(strings.Split(filepath.Base(f), ".")[1], 10, 64)
if perr != nil || int(i) >= len(versions) {
if rerr := os.RemoveAll(f); rerr != nil {
err = rerr
return
}
}
}
return nil
}
func validateNewName(versions []string, old, new string) error {
if new == old {
return errors.Newf("cannot be the same as module name %v", new)
}
if versions[0] == "none" {
return errors.New("cannot use with @none logic")
}
return nil
}
func cleanGoGetTmpFiles(modDir string) error {
// Remove all tmp files
if err := removeAllGlob(filepath.Join(modDir, "*.*.tmp.*")); err != nil {
return err
}
return removeAllGlob(filepath.Join(modDir, "*.tmp.*"))
}
func validateTargetName(targetName string) error {
if targetName == "cmd" {
return errors.Newf("package would be installed with ambiguous name %s. This is a common, but slightly annoying package layout"+
"It's advised to choose unique name with -n flag", targetName)
}
if targetName == strings.TrimSuffix(bingo.FakeRootModFileName, ".mod") {
return errors.Newf("requested binary with name %q`. This is impossible, choose different name using -n flag", strings.TrimSuffix(bingo.FakeRootModFileName, ".mod"))
}
return nil
}
func resolvePackage(logger *log.Logger, verbose bool, tmpModFile string, runnable runner.Runnable, target *bingo.Package) (err error) {
// Do initial go get -d and remember output.
// NOTE: We have to use get -d to resolve version and tell us what is the module and what package.
// If go get will not succeed, or will not update go mod, we will try manual lookup.
// This is required to support modules depending on broken modules (and using exclude/replace statements).
out, gerr := runnable.GetD(target.String())
if gerr == nil {
mods, err := bingo.ModIndirectModules(tmpModFile)
if err != nil {
return err
}
switch len(mods) {
case 0:
return errors.Newf("no indirect module found on %v", tmpModFile)
case 1:
target.RelPath = strings.TrimPrefix(strings.TrimPrefix(target.RelPath, mods[0].Path), "/")
target.Module = mods[0]
return nil
default:
if target.Module.Path != "" {
for _, m := range mods {
if m.Path == target.Module.Path {
target.RelPath = strings.TrimPrefix(strings.TrimPrefix(target.RelPath, m.Path), "/")
target.Module = m
return nil
}
}
return errors.Newf("no indirect module found on %v for %v module", tmpModFile, target.Module.Path)
}
for _, m := range mods {
if m.Path == target.Path() {
target.RelPath = strings.TrimPrefix(strings.TrimPrefix(target.RelPath, m.Path), "/")
target.Module = m
return nil
}
}
// In this case it is not successful from our perspective.
gerr = errors.New(out)
}
}
cacheModPath, err := gomodcache(runnable)
if err != nil {
return errors.Wrapf(err, "can't find GOMODCACHE or deduct it from GOPATH")
}
// We fallback only if go-get failed which happens when it does not know what version to choose.
// In this case
if err := resolveInGoModCache(logger, verbose, cacheModPath, target); err != nil {
return errors.Wrapf(err, "fallback to local go mod cache resolution failed after go get failure: %v", gerr)
}
return nil
}
func gomodcache(runnable runner.Runnable) (string, error) {
cachepath, err := runnable.GoEnv("GOMODCACHE")
if err != nil {
return "", errors.Wrap(err, "go env GOMODCACHE")
}
if cachepath != "" {
return cachepath, nil
}
gpath, err := runnable.GoEnv("GOPATH")
if err != nil {
return "", errors.Wrap(err, "go env GOPATH")
}
return filepath.Join(gpath, "pkg/mod"), nil
}
func latestModVersion(listFile string) (_ string, err error) {
f, err := os.Open(listFile)
if err != nil {
return "", err
}
defer errcapture.Do(&err, f.Close, "list file close")
scanner := bufio.NewScanner(f)
var lastVersion string
for scanner.Scan() {
lastVersion = scanner.Text()
}
if err := scanner.Err(); err != nil {
return "", err
}
if lastVersion == "" {
return "", errors.New("empty file")
}
return lastVersion, nil
}
// encodePath returns the safe encoding of the given module path.
// It fails if the module path is invalid.
// Copied & modified from https://github.com/golang/go/blob/c54bc3448390d4ae4495d6d2c03c9dd4111b08f1/src/cmd/go/internal/module/module.go#L421
func encodePath(path string) string {
haveUpper := false
for _, r := range path {
if 'A' <= r && r <= 'Z' {
haveUpper = true
}
}
if !haveUpper {
return path
}
var buf []byte
for _, r := range path {
if 'A' <= r && r <= 'Z' {
buf = append(buf, '!', byte(r+'a'-'A'))
} else {
buf = append(buf, byte(r))
}
}
return string(buf)
}
// resolveInGoModCache will try to find a referenced module in the Go modules cache.
func resolveInGoModCache(logger *log.Logger, verbose bool, cacheModPath string, target *bingo.Package) error {
modMetaCache := filepath.Join(cacheModPath, "cache/download")
modulePath := target.Path()
// Case sensitivity problem is fixed by replacing upper case with '/!<lower case letter>` signature.
// See https://tip.golang.org/cmd/go/#hdr-Module_proxy_protocol
lookupModulePath := encodePath(modulePath)
// Since we don't know which part of full path is package, which part is module.
// Start from longest and go until we find one.
for ; len(strings.Split(lookupModulePath, "/")) >= 2; func() {
lookupModulePath = filepath.Dir(lookupModulePath)
modulePath = filepath.Dir(modulePath)
}() {
modMetaDir := filepath.Join(modMetaCache, lookupModulePath, "@v")
if _, err := os.Stat(modMetaDir); err != nil {
if !os.IsNotExist(err) {
return err
}
if verbose {
logger.Println("resolveInGoModCache:", modMetaDir, "directory does not exists")
}
continue
}
if verbose {
logger.Println("resolveInGoModCache: Found", modMetaDir, "directory")
}
// There are 2 major cases:
// 1. We have @latest or version is not pinned: find latest module having this package.
if target.Module.Version == "" || target.Module.Version == "latest" {
latest, err := latestModVersion(filepath.Join(modMetaDir, "list"))
if err != nil {
return errors.Wrapf(err, "get latest version from %v", filepath.Join(modMetaDir, "list"))
}
target.Module.Path = modulePath
target.Module.Version = latest
target.RelPath = strings.TrimPrefix(strings.TrimPrefix(target.RelPath, target.Module.Path), "/")
return nil
}
// 2. We don't @latest and have version pinned: find exact version then.
// Look for .info files that have exact version or sha.
if strings.HasPrefix(target.Module.Version, "v") {
if _, err := os.Stat(filepath.Join(modMetaDir, target.Module.Version+".info")); err != nil {
if !os.IsNotExist(err) {
return err
}
if verbose {
logger.Println("resolveInGoModCache:", filepath.Join(modMetaDir, target.Module.Version+".info"),
"file not exists. Looking for +incompatible info file")
}
// Try +incompatible.
if _, err := os.Stat(filepath.Join(modMetaDir, target.Module.Version+"+incompatible.info")); err != nil {
if !os.IsNotExist(err) {
return err
}
if verbose {
logger.Println("resolveInGoModCache:", filepath.Join(modMetaDir, target.Module.Version+"+incompatible.info"),
"file not exists. Looking for different module")
}
continue
}
target.Module.Version += "+incompatible"
}
target.Module.Path = modulePath
target.RelPath = strings.TrimPrefix(strings.TrimPrefix(target.RelPath, target.Module.Path), "/")
return nil
}
// We have commit sha.
files, err := os.ReadDir(modMetaDir)
if err != nil {
return err
}
for _, f := range files {
if f.IsDir() {
continue
}
if len(target.Module.Version) > 12 && strings.HasSuffix(f.Name(), fmt.Sprintf("%v.info", target.Module.Version[:12])) {
target.Module.Path = modulePath
target.Module.Version = strings.TrimSuffix(f.Name(), ".info")
target.RelPath = strings.TrimPrefix(strings.TrimPrefix(target.RelPath, target.Module.Path), "/")
return nil
}
}
if verbose {
ver := target.Module.Version
if len(ver) > 12 {
ver = ver[:12]
}
logger.Println("resolveInGoModCache: .info file for sha", ver, "does not exists. Looking for different module")
}
}
return errors.Newf("no module was cached matching given package %v", target.Path())
}
// getPackage takes package array index, tool name and package path (also module path and version which are optional) and
// generates new module with the given package's module as the only dependency (direct require statement).
// For generation purposes we take the existing <name>.mod file (if exists, if paths matches). This allows:
// - Comments to be preserved.
// - First direct require module will be preserved (unless version changes)
// - Replace to be preserved if the // bingo:no_replace_fetch commend is found it such mod file.
//
// As resolution of module vs package for Go Module is convoluted and all code is under internal dir, we have to rely on `go` binary
// capabilities and output.
// TODO(bwplotka): Consider copying code for it? Of course it's would be easier if such tool would exist in Go project itself (:
func getPackage(ctx context.Context, logger *log.Logger, c installPackageConfig, i int, name string, target bingo.Package) (err error) {
if c.verbose {
logger.Println("getting target", target.String(), "(module", target.Module.Path, ")")
}
// The out module file we generate/maintain keep in modDir.
outModFile := filepath.Join(c.modDir, name+".mod")
tmpEmptyModFilePath := filepath.Join(c.modDir, name+"-e.tmp.mod")
tmpModFilePath := filepath.Join(c.modDir, name+".tmp.mod")
if i > 0 {
// Handle array go modules.
outModFile = filepath.Join(c.modDir, fmt.Sprintf("%s.%d.mod", name, i))
tmpEmptyModFilePath = filepath.Join(c.modDir, fmt.Sprintf("%s.%d-e.tmp.mod", name, i))
tmpModFilePath = filepath.Join(c.modDir, fmt.Sprintf("%s.%d.tmp.mod", name, i))
}
outSumFile := strings.TrimSuffix(outModFile, ".mod") + ".sum"
// If we don't have all information, resolve version.
var fetchedDirectives nonRequireDirectives
if target.Module.Version == "" || !strings.HasPrefix(target.Module.Version, "v") || target.Module.Path == "" {
// Set up totally empty mod file to get clear version to install.
tmpEmptyModFile, err := bingo.CreateFromExistingOrNew(ctx, c.runner, logger, "", tmpEmptyModFilePath)
if err != nil {
return errors.Wrap(err, "create empty tmp mod file")
}
defer errcapture.Do(&err, tmpEmptyModFile.Close, "close")
runnable := c.runner.With(ctx, tmpEmptyModFile.Filepath(), c.modDir, nil)
if err := resolvePackage(logger, c.verbose, tmpEmptyModFile.Filepath(), runnable, &target); err != nil {
return err
}
if !strings.HasSuffix(target.Module.Version, "+incompatible") {
fetchedDirectives, err = autoFetchDirectives(runnable, logger, target)
if err != nil {
return err
}
}
}
// Now we should have target with all required info, prepare tmp file.
// TODO(bwplotka): Is this still needed?
if err := cleanGoGetTmpFiles(c.modDir); err != nil {
return err
}
tmpModFile, err := bingo.CreateFromExistingOrNew(ctx, c.runner, logger, outModFile, tmpModFilePath)
if err != nil {
return errors.Wrap(err, "create tmp mod file")
}
var closed bool
defer func() {
// This defer func is only to handle below set directive method failures since they still need to keep the file open.
if !closed {
errcapture.Do(&err, tmpModFile.Close, "close")
}
}()
if !tmpModFile.IsDirectivesAutoFetchDisabled() && !fetchedDirectives.isEmpty() {
if err := tmpModFile.SetReplaceDirectives(fetchedDirectives.replace...); err != nil {
return err
}
if err := tmpModFile.SetExcludeDirectives(fetchedDirectives.exclude...); err != nil {
return err
}
if err := tmpModFile.SetRetractDirectives(fetchedDirectives.retract...); err != nil {
return err
}
}
// Currently user can't specify build flags and envvars from CLI, take if from optionally, manually updated mod file.
if old := tmpModFile.DirectPackage(); old != nil {
target.BuildEnvs = old.BuildEnvs
target.BuildFlags = old.BuildFlags
}
if err := tmpModFile.SetDirectRequire(target); err != nil {
return err
}
if err := install(ctx, logger, c.runner, c.modDir, name, c.link, tmpModFile); err != nil {
return errors.Wrap(err, "install")
}
tmpModFileFilepath := tmpModFile.Filepath()
// We have close it once here so the defer func does not need to close it again.
closed = true
if err := tmpModFile.Close(); err != nil {
return err
}
// We were working on tmp file, do atomic rename.
if err := os.Rename(tmpModFileFilepath, outModFile); err != nil {
return errors.Wrap(err, "rename mod file")
}
if err := os.Rename(bingo.SumFilePath(tmpModFileFilepath), outSumFile); err != nil {
return errors.Wrap(err, "rename sum file")
}
return nil
}
func localGoModFileAfterGet(gopath string, target bingo.Package) string {
modulePath := target.Module.String()
// Go get uses special notation for non-supported names. See https://github.com/bwplotka/bingo/issues/65.
var b strings.Builder
b.Grow(len(modulePath))
for i := 0; i < len(modulePath); i++ {
c := rune(modulePath[i])
if 'A' <= c && c <= 'Z' {
b.WriteByte('!')
c = unicode.To(unicode.LowerCase, c)
}
b.WriteRune(c)
}
return filepath.Join(gopath, "pkg", "mod", b.String(), "go.mod")
}
type nonRequireDirectives struct {
replace []mod.ReplaceDirective
exclude []mod.ExcludeDirective
retract []mod.RetractDirective
}
func (d nonRequireDirectives) isEmpty() bool {
return len(d.replace) == 0 && len(d.exclude) == 0 && len(d.retract) == 0
}
// autoFetchDirectives is returning all non-require directives, that allows bingo to use exactly the same exclude, replace and retract statement
// as the target module we want to install.
// It's a very common case where modules mitigate faulty modules or conflicts with replace directives.
// Since we always download single tool dependency module per tool module, we can copy its non-require statements if exists to fix this common case.
func autoFetchDirectives(runnable runner.Runnable, logger *log.Logger, target bingo.Package) (d nonRequireDirectives, _ error) {
gopath, err := runnable.GoEnv("GOPATH")
if err != nil {
return d, errors.Wrap(err, "go env")
}
// We leverage fact that when go get runs if downloads the version we find as relevant locally
// in the GOPATH/pkg/mod/...
targetModFile := localGoModFileAfterGet(gopath, target)
if _, err := os.Stat(targetModFile); err != nil {
if os.IsNotExist(err) {
// Pre module package.
return d, nil
}
return d, errors.Wrapf(err, "stat target mod directory %v", targetModFile)
}
// Mod directory has only read permissions.
targetModParsed, err := mod.OpenFileForRead(targetModFile)
if err != nil {
return d, errors.Wrapf(err, "parse target mod file %v", targetModFile)
}
if semver.MustParse(targetModParsed.GoVersion()).GreaterThan(runnable.GoVersion()) {
logger.Printf("WARNING: Go module you are trying to install requires higher Go version (%v) than you are using (%v). Use newer Go version to install it if you encounter build errors (e.g when generics were used).\n", targetModParsed.GoVersion(), runnable.GoVersion().String())
}
d.replace = targetModParsed.ReplaceDirectives()
d.exclude = targetModParsed.ExcludeDirectives()
d.retract = targetModParsed.RetractDirectives()
if len(d.retract) > 0 && runnable.GoVersion().LessThan(version.Go116) {
return d, errors.Newf("target Go module is using new 'retract' directive. Use Go1.16+ to build it")
}
return d, nil
}
// gobin mimics the way go install finds where to install go tool.
func gobin(runnable runner.Runnable) (string, error) {
binPath, err := runnable.GoEnv("GOBIN")
if err != nil {
return "", errors.Wrap(err, "go env GOBIN")
}
if binPath != "" {
return binPath, nil
}
gpath, err := runnable.GoEnv("GOPATH")
if err != nil {
return "", errors.Wrap(err, "go env GOPATH")
}
return filepath.Join(gpath, "bin"), nil
}
func install(ctx context.Context, logger *log.Logger, r *runner.Runner, modDir string, name string, link bool, modFile *bingo.ModFile) (err error) {
pkg := modFile.DirectPackage()
if err := validateTargetName(name); err != nil {
return errors.Wrap(err, pkg.String())
}
modCtx := r.With(ctx, modFile.Filepath(), modDir, nil)
// Check if path is pointing to non-buildable package.
var listArgs []string
listArgs = append(listArgs, modFile.DirectPackage().BuildFlags...)
listArgs = append(listArgs, "-mod=mod", "-f={{.Name}}", pkg.Path())
if listOutput, err := modCtx.List(listArgs...); err != nil {
return errors.Wrap(err, "list")
} else if !strings.HasSuffix(listOutput, "main") {
return errors.Newf("package %s is non-main (go list output %q), nothing to get and build", pkg.Path(), listOutput)
}
// Use go get -d to recreate .sum file
// TODO(bwplotka): Do it only if not present or if we update mod to new version?
if out, err := modCtx.GetD(modFile.DirectPackage().String()); err != nil {
return errors.Wrap(err, out)
}
gobin, err := gobin(modCtx)
if err != nil {
return errors.Wrap(err, "deduct GOBIN")
}
// go install does not define -modfile flag, so we mimic go install with go build -o instead.
binPath := filepath.Join(gobin, fmt.Sprintf("%s-%s", name, pkg.Module.Version))
// New context with new environment files.
modCtx = r.With(ctx, modFile.Filepath(), modDir, pkg.BuildEnvs)
if err := modCtx.Build(pkg.Path(), binPath, pkg.BuildFlags...); err != nil {
if strings.Contains(err.Error(), "module declares its path as: ") &&
strings.Contains(err.Error(), fmt.Sprintf("but was required as: %v", modFile.DirectPackage().Path())) {
// TODO(bwplotka): Add native mode for forks.
logger.Println("The", modFile.DirectPackage().Path(), "module is a potential fork, since go.mod has mismatching module."+
" Building forks is not supported yet. See https://github.com/bwplotka/bingo/issues/110.")
}
return errors.Wrap(err, "build versioned")
}
if !link {
return nil
}
if err := os.RemoveAll(filepath.Join(gobin, name)); err != nil {
return errors.Wrap(err, "rm")
}
if err := os.Symlink(binPath, filepath.Join(gobin, name)); err != nil {
return errors.Wrap(err, "symlink")
}
return nil
}
const modREADMEFmt = `# Project Development Dependencies.
This is directory which stores Go modules with pinned buildable package that is used within this repository, managed by <https://github.com/bwplotka/bingo>.
* Run ` + "`" + "bingo get" + "`" + ` to install all tools having each own module file in this directory.
* Run ` + "`" + "bingo get <tool>" + "`" + ` to install ` + "`" + "<tool>" + "`" + ` that have own module file in this directory.
* For Makefile: Make sure to put ` + "`" + "include %s/Variables.mk" + "`" + ` in your Makefile, then use ` + "`" + "\\$(<UPPER_CASE_TOOL_NAME>)" + "`" + ` variable where ` + "`" + "<tool>" + "`" + ` is the %s/` + "`" + "<tool>.mod" + "`" + `.
* For shell: Run ` + "`" + "source %s/variables.env" + "`" + ` to source all environment variable for each tool.
* See <https://github.com/bwplotka/bingo> or -h on how to add, remove or change binaries dependencies.
## Requirements
* Go 1.24.x or 1.25.x
`
const gitignore = `
# Ignore everything
*
# But not these files:
!.gitignore
!*.mod
!*.sum
!README.md
!Variables.mk
!variables.env
*tmp.mod
*tmp.sum
`
func ensureModDirExists(logger *log.Logger, relModDir string) error {
_, err := os.Stat(relModDir)
if err != nil {
if !os.IsNotExist(err) {
return errors.Wrapf(err, "stat bingo module dir %s", relModDir)
}
logger.Printf("Bingo not used before here, creating directory for pinned modules for you at %s\n", relModDir)
if err := os.MkdirAll(relModDir, os.ModePerm); err != nil {
return errors.Wrapf(err, "create moddir %s", relModDir)
}
}
// Hack against:
// "A file named go.mod must still be present in order to determine the module root directory, but it is not accessed."
// Ref: https://golang.org/doc/go1.14#go-flags
// TODO(bwplotka): Remove it: https://github.com/bwplotka/bingo/issues/20
if err := os.WriteFile(
filepath.Join(relModDir, bingo.FakeRootModFileName),
[]byte("module _ // Fake go.mod auto-created by 'bingo' for go -moddir compatibility with non-Go projects. Commit this file, together with other .mod files."),
0666,
); err != nil {
return err
}
// README.
if err := os.WriteFile(
filepath.Join(relModDir, "README.md"),
[]byte(fmt.Sprintf(modREADMEFmt, relModDir, relModDir, relModDir)),
0666,
); err != nil {
return err
}
// gitignore.
return os.WriteFile(filepath.Join(relModDir, ".gitignore"), []byte(gitignore), 0666)
}
func removeAllGlob(glob string) error {
files, err := filepath.Glob(glob)
if err != nil {
return err
}
for _, f := range files {
if err := os.RemoveAll(f); err != nil {
return err
}
}
return nil
}