mirror of https://github.com/helm/helm.git
Add dummy test case to prove that not all hooks are delted on failure
Signed-off-by: Laszlo Uveges <laszlo@giantswarm.io>
This commit is contained in:
Laszlo Uveges
Gerard Nguyen
parent
8d70e16af4
commit
788652fd27
|
|
@ -1,208 +1,167 @@
|
||||||
/*
|
|
||||||
Copyright The Helm Authors.
|
|
||||||
|
|
||||||
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 action
|
package action
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"helm.sh/helm/v3/pkg/chartutil"
|
||||||
"fmt"
|
"helm.sh/helm/v3/pkg/kube"
|
||||||
|
kubefake "helm.sh/helm/v3/pkg/kube/fake"
|
||||||
|
"helm.sh/helm/v3/pkg/release"
|
||||||
|
"helm.sh/helm/v3/pkg/storage"
|
||||||
|
"helm.sh/helm/v3/pkg/storage/driver"
|
||||||
"io"
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
|
v1 "k8s.io/api/core/v1"
|
||||||
|
"k8s.io/apimachinery/pkg/util/yaml"
|
||||||
|
"k8s.io/cli-runtime/pkg/resource"
|
||||||
|
"reflect"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
|
|
||||||
chart "helm.sh/helm/v4/pkg/chart/v2"
|
|
||||||
kubefake "helm.sh/helm/v4/pkg/kube/fake"
|
|
||||||
release "helm.sh/helm/v4/pkg/release/v1"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func podManifestWithOutputLogs(hookDefinitions []release.HookOutputLogPolicy) string {
|
type HookFailedError struct{}
|
||||||
hookDefinitionString := convertHooksToCommaSeparated(hookDefinitions)
|
|
||||||
return fmt.Sprintf(`kind: Pod
|
func (e *HookFailedError) Error() string {
|
||||||
|
return "Hook failed!"
|
||||||
|
}
|
||||||
|
|
||||||
|
type HookFailingKubeClient struct {
|
||||||
|
kubefake.PrintingKubeClient
|
||||||
|
failOn resource.Info
|
||||||
|
deleteRecord []resource.Info
|
||||||
|
}
|
||||||
|
|
||||||
|
func (_ *HookFailingKubeClient) Build(reader io.Reader, _ bool) (kube.ResourceList, error) {
|
||||||
|
configMap := &v1.ConfigMap{}
|
||||||
|
|
||||||
|
err := yaml.NewYAMLOrJSONDecoder(reader, 1000).Decode(configMap)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return kube.ResourceList{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return kube.ResourceList{{
|
||||||
|
Name: configMap.Name,
|
||||||
|
Namespace: configMap.Namespace,
|
||||||
|
}}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *HookFailingKubeClient) WatchUntilReady(resources kube.ResourceList, duration time.Duration) error {
|
||||||
|
for _, res := range resources {
|
||||||
|
if res.Name == h.failOn.Name && res.Namespace == h.failOn.Namespace {
|
||||||
|
return &HookFailedError{}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return h.PrintingKubeClient.WatchUntilReady(resources, duration)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *HookFailingKubeClient) Delete(resources kube.ResourceList) (*kube.Result, []error) {
|
||||||
|
for _, res := range resources {
|
||||||
|
h.deleteRecord = append(h.deleteRecord, resource.Info{
|
||||||
|
Name: res.Name,
|
||||||
|
Namespace: res.Namespace,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return h.PrintingKubeClient.Delete(resources)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHooksCleanUp(t *testing.T) {
|
||||||
|
hookKubeClient := &HookFailingKubeClient{kubefake.PrintingKubeClient{Out: ioutil.Discard}, resource.Info{
|
||||||
|
Name: "build-config-2",
|
||||||
|
Namespace: "test",
|
||||||
|
}, []resource.Info{}}
|
||||||
|
|
||||||
|
configuration := &Configuration{
|
||||||
|
Releases: storage.Init(driver.NewMemory()),
|
||||||
|
KubeClient: hookKubeClient,
|
||||||
|
Capabilities: chartutil.DefaultCapabilities,
|
||||||
|
Log: func(format string, v ...interface{}) {
|
||||||
|
t.Helper()
|
||||||
|
if *verbose {
|
||||||
|
t.Logf(format, v...)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
hookEvent := release.HookPreInstall
|
||||||
|
|
||||||
|
r := &release.Release{
|
||||||
|
Name: "test-release",
|
||||||
|
Namespace: "test",
|
||||||
|
Hooks: []*release.Hook{
|
||||||
|
{
|
||||||
|
Name: "hook-1",
|
||||||
|
Kind: "ConfigMap",
|
||||||
|
Path: "templates/service_account.yaml",
|
||||||
|
Manifest: `apiVersion: v1
|
||||||
|
kind: ConfigMap
|
||||||
metadata:
|
metadata:
|
||||||
name: finding-sharky,
|
name: build-config-1
|
||||||
annotations:
|
namespace: test
|
||||||
"helm.sh/hook": pre-install
|
data:
|
||||||
"helm.sh/hook-output-log-policy": %s
|
foo: bar
|
||||||
spec:
|
`,
|
||||||
containers:
|
Weight: -5,
|
||||||
- name: sharky-test
|
Events: []release.HookEvent{
|
||||||
image: fake-image
|
hookEvent,
|
||||||
cmd: fake-command`, hookDefinitionString)
|
},
|
||||||
}
|
DeletePolicies: []release.HookDeletePolicy{
|
||||||
|
release.HookBeforeHookCreation,
|
||||||
func podManifestWithOutputLogWithNamespace(hookDefinitions []release.HookOutputLogPolicy) string {
|
release.HookSucceeded,
|
||||||
hookDefinitionString := convertHooksToCommaSeparated(hookDefinitions)
|
release.HookFailed,
|
||||||
return fmt.Sprintf(`kind: Pod
|
},
|
||||||
|
LastRun: release.HookExecution{
|
||||||
|
Phase: release.HookPhaseSucceeded,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Name: "hook-2",
|
||||||
|
Kind: "ConfigMap",
|
||||||
|
Path: "templates/job.yaml",
|
||||||
|
Manifest: `apiVersion: v1
|
||||||
|
kind: ConfigMap
|
||||||
metadata:
|
metadata:
|
||||||
name: finding-george
|
name: build-config-2
|
||||||
namespace: sneaky-namespace
|
namespace: test
|
||||||
annotations:
|
data:
|
||||||
"helm.sh/hook": pre-install
|
foo: bar
|
||||||
"helm.sh/hook-output-log-policy": %s
|
`,
|
||||||
spec:
|
Weight: 0,
|
||||||
containers:
|
Events: []release.HookEvent{
|
||||||
- name: george-test
|
hookEvent,
|
||||||
image: fake-image
|
},
|
||||||
cmd: fake-command`, hookDefinitionString)
|
DeletePolicies: []release.HookDeletePolicy{
|
||||||
|
release.HookBeforeHookCreation,
|
||||||
|
release.HookSucceeded,
|
||||||
|
release.HookFailed,
|
||||||
|
},
|
||||||
|
LastRun: release.HookExecution{
|
||||||
|
Phase: release.HookPhaseFailed,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
func jobManifestWithOutputLog(hookDefinitions []release.HookOutputLogPolicy) string {
|
_ = configuration.execHook(r, hookEvent, 600)
|
||||||
hookDefinitionString := convertHooksToCommaSeparated(hookDefinitions)
|
|
||||||
return fmt.Sprintf(`kind: Job
|
if !reflect.DeepEqual(hookKubeClient.deleteRecord, []resource.Info{
|
||||||
apiVersion: batch/v1
|
{
|
||||||
metadata:
|
Name: "build-config-1",
|
||||||
name: losing-religion
|
Namespace: "test",
|
||||||
annotations:
|
},
|
||||||
"helm.sh/hook": pre-install
|
{
|
||||||
"helm.sh/hook-output-log-policy": %s
|
Name: "build-config-2",
|
||||||
spec:
|
Namespace: "test",
|
||||||
completions: 1
|
},
|
||||||
parallelism: 1
|
{
|
||||||
activeDeadlineSeconds: 30
|
Name: "build-config-2",
|
||||||
template:
|
Namespace: "test",
|
||||||
spec:
|
},
|
||||||
containers:
|
}) {
|
||||||
- name: religion-container
|
t.Fatalf("Got unexpected delete record")
|
||||||
image: religion-image
|
|
||||||
cmd: religion-command`, hookDefinitionString)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func jobManifestWithOutputLogWithNamespace(hookDefinitions []release.HookOutputLogPolicy) string {
|
//if err != nil {
|
||||||
hookDefinitionString := convertHooksToCommaSeparated(hookDefinitions)
|
// t.Fatalf("An expected error occured: %#v", err)
|
||||||
return fmt.Sprintf(`kind: Job
|
//}
|
||||||
apiVersion: batch/v1
|
|
||||||
metadata:
|
|
||||||
name: losing-religion
|
|
||||||
namespace: rem-namespace
|
|
||||||
annotations:
|
|
||||||
"helm.sh/hook": pre-install
|
|
||||||
"helm.sh/hook-output-log-policy": %s
|
|
||||||
spec:
|
|
||||||
completions: 1
|
|
||||||
parallelism: 1
|
|
||||||
activeDeadlineSeconds: 30
|
|
||||||
template:
|
|
||||||
spec:
|
|
||||||
containers:
|
|
||||||
- name: religion-container
|
|
||||||
image: religion-image
|
|
||||||
cmd: religion-command`, hookDefinitionString)
|
|
||||||
}
|
|
||||||
|
|
||||||
func convertHooksToCommaSeparated(hookDefinitions []release.HookOutputLogPolicy) string {
|
|
||||||
var commaSeparated string
|
|
||||||
for i, policy := range hookDefinitions {
|
|
||||||
if i+1 == len(hookDefinitions) {
|
|
||||||
commaSeparated += policy.String()
|
|
||||||
} else {
|
|
||||||
commaSeparated += policy.String() + ","
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return commaSeparated
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestInstallRelease_HookOutputLogsOnFailure(t *testing.T) {
|
|
||||||
// Should output on failure with expected namespace if hook-failed is set
|
|
||||||
runInstallForHooksWithFailure(t, podManifestWithOutputLogs([]release.HookOutputLogPolicy{release.HookOutputOnFailed}), "spaced", true)
|
|
||||||
runInstallForHooksWithFailure(t, podManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnFailed}), "sneaky-namespace", true)
|
|
||||||
runInstallForHooksWithFailure(t, jobManifestWithOutputLog([]release.HookOutputLogPolicy{release.HookOutputOnFailed}), "spaced", true)
|
|
||||||
runInstallForHooksWithFailure(t, jobManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnFailed}), "rem-namespace", true)
|
|
||||||
|
|
||||||
// Should not output on failure with expected namespace if hook-succeed is set
|
|
||||||
runInstallForHooksWithFailure(t, podManifestWithOutputLogs([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded}), "", false)
|
|
||||||
runInstallForHooksWithFailure(t, podManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded}), "", false)
|
|
||||||
runInstallForHooksWithFailure(t, jobManifestWithOutputLog([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded}), "", false)
|
|
||||||
runInstallForHooksWithFailure(t, jobManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded}), "", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestInstallRelease_HookOutputLogsOnSuccess(t *testing.T) {
|
|
||||||
// Should output on success with expected namespace if hook-succeeded is set
|
|
||||||
runInstallForHooksWithSuccess(t, podManifestWithOutputLogs([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded}), "spaced", true)
|
|
||||||
runInstallForHooksWithSuccess(t, podManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded}), "sneaky-namespace", true)
|
|
||||||
runInstallForHooksWithSuccess(t, jobManifestWithOutputLog([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded}), "spaced", true)
|
|
||||||
runInstallForHooksWithSuccess(t, jobManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded}), "rem-namespace", true)
|
|
||||||
|
|
||||||
// Should not output on success if hook-failed is set
|
|
||||||
runInstallForHooksWithSuccess(t, podManifestWithOutputLogs([]release.HookOutputLogPolicy{release.HookOutputOnFailed}), "", false)
|
|
||||||
runInstallForHooksWithSuccess(t, podManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnFailed}), "", false)
|
|
||||||
runInstallForHooksWithSuccess(t, jobManifestWithOutputLog([]release.HookOutputLogPolicy{release.HookOutputOnFailed}), "", false)
|
|
||||||
runInstallForHooksWithSuccess(t, jobManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnFailed}), "", false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestInstallRelease_HooksOutputLogsOnSuccessAndFailure(t *testing.T) {
|
|
||||||
// Should output on success with expected namespace if hook-succeeded and hook-failed is set
|
|
||||||
runInstallForHooksWithSuccess(t, podManifestWithOutputLogs([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded, release.HookOutputOnFailed}), "spaced", true)
|
|
||||||
runInstallForHooksWithSuccess(t, podManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded, release.HookOutputOnFailed}), "sneaky-namespace", true)
|
|
||||||
runInstallForHooksWithSuccess(t, jobManifestWithOutputLog([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded, release.HookOutputOnFailed}), "spaced", true)
|
|
||||||
runInstallForHooksWithSuccess(t, jobManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded, release.HookOutputOnFailed}), "rem-namespace", true)
|
|
||||||
|
|
||||||
// Should output on failure if hook-succeeded and hook-failed is set
|
|
||||||
runInstallForHooksWithFailure(t, podManifestWithOutputLogs([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded, release.HookOutputOnFailed}), "spaced", true)
|
|
||||||
runInstallForHooksWithFailure(t, podManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded, release.HookOutputOnFailed}), "sneaky-namespace", true)
|
|
||||||
runInstallForHooksWithFailure(t, jobManifestWithOutputLog([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded, release.HookOutputOnFailed}), "spaced", true)
|
|
||||||
runInstallForHooksWithFailure(t, jobManifestWithOutputLogWithNamespace([]release.HookOutputLogPolicy{release.HookOutputOnSucceeded, release.HookOutputOnFailed}), "rem-namespace", true)
|
|
||||||
}
|
|
||||||
|
|
||||||
func runInstallForHooksWithSuccess(t *testing.T, manifest, expectedNamespace string, shouldOutput bool) {
|
|
||||||
var expectedOutput string
|
|
||||||
if shouldOutput {
|
|
||||||
expectedOutput = fmt.Sprintf("attempted to output logs for namespace: %s", expectedNamespace)
|
|
||||||
}
|
|
||||||
is := assert.New(t)
|
|
||||||
instAction := installAction(t)
|
|
||||||
instAction.ReleaseName = "failed-hooks"
|
|
||||||
outBuffer := &bytes.Buffer{}
|
|
||||||
instAction.cfg.KubeClient = &kubefake.PrintingKubeClient{Out: io.Discard, LogOutput: outBuffer}
|
|
||||||
|
|
||||||
templates := []*chart.File{
|
|
||||||
{Name: "templates/hello", Data: []byte("hello: world")},
|
|
||||||
{Name: "templates/hooks", Data: []byte(manifest)},
|
|
||||||
}
|
|
||||||
vals := map[string]interface{}{}
|
|
||||||
|
|
||||||
res, err := instAction.Run(buildChartWithTemplates(templates), vals)
|
|
||||||
is.NoError(err)
|
|
||||||
is.Equal(expectedOutput, outBuffer.String())
|
|
||||||
is.Equal(release.StatusDeployed, res.Info.Status)
|
|
||||||
}
|
|
||||||
|
|
||||||
func runInstallForHooksWithFailure(t *testing.T, manifest, expectedNamespace string, shouldOutput bool) {
|
|
||||||
var expectedOutput string
|
|
||||||
if shouldOutput {
|
|
||||||
expectedOutput = fmt.Sprintf("attempted to output logs for namespace: %s", expectedNamespace)
|
|
||||||
}
|
|
||||||
is := assert.New(t)
|
|
||||||
instAction := installAction(t)
|
|
||||||
instAction.ReleaseName = "failed-hooks"
|
|
||||||
failingClient := instAction.cfg.KubeClient.(*kubefake.FailingKubeClient)
|
|
||||||
failingClient.WatchUntilReadyError = fmt.Errorf("failed watch")
|
|
||||||
instAction.cfg.KubeClient = failingClient
|
|
||||||
outBuffer := &bytes.Buffer{}
|
|
||||||
failingClient.PrintingKubeClient = kubefake.PrintingKubeClient{Out: io.Discard, LogOutput: outBuffer}
|
|
||||||
|
|
||||||
templates := []*chart.File{
|
|
||||||
{Name: "templates/hello", Data: []byte("hello: world")},
|
|
||||||
{Name: "templates/hooks", Data: []byte(manifest)},
|
|
||||||
}
|
|
||||||
vals := map[string]interface{}{}
|
|
||||||
|
|
||||||
res, err := instAction.Run(buildChartWithTemplates(templates), vals)
|
|
||||||
is.Error(err)
|
|
||||||
is.Contains(res.Info.Description, "failed pre-install")
|
|
||||||
is.Equal(expectedOutput, outBuffer.String())
|
|
||||||
is.Equal(release.StatusFailed, res.Info.Status)
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue