-
Notifications
You must be signed in to change notification settings - Fork 131
/
tools.go
411 lines (344 loc) · 10.6 KB
/
tools.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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
package tools
import (
"bytes"
"errors"
"fmt"
"io"
"io/ioutil"
"net/http"
"os"
"os/exec"
"path/filepath"
"runtime"
"time"
"github.com/bitrise-io/bitrise/configs"
"github.com/bitrise-io/bitrise/log"
"github.com/bitrise-io/bitrise/tools/timeoutcmd"
envman "github.com/bitrise-io/envman/cli"
envmanEnv "github.com/bitrise-io/envman/env"
envmanModels "github.com/bitrise-io/envman/models"
"github.com/bitrise-io/go-utils/command"
"github.com/bitrise-io/go-utils/pathutil"
stepman "github.com/bitrise-io/stepman/cli"
stepmanModels "github.com/bitrise-io/stepman/models"
"golang.org/x/sys/unix"
)
// UnameGOOS ...
func UnameGOOS() (string, error) {
switch runtime.GOOS {
case "darwin":
return "Darwin", nil
case "linux":
return "Linux", nil
}
return "", fmt.Errorf("Unsupported platform (%s)", runtime.GOOS)
}
// UnameGOARCH ...
func UnameGOARCH() (string, error) {
switch runtime.GOARCH {
case "amd64":
return "x86_64", nil
case "arm64":
return "arm64", nil
}
return "", fmt.Errorf("Unsupported architecture (%s)", runtime.GOARCH)
}
// InstallToolFromGitHub ...
func InstallToolFromGitHub(toolname, githubUser, toolVersion string) error {
unameGOOS, err := UnameGOOS()
if err != nil {
return fmt.Errorf("Failed to determine OS: %s", err)
}
unameGOARCH, err := UnameGOARCH()
if err != nil {
return fmt.Errorf("Failed to determine ARCH: %s", err)
}
downloadURL := "https://github.com/" + githubUser + "/" + toolname + "/releases/download/" + toolVersion + "/" + toolname + "-" + unameGOOS + "-" + unameGOARCH
return InstallFromURL(toolname, downloadURL)
}
// DownloadFile ...
func DownloadFile(downloadURL, targetDirPath string) error {
outFile, err := os.Create(targetDirPath)
defer func() {
if err := outFile.Close(); err != nil {
log.Warnf("Failed to close (%s)", targetDirPath)
}
}()
if err != nil {
return fmt.Errorf("failed to create (%s), error: %s", targetDirPath, err)
}
resp, err := http.Get(downloadURL)
if err != nil {
return fmt.Errorf("failed to download from (%s), error: %s", downloadURL, err)
}
defer func() {
if err := resp.Body.Close(); err != nil {
log.Warnf("failed to close (%s) body", downloadURL)
}
}()
_, err = io.Copy(outFile, resp.Body)
if err != nil {
return fmt.Errorf("failed to download from (%s), error: %s", downloadURL, err)
}
return nil
}
// InstallFromURL ...
func InstallFromURL(toolBinName, downloadURL string) error {
if len(toolBinName) < 1 {
return fmt.Errorf("no Tool (bin) Name provided! URL was: %s", downloadURL)
}
tmpDir, err := pathutil.NormalizedOSTempDirPath("__tmp_download_dest__")
if err != nil {
return fmt.Errorf("failed to create tmp dir for download destination")
}
tmpDestinationPth := filepath.Join(tmpDir, toolBinName)
if err := DownloadFile(downloadURL, tmpDestinationPth); err != nil {
return fmt.Errorf("failed to download, error: %s", err)
}
bitriseToolsDirPath := configs.GetBitriseToolsDirPath()
destinationPth := filepath.Join(bitriseToolsDirPath, toolBinName)
if exist, err := pathutil.IsPathExists(destinationPth); err != nil {
return fmt.Errorf("failed to check if file exist (%s), error: %s", destinationPth, err)
} else if exist {
if err := os.Remove(destinationPth); err != nil {
return fmt.Errorf("failed to remove file (%s), error: %s", destinationPth, err)
}
}
if err := MoveFile(tmpDestinationPth, destinationPth); err != nil {
return fmt.Errorf("failed to copy (%s) to (%s), error: %s", tmpDestinationPth, destinationPth, err)
}
if err := os.Chmod(destinationPth, 0755); err != nil {
return fmt.Errorf("failed to make file (%s) executable, error: %s", destinationPth, err)
}
return nil
}
// ------------------
// --- Stepman
// StepmanSetup ...
func StepmanSetup(collection string) error {
log := log.NewLogger(log.GetGlobalLoggerOpts())
return stepman.Setup(collection, "", log)
}
// StepmanUpdate ...
func StepmanUpdate(collection string) error {
log := log.NewLogger(log.GetGlobalLoggerOpts())
return stepman.UpdateLibrary(collection, log)
}
// StepmanActivate ...
func StepmanActivate(collection, stepID, stepVersion, dir, ymlPth string) error {
log := log.NewLogger(log.GetGlobalLoggerOpts())
return stepman.Activate(collection, stepID, stepVersion, dir, ymlPth, false, log)
}
// StepmanStepInfo ...
func StepmanStepInfo(collection, stepID, stepVersion string) (stepmanModels.StepInfoModel, error) {
log := log.NewLogger(log.GetGlobalLoggerOpts())
return stepman.QueryStepInfo(collection, stepID, stepVersion, log)
}
// StepmanRawStepList ...
func StepmanRawStepList(collection string) (string, error) {
args := []string{"step-list", "--collection", collection, "--format", "raw"}
return command.RunCommandAndReturnCombinedStdoutAndStderr("stepman", args...)
}
// StepmanJSONStepList ...
func StepmanJSONStepList(collection string) (string, error) {
args := []string{"step-list", "--collection", collection, "--format", "json"}
var outBuffer bytes.Buffer
var errBuffer bytes.Buffer
if err := command.RunCommandWithWriters(io.Writer(&outBuffer), io.Writer(&errBuffer), "stepman", args...); err != nil {
return outBuffer.String(), fmt.Errorf("Error: %s, details: %s", err, errBuffer.String())
}
return outBuffer.String(), nil
}
//
// Share
// StepmanShare ...
func StepmanShare() error {
args := []string{"share", "--toolmode"}
return command.RunCommand("stepman", args...)
}
// StepmanShareAudit ...
func StepmanShareAudit() error {
args := []string{"share", "audit", "--toolmode"}
return command.RunCommand("stepman", args...)
}
// StepmanShareCreate ...
func StepmanShareCreate(tag, git, stepID string) error {
args := []string{"share", "create", "--tag", tag, "--git", git, "--stepid", stepID, "--toolmode"}
return command.RunCommand("stepman", args...)
}
// StepmanShareFinish ...
func StepmanShareFinish() error {
args := []string{"share", "finish", "--toolmode"}
return command.RunCommand("stepman", args...)
}
// StepmanShareStart ...
func StepmanShareStart(collection string) error {
args := []string{"share", "start", "--collection", collection, "--toolmode"}
return command.RunCommand("stepman", args...)
}
// ------------------
// --- Envman
// EnvmanInit ...
func EnvmanInit(envStorePth string, clear bool) error {
return envman.InitEnvStore(envStorePth, clear)
}
// EnvmanAdd ...
func EnvmanAdd(envStorePth, key, value string, expand, skipIfEmpty, sensitive bool) error {
return envman.AddEnv(envStorePth, key, value, expand, false, skipIfEmpty, sensitive)
}
// EnvmanAddEnvs ...
func EnvmanAddEnvs(envstorePth string, envsList []envmanModels.EnvironmentItemModel) error {
for _, env := range envsList {
key, value, err := env.GetKeyValuePair()
if err != nil {
return err
}
opts, err := env.GetOptions()
if err != nil {
return err
}
isExpand := envmanModels.DefaultIsExpand
if opts.IsExpand != nil {
isExpand = *opts.IsExpand
}
skipIfEmpty := envmanModels.DefaultSkipIfEmpty
if opts.SkipIfEmpty != nil {
skipIfEmpty = *opts.SkipIfEmpty
}
sensitive := envmanModels.DefaultIsSensitive
if opts.IsSensitive != nil {
sensitive = *opts.IsSensitive
}
if err := EnvmanAdd(envstorePth, key, value, isExpand, skipIfEmpty, sensitive); err != nil {
return err
}
}
return nil
}
// EnvmanReadEnvList ...
func EnvmanReadEnvList(envStorePth string) (envmanModels.EnvsJSONListModel, error) {
return envman.ReadEnvsJSONList(envStorePth, true, false, &envmanEnv.DefaultEnvironmentSource{})
}
// EnvmanClear ...
func EnvmanClear(envStorePth string) error {
return envman.ClearEnvs(envStorePth)
}
type Flusher interface {
Flush() (int, error)
}
type ErrorParser interface {
ErrorMessages() []string
}
// EnvmanRun runs a command through envman.
func EnvmanRun(envStorePth,
workDirPth string,
cmdArgs []string,
timeout time.Duration,
noOutputTimeout time.Duration,
stdInPayload []byte,
outWriter io.Writer,
) (int, error) {
envs, err := envman.ReadAndEvaluateEnvs(envStorePth, &envmanEnv.DefaultEnvironmentSource{})
if err != nil {
return 1, fmt.Errorf("failed to read command environment: %w", err)
}
var inReader io.Reader
if stdInPayload != nil {
inReader = bytes.NewReader(stdInPayload)
} else {
inReader = os.Stdin
}
name := cmdArgs[0]
var args []string
if len(cmdArgs) > 1 {
args = cmdArgs[1:]
}
cmd := timeoutcmd.New(workDirPth, name, args...)
cmd.SetTimeout(timeout)
cmd.SetHangTimeout(noOutputTimeout)
cmd.SetStandardIO(inReader, outWriter, outWriter)
cmd.SetEnv(append(envs, "PWD="+workDirPth))
err = cmd.Start()
// flush the writer anyway if the process is finished
flusher, isFlusher := outWriter.(Flusher)
if isFlusher {
if _, ferr := flusher.Flush(); ferr != nil {
log.Warnf("Couldn't flush command output logs: %s", ferr)
}
}
// return error message from the command output
errorParser, isErrorParser := outWriter.(ErrorParser)
if err != nil {
var exitErr *exec.ExitError
if errors.As(err, &exitErr) {
exitCode := exitErr.ExitCode()
if isErrorParser {
errorMessages := errorParser.ErrorMessages()
if len(errorMessages) > 0 {
lastErrorMessage := errorMessages[len(errorMessages)-1]
return exitCode, errors.New(lastErrorMessage)
}
}
return exitCode, err
} else {
return 1, fmt.Errorf("executing command failed: %w", err)
}
}
return 0, nil
}
// ------------------
// --- Utility
// GetSecretValues filters out built in configuration parameters from the secret envs
func GetSecretValues(secrets []envmanModels.EnvironmentItemModel) []string {
var secretValues []string
for _, secret := range secrets {
key, value, err := secret.GetKeyValuePair()
if err != nil || len(value) < 1 || IsBuiltInFlagTypeKey(key) {
if err != nil {
log.Warnf("Error getting key-value pair from secret (%v): %s", secret, err)
}
continue
}
secretValues = append(secretValues, value)
}
return secretValues
}
// MoveFile ...
func MoveFile(oldpath, newpath string) error {
err := os.Rename(oldpath, newpath)
if err == nil {
return nil
}
if linkErr, ok := err.(*os.LinkError); ok {
if linkErr.Err == unix.EXDEV {
info, err := os.Stat(oldpath)
if err != nil {
return err
}
data, err := ioutil.ReadFile(oldpath)
if err != nil {
return err
}
err = ioutil.WriteFile(newpath, data, info.Mode())
if err != nil {
return err
}
return os.Remove(oldpath)
}
}
return err
}
// IsBuiltInFlagTypeKey returns true if the env key is a built-in flag type env key
func IsBuiltInFlagTypeKey(env string) bool {
switch env {
case configs.IsSecretFilteringKey,
configs.IsSecretEnvsFilteringKey,
configs.CIModeEnvKey,
configs.PRModeEnvKey,
configs.DebugModeEnvKey,
configs.PullRequestIDEnvKey:
return true
default:
return false
}
}