Merge pull request #43 from stakater/shutdownfix

adding shutdown for host cluster to shutdown factory.

Author: ufateh

.vscode/launch.json

@@ -1,45 +1,55 @@
 {
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Debug Go Tests",
-            "type": "go",
-            "request": "launch",
-            "mode": "test",
-            "program": "${fileDirname}", // Specifies that tests in the current directory's package should be run
-            "args": ["-test.v", "--ginkgo.vv", "--ginkgo.focus", "${selectedText}"], // Verbose test output
-            "preLaunchTask": "", // This should match the label of your pre-test task
-            "env": {
-              "GOFLAGS": "-count=1", // Avoid test caching
-            },
-          },
-          {
-            "name": "Debug E2E Tests",
-            "type": "go",
-            "request": "launch",
-            "mode": "test",
-            "program": "${fileDirname}", // Specifies that tests in the current directory's package should be run
-            "args": ["-test.v", "--ginkgo.vv", "--ginkgo.focus", "${selectedText}"], // Verbose test output
-            "preLaunchTask": "", // This should match the label of your pre-test task
-            "env": {
-              "GOFLAGS": "-count=1", // Avoid test caching
-              "HOSTED_CLUSTER_NAME": "c7ked5y6v",
-              "HOSTED_CLUSTER_NAMESPACE": "hypershift-c7ked5y6v",
-              "SPOKE_ROUTE_NAMESPACE": "openshift-monitoring",
-              "HUB_NAMESPACE": "c7ked5y6v",
-              "ROUTE_NAME": "e2e-example-route",
-              "ROUTE_LABELS": "app=example,env=prod",
-              "PROBE_JOB_NAME": "e2e-uptime-probe-job",
-              "PROBE_INTERVAL": "30s",
-              "PROBE_TIMEOUT": "10s",
-              "PROBE_MODULE": "http_2xx",
-              "PROBER_URL": "e2e-blackbox-exporter.openshift-monitoring.svc.cluster.local:9115",
-              "PROBER_SCHEME": "http",
-              "PROBER_PATH": "/probe"
-            },
-          },
-    ]
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Go Tests",
+      "type": "go",
+      "request": "launch",
+      "mode": "test",
+      "program": "${fileDirname}", // Specifies that tests in the current directory's package should be run
+      "args": [
+        "-test.v",
+        "--ginkgo.vv",
+        "--ginkgo.focus",
+        "${selectedText}"
+      ], // Verbose test output
+      "preLaunchTask": "", // This should match the label of your pre-test task
+      "env": {
+        "GOFLAGS": "-count=1", // Avoid test caching
+      },
+    },
+    {
+      "name": "Debug E2E Tests",
+      "type": "go",
+      "request": "launch",
+      "mode": "test",
+      "program": "${fileDirname}", // Specifies that tests in the current directory's package should be run
+      "args": [
+        "-test.v",
+        "--ginkgo.vv",
+        "--ginkgo.focus",
+        "${selectedText}"
+      ], // Verbose test output
+      "preLaunchTask": "", // This should match the label of your pre-test task
+      "env": {
+        "GOFLAGS": "-count=1", // Avoid test caching
+        "HOSTED_CLUSTER_NAME": "c7ked5y6v",
+        "HOSTED_CLUSTER_NAMESPACE": "hypershift-c7ked5y6v",
+        "SPOKE_ROUTE_NAMESPACE": "openshift-monitoring",
+        "HUB_NAMESPACE": "c7ked5y6v",
+        "ROUTE_NAME": "e2e-example-route",
+        "ROUTE_LABELS": "app=example,env=prod",
+        "PROBE_JOB_NAME": "e2e-uptime-probe-job",
+        "PROBE_INTERVAL": "30s",
+        "PROBE_TIMEOUT": "10s",
+        "PROBE_MODULE": "http_2xx",
+        "PROBER_URL": "e2e-blackbox-exporter.openshift-monitoring.svc.cluster.local:9115",
+        "PROBER_SCHEME": "http",
+        "PROBER_PATH": "/probe"
+      },
+    },
+  ]
 }

README.md

@@ -88,6 +88,12 @@ make run
 ```
 
 **Running E2E Tests:**
+
+Make sure that operator is running
+```bash
+make run
+```
+
 Use the provided VSCode launch configuration to execute the end-to-end tests. The launch file contains the necessary configuration for running tests in your development environment. `Debug E2E Tests` is the launch configuration for running the end-to-end tests. It have environment variables which can be used to configure the test. To run the test in VSCode, you need to select the test name and then click on the `Debug E2E Tests` launch configuration.
 
 If you want to run the test outside of VSCode, you can run the following command (make sure you have all the environment variables set mentioned in the launch configuration `launch.json`):

config/rbac/role.yaml

@@ -35,7 +35,7 @@ rules:
 - apiGroups:
   - networking.stakater.com
   resources:
-  - routes
+  - uptimeprobes
   verbs:
   - create
   - delete
@@ -47,26 +47,26 @@ rules:
 - apiGroups:
   - networking.stakater.com
   resources:
-  - uptimeprobes
+  - uptimeprobes/finalizers
   verbs:
-  - create
-  - delete
-  - get
-  - list
-  - patch
   - update
-  - watch
 - apiGroups:
   - networking.stakater.com
   resources:
-  - uptimeprobes/finalizers
+  - uptimeprobes/status
   verbs:
+  - get
+  - patch
   - update
 - apiGroups:
-  - networking.stakater.com
+  - route.openshift.io
   resources:
-  - uptimeprobes/status
+  - routes
   verbs:
+  - create
+  - delete
   - get
+  - list
   - patch
   - update
+  - watch

internal/controller/spoke_cluster_manager_controller.go

@@ -14,6 +14,7 @@ import (
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/manager"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 )
 
@@ -37,7 +38,7 @@ type SpokeClusterManagerReconciler struct {
 //+kubebuilder:rbac:groups=networking.stakater.com,resources=uptimeprobes/finalizers,verbs=update
 //+kubebuilder:rbac:groups=hypershift.openshift.io,resources=hostedclusters,verbs=get;list;watch
 //+kubebuilder:rbac:groups=core,resources=secrets,verbs=get;list;watch
-//+kubebuilder:rbac:groups=networking.stakater.com,resources=routes,verbs=get;list;watch;create;update;patch;delete
+// +kubebuilder:rbac:groups=route.openshift.io,resources=routes,verbs=get;list;watch;create;update;patch;delete
 
 func (r *SpokeClusterManagerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	r.log = log.FromContext(ctx)
@@ -67,21 +68,21 @@ func (r *SpokeClusterManagerReconciler) Reconcile(ctx context.Context, req ctrl.
 	return ctrl.Result{}, nil
 }
 
-func (r *SpokeClusterManagerReconciler) setupRemoteClientForHostCluster() error {
+func (r *SpokeClusterManagerReconciler) setupRemoteClientForHostCluster() (chan struct{}, error) {
 	if r.RemoteClients == nil {
 		r.RemoteClients = make(map[string]SpokeManager)
 	}
 
 	if _, ok := r.RemoteClients[clientKey]; ok {
-		return nil
+		return nil, nil
 	}
 
 	r.RemoteClients[clientKey] = SpokeManager{
 		Interface:        dynamic.NewForConfigOrDie(r.manager.GetConfig()),
 		stopInformerChan: make(chan struct{}),
 	}
 
-	return (&SpokeRouteReconciler{
+	return r.RemoteClients[clientKey].stopInformerChan, (&SpokeRouteReconciler{
 		Client:       r.Client,
 		RemoteClient: r.RemoteClients[clientKey].Interface,
 		Scheme:       r.Scheme,
@@ -165,11 +166,22 @@ func (r *SpokeClusterManagerReconciler) SetupWithManager(mgr ctrl.Manager) error
 
 	r.manager = mgr
 
-	err := r.setupRemoteClientForHostCluster()
+	// setup remote client for host cluster with stop channel
+	stopChan, err := r.setupRemoteClientForHostCluster()
 	if err != nil {
 		return err
 	}
 
+	// Add cleanup to manager
+	if err := mgr.Add(manager.RunnableFunc(func(ctx context.Context) error {
+		<-ctx.Done()
+		delete(r.RemoteClients, clientKey)
+		close(stopChan)
+		return nil
+	})); err != nil {
+		return err
+	}
+
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&v1beta1.HostedCluster{}).
 		Complete(r)

internal/controller/spoke_cluster_manager_controller_test.go

@@ -240,11 +240,11 @@ var _ = Describe("SpokeClusterManagerController", func() {
 			reconciler.RemoteClients[clientKey] = mockSpokeManager
 
 			// Try to setup host client again
-			err := reconciler.setupRemoteClientForHostCluster()
+			_, err := reconciler.setupRemoteClientForHostCluster()
 			Expect(err).NotTo(HaveOccurred())
 
 			// Verify the original client was not replaced
-			hostClient := reconciler.RemoteClients["host"]
+			hostClient := reconciler.RemoteClients[clientKey]
 			Expect(hostClient).To(Equal(mockSpokeManager))
 		})
 	})

test/e2e/e2e_test.go

@@ -519,4 +519,110 @@ var _ = Describe("UptimeGuardian E2E", Ordered, func() {
 			}, timeout, interval).Should(Succeed())
 		})
 	})
+
+	Context("When testing host cluster route monitoring", func() {
+		var (
+			uptimeProbe      *v1alpha1.UptimeProbe
+			skipCleanup      bool
+			hubDynamicClient dynamic.Interface
+		)
+
+		BeforeEach(func() {
+			skipCleanup = false
+
+			// Create dynamic client for host cluster
+			config, err := utils.GetKubeConfigFromEnv()
+			Expect(err).NotTo(HaveOccurred(), "Should get kubeconfig")
+
+			hubDynamicClient, err = dynamic.NewForConfig(config)
+			Expect(err).NotTo(HaveOccurred(), "Should create dynamic client")
+
+			// Create UptimeProbe for host cluster
+			uptimeProbe = &v1alpha1.UptimeProbe{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "e2e-test-host-uptime-probe",
+					Namespace: hubNamespace,
+				},
+				Spec: v1alpha1.UptimeProbeSpec{
+					LabelSelector: metav1.LabelSelector{
+						MatchLabels: map[string]string{"monitor": "host"},
+					},
+					ProbeConfig: v1alpha1.ProbeConfig{
+						JobName:         "host-" + probeJobName,
+						Interval:        monitoringv1.Duration(probeInterval),
+						Module:          probeModule,
+						ScrapeTimeout:   monitoringv1.Duration(probeScrapeTimeout),
+						ProberUrl:       proberUrl,
+						ProberScheme:    proberScheme,
+						ProberPath:      proberPath,
+						TargetNamespace: hubNamespace,
+					},
+				},
+			}
+		})
+
+		AfterEach(func() {
+			if skipCleanup {
+				return
+			}
+			// Cleanup
+			Expect(k8sClient.Delete(ctx, uptimeProbe)).Should(Succeed())
+
+			// Delete test routes
+			_ = hubDynamicClient.Resource(getRouteGVR()).Namespace(hubNamespace).Delete(ctx, "host-route", metav1.DeleteOptions{})
+		})
+
+		It("should monitor host cluster routes", func() {
+			By("Creating route in host cluster")
+			hostLabels := map[string]string{"monitor": "host"}
+			err := createTestRoutes(ctx, hubDynamicClient, hubNamespace, "host-route", hostLabels)
+			Expect(err).NotTo(HaveOccurred())
+
+			By("Creating UptimeProbe for host routes")
+			Expect(k8sClient.Create(ctx, uptimeProbe)).Should(Succeed())
+
+			By("Verifying Probe CR is created with correct name format")
+			Eventually(func() error {
+				probe := &monitoringv1.Probe{}
+				return k8sClient.Get(ctx, types.NamespacedName{
+					Name:      fmt.Sprintf("%s-%s-%s", "host", hubNamespace, "host-route"),
+					Namespace: hubNamespace,
+				}, probe)
+			}, timeout, interval).Should(Succeed())
+
+			By("Verifying Probe CR has correct configuration")
+			probe := &monitoringv1.Probe{}
+			err = k8sClient.Get(ctx, types.NamespacedName{
+				Name:      fmt.Sprintf("%s-%s-%s", "host", hubNamespace, "host-route"),
+				Namespace: hubNamespace,
+			}, probe)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(probe.Spec.JobName).To(Equal("host-" + probeJobName))
+			Expect(string(probe.Spec.Interval)).To(Equal(probeInterval))
+			Expect(probe.Spec.Module).To(Equal(probeModule))
+		})
+
+		It("should handle route deletion in host cluster", func() {
+			By("Creating route in host cluster")
+			hostLabels := map[string]string{"monitor": "host"}
+			err := createTestRoutes(ctx, hubDynamicClient, hubNamespace, "host-route", hostLabels)
+			Expect(err).NotTo(HaveOccurred())
+
+			By("Creating UptimeProbe for host routes")
+			Expect(k8sClient.Create(ctx, uptimeProbe)).Should(Succeed())
+
+			By("Deleting the route")
+			err = hubDynamicClient.Resource(getRouteGVR()).Namespace(hubNamespace).Delete(ctx, "host-route", metav1.DeleteOptions{})
+			Expect(err).NotTo(HaveOccurred())
+
+			By("Verifying Probe CR is removed")
+			Eventually(func() error {
+				probe := &monitoringv1.Probe{}
+				return k8sClient.Get(ctx, types.NamespacedName{
+					Name:      fmt.Sprintf("%s-%s-%s", "host", hubNamespace, "host-route"),
+					Namespace: hubNamespace,
+				}, probe)
+			}, timeout, interval).Should(HaveOccurred())
+		})
+	})
 })