Skip to content
This repository was archived by the owner on Mar 24, 2023. It is now read-only.

Commit 54a8a3a

Browse files
laveryalaverya
authored
Merge pull request #826 from laverya/fix-templated-kustomize-base-paths
render templates in step yaml before running preexecute functions
2 parents 847d4d3 + 15ca721 commit 54a8a3a

4 files changed

+67
-34
lines changed

‎pkg/lifecycle/daemon/routes_navcycle.go

+8-2
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,14 @@ func (d *NavcycleRoutes) getRequiredButIncompleteStepFor(requires []string) (str
157157
return "", nil
158158
}
159159

160-
func (d *NavcycleRoutes) hydrateAndSend(step daemontypes.Step, c *gin.Context) {
161-
result, err := d.hydrateStep(step)
160+
func (d *NavcycleRoutes) hydrateAndSend(step api.Step, c *gin.Context) {
161+
step, err := d.buildStepContents(step)
162+
if err != nil {
163+
c.AbortWithError(500, err)
164+
return
165+
}
166+
167+
result, err := d.hydrateStep(daemontypes.NewStep(step))
162168
if err != nil {
163169
c.AbortWithError(500, err)
164170
return

‎pkg/lifecycle/daemon/routes_navcycle_completestep.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ func (d *NavcycleRoutes) completeStep(c *gin.Context) {
4747
// hack, give it 10 ms in case its an instant step. Hydrate and send will read progress from the syncMap
4848
time.Sleep(10 * time.Millisecond)
4949

50-
d.hydrateAndSend(daemontypes.NewStep(step), c)
50+
d.hydrateAndSend(step, c)
5151
go d.handleAsync(errChan, debug, step, stepID)
5252
return
5353
}

‎pkg/lifecycle/daemon/routes_navcycle_getstep.go

+40-21
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99
"github.com/go-kit/kit/log"
1010
"github.com/go-kit/kit/log/level"
1111
"github.com/pkg/errors"
12+
"github.com/replicatedhq/ship/pkg/api"
1213
"github.com/replicatedhq/ship/pkg/constants"
1314
"github.com/replicatedhq/ship/pkg/lifecycle/daemon/daemontypes"
1415
"github.com/replicatedhq/ship/pkg/lifecycle/render/helm"
@@ -24,6 +25,12 @@ func (d *NavcycleRoutes) getStep(c *gin.Context) {
2425
return
2526
}
2627

28+
step, err := d.buildStepContents(step)
29+
if err != nil {
30+
level.Error(d.Logger).Log("event", "getStep.buildContents.fail", "err", err)
31+
return
32+
}
33+
2734
if preExecuteFunc, exists := d.PreExecuteFuncMap[step.Shared().ID]; exists {
2835
if err := preExecuteFunc(context.Background(), step); err != nil {
2936
level.Error(d.Logger).Log("event", "preExecute.fail", "err", err)
@@ -34,34 +41,58 @@ func (d *NavcycleRoutes) getStep(c *gin.Context) {
3441
delete(d.PreExecuteFuncMap, step.ShortName())
3542
}
3643

37-
d.hydrateAndSend(daemontypes.NewStep(step), c)
44+
d.hydrateAndSend(step, c)
3845
return
3946
}
4047
}
4148

4249
d.errNotFound(c)
4350
}
4451

45-
func (d *NavcycleRoutes) hydrateStep(step daemontypes.Step) (*daemontypes.StepResponse, error) {
46-
debug := level.Debug(log.With(d.Logger, "method", "hydrateStep"))
47-
52+
func (d *NavcycleRoutes) buildStepContents(step api.Step) (api.Step, error) {
4853
currentState, err := d.StateManager.TryLoad()
4954
if err != nil {
5055
level.Error(d.Logger).Log("event", "tryLoad.fail", "err", err)
51-
return nil, errors.Wrap(err, "load state")
56+
return api.Step{}, errors.Wrap(err, "load state")
5257
}
5358

5459
if step.Kustomize != nil {
5560
builder, err := d.BuilderBuilder.FullBuilder(d.Release.Metadata, d.Release.Spec.Config.V1, currentState.CurrentConfig())
5661
if err != nil {
57-
return nil, errors.Wrap(err, "create kustomize template builder")
62+
return api.Step{}, errors.Wrap(err, "create kustomize template builder")
63+
}
64+
renderedBasePath, err := builder.String(step.Kustomize.Base)
65+
if err != nil {
66+
return api.Step{}, errors.Wrap(err, "render kustomize basepath template")
67+
}
68+
step.Kustomize.Base = renderedBasePath
69+
}
70+
71+
if step.Message != nil {
72+
builder, err := d.BuilderBuilder.FullBuilder(d.Release.Metadata, d.Release.Spec.Config.V1, currentState.CurrentConfig())
73+
if err != nil {
74+
return api.Step{}, errors.Wrap(err, "create message template builder")
5875
}
59-
renderedBasePath, err := builder.String(step.Kustomize.BasePath)
76+
renderedContents, err := builder.String(step.Message.Contents)
6077
if err != nil {
61-
return nil, errors.Wrap(err, "render kusstomize basepath contents")
78+
return api.Step{}, errors.Wrap(err, "render message contents")
6279
}
63-
step.Kustomize.BasePath = renderedBasePath
80+
step.Message.Contents = renderedContents
81+
}
82+
83+
return step, nil
84+
}
6485

86+
func (d *NavcycleRoutes) hydrateStep(step daemontypes.Step) (*daemontypes.StepResponse, error) {
87+
debug := level.Debug(log.With(d.Logger, "method", "hydrateStep"))
88+
89+
currentState, err := d.StateManager.TryLoad()
90+
if err != nil {
91+
level.Error(d.Logger).Log("event", "tryLoad.fail", "err", err)
92+
return nil, errors.Wrap(err, "load state")
93+
}
94+
95+
if step.Kustomize != nil {
6596
tree, err := d.TreeLoader.LoadTree(step.Kustomize.BasePath)
6697
if err != nil {
6798
level.Error(d.Logger).Log("event", "loadTree.fail", "err", err)
@@ -93,18 +124,6 @@ func (d *NavcycleRoutes) hydrateStep(step daemontypes.Step) (*daemontypes.StepRe
93124
step.HelmValues.Namespace = namespace
94125
}
95126

96-
if step.Message != nil {
97-
builder, err := d.BuilderBuilder.FullBuilder(d.Release.Metadata, d.Release.Spec.Config.V1, currentState.CurrentConfig())
98-
if err != nil {
99-
return nil, errors.Wrap(err, "create message template builder")
100-
}
101-
rendered, err := builder.String(step.Source.Message.Contents)
102-
if err != nil {
103-
return nil, errors.Wrap(err, "render message contents")
104-
}
105-
step.Message.Contents = rendered
106-
}
107-
108127
result := &daemontypes.StepResponse{
109128
CurrentStep: step,
110129
Phase: step.Source.ShortName(),

‎pkg/lifecycle/daemon/routes_navcycle_getstep_test.go

+18-10
Original file line numberDiff line numberDiff line change
@@ -407,22 +407,22 @@ func TestHydrateActions(t *testing.T) {
407407
func TestHydrateStep(t *testing.T) {
408408
tests := []struct {
409409
name string
410-
step daemontypes.Step
410+
step api.Step
411411
state state2.State
412412
fs map[string]string
413413
release *api.Release
414414
want *daemontypes.StepResponse
415415
}{
416416
{
417417
name: "message",
418-
step: daemontypes.NewStep(api.Step{
418+
step: api.Step{
419419
Message: &api.Message{
420420
Contents: "hey there {{repl Installation \"customer_id\"}} {{repl ConfigOption \"spam\"}}",
421421
StepShared: api.StepShared{
422422
ID: "foo",
423423
},
424424
},
425-
}),
425+
},
426426
release: &api.Release{
427427
Metadata: api.ReleaseMetadata{
428428
CustomerID: "12345",
@@ -447,7 +447,7 @@ func TestHydrateStep(t *testing.T) {
447447
CurrentStep: daemontypes.Step{
448448
Source: api.Step{
449449
Message: &api.Message{
450-
Contents: "hey there {{repl Installation \"customer_id\"}} {{repl ConfigOption \"spam\"}}",
450+
Contents: "hey there 12345 eggs",
451451
StepShared: api.StepShared{
452452
ID: "foo",
453453
},
@@ -487,6 +487,7 @@ func TestHydrateStep(t *testing.T) {
487487

488488
if test.state != nil {
489489
mockState.EXPECT().TryLoad().Return(test.state, nil)
490+
mockState.EXPECT().TryLoad().Return(test.state, nil)
490491
}
491492

492493
v2 := &NavcycleRoutes{
@@ -502,7 +503,10 @@ func TestHydrateStep(t *testing.T) {
502503
Release: test.release,
503504
}
504505

505-
response, err := v2.hydrateStep(test.step)
506+
builtStep, err := v2.buildStepContents(test.step)
507+
req.NoError(err)
508+
509+
response, err := v2.hydrateStep(daemontypes.NewStep(builtStep))
506510
req.NoError(err, "hydrate step")
507511
req.Equal(test.want, response)
508512
})
@@ -512,15 +516,15 @@ func TestHydrateStep(t *testing.T) {
512516
func TestHydrateTemplatedKustomizeStep(t *testing.T) {
513517
tests := []struct {
514518
name string
515-
step daemontypes.Step
519+
step api.Step
516520
state state2.State
517521
fs map[string]string
518522
release *api.Release
519523
want *daemontypes.StepResponse
520524
}{
521525
{
522526
name: "kustomize",
523-
step: daemontypes.NewStep(api.Step{
527+
step: api.Step{
524528
Kustomize: &api.Kustomize{
525529
Base: "{{repl ToUpper \"abcdef\"}}",
526530
Dest: "more.yaml",
@@ -529,7 +533,7 @@ func TestHydrateTemplatedKustomizeStep(t *testing.T) {
529533
ID: "bar",
530534
},
531535
},
532-
}),
536+
},
533537
release: &api.Release{
534538
Metadata: api.ReleaseMetadata{
535539
CustomerID: "12345",
@@ -554,7 +558,7 @@ func TestHydrateTemplatedKustomizeStep(t *testing.T) {
554558
CurrentStep: daemontypes.Step{
555559
Source: api.Step{
556560
Kustomize: &api.Kustomize{
557-
Base: "{{repl ToUpper \"abcdef\"}}",
561+
Base: "ABCDEF",
558562
Dest: "more.yaml",
559563
Overlay: "overlay/mine",
560564
StepShared: api.StepShared{
@@ -612,6 +616,7 @@ func TestHydrateTemplatedKustomizeStep(t *testing.T) {
612616
if test.state != nil {
613617
mockState.EXPECT().TryLoad().Return(test.state, nil)
614618
mockState.EXPECT().TryLoad().Return(test.state, nil)
619+
mockState.EXPECT().TryLoad().Return(test.state, nil)
615620
}
616621

617622
treeLoader := filetree.NewLoader(mockFs, testLogger, mockState)
@@ -633,7 +638,10 @@ func TestHydrateTemplatedKustomizeStep(t *testing.T) {
633638
err := mockFs.MkdirAll("ABCDEF", 0755)
634639
req.NoError(err, "mkdir")
635640

636-
response, err := v2.hydrateStep(test.step)
641+
builtStep, err := v2.buildStepContents(test.step)
642+
req.NoError(err)
643+
644+
response, err := v2.hydrateStep(daemontypes.NewStep(builtStep))
637645
req.NoError(err, "hydrate templated kustomize step")
638646
req.Equal(test.want, response)
639647
})

0 commit comments

Comments
 (0)