/
build.go
186 lines (155 loc) · 5.03 KB
/
build.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
// package golang provides util functions for managing Go project with Go.
package golang
import (
"context"
"crypto/sha256"
"encoding/hex"
"fmt"
"io"
"os"
"path"
"strings"
"github.com/magefile/mage/sh"
)
// BinDir is base directory for build outputs.
const BinDir = "./target/bin/"
// BuildInfo contains relevant information about produced binary.
type BuildInfo struct {
BinPath string
GOOS string
GOARCH string
}
type (
BuildPlatform struct{ OS, Arch string }
BuildMatrix []BuildPlatform
)
// DefaultBuildMatrix defines subset of cross-compile targets supported by Go.
var DefaultBuildMatrix = BuildMatrix{
{OS: "linux", Arch: "amd64"},
{OS: "linux", Arch: "arm64"},
{OS: "darwin", Arch: "amd64"},
{OS: "darwin", Arch: "arm64"},
}
// Build builds binary which is created under ./target/bin/{GOOS}/{GOARCH}/.
func Build(ctx context.Context, target string, buildArgs ...string) (BuildInfo, error) {
return BuildWith(ctx, nil, target, buildArgs...)
}
// BuildWith injects given env and builds binary which is created under ./target/bin/{GOOS}/{GOARCH}/.
func BuildWith(ctx context.Context, env map[string]string, target string, buildArgs ...string) (BuildInfo, error) {
return build(ctx, env, BinDir, target, buildArgs...)
}
// BuildForPlatform builds binary for wanted architecture and os.
func BuildForPlatform(ctx context.Context, goos, goarch, target string, buildArgs ...string) (BuildInfo, error) {
return BuildForPlatformWith(ctx, nil, goos, goarch, target, buildArgs...)
}
// BuildForPlatform injects env, builds binary for wanted architecture and os.
func BuildForPlatformWith(ctx context.Context, env map[string]string, goos, goarch, target string, buildArgs ...string) (BuildInfo, error) {
if env == nil {
env = map[string]string{}
}
env["GOOS"] = goos
env["GOARCH"] = goarch
return BuildWith(ctx, env, target, buildArgs...)
}
// WithSHA is a wrapper for build functions that adds SHA256Sum calculation.
func WithSHA(info BuildInfo, err error) (BuildInfo, error) {
if err != nil {
return BuildInfo{}, err
}
return info, SHA256Sum(info.BinPath, info.BinPath+".sha256")
}
// BuildForTesting builds binary that is instrumented for coverage collection and race detection.
func BuildForTesting(ctx context.Context, target string, raceDetection bool, binDir string) (BuildInfo, error) {
var env map[string]string
if !raceDetection {
env = map[string]string{
"CGO_ENABLED": "1",
}
}
pkgs, err := ListPackages(ctx, "./...")
if err != nil {
return BuildInfo{}, err
}
args := []string{"-cover", "-covermode", "atomic", "-coverpkg=" + strings.Join(pkgs, ",")}
if !raceDetection {
args = append([]string{"-race"}, args...)
}
return build(ctx, env, binDir, target, args...)
}
// BuildFromMatrixWithSHA is a higher level build utility function doing cross compilation with sha calculation.
func BuildFromMatrixWithSHA(ctx context.Context, env map[string]string, matrix BuildMatrix, target string, buildArgs ...string) ([]BuildInfo, error) {
info := make([]BuildInfo, 0, len(matrix))
for _, m := range matrix {
i, err := WithSHA(BuildForPlatformWith(ctx, env, m.OS, m.Arch, target, buildArgs...))
if err != nil {
return nil, err
}
info = append(info, i)
}
return info, nil
}
// ListPackages lists all packages in given target.
func ListPackages(ctx context.Context, target string) ([]string, error) {
pkgsRaw, err := sh.Output("go", "list", target)
if err != nil {
return nil, err
}
pkgs := strings.Split(strings.ReplaceAll(pkgsRaw, "\r\n", ","), "\n")
return pkgs, nil
}
// SHA256Sum calculates sum for input file and stores it in output file.
// Output should be compatible with sha256sum program.
func SHA256Sum(input, output string) error {
f, err := os.Open(input)
if err != nil {
return err
}
defer f.Close()
data, err := io.ReadAll(f)
if err != nil {
return err
}
sum := sha256.Sum256(data)
hexSum := hex.EncodeToString(sum[:])
sumFile, err := os.Create(output)
if err != nil {
return err
}
defer f.Close()
_, err = fmt.Fprintf(sumFile, "%s *%s\n", hexSum, input)
if err != nil {
return err
}
return nil
}
func build(ctx context.Context, env map[string]string, base, target string, buildArgs ...string) (BuildInfo, error) {
info, err := prepareBuildInfo(env, base, target)
if err != nil {
return BuildInfo{}, err
}
args := append([]string{"build", "-o", info.BinPath}, append(buildArgs, target)...)
if err = GoWith(ctx, env, args...); err != nil {
return BuildInfo{}, err
}
return info, nil
}
func prepareBuildInfo(env map[string]string, base, target string) (BuildInfo, error) {
goos, err := sh.Output("go", "env", "GOOS")
if err != nil {
return BuildInfo{}, err
}
goarch, err := sh.Output("go", "env", "GOARCH")
if err != nil {
return BuildInfo{}, err
}
if envOS, ok := env["GOOS"]; ok {
goos = envOS
}
if envArch, ok := env["GOARCH"]; ok {
goarch = envArch
}
parts := strings.Split(strings.TrimSuffix(target, "/"), "/")
name := parts[len(parts)-1]
binaryPath := path.Join(base, goos, goarch, name)
return BuildInfo{BinPath: binaryPath, GOOS: goos, GOARCH: goarch}, nil
}