• Michelle Noorali's avatar
    fix(pkg/tiller): reuseValues combines all prev val · 4dd21780
    Michelle Noorali authored
    Resolves #3655
    We were seeing that when running helm upgrade with the reuse-values
    flag enabled that you could end up in the position where overrides
    a.k.a computed values from previous revisions were not being saved on
    the updated revision. This left us in a weird position where some
    computed values would disappear mysteriously in the abyss. That
    happened because computed values from previous revisions weren't merged
    with the new computed values every time the reuse-values flag was used.
    This PR merges computed values from the previous revisions so you don't
    end up in that kind of conundrum.
    
    (cherry picked from commit 9266731d)
    Unverified
    4dd21780
release_update_test.go 13.79 KiB
/*
Copyright 2016 The Kubernetes Authors All rights reserved.
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.
package tiller
import (
	"fmt"
	"strings"
	"testing"
	"github.com/golang/protobuf/proto"
	"k8s.io/helm/pkg/helm"
	"k8s.io/helm/pkg/proto/hapi/chart"
	"k8s.io/helm/pkg/proto/hapi/release"
	"k8s.io/helm/pkg/proto/hapi/services"
func TestUpdateRelease(t *testing.T) {
	c := helm.NewContext()
	rs := rsFixture()
	rel := releaseStub()
	rs.env.Releases.Create(rel)
	req := &services.UpdateReleaseRequest{
		Name: rel.Name,
		Chart: &chart.Chart{
			Metadata: &chart.Metadata{Name: "hello"},
			Templates: []*chart.Template{
				{Name: "templates/hello", Data: []byte("hello: world")},
				{Name: "templates/hooks", Data: []byte(manifestWithUpgradeHooks)},
	res, err := rs.UpdateRelease(c, req)
	if err != nil {
		t.Fatalf("Failed updated: %s", err)
	if res.Release.Name == "" {
		t.Errorf("Expected release name.")
	if res.Release.Name != rel.Name {
		t.Errorf("Updated release name does not match previous release name. Expected %s, got %s", rel.Name, res.Release.Name)
	if res.Release.Namespace != rel.Namespace {
		t.Errorf("Expected release namespace '%s', got '%s'.", rel.Namespace, res.Release.Namespace)
	updated := compareStoredAndReturnedRelease(t, *rs, *res)
	if len(updated.Hooks) != 1 {
		t.Fatalf("Expected 1 hook, got %d", len(updated.Hooks))
	if updated.Hooks[0].Manifest != manifestWithUpgradeHooks {
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
t.Errorf("Unexpected manifest: %v", updated.Hooks[0].Manifest) } if updated.Hooks[0].Events[0] != release.Hook_POST_UPGRADE { t.Errorf("Expected event 0 to be post upgrade") } if updated.Hooks[0].Events[1] != release.Hook_PRE_UPGRADE { t.Errorf("Expected event 0 to be pre upgrade") } if len(updated.Manifest) == 0 { t.Errorf("Expected manifest in %v", res) } if res.Release.Config == nil { t.Errorf("Got release without config: %#v", res.Release) } else if res.Release.Config.Raw != rel.Config.Raw { t.Errorf("Expected release values %q, got %q", rel.Config.Raw, res.Release.Config.Raw) } if !strings.Contains(updated.Manifest, "---\n# Source: hello/templates/hello\nhello: world") { t.Errorf("unexpected output: %s", updated.Manifest) } if res.Release.Version != 2 { t.Errorf("Expected release version to be %v, got %v", 2, res.Release.Version) } edesc := "Upgrade complete" if got := res.Release.Info.Description; got != edesc { t.Errorf("Expected description %q, got %q", edesc, got) } } func TestUpdateRelease_ResetValues(t *testing.T) { c := helm.NewContext() rs := rsFixture() rel := releaseStub() rs.env.Releases.Create(rel) req := &services.UpdateReleaseRequest{ Name: rel.Name, Chart: &chart.Chart{ Metadata: &chart.Metadata{Name: "hello"}, Templates: []*chart.Template{ {Name: "templates/hello", Data: []byte("hello: world")}, {Name: "templates/hooks", Data: []byte(manifestWithUpgradeHooks)}, }, }, ResetValues: true, } res, err := rs.UpdateRelease(c, req) if err != nil { t.Fatalf("Failed updated: %s", err) } // This should have been unset. Config: &chart.Config{Raw: `name: value`}, if res.Release.Config != nil && res.Release.Config.Raw != "" { t.Errorf("Expected chart config to be empty, got %q", res.Release.Config.Raw) } } // This is a regression test for bug found in issue #3655 func TestUpdateRelease_ComplexReuseValues(t *testing.T) { c := helm.NewContext() rs := rsFixture() installReq := &services.InstallReleaseRequest{ Namespace: "spaced", Chart: &chart.Chart{ Metadata: &chart.Metadata{Name: "hello"},
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
Templates: []*chart.Template{ {Name: "templates/hello", Data: []byte("hello: world")}, {Name: "templates/hooks", Data: []byte(manifestWithHook)}, }, Values: &chart.Config{Raw: "defaultFoo: defaultBar"}, }, Values: &chart.Config{Raw: "foo: bar"}, } fmt.Println("Running Install release with foo: bar override") installResp, err := rs.InstallRelease(c, installReq) if err != nil { t.Fatal(err) } rel := installResp.Release req := &services.UpdateReleaseRequest{ Name: rel.Name, Chart: &chart.Chart{ Metadata: &chart.Metadata{Name: "hello"}, Templates: []*chart.Template{ {Name: "templates/hello", Data: []byte("hello: world")}, {Name: "templates/hooks", Data: []byte(manifestWithUpgradeHooks)}, }, Values: &chart.Config{Raw: "defaultFoo: defaultBar"}, }, } fmt.Println("Running Update release with no overrides and no reuse-values flag") res, err := rs.UpdateRelease(c, req) if err != nil { t.Fatalf("Failed updated: %s", err) } expect := "foo: bar" if res.Release.Config != nil && res.Release.Config.Raw != expect { t.Errorf("Expected chart values to be %q, got %q", expect, res.Release.Config.Raw) } rel = res.Release req = &services.UpdateReleaseRequest{ Name: rel.Name, Chart: &chart.Chart{ Metadata: &chart.Metadata{Name: "hello"}, Templates: []*chart.Template{ {Name: "templates/hello", Data: []byte("hello: world")}, {Name: "templates/hooks", Data: []byte(manifestWithUpgradeHooks)}, }, Values: &chart.Config{Raw: "defaultFoo: defaultBar"}, }, Values: &chart.Config{Raw: "foo2: bar2"}, ReuseValues: true, } fmt.Println("Running Update release with foo2: bar2 override and reuse-values") res, err = rs.UpdateRelease(c, req) if err != nil { t.Fatalf("Failed updated: %s", err) } // This should have the newly-passed overrides. expect = "foo: bar\nfoo2: bar2\n" if res.Release.Config != nil && res.Release.Config.Raw != expect { t.Errorf("Expected request config to be %q, got %q", expect, res.Release.Config.Raw) } rel = res.Release req = &services.UpdateReleaseRequest{ Name: rel.Name, Chart: &chart.Chart{
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
Metadata: &chart.Metadata{Name: "hello"}, Templates: []*chart.Template{ {Name: "templates/hello", Data: []byte("hello: world")}, {Name: "templates/hooks", Data: []byte(manifestWithUpgradeHooks)}, }, Values: &chart.Config{Raw: "defaultFoo: defaultBar"}, }, Values: &chart.Config{Raw: "foo: baz"}, ReuseValues: true, } fmt.Println("Running Update release with foo=baz override with reuse-values flag") res, err = rs.UpdateRelease(c, req) if err != nil { t.Fatalf("Failed updated: %s", err) } expect = "foo: baz\nfoo2: bar2\n" if res.Release.Config != nil && res.Release.Config.Raw != expect { t.Errorf("Expected chart values to be %q, got %q", expect, res.Release.Config.Raw) } } func TestUpdateRelease_ReuseValues(t *testing.T) { c := helm.NewContext() rs := rsFixture() rel := releaseStub() rs.env.Releases.Create(rel) req := &services.UpdateReleaseRequest{ Name: rel.Name, Chart: &chart.Chart{ Metadata: &chart.Metadata{Name: "hello"}, Templates: []*chart.Template{ {Name: "templates/hello", Data: []byte("hello: world")}, {Name: "templates/hooks", Data: []byte(manifestWithUpgradeHooks)}, }, // Since reuseValues is set, this should get ignored. Values: &chart.Config{Raw: "foo: bar\n"}, }, Values: &chart.Config{Raw: "name2: val2"}, ReuseValues: true, } res, err := rs.UpdateRelease(c, req) if err != nil { t.Fatalf("Failed updated: %s", err) } // This should have been overwritten with the old value. expect := "name: value\n" if res.Release.Chart.Values != nil && res.Release.Chart.Values.Raw != expect { t.Errorf("Expected chart values to be %q, got %q", expect, res.Release.Chart.Values.Raw) } // This should have the newly-passed overrides and any other computed values. `name: value` comes from release Config via releaseStub() expect = "name: value\nname2: val2" if res.Release.Config != nil && res.Release.Config.Raw != expect { t.Errorf("Expected request config to be %q, got %q", expect, res.Release.Config.Raw) } compareStoredAndReturnedRelease(t, *rs, *res) } func TestUpdateRelease_ResetReuseValues(t *testing.T) { // This verifies that when both reset and reuse are set, reset wins. c := helm.NewContext() rs := rsFixture() rel := releaseStub() rs.env.Releases.Create(rel) req := &services.UpdateReleaseRequest{ Name: rel.Name, Chart: &chart.Chart{ Metadata: &chart.Metadata{Name: "hello"},
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
Templates: []*chart.Template{ {Name: "templates/hello", Data: []byte("hello: world")}, {Name: "templates/hooks", Data: []byte(manifestWithUpgradeHooks)}, }, }, ResetValues: true, ReuseValues: true, } res, err := rs.UpdateRelease(c, req) if err != nil { t.Fatalf("Failed updated: %s", err) } // This should have been unset. Config: &chart.Config{Raw: `name: value`}, if res.Release.Config != nil && res.Release.Config.Raw != "" { t.Errorf("Expected chart config to be empty, got %q", res.Release.Config.Raw) } compareStoredAndReturnedRelease(t, *rs, *res) } func TestUpdateReleaseFailure(t *testing.T) { c := helm.NewContext() rs := rsFixture() rel := releaseStub() rs.env.Releases.Create(rel) rs.env.KubeClient = newUpdateFailingKubeClient() rs.Log = t.Logf req := &services.UpdateReleaseRequest{ Name: rel.Name, DisableHooks: true, Chart: &chart.Chart{ Metadata: &chart.Metadata{Name: "hello"}, Templates: []*chart.Template{ {Name: "templates/something", Data: []byte("hello: world")}, }, }, } res, err := rs.UpdateRelease(c, req) if err == nil { t.Error("Expected failed update") } if updatedStatus := res.Release.Info.Status.Code; updatedStatus != release.Status_FAILED { t.Errorf("Expected FAILED release. Got %d", updatedStatus) } compareStoredAndReturnedRelease(t, *rs, *res) expectedDescription := "Upgrade \"angry-panda\" failed: Failed update in kube client" if got := res.Release.Info.Description; got != expectedDescription { t.Errorf("Expected description %q, got %q", expectedDescription, got) } oldRelease, err := rs.env.Releases.Get(rel.Name, rel.Version) if err != nil { t.Errorf("Expected to be able to get previous release") } if oldStatus := oldRelease.Info.Status.Code; oldStatus != release.Status_DEPLOYED { t.Errorf("Expected Deployed status on previous Release version. Got %v", oldStatus) } } func TestUpdateReleaseFailure_Force(t *testing.T) { c := helm.NewContext() rs := rsFixture() rel := namedReleaseStub("forceful-luke", release.Status_FAILED) rs.env.Releases.Create(rel) rs.Log = t.Logf
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
req := &services.UpdateReleaseRequest{ Name: rel.Name, DisableHooks: true, Chart: &chart.Chart{ Metadata: &chart.Metadata{Name: "hello"}, Templates: []*chart.Template{ {Name: "templates/something", Data: []byte("text: 'Did you ever hear the tragedy of Darth Plagueis the Wise? I thought not. It’s not a story the Jedi would tell you. It’s a Sith legend. Darth Plagueis was a Dark Lord of the Sith, so powerful and so wise he could use the Force to influence the Midichlorians to create life... He had such a knowledge of the Dark Side that he could even keep the ones he cared about from dying. The Dark Side of the Force is a pathway to many abilities some consider to be unnatural. He became so powerful... The only thing he was afraid of was losing his power, which eventually, of course, he did. Unfortunately, he taught his apprentice everything he knew, then his apprentice killed him in his sleep. Ironic. He could save others from death, but not himself.'")}, }, }, Force: true, } res, err := rs.UpdateRelease(c, req) if err != nil { t.Errorf("Expected successful update, got %v", err) } if updatedStatus := res.Release.Info.Status.Code; updatedStatus != release.Status_DEPLOYED { t.Errorf("Expected DEPLOYED release. Got %d", updatedStatus) } compareStoredAndReturnedRelease(t, *rs, *res) expectedDescription := "Upgrade complete" if got := res.Release.Info.Description; got != expectedDescription { t.Errorf("Expected description %q, got %q", expectedDescription, got) } oldRelease, err := rs.env.Releases.Get(rel.Name, rel.Version) if err != nil { t.Errorf("Expected to be able to get previous release") } if oldStatus := oldRelease.Info.Status.Code; oldStatus != release.Status_DELETED { t.Errorf("Expected Deleted status on previous Release version. Got %v", oldStatus) } } func TestUpdateReleaseNoHooks(t *testing.T) { c := helm.NewContext() rs := rsFixture() rel := releaseStub() rs.env.Releases.Create(rel) req := &services.UpdateReleaseRequest{ Name: rel.Name, DisableHooks: true, Chart: &chart.Chart{ Metadata: &chart.Metadata{Name: "hello"}, Templates: []*chart.Template{ {Name: "templates/hello", Data: []byte("hello: world")}, {Name: "templates/hooks", Data: []byte(manifestWithUpgradeHooks)}, }, }, } res, err := rs.UpdateRelease(c, req) if err != nil { t.Fatalf("Failed updated: %s", err) } if hl := res.Release.Hooks[0].LastRun; hl != nil { t.Errorf("Expected that no hooks were run. Got %d", hl) } } func TestUpdateReleaseNoChanges(t *testing.T) { c := helm.NewContext() rs := rsFixture() rel := releaseStub()
421422423424425426427428429430431432433434435436437438439440441442443444445446447
rs.env.Releases.Create(rel) req := &services.UpdateReleaseRequest{ Name: rel.Name, DisableHooks: true, Chart: rel.GetChart(), } _, err := rs.UpdateRelease(c, req) if err != nil { t.Fatalf("Failed updated: %s", err) } } func compareStoredAndReturnedRelease(t *testing.T, rs ReleaseServer, res services.UpdateReleaseResponse) *release.Release { storedRelease, err := rs.env.Releases.Get(res.Release.Name, res.Release.Version) if err != nil { t.Fatalf("Expected release for %s (%v).", res.Release.Name, rs.env.Releases) } if !proto.Equal(storedRelease, res.Release) { t.Errorf("Stored release doesn't match returned Release") } return storedRelease }