kubevela/pkg/controller/standard.oam.dev/v1alpha1/rollout/handler_test.go

/*
Copyright 2021 The KubeVela 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 rollout

import (
	"testing"

	"gotest.tools/assert"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/utils/pointer"

	"github.com/oam-dev/kubevela/apis/core.oam.dev/v1beta1"
	oamstandard "github.com/oam-dev/kubevela/apis/standard.oam.dev/v1alpha1"
)

func TestHandleTerminated(t *testing.T) {
	testcases := map[string]struct {
		rollout oamstandard.Rollout
		want    bool
	}{
		"succeed": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					SourceRevisionName: "v1",
					TargetRevisionName: "v2",
				},
				Status: oamstandard.CompRolloutStatus{
					LastSourceRevision:         "v1",
					LastUpgradedTargetRevision: "v2",
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RolloutSucceedState,
					},
				},
			},
			want: true,
		},
		"failed": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					SourceRevisionName: "v1",
					TargetRevisionName: "v2",
				},
				Status: oamstandard.CompRolloutStatus{
					LastSourceRevision:         "v1",
					LastUpgradedTargetRevision: "v2",
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RolloutFailedState,
					},
				},
			},
			want: true,
		},
		"restart after succeed": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					SourceRevisionName: "v2",
					TargetRevisionName: "v3",
				},
				Status: oamstandard.CompRolloutStatus{
					LastSourceRevision:         "v2",
					LastUpgradedTargetRevision: "v1",
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RolloutSucceedState,
					},
				},
			},
			want: false,
		},
		"restart after failed": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					SourceRevisionName: "v2",
					TargetRevisionName: "v3",
				},
				Status: oamstandard.CompRolloutStatus{
					LastSourceRevision:         "v2",
					LastUpgradedTargetRevision: "v1",
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RolloutFailedState,
					},
				},
			},
			want: false,
		},
		"still in middle of rollout": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					SourceRevisionName: "v1",
					TargetRevisionName: "v2",
				},
				Status: oamstandard.CompRolloutStatus{
					LastSourceRevision:         "v1",
					LastUpgradedTargetRevision: "v2",
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RollingInBatchesState,
					},
				},
			},
			want: false,
		},
		"last scale have finished": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "v1",
					RolloutPlan: oamstandard.RolloutPlan{
						TargetSize: pointer.Int32Ptr(2),
					},
				},
				Status: oamstandard.CompRolloutStatus{
					LastUpgradedTargetRevision: "v1",
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState:      oamstandard.RolloutSucceedState,
						RolloutTargetSize: 2,
					},
				},
			},
			want: true,
		},
		"modify targetSize trigger scale operation again": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "v1",
					RolloutPlan: oamstandard.RolloutPlan{
						TargetSize: pointer.Int32Ptr(4),
					},
				},
				Status: oamstandard.CompRolloutStatus{
					LastUpgradedTargetRevision: "v1",
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState:      oamstandard.RollingInBatchesState,
						RolloutTargetSize: 2,
					},
				},
			},
			want: false,
		},
	}
	for casename, c := range testcases {
		got := checkRollingTerminated(c.rollout)
		if got != c.want {
			t.Errorf("%s result missmatch want:%v got: %v", casename, c.want, got)
		}
	}
}

func Test_isRolloutModified(t *testing.T) {
	tests := map[string]struct {
		rollout oamstandard.Rollout
		want    bool
	}{
		"initial case when no source or target set": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "target1",
				},
				Status: oamstandard.CompRolloutStatus{
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RollingInBatchesState,
					},
				},
			},
			want: false,
		},
		"scale no change case": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "target1",
				},
				Status: oamstandard.CompRolloutStatus{
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RollingInBatchesState,
					},
					LastUpgradedTargetRevision: "target1",
				},
			},
			want: false,
		},
		"rollout no change case": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "target1",
				},
				Status: oamstandard.CompRolloutStatus{
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RollingInBatchesState,
					},
					LastUpgradedTargetRevision: "target1",
				},
			},
			want: false,
		},
		"scale change case": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "target2",
				},
				Status: oamstandard.CompRolloutStatus{
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RollingInBatchesState,
					},
					LastUpgradedTargetRevision: "target1",
				},
			},
			want: true,
		},
		"rollout one change case": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "target2",
				},
				Status: oamstandard.CompRolloutStatus{
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RollingInBatchesState,
					},
					LastUpgradedTargetRevision: "target1",
				},
			},
			want: true,
		},
		"rollout both change case": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "target2",
				},
				Status: oamstandard.CompRolloutStatus{
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RollingInBatchesState,
					},
					LastUpgradedTargetRevision: "target1",
				},
			},
			want: true,
		},
		"deleting both change case": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "target2",
				},
				Status: oamstandard.CompRolloutStatus{
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState: oamstandard.RolloutDeletingState,
					},
					LastUpgradedTargetRevision: "target1",
				},
			},
			want: false,
		},
		"restart a scale operation": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "target1",
					RolloutPlan: oamstandard.RolloutPlan{
						TargetSize: pointer.Int32Ptr(1),
					},
				},
				Status: oamstandard.CompRolloutStatus{
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState:      oamstandard.RolloutSucceedState,
						RolloutTargetSize: 2,
					},
					LastUpgradedTargetRevision: "target1",
				},
			},
			want: true,
		},
		"scale have finished": {
			rollout: oamstandard.Rollout{
				Spec: oamstandard.RolloutSpec{
					TargetRevisionName: "target1",
					RolloutPlan: oamstandard.RolloutPlan{
						TargetSize: pointer.Int32Ptr(2),
					},
				},
				Status: oamstandard.CompRolloutStatus{
					RolloutStatus: oamstandard.RolloutStatus{
						RollingState:      oamstandard.RolloutSucceedState,
						RolloutTargetSize: 2,
					},
					LastUpgradedTargetRevision: "target1",
				},
			},
			want: false,
		},
	}
	for name, tt := range tests {
		h := handler{}
		t.Run(name, func(t *testing.T) {
			if got := h.isRolloutModified(tt.rollout); got != tt.want {
				t.Errorf("isRolloutModified() = %v, want %v", got, tt.want)
			}
		})
	}
}

func TestPassOwnerReference(t *testing.T) {
	rollout := oamstandard.Rollout{
		ObjectMeta: metav1.ObjectMeta{
			OwnerReferences: []metav1.OwnerReference{
				{
					APIVersion: v1beta1.SchemeGroupVersion.String(),
					Kind:       v1beta1.ResourceTrackerKind,
					UID:        "test-uid",
					Controller: pointer.Bool(true),
					Name:       "test-resouceTracker",
				},
			},
		},
	}
	u := &unstructured.Unstructured{}
	u.SetName("test-workload")
	h := &handler{
		rollout:        &rollout,
		targetWorkload: u,
	}
	h.passOwnerToTargetWorkload()
	assert.Assert(t, len(h.targetWorkload.GetOwnerReferences()) == 1)
	assert.Assert(t, *h.targetWorkload.GetOwnerReferences()[0].Controller == false)
}