Improve test coverage of appstudio-controller and remove application_controller.go file

Author: Rizwana777

appstudio-controller/controllers/appstudio.redhat.com/application_controller.go

@@ -15,6 +15,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 
+	"github.com/golang/mock/gomock"
+	"github.com/redhat-appstudio/managed-gitops/backend-shared/apis/managed-gitops/v1alpha1/mocks"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
@@ -351,6 +353,44 @@ var _ = Describe("Test DeploymentTargetReclaimController", func() {
 				})
 
 			})
+
+			It("test findMatchingSpaceRequestForDT for SpaceRequestList", func() {
+				var (
+					mockK8sClient    *mocks.MockClient
+					ctx              context.Context
+					deploymentTarget appstudiosharedv1.DeploymentTarget
+				)
+
+				// Create a list of SpaceRequests with different TierNames
+				spaceRequests := []codereadytoolchainv1alpha1.SpaceRequest{
+					{
+						ObjectMeta: metav1.ObjectMeta{
+							Labels: map[string]string{
+								DeploymentTargetLabel: deploymentTarget.Name,
+							},
+						},
+						Spec: codereadytoolchainv1alpha1.SpaceRequestSpec{
+							TierName: "appstudio-env",
+						},
+					},
+				}
+
+				mockCtrl := gomock.NewController(GinkgoT())
+				defer mockCtrl.Finish()
+				mockK8sClient = mocks.NewMockClient(mockCtrl)
+
+				// Mock the List operation to return the list of SpaceRequests
+				mockK8sClient.EXPECT().
+					List(ctx, gomock.Any(), gomock.Any()).
+					SetArg(1, codereadytoolchainv1alpha1.SpaceRequestList{Items: spaceRequests}).
+					Return(nil)
+
+				result, err := findMatchingSpaceRequestForDT(ctx, mockK8sClient, deploymentTarget)
+				Expect(err).ToNot(HaveOccurred())
+				Expect(result).ToNot(BeNil())
+				Expect(result.Spec.TierName).To(Equal("appstudio-env"))
+			})
+
 		})
 
 	})

appstudio-controller/controllers/appstudio.redhat.com/deploymenttarget_controller_test.go

@@ -5,11 +5,13 @@ import (
 	"fmt"
 	"reflect"
 
+	"github.com/golang/mock/gomock"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	appstudioshared "github.com/redhat-appstudio/application-api/api/v1alpha1"
 
 	managedgitopsv1alpha1 "github.com/redhat-appstudio/managed-gitops/backend-shared/apis/managed-gitops/v1alpha1"
+	"github.com/redhat-appstudio/managed-gitops/backend-shared/apis/managed-gitops/v1alpha1/mocks"
 	"github.com/redhat-appstudio/managed-gitops/backend-shared/util/tests"
 
 	sharedutil "github.com/redhat-appstudio/managed-gitops/backend-shared/util"
@@ -1778,6 +1780,109 @@ var _ = Describe("Environment controller tests", func() {
 		)
 
 	})
+
+	Context("test generateDesiredResource function", func() {
+		var mockCtrl *gomock.Controller
+		var mockK8sClient *mocks.MockClient
+		log := log.FromContext(ctx)
+		var env appstudioshared.Environment
+		BeforeEach(func() {
+
+			scheme,
+				argocdNamespace,
+				kubesystemNamespace,
+				namespace,
+				err := tests.GenericTestSetup()
+			Expect(err).ToNot(HaveOccurred())
+
+			err = appstudioshared.AddToScheme(scheme)
+			Expect(err).ToNot(HaveOccurred())
+
+			apiNamespace = *namespace
+
+			// Create fake client
+			k8sClient = fake.NewClientBuilder().
+				WithScheme(scheme).
+				WithObjects(namespace, argocdNamespace, kubesystemNamespace).
+				Build()
+
+			mockCtrl = gomock.NewController(GinkgoT())
+			mockK8sClient = mocks.NewMockClient(mockCtrl)
+
+			env = appstudioshared.Environment{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "my-env",
+					Namespace: apiNamespace.Name,
+				},
+				Spec: appstudioshared.EnvironmentSpec{
+					DisplayName:        "my-environment",
+					DeploymentStrategy: appstudioshared.DeploymentStrategy_Manual,
+					ParentEnvironment:  "",
+					Tags:               []string{},
+					Configuration:      appstudioshared.EnvironmentConfiguration{},
+					UnstableConfigurationFields: &appstudioshared.UnstableEnvironmentConfiguration{
+						KubernetesClusterCredentials: appstudioshared.KubernetesClusterCredentials{
+							TargetNamespace:            "my-target-namespace",
+							APIURL:                     "https://my-api-url",
+							ClusterCredentialsSecret:   "test-non-exist",
+							AllowInsecureSkipTLSVerify: false,
+						},
+					},
+				},
+			}
+
+			reconciler = EnvironmentReconciler{
+				Client: k8sClient,
+				Scheme: scheme,
+			}
+
+		})
+
+		AfterEach(func() {
+			mockCtrl.Finish()
+		})
+
+		It("test to cover updateEnvironmentReconciledStatusCondition for generic error while fetching secret", func() {
+
+			err := k8sClient.Create(ctx, &env)
+			Expect(err).ToNot(HaveOccurred())
+
+			mockK8sClient.EXPECT().Get(gomock.Any(), gomock.Any(), gomock.Any()).Return(fmt.Errorf("some generic error"))
+			mockK8sClient.EXPECT().Status().Return(mockK8sClient)
+			mockK8sClient.EXPECT().Update(gomock.Any(), gomock.Any()).Return(fmt.Errorf("unable to update environment status condition."))
+
+			desiredManagedEnv, semanticErrOccurred_dontContinue, err := generateDesiredResource(ctx, env, mockK8sClient, log)
+			Expect(desiredManagedEnv).To(BeNil())
+			Expect(semanticErrOccurred_dontContinue).To(BeFalse())
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(ContainSubstring("unable to update environment status condition"))
+
+			err = k8sClient.Delete(ctx, &env)
+			Expect(err).ToNot(HaveOccurred())
+
+		})
+
+		It("test to cover updateEnvironmentReconciledStatusCondition for generic error while fetching dtc", func() {
+
+			env.Spec.Configuration.Target.DeploymentTargetClaim.ClaimName = "test-dtc"
+			err := k8sClient.Create(ctx, &env)
+			Expect(err).ToNot(HaveOccurred())
+
+			mockK8sClient.EXPECT().Get(gomock.Any(), gomock.Any(), gomock.Any()).Return(fmt.Errorf("some generic error"))
+			mockK8sClient.EXPECT().Status().Return(mockK8sClient)
+			mockK8sClient.EXPECT().Update(gomock.Any(), gomock.Any()).Return(fmt.Errorf("unable to update environment status condition."))
+
+			desiredManagedEnv, semanticErrOccurred_dontContinue, err := generateDesiredResource(ctx, env, mockK8sClient, log)
+			Expect(desiredManagedEnv).To(BeNil())
+			Expect(semanticErrOccurred_dontContinue).To(BeFalse())
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(ContainSubstring("unable to update environment status condition"))
+
+			err = k8sClient.Delete(ctx, &env)
+			Expect(err).ToNot(HaveOccurred())
+		})
+
+	})
 })
 
 // expectEnvironmentStatusConditionError verifies that both a Reconciled and an EnvironmentConditionErrorOccurred

appstudio-controller/controllers/appstudio.redhat.com/environment_controller_test.go

@@ -92,6 +92,10 @@ type SnapshotEnvironmentBindingReconciler struct {
 //+kubebuilder:rbac:groups=managed-gitops.redhat.com,resources=gitopsdeployments,verbs=get;list;watch;create;update;patch;delete
 //+kubebuilder:rbac:groups=core,resources=namespaces,verbs=get;list;watch;
 
+//+kubebuilder:rbac:groups=appstudio.redhat.com,resources=applications,verbs=get;list;watch;create;update;patch;delete
+//+kubebuilder:rbac:groups=appstudio.redhat.com,resources=applications/status,verbs=get;update;patch
+//+kubebuilder:rbac:groups=appstudio.redhat.com,resources=applications/finalizers,verbs=update
+
 // Reconcile is part of the main kubernetes reconciliation loop which aims to
 // move the current state of the cluster closer to the desired state.
 //

appstudio-controller/controllers/appstudio.redhat.com/snapshotenvironmentbinding_controller.go

@@ -705,6 +705,29 @@ var _ = Describe("SnapshotEnvironmentBinding Reconciler Tests", func() {
 
 		})
 
+		It("should verify that if DeploymentTargetClaim is not found referencing to an the Environment", func() {
+			By("creating an Environment that references the DTC")
+			environment.Spec.UnstableConfigurationFields = nil
+			environment.Spec.Configuration.Target = appstudiosharedv1.EnvironmentTarget{
+				DeploymentTargetClaim: appstudiosharedv1.DeploymentTargetClaimConfig{
+					ClaimName: "dtc-that-doesnt-exist",
+				},
+			}
+			err := bindingReconciler.Client.Update(ctx, &environment)
+			Expect(err).ToNot(HaveOccurred())
+
+			By("creating default Binding")
+			err = bindingReconciler.Client.Create(ctx, binding)
+			Expect(err).ToNot(HaveOccurred())
+
+			By("calling Reconcile on the SnapshotEnvironmentBinding")
+			request = newRequest(binding.Namespace, binding.Name)
+			_, err = bindingReconciler.Reconcile(ctx, request)
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(ContainSubstring("error on retrieving DeploymentTargetClaim"))
+
+		})
+
 		It("should verify that if the Environment contains configuration information, that it is included in the generated GitOpsDeployment", func() {
 
 			By("creating an Environment with valid configuration fields")

appstudio-controller/controllers/appstudio.redhat.com/snapshotenvironmentbinding_controller_test.go

@@ -112,6 +112,25 @@ var _ = Describe("Test DevsandboxDeploymentController", func() {
 			Expect(dt.Annotations).ToNot(BeNil())
 			Expect(dt.Annotations[appstudiosharedv1.AnnDynamicallyProvisioned]).To(Equal(string(appstudiosharedv1.Provisioner_Devsandbox)))
 			Expect(dt.Spec.KubernetesClusterCredentials.AllowInsecureSkipTLSVerify).To(BeFalse())
+
+			By("verify when spacerequest has DeploymentTargetLabel label")
+			err = k8sClient.Get(ctx, client.ObjectKeyFromObject(&spacerequest), &spacerequest)
+			Expect(err).ToNot(HaveOccurred())
+
+			// Add DeploymentTargetLabel
+			spacerequest.Labels = map[string]string{
+				DeploymentTargetClaimLabel: dtc.Name,
+				DeploymentTargetLabel:      dt.Name,
+			}
+
+			err = k8sClient.Update(ctx, &spacerequest)
+			Expect(err).ToNot(HaveOccurred())
+
+			request = newRequest(spacerequest.Namespace, spacerequest.Name)
+			res, err = reconciler.Reconcile(ctx, request)
+			Expect(err).ToNot(HaveOccurred())
+			Expect(res).To(Equal(ctrl.Result{}))
+
 		})
 
 		It("should return an error when handling a SpaceRequest that doesn't have a matching DTC", func() {

appstudio-controller/controllers/appstudio.redhat.com/spacerequest_controller_test.go

@@ -5,6 +5,7 @@ go 1.19
 require (
 	github.com/codeready-toolchain/api v0.0.0-20230417183849-f62ccbf3bd40
 	github.com/codeready-toolchain/toolchain-common v0.0.0-20230417235430-8258a3281250
+	github.com/golang/mock v1.6.0
 	github.com/onsi/ginkgo/v2 v2.6.0
 	github.com/onsi/gomega v1.24.1
 	github.com/redhat-appstudio/application-api v0.0.0-20231025105224-2790bb451725

appstudio-controller/go.mod

@@ -113,13 +113,6 @@ func main() {
 		os.Exit(1)
 	}
 
-	if err = (&appstudioredhatcomcontrollers.ApplicationReconciler{
-		Client: mgr.GetClient(),
-		Scheme: mgr.GetScheme(),
-	}).SetupWithManager(mgr); err != nil {
-		setupLog.Error(err, "unable to create controller", "controller", "Application")
-		os.Exit(1)
-	}
 	if err = (&appstudioredhatcomcontrollers.SnapshotReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),