Skip to content

fix: Better build overrides #1492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 3 commits into from
Jan 29, 2024
Merged

fix: Better build overrides #1492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
965f881
fix: Better build overrides
candiduslynx Jan 29, 2024
b65c907
explicit cgo param
candiduslynx Jan 29, 2024
a6d6867
rename
candiduslynx Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions plugin/options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,6 @@ func WithJSONSchema(schema string) Option {
}
}

func WithStaticLinking() Option {
return func(p *Plugin) {
p.staticLinking = true
}
}

func WithKind(kind string) Option {
k := Kind(kind)
err := k.Validate()
Expand Down
7 changes: 0 additions & 7 deletions plugin/plugin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,6 @@ type Plugin struct {
targets []BuildTarget
// Called upon init call to validate and init configuration
newClient NewClientFunc
// staticLinking true if C libraries should be added to compiled executable
staticLinking bool
// Logger to call, this logger is passed to the serve.Serve Client, if not defined Serve will create one instead.
logger zerolog.Logger
// mu is a mutex that limits the number of concurrent init/syncs (can only be one at a time)
Expand Down Expand Up @@ -172,11 +170,6 @@ func (p *Plugin) OnSyncFinish(ctx context.Context) error {
return nil
}

// IsStaticLinkingEnabled whether static linking is to be enabled
func (p *Plugin) IsStaticLinkingEnabled() bool {
return p.staticLinking
}

func (p *Plugin) Targets() []BuildTarget {
return p.targets
}
Expand Down
30 changes: 23 additions & 7 deletions plugin/plugin_package.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,30 @@ const (
)

type BuildTarget struct {
OS string `json:"os"`
Arch string `json:"arch"`
OS string `json:"os"`
Arch string `json:"arch"`
CGO bool `json:"cgo"`
Env []string `json:"env"`
}

func (t BuildTarget) EnvVariables() []string {
cgo := "CGO_ENABLED="
if t.CGO {
cgo += "1"
} else {
cgo += "0"
}
return append([]string{
"GOOS=" + t.OS,
"GOARCH=" + t.Arch,
cgo, // default is to tool at the param. Can be overridden by adding `CGO_ENABLED=1` to BuildTarget.Env
}, t.Env...)
}

var DefaultBuildTargets = []BuildTarget{
{GoOSLinux, GoArchAmd64},
{GoOSLinux, GoArchArm64},
{GoOSWindows, GoArchAmd64},
{GoOSDarwin, GoArchAmd64},
{GoOSDarwin, GoArchArm64},
{OS: GoOSLinux, Arch: GoArchAmd64},
{OS: GoOSLinux, Arch: GoArchArm64},
{OS: GoOSWindows, Arch: GoArchAmd64},
{OS: GoOSDarwin, Arch: GoArchAmd64},
{OS: GoOSDarwin, Arch: GoArchArm64},
}
18 changes: 6 additions & 12 deletions serve/package.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,28 +107,22 @@ func (s *PluginServe) writeTablesJSON(ctx context.Context, dir string) error {
return os.WriteFile(outputPath, buffer.Bytes(), 0644)
}

func (s *PluginServe) build(pluginDirectory, goos, goarch, distPath, pluginVersion string) (*TargetBuild, error) {
pluginFileName := fmt.Sprintf("plugin-%s-%s-%s-%s", s.plugin.Name(), pluginVersion, goos, goarch)
func (s *PluginServe) build(pluginDirectory string, target plugin.BuildTarget, distPath, pluginVersion string) (*TargetBuild, error) {
pluginFileName := fmt.Sprintf("plugin-%s-%s-%s-%s", s.plugin.Name(), pluginVersion, target.OS, target.Arch)
pluginPath := path.Join(distPath, pluginFileName)
importPath, err := s.getModuleName(pluginDirectory)
if err != nil {
return nil, err
}
ldFlags := fmt.Sprintf("-s -w -X %[1]s/plugin.Version=%[2]s -X %[1]s/resources/plugin.Version=%[2]s", importPath, pluginVersion)
if s.plugin.IsStaticLinkingEnabled() && strings.EqualFold(goos, plugin.GoOSLinux) {
ldFlags += " -linkmode external -extldflags=-static"
}
args := []string{"build", "-o", pluginPath}
args = append(args, "-buildmode=exe")
args = append(args, "-ldflags", ldFlags)
cmd := exec.Command("go", args...)
cmd.Dir = pluginDirectory
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Env = os.Environ()
cmd.Env = append(cmd.Env, fmt.Sprintf("GOOS=%s", goos))
cmd.Env = append(cmd.Env, fmt.Sprintf("GOARCH=%s", goarch))
cmd.Env = append(cmd.Env, fmt.Sprintf("CGO_ENABLED=%v", getEnvOrDefault("CGO_ENABLED", "0"))) // default to CGO_ENABLED=0
cmd.Env = append(os.Environ(), target.EnvVariables()...)
if err := cmd.Run(); err != nil {
return nil, fmt.Errorf("failed to build plugin with `go %v`: %w", args, err)
}
Expand Down Expand Up @@ -178,8 +172,8 @@ func (s *PluginServe) build(pluginDirectory, goos, goarch, distPath, pluginVersi
}

return &TargetBuild{
OS: goos,
Arch: goarch,
OS: target.OS,
Arch: target.Arch,
Path: targetZip,
Checksum: "sha256:" + checksum,
}, nil
Expand Down Expand Up @@ -421,7 +415,7 @@ func (s *PluginServe) newCmdPluginPackage() *cobra.Command {
targets := []TargetBuild{}
for _, target := range s.plugin.Targets() {
fmt.Println("Building for OS: " + target.OS + ", ARCH: " + target.Arch)
targetBuild, err := s.build(pluginDirectory, target.OS, target.Arch, distPath, pluginVersion)
targetBuild, err := s.build(pluginDirectory, target, distPath, pluginVersion)
if err != nil {
return fmt.Errorf("failed to build plugin for %s/%s: %w", target.OS, target.Arch, err)
}
Expand Down