-
Notifications
You must be signed in to change notification settings - Fork 3
/
cmd.go
131 lines (115 loc) · 3.66 KB
/
cmd.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
// Copyright 2023 Cisco Systems, Inc. and its affiliates
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
package build
import (
"context"
"fmt"
"github.com/cisco-open/go-lanai/cmd/lanai-cli/cmdutils"
"github.com/cisco-open/go-lanai/pkg/utils"
"github.com/spf13/cobra"
"os"
"strings"
"time"
)
var (
Cmd = &cobra.Command{
Use: "build [--version|-v version] [--ldflags additional_ldflags] -- [other 'go build' arguments]",
Short: "utilities to help build project with proper ldflags and mods",
FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
RunE: RunBuild,
}
Args = GeneralArguments{
Version: "Unknown",
}
)
type GeneralArguments struct {
Version string `flag:"version,v" desc:"Version value to be included as 'version' in build info"`
Modules []string `flag:"deps,d" desc:"Comma delimited list of <module_path> to be included as 'dependencies'' in build info. Note: if <module_path> is followed by [@branch], the branch value is ignored"`
LdFlags string `flag:"ldflags" desc:"Additional ldflags passed to \"go build\""`
}
func init() {
cmdutils.PersistentFlags(Cmd, &Args)
}
func RunBuild(cmd *cobra.Command, args []string) error {
// calculate build info ldflags
ldflags := strings.Join([]string {
ldFlagsForBuildInfo(cmd.Context()),
Args.LdFlags,
}, " ")
// go build
shcmd := fmt.Sprintf(`go build -ldflags="%s" %s`, ldflags, strings.Join(args, " "))
_, e := cmdutils.RunShellCommands(cmd.Context(),
cmdutils.ShellShowCmd(true),
cmdutils.ShellUseWorkingDir(),
cmdutils.ShellCmd(shcmd),
cmdutils.ShellStdOut(os.Stdout),
)
return e
}
func ldFlagsForBuildInfo(ctx context.Context) string {
flags := []string {
ldFlagBootstrapVariable("BuildVersion", Args.Version),
ldFlagBootstrapVariable("BuildTime", time.Now().Format(utils.ISO8601Seconds)),
ldFlagBootstrapVariable("BuildHash", gitHeadHash(ctx)),
ldFlagBootstrapVariable("BuildDeps", moduleDeps(ctx)),
}
return strings.Join(flags, " ")
}
// ldFlagBuildInfoVariable work with bootstrap.*
func ldFlagBootstrapVariable(varName string, v string ) string {
if v == "" {
return ""
}
return fmt.Sprintf("-X '%s/pkg/bootstrap.%s=%s'", cmdutils.ModulePath, varName, v)
}
func gitHeadHash(ctx context.Context) string {
gitutils, e := cmdutils.NewGitUtilsWithWorkingDir()
if e != nil {
return ""
}
hash, e := gitutils.WithContext(ctx).HeadCommitHash()
if e != nil {
return ""
}
return hash.String()
}
func moduleDeps(ctx context.Context) string {
modPaths := utils.NewStringSet(cmdutils.ModulePath)
for _, m := range Args.Modules {
path := strings.TrimSpace(strings.SplitN(m, "@", 2)[0])
if path != "" {
modPaths.Add(path)
}
}
mods, e := cmdutils.FindModule(ctx, nil, modPaths.Values()...)
if e != nil {
return ""
}
var modules []string
for _, m := range mods {
ver := m.Version
switch {
case m.Replace != nil && m.Replace.Version != "":
ver = m.Replace.Version
case m.Replace != nil:
ver = "0.0.0-SNAPSHOT"
case ver == "":
ver = "0.0.0-UNKNOWN"
}
modules = append(modules, fmt.Sprintf("%s@%s", m.Path, ver))
}
return strings.Join(modules, ",")
}