forked from buildkite/agent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bootstrap.go
1636 lines (1359 loc) · 48.9 KB
/
bootstrap.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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package bootstrap
import (
"context"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"os"
"path"
"path/filepath"
"regexp"
"strconv"
"strings"
"time"
"github.com/buildkite/agent/v3/agent/plugin"
"github.com/buildkite/agent/v3/bootstrap/shell"
"github.com/buildkite/agent/v3/env"
"github.com/buildkite/agent/v3/experiments"
"github.com/buildkite/agent/v3/hook"
"github.com/buildkite/agent/v3/process"
"github.com/buildkite/agent/v3/retry"
"github.com/buildkite/agent/v3/utils"
"github.com/buildkite/shellwords"
"github.com/pkg/errors"
)
// RedactLengthMin is the shortest string length that will be considered a
// potential secret by the environment redactor. e.g. if the redactor is
// configured to filter out environment variables matching *_TOKEN, and
// API_TOKEN is set to "none", this minimum length will prevent the word "none"
// from being redacted from useful log output.
const RedactLengthMin = 6
// Bootstrap represents the phases of execution in a Buildkite Job. It's run
// as a sub-process of the buildkite-agent and finishes at the conclusion of a job.
// Historically (prior to v3) the bootstrap was a shell script, but was ported to
// Golang for portability and testability
type Bootstrap struct {
// Config provides the bootstrap configuration
Config
// Shell is the shell environment for the bootstrap
shell *shell.Shell
// Plugins to use
plugins []*plugin.Plugin
// Plugin checkouts from the plugin phases
pluginCheckouts []*pluginCheckout
// Directories to clean up at end of bootstrap
cleanupDirs []string
// A channel to track cancellation
cancelCh chan struct{}
}
// New returns a new Bootstrap instance
func New(conf Config) *Bootstrap {
return &Bootstrap{
Config: conf,
cancelCh: make(chan struct{}),
}
}
// Run the bootstrap and return the exit code
func (b *Bootstrap) Run(ctx context.Context) (exitCode int) {
// Check if not nil to allow for tests to overwrite shell
if b.shell == nil {
var err error
b.shell, err = shell.NewWithContext(ctx)
if err != nil {
fmt.Printf("Error creating shell: %v", err)
return 1
}
b.shell.PTY = b.Config.RunInPty
b.shell.Debug = b.Config.Debug
}
// Listen for cancellation
go func() {
select {
case <-ctx.Done():
return
case <-b.cancelCh:
b.shell.Commentf("Received cancellation signal, interrupting")
b.shell.Interrupt()
}
}()
// Tear down the environment (and fire pre-exit hook) before we exit
defer func() {
if err := b.tearDown(); err != nil {
b.shell.Errorf("Error tearing down bootstrap: %v", err)
// this gets passed back via the named return
exitCode = shell.GetExitCode(err)
}
}()
// Initialize the environment, a failure here will still call the tearDown
if err := b.setUp(); err != nil {
b.shell.Errorf("Error setting up bootstrap: %v", err)
return shell.GetExitCode(err)
}
var includePhase = func(phase string) bool {
if len(b.Phases) == 0 {
return true
}
for _, include := range b.Phases {
if include == phase {
return true
}
}
return false
}
// Execute the bootstrap phases in order
var phaseErr error
if includePhase(`plugin`) {
phaseErr = b.preparePlugins()
if phaseErr == nil {
phaseErr = b.PluginPhase()
}
}
if phaseErr == nil && includePhase(`checkout`) {
phaseErr = b.CheckoutPhase()
} else {
checkoutDir, exists := b.shell.Env.Get(`BUILDKITE_BUILD_CHECKOUT_PATH`)
if exists {
_ = b.shell.Chdir(checkoutDir)
}
}
if phaseErr == nil && includePhase(`plugin`) {
phaseErr = b.VendoredPluginPhase()
}
if phaseErr == nil && includePhase(`command`) {
phaseErr = b.CommandPhase()
// Only upload artifacts as part of the command phase
if err := b.uploadArtifacts(); err != nil {
b.shell.Errorf("%v", err)
return shell.GetExitCode(err)
}
}
// Phase errors are where something of ours broke that merits a big red error
// this won't include command failures, as we view that as more in the user space
if phaseErr != nil {
b.shell.Errorf("%v", phaseErr)
return shell.GetExitCode(phaseErr)
}
// Use the exit code from the command phase
exitStatus, _ := b.shell.Env.Get(`BUILDKITE_COMMAND_EXIT_STATUS`)
exitStatusCode, _ := strconv.Atoi(exitStatus)
return exitStatusCode
}
// Cancel interrupts any running shell processes and causes the bootstrap to stop
func (b *Bootstrap) Cancel() error {
b.cancelCh <- struct{}{}
return nil
}
// executeHook runs a hook script with the hookRunner
func (b *Bootstrap) executeHook(name string, hookPath string, extraEnviron *env.Environment) error {
if !utils.FileExists(hookPath) {
if b.Debug {
b.shell.Commentf("Skipping %s hook, no script at \"%s\"", name, hookPath)
}
return nil
}
b.shell.Headerf("Running %s hook", name)
if redactor := b.setupRedactor(); redactor != nil {
defer redactor.Flush()
}
// We need a script to wrap the hook script so that we can snaffle the changed
// environment variables
script, err := hook.CreateScriptWrapper(hookPath)
if err != nil {
b.shell.Errorf("Error creating hook script: %v", err)
return err
}
defer script.Close()
cleanHookPath := hookPath
// Show a relative path if we can
if strings.HasPrefix(hookPath, b.shell.Getwd()) {
var err error
if cleanHookPath, err = filepath.Rel(b.shell.Getwd(), hookPath); err != nil {
cleanHookPath = hookPath
}
}
// Show the hook runner in debug, but the thing being run otherwise 💅🏻
if b.Debug {
b.shell.Commentf("A hook runner was written to \"%s\" with the following:", script.Path())
b.shell.Promptf("%s", process.FormatCommand(script.Path(), nil))
} else {
b.shell.Promptf("%s", process.FormatCommand(cleanHookPath, []string{}))
}
// Run the wrapper script
if err := b.shell.RunScript(script.Path(), extraEnviron); err != nil {
exitCode := shell.GetExitCode(err)
b.shell.Env.Set("BUILDKITE_LAST_HOOK_EXIT_STATUS", fmt.Sprintf("%d", exitCode))
// Give a simpler error if it's just a shell exit error
if shell.IsExitError(err) {
return &shell.ExitError{
Code: exitCode,
Message: fmt.Sprintf("The %s hook exited with status %d", name, exitCode),
}
}
return err
}
// Store the last hook exit code for subsequent steps
b.shell.Env.Set("BUILDKITE_LAST_HOOK_EXIT_STATUS", "0")
// Get changed environment
changes, err := script.Changes()
if err != nil {
return errors.Wrapf(err, "Failed to get environment")
}
// Finally, apply changes to the current shell and config
b.applyEnvironmentChanges(changes.Env, changes.Dir)
return nil
}
func (b *Bootstrap) applyEnvironmentChanges(environ *env.Environment, dir string) {
if dir != b.shell.Getwd() {
_ = b.shell.Chdir(dir)
}
// Do we even have any environment variables to change?
if environ == nil || environ.Length() == 0 {
return
}
// First, let see any of the environment variables are supposed
// to change the bootstrap configuration at run time.
bootstrapConfigEnvChanges := b.Config.ReadFromEnvironment(environ)
// Print out the env vars that changed. As we go through each
// one, we'll determine if it was a special "bootstrap"
// environment variable that has changed the bootstrap
// configuration at runtime.
//
// If it's "special", we'll show the value it was changed to -
// otherwise we'll hide it. Since we don't know if an
// environment variable contains sensitive information (i.e.
// THIRD_PARTY_API_KEY) we'll just not show any values for
// anything not controlled by us.
for k, v := range environ.ToMap() {
if _, ok := bootstrapConfigEnvChanges[k]; ok {
b.shell.Commentf("%s is now %q", k, v)
} else {
b.shell.Commentf("%s changed", k)
}
}
// Now that we've finished telling the user what's changed,
// let's mutate the current shell environment to include all
// the new values.
b.shell.Env = b.shell.Env.Merge(environ)
}
func (b *Bootstrap) hasGlobalHook(name string) bool {
_, err := b.globalHookPath(name)
return err == nil
}
// Returns the absolute path to a global hook, or os.ErrNotExist if none is found
func (b *Bootstrap) globalHookPath(name string) (string, error) {
return hook.Find(b.HooksPath, name)
}
// Executes a global hook if one exists
func (b *Bootstrap) executeGlobalHook(name string) error {
if !b.hasGlobalHook(name) {
return nil
}
p, err := b.globalHookPath(name)
if err != nil {
return err
}
return b.executeHook("global "+name, p, nil)
}
// Returns the absolute path to a local hook, or os.ErrNotExist if none is found
func (b *Bootstrap) localHookPath(name string) (string, error) {
dir := filepath.Join(b.shell.Getwd(), ".buildkite", "hooks")
return hook.Find(dir, name)
}
func (b *Bootstrap) hasLocalHook(name string) bool {
_, err := b.localHookPath(name)
return err == nil
}
// Executes a local hook
func (b *Bootstrap) executeLocalHook(name string) error {
if !b.hasLocalHook(name) {
return nil
}
localHookPath, err := b.localHookPath(name)
if err != nil {
return nil
}
// For high-security configs, we allow the disabling of local hooks.
localHooksEnabled := b.Config.LocalHooksEnabled
// Allow hooks to disable local hooks by setting BUILDKITE_NO_LOCAL_HOOKS=true
noLocalHooks, _ := b.shell.Env.Get(`BUILDKITE_NO_LOCAL_HOOKS`)
if noLocalHooks == "true" || noLocalHooks == "1" {
localHooksEnabled = false
}
if !localHooksEnabled {
return fmt.Errorf("Refusing to run %s, local hooks are disabled", localHookPath)
}
return b.executeHook("local "+name, localHookPath, nil)
}
func dirForAgentName(agentName string) string {
badCharsPattern := regexp.MustCompile("[[:^alnum:]]")
return badCharsPattern.ReplaceAllString(agentName, "-")
}
func dirForRepository(repository string) string {
badCharsPattern := regexp.MustCompile("[[:^alnum:]]")
return badCharsPattern.ReplaceAllString(repository, "-")
}
// Given a repository, it will add the host to the set of SSH known_hosts on the machine
func addRepositoryHostToSSHKnownHosts(sh *shell.Shell, repository string) {
if utils.FileExists(repository) {
return
}
knownHosts, err := findKnownHosts(sh)
if err != nil {
sh.Warningf("Failed to find SSH known_hosts file: %v", err)
return
}
if err = knownHosts.AddFromRepository(repository); err != nil {
sh.Warningf("Error adding to known_hosts: %v", err)
return
}
}
// setUp is run before all the phases run. It's responsible for initializing the
// bootstrap environment
func (b *Bootstrap) setUp() error {
// Create an empty env for us to keep track of our env changes in
b.shell.Env = env.FromSlice(os.Environ())
// Add the $BUILDKITE_BIN_PATH to the $PATH if we've been given one
if b.BinPath != "" {
path, _ := b.shell.Env.Get("PATH")
b.shell.Env.Set("PATH", fmt.Sprintf("%s%s%s", b.BinPath, string(os.PathListSeparator), path))
}
// Set a BUILDKITE_BUILD_CHECKOUT_PATH unless one exists already. We do this here
// so that the environment will have a checkout path to work with
if _, exists := b.shell.Env.Get("BUILDKITE_BUILD_CHECKOUT_PATH"); !exists {
if b.BuildPath == "" {
return fmt.Errorf("Must set either a BUILDKITE_BUILD_PATH or a BUILDKITE_BUILD_CHECKOUT_PATH")
}
b.shell.Env.Set("BUILDKITE_BUILD_CHECKOUT_PATH",
filepath.Join(b.BuildPath, dirForAgentName(b.AgentName), b.OrganizationSlug, b.PipelineSlug))
}
// The job runner sets BUILDKITE_IGNORED_ENV with any keys that were ignored
// or overwritten. This shows a warning to the user so they don't get confused
// when their environment changes don't seem to do anything
if ignored, exists := b.shell.Env.Get("BUILDKITE_IGNORED_ENV"); exists {
b.shell.Headerf("Detected protected environment variables")
b.shell.Commentf("Your pipeline environment has protected environment variables set. " +
"These can only be set via hooks, plugins or the agent configuration.")
for _, env := range strings.Split(ignored, ",") {
b.shell.Warningf("Ignored %s", env)
}
b.shell.Printf("^^^ +++")
}
if b.Debug {
b.shell.Headerf("Buildkite environment variables")
for _, e := range b.shell.Env.ToSlice() {
if strings.HasPrefix(e, "BUILDKITE_AGENT_ACCESS_TOKEN=") {
b.shell.Printf("BUILDKITE_AGENT_ACCESS_TOKEN=******************")
} else if strings.HasPrefix(e, "BUILDKITE") || strings.HasPrefix(e, "CI") || strings.HasPrefix(e, "PATH") {
b.shell.Printf("%s", strings.Replace(e, "\n", "\\n", -1))
}
}
}
// Disable any interactive Git/SSH prompting
b.shell.Env.Set("GIT_TERMINAL_PROMPT", "0")
// It's important to do this before checking out plugins, in case you want
// to use the global environment hook to whitelist the plugins that are
// allowed to be used.
return b.executeGlobalHook("environment")
}
// tearDown is called before the bootstrap exits, even on error
func (b *Bootstrap) tearDown() error {
if err := b.executeGlobalHook("pre-exit"); err != nil {
return err
}
if err := b.executeLocalHook("pre-exit"); err != nil {
return err
}
if err := b.executePluginHook("pre-exit", b.pluginCheckouts); err != nil {
return err
}
// Support deprecated BUILDKITE_DOCKER* env vars
if hasDeprecatedDockerIntegration(b.shell) {
return tearDownDeprecatedDockerIntegration(b.shell)
}
for _, dir := range b.cleanupDirs {
if err := os.RemoveAll(dir); err != nil {
b.shell.Warningf("Failed to remove dir %s: %v", dir, err)
}
}
return nil
}
func (b *Bootstrap) hasPlugins() bool {
if b.Config.Plugins == "" {
return false
}
return true
}
func (b *Bootstrap) preparePlugins() error {
if !b.hasPlugins() {
return nil
}
b.shell.Headerf("Preparing plugins")
if b.Debug {
b.shell.Commentf("Plugin JSON is %s", b.Plugins)
}
// Check if we can run plugins (disabled via --no-plugins)
if !b.Config.PluginsEnabled {
if !b.Config.LocalHooksEnabled {
return fmt.Errorf("Plugins have been disabled on this agent with `--no-local-hooks`")
} else if !b.Config.CommandEval {
return fmt.Errorf("Plugins have been disabled on this agent with `--no-command-eval`")
} else {
return fmt.Errorf("Plugins have been disabled on this agent with `--no-plugins`")
}
}
var err error
b.plugins, err = plugin.CreateFromJSON(b.Config.Plugins)
if err != nil {
return errors.Wrap(err, "Failed to parse a plugin definition")
}
if b.Debug {
b.shell.Commentf("Parsed %d plugins", len(b.plugins))
}
return nil
}
func (b *Bootstrap) validatePluginCheckout(checkout *pluginCheckout) error {
if !b.Config.PluginValidation {
return nil
}
if checkout.Definition == nil {
if b.Debug {
b.shell.Commentf("Parsing plugin definition for %s from %s", checkout.Plugin.Name(), checkout.CheckoutDir)
}
// parse the plugin definition from the plugin checkout dir
var err error
checkout.Definition, err = plugin.LoadDefinitionFromDir(checkout.CheckoutDir)
if err == plugin.ErrDefinitionNotFound {
b.shell.Warningf("Failed to find plugin definition for plugin %s", checkout.Plugin.Name())
return nil
} else if err != nil {
return err
}
}
val := &plugin.Validator{}
result := val.Validate(checkout.Definition, checkout.Plugin.Configuration)
if !result.Valid() {
b.shell.Headerf("Plugin validation failed for %q", checkout.Plugin.Name())
json, _ := json.Marshal(checkout.Plugin.Configuration)
b.shell.Commentf("Plugin configuration JSON is %s", json)
return result
}
b.shell.Commentf("Valid plugin configuration for %q", checkout.Plugin.Name())
return nil
}
// PluginPhase is where plugins that weren't filtered in the Environment phase are
// checked out and made available to later phases
func (b *Bootstrap) PluginPhase() error {
if len(b.plugins) == 0 {
if b.Debug {
b.shell.Commentf("Skipping plugin phase")
}
return nil
}
checkouts := []*pluginCheckout{}
// Checkout and validate plugins that aren't vendored
for _, p := range b.plugins {
if p.Vendored {
if b.Debug {
b.shell.Commentf("Skipping vendored plugin %s", p.Name())
}
continue
}
checkout, err := b.checkoutPlugin(p)
if err != nil {
return errors.Wrapf(err, "Failed to checkout plugin %s", p.Name())
}
err = b.validatePluginCheckout(checkout)
if err != nil {
return err
}
checkouts = append(checkouts, checkout)
}
// Store the checkouts for future use
b.pluginCheckouts = checkouts
// Now we can run plugin environment hooks too
return b.executePluginHook("environment", checkouts)
}
// VendoredPluginPhase is where plugins that are included in the
// checked out code are added
func (b *Bootstrap) VendoredPluginPhase() error {
if !b.hasPlugins() {
return nil
}
vendoredCheckouts := []*pluginCheckout{}
// Validate vendored plugins
for _, p := range b.plugins {
if !p.Vendored {
continue
}
checkoutPath, _ := b.shell.Env.Get("BUILDKITE_BUILD_CHECKOUT_PATH")
pluginLocation, err := filepath.Abs(filepath.Join(checkoutPath, p.Location))
if err != nil {
return errors.Wrapf(err, "Failed to resolve vendored plugin path for plugin %s", p.Name())
}
if !utils.FileExists(pluginLocation) {
return fmt.Errorf("Vendored plugin path %s doesn't exist", p.Location)
}
checkout := &pluginCheckout{
Plugin: p,
CheckoutDir: pluginLocation,
HooksDir: filepath.Join(pluginLocation, "hooks"),
}
// Also make sure that plugin is within this repository
// checkout and isn't elsewhere on the system.
if !strings.HasPrefix(pluginLocation, checkoutPath+string(os.PathSeparator)) {
return fmt.Errorf("Vendored plugin paths must be within the checked-out repository")
}
err = b.validatePluginCheckout(checkout)
if err != nil {
return err
}
vendoredCheckouts = append(vendoredCheckouts, checkout)
}
// Finally append our vendored checkouts to the rest for subsequent hooks
b.pluginCheckouts = append(b.pluginCheckouts, vendoredCheckouts...)
// Now we can run plugin environment hooks too
return b.executePluginHook("environment", vendoredCheckouts)
}
// Executes a named hook on plugins that have it
func (b *Bootstrap) executePluginHook(name string, checkouts []*pluginCheckout) error {
for _, p := range checkouts {
hookPath, err := hook.Find(p.HooksDir, name)
// os.IsNotExist() doesn't unwrap wrapped errors (as at Go 1.13).
// agent is still go pre-1.13 compatible (I think) so we're avoiding errors.Is().
// In future somebody should check if os.IsNotExist() has added support for
// error unwrapping, or change this code to errors.Is(err, os.ErrNotExist)
if os.IsNotExist(err) {
continue // this plugin does not implement this hook
} else if err != nil {
return err
}
env, _ := p.ConfigurationToEnvironment()
if err := b.executeHook("plugin "+p.Plugin.Name()+" "+name, hookPath, env); err != nil {
return err
}
}
return nil
}
// If any plugin has a hook by this name
func (b *Bootstrap) hasPluginHook(name string) bool {
for _, p := range b.pluginCheckouts {
if _, err := hook.Find(p.HooksDir, name); err == nil {
return true
}
}
return false
}
// Checkout a given plugin to the plugins directory and return that directory
func (b *Bootstrap) checkoutPlugin(p *plugin.Plugin) (*pluginCheckout, error) {
// Make sure we have a plugin path before trying to do anything
if b.PluginsPath == "" {
return nil, fmt.Errorf("Can't checkout plugin without a `plugins-path`")
}
// Get the identifer for the plugin
id, err := p.Identifier()
if err != nil {
return nil, err
}
// Ensure the plugin directory exists, otherwise we can't create the lock
err = os.MkdirAll(b.PluginsPath, 0777)
if err != nil {
return nil, err
}
// Try and lock this particular plugin while we check it out (we create
// the file outside of the plugin directory so git clone doesn't have
// a cry about the directory not being empty)
pluginCheckoutHook, err := b.shell.LockFile(filepath.Join(b.PluginsPath, id+".lock"), time.Minute*5)
if err != nil {
return nil, err
}
defer pluginCheckoutHook.Unlock()
// Create a path to the plugin
directory := filepath.Join(b.PluginsPath, id)
pluginGitDirectory := filepath.Join(directory, ".git")
checkout := &pluginCheckout{
Plugin: p,
CheckoutDir: directory,
HooksDir: filepath.Join(directory, "hooks"),
}
// Has it already been checked out?
if utils.FileExists(pluginGitDirectory) {
// It'd be nice to show the current commit of the plugin, so
// let's figure that out.
headCommit, err := gitRevParseInWorkingDirectory(b.shell, directory, "--short=7", "HEAD")
if err != nil {
b.shell.Commentf("Plugin %q already checked out (can't `git rev-parse HEAD` plugin git directory)", p.Label())
} else {
b.shell.Commentf("Plugin %q already checked out (%s)", p.Label(), strings.TrimSpace(headCommit))
}
return checkout, nil
}
// Make the directory
err = os.MkdirAll(directory, 0777)
if err != nil {
return nil, err
}
// Once we've got the lock, we need to make sure another process didn't already
// checkout the plugin
if utils.FileExists(pluginGitDirectory) {
b.shell.Commentf("Plugin \"%s\" already checked out", p.Label())
return checkout, nil
}
repo, err := p.Repository()
if err != nil {
return nil, err
}
b.shell.Commentf("Plugin \"%s\" will be checked out to \"%s\"", p.Location, directory)
if b.Debug {
b.shell.Commentf("Checking if \"%s\" is a local repository", repo)
}
// Switch to the plugin directory
previousWd := b.shell.Getwd()
if err = b.shell.Chdir(directory); err != nil {
return nil, err
}
// Switch back to the previous working directory
defer b.shell.Chdir(previousWd)
b.shell.Commentf("Switching to the plugin directory")
if b.SSHKeyscan {
addRepositoryHostToSSHKnownHosts(b.shell, repo)
}
// Plugin clones shouldn't use custom GitCloneFlags
if err = b.shell.Run("git", "clone", "-v", "--", repo, "."); err != nil {
return nil, err
}
// Switch to the version if we need to
if p.Version != "" {
b.shell.Commentf("Checking out `%s`", p.Version)
if err = b.shell.Run("git", "checkout", "-f", p.Version); err != nil {
return nil, err
}
}
return checkout, nil
}
func (b *Bootstrap) removeCheckoutDir() error {
checkoutPath, _ := b.shell.Env.Get("BUILDKITE_BUILD_CHECKOUT_PATH")
// on windows, sometimes removing large dirs can fail for various reasons
// for instance having files open
// see https://github.com/golang/go/issues/20841
for i := 0; i < 10; i++ {
b.shell.Commentf("Removing %s", checkoutPath)
if err := os.RemoveAll(checkoutPath); err != nil {
b.shell.Errorf("Failed to remove \"%s\" (%s)", checkoutPath, err)
} else {
if _, err := os.Stat(checkoutPath); os.IsNotExist(err) {
return nil
} else {
b.shell.Errorf("Failed to remove %s", checkoutPath)
}
}
b.shell.Commentf("Waiting 10 seconds")
<-time.After(time.Second * 10)
}
return fmt.Errorf("Failed to remove %s", checkoutPath)
}
func (b *Bootstrap) createCheckoutDir() error {
checkoutPath, _ := b.shell.Env.Get("BUILDKITE_BUILD_CHECKOUT_PATH")
if !utils.FileExists(checkoutPath) {
b.shell.Commentf("Creating \"%s\"", checkoutPath)
if err := os.MkdirAll(checkoutPath, 0777); err != nil {
return err
}
}
if b.shell.Getwd() != checkoutPath {
if err := b.shell.Chdir(checkoutPath); err != nil {
return err
}
}
return nil
}
// CheckoutPhase creates the build directory and makes sure we're running the
// build at the right commit.
func (b *Bootstrap) CheckoutPhase() error {
if err := b.executeGlobalHook("pre-checkout"); err != nil {
return err
}
if err := b.executePluginHook("pre-checkout", b.pluginCheckouts); err != nil {
return err
}
// Remove the checkout directory if BUILDKITE_CLEAN_CHECKOUT is present
if b.CleanCheckout {
b.shell.Headerf("Cleaning pipeline checkout")
if err := b.removeCheckoutDir(); err != nil {
return err
}
}
b.shell.Headerf("Preparing working directory")
// If we have a blank repository then use a temp dir for builds
if b.Config.Repository == "" {
buildDir, err := ioutil.TempDir("", "buildkite-job-"+b.Config.JobID)
if err != nil {
return err
}
b.shell.Env.Set(`BUILDKITE_BUILD_CHECKOUT_PATH`, buildDir)
// Track the directory so we can remove it at the end of the bootstrap
b.cleanupDirs = append(b.cleanupDirs, buildDir)
}
// Make sure the build directory exists
if err := b.createCheckoutDir(); err != nil {
return err
}
// There can only be one checkout hook, either plugin or global, in that order
switch {
case b.hasPluginHook("checkout"):
if err := b.executePluginHook("checkout", b.pluginCheckouts); err != nil {
return err
}
case b.hasGlobalHook("checkout"):
if err := b.executeGlobalHook("checkout"); err != nil {
return err
}
default:
if b.Config.Repository != "" {
err := retry.Do(func(s *retry.Stats) error {
err := b.defaultCheckoutPhase()
if err == nil {
return nil
}
switch {
case shell.IsExitError(err) && shell.GetExitCode(err) == -1:
b.shell.Warningf("Checkout was interrupted by a signal")
s.Break()
case errors.Cause(err) == context.Canceled:
b.shell.Warningf("Checkout was cancelled")
s.Break()
default:
b.shell.Warningf("Checkout failed! %s (%s)", err, s)
// Specifically handle git errors
if ge, ok := err.(*gitError); ok {
switch ge.Type {
// These types can fail because of corrupted checkouts
case gitErrorClone:
case gitErrorClean:
case gitErrorCleanSubmodules:
// do nothing, this will fall through to destroy the checkout
default:
return err
}
}
// Checkout can fail because of corrupted files in the checkout
// which can leave the agent in a state where it keeps failing
// This removes the checkout dir, which means the next checkout
// will be a lot slower (clone vs fetch), but hopefully will
// allow the agent to self-heal
_ = b.removeCheckoutDir()
// Now make sure the build directory exists again before we try
// to checkout again, or proceed and run hooks which presume the
// checkout dir exists
if err := b.createCheckoutDir(); err != nil {
return err
}
}
return err
}, &retry.Config{Maximum: 3, Interval: 2 * time.Second})
if err != nil {
return err
}
} else {
b.shell.Commentf("Skipping checkout, BUILDKITE_REPO is empty")
}
}
// Store the current value of BUILDKITE_BUILD_CHECKOUT_PATH, so we can detect if
// one of the post-checkout hooks changed it.
previousCheckoutPath, _ := b.shell.Env.Get("BUILDKITE_BUILD_CHECKOUT_PATH")
// Run post-checkout hooks
if err := b.executeGlobalHook("post-checkout"); err != nil {
return err
}
if err := b.executeLocalHook("post-checkout"); err != nil {
return err
}
if err := b.executePluginHook("post-checkout", b.pluginCheckouts); err != nil {
return err
}
// Capture the new checkout path so we can see if it's changed.
newCheckoutPath, _ := b.shell.Env.Get("BUILDKITE_BUILD_CHECKOUT_PATH")
// If the working directory has been changed by a hook, log and switch to it
if previousCheckoutPath != "" && previousCheckoutPath != newCheckoutPath {
b.shell.Headerf("A post-checkout hook has changed the working directory to \"%s\"", newCheckoutPath)
if err := b.shell.Chdir(newCheckoutPath); err != nil {
return err
}
}
return nil
}
func hasGitSubmodules(sh *shell.Shell) bool {
return utils.FileExists(filepath.Join(sh.Getwd(), ".gitmodules"))
}
func hasGitCommit(sh *shell.Shell, gitDir string, commit string) bool {
// Resolve commit to an actual commit object
output, err := sh.RunAndCapture("git", "--git-dir", gitDir, "rev-parse", commit+"^{commit}")
if err != nil {
return false
}
// Filter out commitish things like HEAD et al
if strings.TrimSpace(output) != commit {
return false
}
// Otherwise it's a commit in the repo
return true
}
func (b *Bootstrap) updateGitMirror() (string, error) {
// Create a unique directory for the repository mirror
mirrorDir := filepath.Join(b.Config.GitMirrorsPath, dirForRepository(b.Repository))
// Create the mirrors path if it doesn't exist
if baseDir := filepath.Dir(mirrorDir); !utils.FileExists(baseDir) {
b.shell.Commentf("Creating \"%s\"", baseDir)
if err := os.MkdirAll(baseDir, 0777); err != nil {
return "", err
}
}
b.shell.Chdir(b.Config.GitMirrorsPath)
lockTimeout := time.Second * time.Duration(b.GitMirrorsLockTimeout)
if b.Debug {
b.shell.Commentf("Acquiring mirror repository clone lock")
}
// Lock the mirror dir to prevent concurrent clones
mirrorCloneLock, err := b.shell.LockFile(mirrorDir+".clonelock", lockTimeout)
if err != nil {
return "", err
}
defer mirrorCloneLock.Unlock()