helm/pkg/cmd/rollback_test.go

/*
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 cmd

import (
	"fmt"
	"reflect"
	"strings"
	"testing"

	chart "helm.sh/helm/v4/pkg/chart/v2"
	"helm.sh/helm/v4/pkg/release/common"
	release "helm.sh/helm/v4/pkg/release/v1"
)

func TestRollbackCmd(t *testing.T) {
	rels := []*release.Release{
		{
			Name:    "funny-honey",
			Info:    &release.Info{Status: common.StatusSuperseded},
			Chart:   &chart.Chart{},
			Version: 1,
		},
		{
			Name:    "funny-honey",
			Info:    &release.Info{Status: common.StatusDeployed},
			Chart:   &chart.Chart{},
			Version: 2,
		},
	}

	tests := []cmdTestCase{{
		name:   "rollback a release",
		cmd:    "rollback funny-honey 1",
		golden: "output/rollback.txt",
		rels:   rels,
	}, {
		name:   "rollback a release with timeout",
		cmd:    "rollback funny-honey 1 --timeout 120s",
		golden: "output/rollback-timeout.txt",
		rels:   rels,
	}, {
		name:   "rollback a release with wait",
		cmd:    "rollback funny-honey 1 --wait",
		golden: "output/rollback-wait.txt",
		rels:   rels,
	}, {
		name:   "rollback a release with wait-for-jobs",
		cmd:    "rollback funny-honey 1 --wait --wait-for-jobs",
		golden: "output/rollback-wait-for-jobs.txt",
		rels:   rels,
	}, {
		name:   "rollback a release without revision",
		cmd:    "rollback funny-honey",
		golden: "output/rollback-no-revision.txt",
		rels:   rels,
	}, {
		name:      "rollback a release with non-existent version",
		cmd:       "rollback funny-honey 3",
		golden:    "output/rollback-non-existent-version.txt",
		rels:      rels,
		wantError: true,
	}, {
		name:      "rollback a release without release name",
		cmd:       "rollback",
		golden:    "output/rollback-no-args.txt",
		rels:      rels,
		wantError: true,
	}, {
		name:   "rollback a release with description",
		cmd:    "rollback funny-honey 1 --description 'Reverting due to bug in version 2'",
		golden: "output/rollback-with-description.txt",
		rels:   rels,
	}}
	runTestCmd(t, tests)
}

func TestRollbackRevisionCompletion(t *testing.T) {
	mk := func(name string, vers int, status common.Status) *release.Release {
		return release.Mock(&release.MockReleaseOptions{
			Name:    name,
			Version: vers,
			Status:  status,
		})
	}

	releases := []*release.Release{
		mk("musketeers", 11, common.StatusDeployed),
		mk("musketeers", 10, common.StatusSuperseded),
		mk("musketeers", 9, common.StatusSuperseded),
		mk("musketeers", 8, common.StatusSuperseded),
		mk("carabins", 1, common.StatusSuperseded),
	}

	tests := []cmdTestCase{{
		name:   "completion for release parameter",
		cmd:    "__complete rollback ''",
		rels:   releases,
		golden: "output/rollback-comp.txt",
	}, {
		name:   "completion for revision parameter",
		cmd:    "__complete rollback musketeers ''",
		rels:   releases,
		golden: "output/revision-comp.txt",
	}, {
		name:   "completion for with too many args",
		cmd:    "__complete rollback musketeers 11 ''",
		rels:   releases,
		golden: "output/rollback-wrong-args-comp.txt",
	}}
	runTestCmd(t, tests)
}

func TestRollbackFileCompletion(t *testing.T) {
	checkFileCompletion(t, "rollback", false)
	checkFileCompletion(t, "rollback myrelease", false)
	checkFileCompletion(t, "rollback myrelease 1", false)
}

func TestRollbackWithDescription(t *testing.T) {
	releaseName := "funny-bunny-desc"
	rels := []*release.Release{
		{
			Name:    releaseName,
			Info:    &release.Info{Status: common.StatusSuperseded},
			Chart:   &chart.Chart{},
			Version: 1,
		},
		{
			Name:    releaseName,
			Info:    &release.Info{Status: common.StatusDeployed},
			Chart:   &chart.Chart{},
			Version: 2,
		},
	}
	storage := storageFixture()
	for _, rel := range rels {
		if err := storage.Create(rel); err != nil {
			t.Fatal(err)
		}
	}

	customDescription := "Rollback due to critical bug in version 2"
	_, _, err := executeActionCommandC(storage, fmt.Sprintf("rollback %s 1 --description '%s'", releaseName, customDescription))
	if err != nil {
		t.Fatalf("unexpected error, got '%v'", err)
	}

	// Verify the description was stored correctly
	updatedReli, err := storage.Get(releaseName, 3)
	if err != nil {
		t.Fatalf("unexpected error getting release, got '%v'", err)
	}
	updatedRel, err := releaserToV1Release(updatedReli)
	if err != nil {
		t.Fatalf("unexpected error converting release, got '%v'", err)
	}

	if updatedRel.Info.Description != customDescription {
		t.Errorf("Expected description '%s', got '%s'", customDescription, updatedRel.Info.Description)
	}
}

func TestRollbackDescriptionTooLong(t *testing.T) {
	releaseName := "funny-bunny-long-desc"
	rels := []*release.Release{
		{
			Name:    releaseName,
			Info:    &release.Info{Status: common.StatusSuperseded},
			Chart:   &chart.Chart{},
			Version: 1,
		},
		{
			Name:    releaseName,
			Info:    &release.Info{Status: common.StatusDeployed},
			Chart:   &chart.Chart{},
			Version: 2,
		},
	}
	storage := storageFixture()
	for _, rel := range rels {
		if err := storage.Create(rel); err != nil {
			t.Fatal(err)
		}
	}

	// Create a description that exceeds the 512 character limit
	longDescription := strings.Repeat("a", 513)
	_, _, err := executeActionCommandC(storage, fmt.Sprintf("rollback %s 1 --description '%s'", releaseName, longDescription))
	if err == nil {
		t.Error("expected error for description exceeding max length, got success")
	}
	if err != nil && !strings.Contains(err.Error(), "description must be 512 characters or less") {
		t.Errorf("expected error about description length, got: %v", err)
	}
}

func TestRollbackWithLabels(t *testing.T) {
	labels1 := map[string]string{"operation": "install", "firstLabel": "firstValue"}
	labels2 := map[string]string{"operation": "upgrade", "secondLabel": "secondValue"}

	releaseName := "funny-bunny-labels"
	rels := []*release.Release{
		{
			Name:    releaseName,
			Info:    &release.Info{Status: common.StatusSuperseded},
			Chart:   &chart.Chart{},
			Version: 1,
			Labels:  labels1,
		},
		{
			Name:    releaseName,
			Info:    &release.Info{Status: common.StatusDeployed},
			Chart:   &chart.Chart{},
			Version: 2,
			Labels:  labels2,
		},
	}
	storage := storageFixture()
	for _, rel := range rels {
		if err := storage.Create(rel); err != nil {
			t.Fatal(err)
		}
	}
	_, _, err := executeActionCommandC(storage, fmt.Sprintf("rollback %s 1", releaseName))
	if err != nil {
		t.Errorf("unexpected error, got '%v'", err)
	}
	updatedReli, err := storage.Get(releaseName, 3)
	if err != nil {
		t.Errorf("unexpected error, got '%v'", err)
	}
	updatedRel, err := releaserToV1Release(updatedReli)
	if err != nil {
		t.Errorf("unexpected error, got '%v'", err)
	}

	if !reflect.DeepEqual(updatedRel.Labels, labels1) {
		t.Errorf("Expected {%v}, got {%v}", labels1, updatedRel.Labels)
	}
}