golang

type MixinImproveDebugging ¶

type MixinImproveDebugging struct{}

MixinImproveDebugging is a task.Mixin for golang.Options to add linker flags to improve the debugging of binary artifacts. This includes the disabling of inlining and all compiler optimizations to improve the compatibility for debuggers.

Note that this mixin adds the "all" prefix for "-gcflags" parameters to make sure all packages are affected. If you disabled the "all" prefix on purpose you need to handle this conflict on your own, e.g. by creating more than one binary artifact each with different build options.

See `go help build` and `go tool compile -help` for the documentation of supported flags.

References

• https://golang.org/cmd/link
• https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
• https://golang.org/doc/go1.10#build

func (m MixinImproveDebugging) Apply(so task.Options) (task.Options, error)

type MixinImproveEscapeAnalysis ¶

type MixinImproveEscapeAnalysis struct{}

MixinImproveEscapeAnalysis is a task.Mixin for golang.Options to add linker flags to improve the escape analysis of binary artifacts. Enables 2/4 level for reporting verbosity, higher levels are too noisy and rarely necessary.

Note that this mixin removes the "all" prefix for "-gcflags" parameters to make sure only the target package is affected, otherwise reports for (traverse) dependencies would be included as well. If you enabled the "all" prefix on purpose you need to handle this conflict on your own, e.g. by creating more than one binary artifact each with different build options.

See `go help build` and `go tool compile -help` for the documentation of supported flags.

References

• https://golang.org/cmd/link
• https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
• https://golang.org/doc/go1.10#build

func (m MixinImproveEscapeAnalysis) Apply(so task.Options) (task.Options, error)

type MixinInjectBuildTimeVariableValues ¶

type MixinInjectBuildTimeVariableValues struct {
	// Data is the map of key/value pairs to inject to variables at build-time.
	// The key must be the path to the variable in form of "<IMPORT_PATH>.<VARIABLE_NAME>",
	// e.g. "pkg/internal/support/app.version".
	// The value is the actual value that will be assigned to the variable, e.g. the application version.
	Data map[string]string

	// GoModule is the identifier of the target Go module to inject the given key/value pairs into.
	GoModule *project.GoModuleID
}

MixinInjectBuildTimeVariableValues is a task.Mixin for golang.Options to inject build-time values through the `-X` linker flags to populate e.g. application metadata variables.

See `go help build`, `go tool compile -help` and the `go` command documentations for more details:

• https://www.digitalocean.com/community/tutorials/using-ldflags-to-set-version-information-for-go-applications
• https://blog.cloudflare.com/setting-go-variables-at-compile-time
• https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies

func (m MixinInjectBuildTimeVariableValues) Apply(so task.Options) (task.Options, error)

type MixinStripDebugMetadata ¶

type MixinStripDebugMetadata struct{}

MixinStripDebugMetadata is a task.Mixin for golang.Options to add linker flags to strip debug information from binary artifacts. This includes DWARF tables needed for debuggers, but keeps annotations needed for stack traces so panics are still readable. It also shrinks the file size and memory overhead as well as reducing the chance for possible security related problems due to enabled development features or debug information leaks.

See `go tool compile -help` and `go doc cmd/link` for the documentation of supported flags.

See the official Go documentations and other resources for more details:

• https://golang.org/cmd/link
• https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
• https://rakyll.org/go-tool-flags
• https://github.com/golang/go/wiki/CompilerOptimizations
• https://blog.filippo.io/shrink-your-go-binaries-with-this-one-weird-trick

Note that this mixin adds the "all" prefix for "-gcflags" parameters to make sure all packages are affected If you disabled the "all" prefix on purpose you need to handle this conflict on your own, e.g. by creating more than one binary artifact each with different build options.

See `go help build`, `go tool compile -help` and the `go` command documentations for more details:

• https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
• https://golang.org/doc/go1.10#build

A subsequent optimization could be the usage of UPX (https://github.com/upx/upx) to compress the binary artifact afterwards.

func (m MixinStripDebugMetadata) Apply(so task.Options) (task.Options, error)

type Option ¶

type Option func(*Options)

Option is a shared Go toolchain task option.

func WithAsmFlags(asmFlags ...string) Option

func WithEnv(env map[string]string) Option

func WithFlags(flags ...string) Option

func WithFlagsPrefixAll(flagsPrefixAll bool) Option

func WithGcFlags(gcFlags ...string) Option

func WithLdFlags(ldFlags ...string) Option

func WithMixins(mixins ...task.Mixin) Option

func WithRaceDetector(enableRaceDetector bool) Option

func WithTags(tags ...string) Option

func WithTrimmedPath(enableTrimPath bool) Option

type Options ¶

type Options struct {
	// AsmFlags are arguments for the `-asmflags` flag that are passed to each `go tool asm` invocation.
	//
	// See `go help buildmode`, `go help build` and the `go` command documentations for more details:
	//   - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	AsmFlags []string

	// EnableRaceDetector indicates whether the race detector should be enabled.
	//
	// See `go help build` and the `go` command documentations for more details:
	//   - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	//   - https://golang.org/cmd/go/#hdr-Testing_flags
	EnableRaceDetector bool

	// EnableTrimPath indicates whether all file system paths should be removed from the resulting executable.
	// This is done by adding compiler and linker flags to remove the absolute path to the project root directory from
	// binary artifacts.
	//
	// See `go help build` and the `go` command documentations for more details:
	//   - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	//   - https://golang.org/doc/go1.13#go-command
	EnableTrimPath bool

	// Env is the Go toolchain specific environment.
	Env map[string]string

	// Flags are additional flags passed to the `go` command.
	//
	// See `go help build` and the `go` command documentations for more details:
	//   - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	Flags []string

	// FlagsPrefixAll indicates whether values of `-asmflags` and `-gcflags` should be prefixed with the `all=`
	// pattern in order to apply to all packages.
	// As of Go 1.10 (https://golang.org/doc/go1.10#build), the value specified to `-asmflags` and `-gcflags` are only
	// applied to the current package, therefore the `all=` pattern is used to apply the flag to all packages.
	//
	// See `go help build` and the `go` command documentations for more details:
	//   - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	//   - https://golang.org/doc/go1.10#build
	FlagsPrefixAll bool

	// GcFlags are arguments for the `-gcflags` flag that are passed to each `go tool compile` invocation.
	//
	// See `go help buildmode`, `go help build` and the `go` command documentations for more details:
	//   - https://golang.org/cmd/go/#hdr-Build_modes
	//   - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	GcFlags []string

	// LdFlags are arguments for the `-ldflags` flag that are passed to each `go tool link` invocation.
	//
	// See `go help buildmode`, `go help build` and the `go` command documentations for more details:
	//   - https://golang.org/cmd/go/#hdr-Build_modes
	//   - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	LdFlags []string

	// Tags are Go tags.
	//
	// See `go help build` and the `go` command documentations for more details:
	//   - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	Tags []string
	// contains filtered or unexported fields
}

Options are shared Go toolchain task options.

References

• https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies

func NewOptions(opts ...Option) *Options

type Runner ¶

type Runner struct {
	// contains filtered or unexported fields
}

Runner is a task runner for the Go toolchain.

func NewRunner(opts ...RunnerOption) *Runner

func (r *Runner) FilePath() string

func (r *Runner) Handles() task.Kind

func (r *Runner) Run(t task.Task) error

func (r *Runner) RunOut(t task.Task) (string, error)

func (r *Runner) Validate() error

type RunnerOption ¶

type RunnerOption func(*RunnerOptions)

RunnerOption is a runner option.

func WithRunnerEnv(env map[string]string) RunnerOption

func WithRunnerExec(nameOrPath string) RunnerOption

func WithRunnerQuiet(quiet bool) RunnerOption

type RunnerOptions ¶

type RunnerOptions struct {
	// Env is the runner specific environment.
	Env map[string]string

	// Exec is the name or path of the runner command executable.
	Exec string

	// Quiet indicates whether the runner output should be minimal.
	Quiet bool
}

RunnerOptions are runner options.

func NewRunnerOptions(opts ...RunnerOption) *RunnerOptions