Add initial operator unit tests (#172)

Author: JohnGarbutt

capi_janitor/openstack/operator.py

@@ -349,13 +349,21 @@ async def wrapper(**kwargs):
 @retry_event
 async def on_openstackcluster_event(
     name, namespace, meta, labels, spec, logger, **kwargs
+):
+    _on_openstackcluster_event_impl(
+        name, namespace, meta, labels, spec, logger, **kwargs
+    )
+
+
+async def _on_openstackcluster_event_impl(
+    name, namespace, meta, labels, spec, logger, **kwargs
 ):
     """
     Executes whenever an event occurs for an OpenStack cluster.
     """
     # Get the resource for manipulating OpenStackClusters at the preferred version
-    capoapi = await ekclient.api_preferred_version(CAPO_API_GROUP)
-    openstackclusters = await capoapi.resource("openstackclusters")
+    openstackclusters = await _get_os_cluster_client()
+
     # Use the value of the `cluster.x-k8s.io/cluster-name` label as the cluster name if it exists,
     # otherwise, fall back to the OpenStackCluster resource name.
     clustername = labels.get("cluster.x-k8s.io/cluster-name", name)
@@ -376,6 +384,7 @@ async def on_openstackcluster_event(
 
     # If our finalizer is not present, we don't do anything
     if FINALIZER not in finalizers:
+        logger.info("janitor finalizer not present, skipping cleanup")
         return
 
     # Get the cloud credential from the cluster and use it to delete dangling
@@ -440,3 +449,9 @@ async def on_openstackcluster_event(
         openstackclusters, name, namespace, [f for f in finalizers if f != FINALIZER]
     )
     logger.info("removed janitor finalizer from cluster")
+
+
+async def _get_os_cluster_client():
+    capoapi = await ekclient.api_preferred_version(CAPO_API_GROUP)
+    openstackclusters = await capoapi.resource("openstackclusters")
+    return openstackclusters

capi_janitor/tests/openstack/test_operator.py

@@ -14,4 +14,56 @@ async def test_operator(self):
 
         await operator.on_cleanup()
 
-        mock_easykube.aclose.assert_awaited_once()
+        mock_easykube.aclose.assert_awaited_once_with()
+
+    @mock.patch.object(operator, "patch_finalizers")
+    @mock.patch.object(operator, "_get_os_cluster_client")
+    async def test_on_openstackcluster_event_adds_finalizers(
+        self, mock_get_client, mock_patch_finalizers
+    ):
+        logger = mock.Mock()
+        mock_get_client.return_value = "mock_client"
+
+        await operator._on_openstackcluster_event_impl(
+            name="mycluster",
+            namespace="default",
+            meta={},
+            labels={},
+            spec={},
+            logger=logger,
+            body={},
+        )
+
+        mock_patch_finalizers.assert_awaited_once_with(
+            "mock_client", "mycluster", "default", ["janitor.capi.stackhpc.com"]
+        )
+        logger.debug.assert_has_calls(
+            [mock.call("cluster name that will be used for cleanup: 'mycluster'")]
+        )
+        logger.info.assert_has_calls([mock.call("added janitor finalizer to cluster")])
+
+    @mock.patch.object(operator, "patch_finalizers")
+    @mock.patch.object(operator, "_get_os_cluster_client")
+    async def test_on_openstackcluster_event_skip_no_finalizers(
+        self, mock_get_client, mock_patch_finalizers
+    ):
+        logger = mock.Mock()
+        mock_get_client.return_value = "mock_client"
+
+        await operator._on_openstackcluster_event_impl(
+            name="mycluster",
+            namespace="default",
+            meta={"deletionTimestamp": "2023-10-01T00:00:00Z"},
+            labels={},
+            spec={},
+            logger=logger,
+            body={},
+        )
+
+        mock_patch_finalizers.assert_not_awaited()
+        logger.debug.assert_has_calls(
+            [mock.call("cluster name that will be used for cleanup: 'mycluster'")]
+        )
+        logger.info.assert_has_calls(
+            [mock.call("janitor finalizer not present, skipping cleanup")]
+        )