Update interfaces and unit tests for Finalize method

Signed-off-by: GautamBytes <manchandanigautam@gmail.com>

Author: GautamBytes

pkg/controller/batchrelease/control/bluegreenstyle/cloneset/control_test.go

@@ -244,7 +244,7 @@ var _ = Describe("CloneSet Control", func() {
 		Expect(err).NotTo(HaveOccurred())
 		// call Finalize method
 		err = retryFunction(3, func() error {
-			return rc.Finalize(release)
+			return rc.Finalize(release, false)
 		})
 		Expect(err).NotTo(HaveOccurred())
 
@@ -526,7 +526,7 @@ func TestRealController(t *testing.T) {
 		MinReadySeconds: 0,
 	})))
 
-	controller.Finalize(release)
+	controller.Finalize(release, false)
 	fetch = &kruiseappsv1alpha1.CloneSet{}
 	Expect(cli.Get(context.TODO(), cloneKey, fetch)).NotTo(HaveOccurred())
 	Expect(fetch.Spec.UpdateStrategy.MaxSurge.StrVal).Should(Equal("0%"))

pkg/controller/batchrelease/control/bluegreenstyle/control_plane.go

@@ -17,13 +17,13 @@ limitations under the License.
 package bluegreenstyle
 
 import (
+	"github.com/openkruise/rollouts/pkg/feature"
+	utilfeature "github.com/openkruise/rollouts/pkg/util/feature"
 	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/types"
-	"github.com/openkruise/rollouts/pkg/feature"
 	"k8s.io/client-go/tools/record"
 	"k8s.io/klog/v2"
-	utilfeature "github.com/openkruise/rollouts/pkg/util/feature"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/openkruise/rollouts/api/v1beta1"

pkg/controller/batchrelease/control/bluegreenstyle/deployment/control_test.go

@@ -311,7 +311,7 @@ var _ = Describe("Deployment Control", func() {
 		Expect(err).NotTo(HaveOccurred())
 		// call Finalize method
 		err = retryFunction(3, func() error {
-			return rc.Finalize(release)
+			return rc.Finalize(release, false)
 		})
 		Expect(err).NotTo(HaveOccurred())
 
@@ -612,7 +612,7 @@ func TestRealController(t *testing.T) {
 	Expect(reflect.DeepEqual(fetch.Spec.Strategy.RollingUpdate.MaxSurge, &intstr.IntOrString{Type: intstr.String, StrVal: "50%"})).Should(BeTrue())
 
 	release.Spec.ReleasePlan.BatchPartition = nil
-	err = controller.Finalize(release)
+	err = controller.Finalize(release, false)
 	Expect(errors.IsRetryError(err)).Should(BeTrue())
 	fetch = &apps.Deployment{}
 	Expect(cli.Get(context.TODO(), deploymentKey, fetch)).NotTo(HaveOccurred())

pkg/controller/batchrelease/control/bluegreenstyle/interface.go

@@ -45,5 +45,5 @@ type Interface interface {
 	UpgradeBatch(ctx *batchcontext.BatchContext) error
 	// Finalize do something after rolling out, for example:
 	// - set pause to false, restore the original setting, delete annotation
-	Finalize(release *v1beta1.BatchRelease) error
+	Finalize(release *v1beta1.BatchRelease, keepPaused bool) error
 }

pkg/controller/batchrelease/control/canarystyle/control_plane.go

@@ -27,10 +27,10 @@ import (
 
 	"github.com/openkruise/rollouts/api/v1beta1"
 	"github.com/openkruise/rollouts/pkg/controller/batchrelease/control"
-	"github.com/openkruise/rollouts/pkg/feature"
-	utilfeature "github.com/openkruise/rollouts/pkg/util/feature"
 	"github.com/openkruise/rollouts/pkg/controller/batchrelease/labelpatch"
+	"github.com/openkruise/rollouts/pkg/feature"
 	"github.com/openkruise/rollouts/pkg/util"
+	utilfeature "github.com/openkruise/rollouts/pkg/util/feature"
 )
 
 // CloneSetRolloutController is responsible for handling rollout CloneSet type of workloads

pkg/controller/batchrelease/control/canarystyle/deployment/control_test.go

@@ -252,7 +252,7 @@ func TestRealStableController(t *testing.T) {
 	Expect(fetch.Annotations[util.BatchReleaseControlAnnotation]).Should(Equal(getControlInfo(release)))
 	c.stableObject = fetch // mock
 
-	err = controller.Finalize(release)
+	err = controller.Finalize(release, false)
 	Expect(err).NotTo(HaveOccurred())
 	fetch = &apps.Deployment{}
 	Expect(cli.Get(context.TODO(), deploymentKey, fetch)).NotTo(HaveOccurred())

pkg/controller/batchrelease/control/canarystyle/deployment/stable.go

@@ -67,8 +67,8 @@ func (rc *realStableController) Finalize(release *v1beta1.BatchRelease, keepPaus
 		// if batchPartition == nil, workload should be promoted;
 		pause := release.Spec.ReleasePlan.BatchPartition != nil
 		body = fmt.Sprintf(`{"metadata":{"annotations":{"%s":null}},"spec":{"paused":%v}}`,
-		   util.BatchReleaseControlAnnotation, pause)
-		}
+			util.BatchReleaseControlAnnotation, pause)
+	}
 
 	if err := rc.stableClient.Patch(context.TODO(), d, client.RawPatch(types.StrategicMergePatchType, []byte(body))); err != nil {
 		return err

pkg/controller/batchrelease/control/canarystyle/interface.go

@@ -57,5 +57,5 @@ type StableInterface interface {
 	// Finalize do something after rolling out, for example:
 	// - free the stable workload from rollout control;
 	// - resume stable workload and wait all pods updated if we need.
-	Finalize(controller *v1beta1.BatchRelease) error
+	Finalize(controller *v1beta1.BatchRelease, keepPaused bool) error
 }

pkg/controller/batchrelease/control/partitionstyle/cloneset/control_test.go

@@ -313,7 +313,7 @@ func TestRealController(t *testing.T) {
 	Expect(cli.Get(context.TODO(), cloneKey, fetch)).NotTo(HaveOccurred())
 	Expect(fetch.Spec.UpdateStrategy.Partition.StrVal).Should(Equal("90%"))
 
-	err = controller.Finalize(release)
+	err = controller.Finalize(release, false)
 	Expect(err).NotTo(HaveOccurred())
 	fetch = &kruiseappsv1alpha1.CloneSet{}
 	Expect(cli.Get(context.TODO(), cloneKey, fetch)).NotTo(HaveOccurred())

pkg/controller/batchrelease/control/partitionstyle/control_plane.go

@@ -30,12 +30,12 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/openkruise/rollouts/api/v1alpha1"
-	"github.com/openkruise/rollouts/pkg/feature"
-	utilfeature "github.com/openkruise/rollouts/pkg/util/feature"
 	"github.com/openkruise/rollouts/api/v1beta1"
 	"github.com/openkruise/rollouts/pkg/controller/batchrelease/control"
 	"github.com/openkruise/rollouts/pkg/controller/batchrelease/labelpatch"
+	"github.com/openkruise/rollouts/pkg/feature"
 	"github.com/openkruise/rollouts/pkg/util"
+	utilfeature "github.com/openkruise/rollouts/pkg/util/feature"
 )
 
 type realBatchControlPlane struct {