Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: split go mod into 2 pipes (#2502)
Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>
- Loading branch information
Showing
6 changed files
with
427 additions
and
373 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| // Package gomod provides go modules utilities, such as template variables and the ability to proxy the module from | ||
| // proxy.golang.org. | ||
| package gomod |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| // Package gomod provides go modules utilities, such as template variables and the ability to proxy the module from | ||
| // proxy.golang.org. | ||
| package gomod | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "os/exec" | ||
| "path" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "github.com/apex/log" | ||
| "github.com/goreleaser/goreleaser/internal/tmpl" | ||
| "github.com/goreleaser/goreleaser/pkg/config" | ||
| "github.com/goreleaser/goreleaser/pkg/context" | ||
| ) | ||
|
|
||
| // ProxyPipe for gomod proxy. | ||
| type ProxyPipe struct{} | ||
|
|
||
| func (ProxyPipe) String() string { return "proxying go module" } | ||
|
|
||
| func (ProxyPipe) Skip(ctx *context.Context) bool { | ||
| return ctx.ModulePath == "" || !ctx.Config.GoMod.Proxy || ctx.Snapshot | ||
| } | ||
|
|
||
| // Run the ProxyPipe. | ||
| func (ProxyPipe) Run(ctx *context.Context) error { | ||
| for i := range ctx.Config.Builds { | ||
| build := &ctx.Config.Builds[i] | ||
| if err := proxyBuild(ctx, build); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| const goModTpl = ` | ||
| module {{ .BuildID }} | ||
| require {{ .ModulePath }} {{ .Tag }} | ||
| ` | ||
|
|
||
| const mainGoTpl = ` | ||
| // +build main | ||
| package main | ||
| import _ "{{ .Main }}" | ||
| ` | ||
|
|
||
| // ErrProxy happens when something goes wrong while proxying the current go module. | ||
| type ErrProxy struct { | ||
| err error | ||
| details string | ||
| } | ||
|
|
||
| func newErrProxy(err error) error { | ||
| return ErrProxy{ | ||
| err: err, | ||
| } | ||
| } | ||
|
|
||
| func newDetailedErrProxy(err error, details string) error { | ||
| return ErrProxy{ | ||
| err: err, | ||
| details: details, | ||
| } | ||
| } | ||
|
|
||
| func (e ErrProxy) Error() string { | ||
| out := fmt.Sprintf("failed to proxy module: %v", e.err) | ||
| if e.details != "" { | ||
| return fmt.Sprintf("%s: %s", out, e.details) | ||
| } | ||
| return out | ||
| } | ||
|
|
||
| func (e ErrProxy) Unwrap() error { | ||
| return e.err | ||
| } | ||
|
|
||
| func proxyBuild(ctx *context.Context, build *config.Build) error { | ||
| mainPackage := path.Join(ctx.ModulePath, build.Main) | ||
| if strings.HasSuffix(build.Main, ".go") { | ||
| pkg := path.Dir(build.Main) | ||
| log.Warnf("guessing package of '%s' to be '%s', if this is incorrect, setup 'build.%s.main' to be the correct package", build.Main, pkg, build.ID) | ||
| mainPackage = path.Join(ctx.ModulePath, pkg) | ||
| } | ||
| template := tmpl.New(ctx).WithExtraFields(tmpl.Fields{ | ||
| "Main": mainPackage, | ||
| "BuildID": build.ID, | ||
| }) | ||
|
|
||
| log.Infof("proxying %s@%s to build %s", ctx.ModulePath, ctx.Git.CurrentTag, mainPackage) | ||
|
|
||
| mod, err := template.Apply(goModTpl) | ||
| if err != nil { | ||
| return newErrProxy(err) | ||
| } | ||
|
|
||
| main, err := template.Apply(mainGoTpl) | ||
| if err != nil { | ||
| return newErrProxy(err) | ||
| } | ||
|
|
||
| dir := filepath.Join(ctx.Config.Dist, "proxy", build.ID) | ||
|
|
||
| log.Debugf("creating needed files") | ||
|
|
||
| if err := os.MkdirAll(dir, 0o755); err != nil { | ||
| return newErrProxy(err) | ||
| } | ||
|
|
||
| if err := os.WriteFile(filepath.Join(dir, "main.go"), []byte(main), 0o666); err != nil { | ||
| return newErrProxy(err) | ||
| } | ||
|
|
||
| if err := os.WriteFile(filepath.Join(dir, "go.mod"), []byte(mod), 0o666); err != nil { | ||
| return newErrProxy(err) | ||
| } | ||
|
|
||
| if err := copyGoSum("go.sum", filepath.Join(dir, "go.sum")); err != nil { | ||
| return newErrProxy(err) | ||
| } | ||
|
|
||
| log.Debugf("tidying") | ||
| cmd := exec.CommandContext(ctx, ctx.Config.GoMod.GoBinary, "mod", "tidy") | ||
| cmd.Dir = dir | ||
| cmd.Env = append(ctx.Config.GoMod.Env, os.Environ()...) | ||
| if out, err := cmd.CombinedOutput(); err != nil { | ||
| return newDetailedErrProxy(err, string(out)) | ||
| } | ||
|
|
||
| build.UnproxiedMain = build.Main | ||
| build.UnproxiedDir = build.Dir | ||
| build.Main = mainPackage | ||
| build.Dir = dir | ||
| return nil | ||
| } | ||
|
|
||
| func copyGoSum(src, dst string) error { | ||
| r, err := os.OpenFile(src, os.O_RDONLY, 0o666) | ||
| if err != nil { | ||
| if errors.Is(err, os.ErrNotExist) { | ||
| return nil | ||
| } | ||
| return err | ||
| } | ||
| defer r.Close() | ||
|
|
||
| w, err := os.Create(dst) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer w.Close() | ||
|
|
||
| _, err = io.Copy(w, r) | ||
| return err | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
f7c865cThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs: