From 7e2e7a440c308f682937eae92591de8dceb3d958 Mon Sep 17 00:00:00 2001
From: jamesbeedy <jamesbeedy@gmail.com>
Date: Sat, 23 Nov 2024 22:18:45 +0000
Subject: [PATCH] chore(slurmctld, slurm): clean up relation data

These changes remove the unused "cluster_name" from the relation
data sent to slurmd on the slurmd relation. Additionally, make the
"cluster_name" property private.
---
 charms/slurmctld/charmcraft.yaml          | 2 +-
 charms/slurmctld/src/charm.py             | 4 ++--
 charms/slurmctld/src/interface_slurmd.py  | 1 -
 charms/slurmctld/tests/unit/test_charm.py | 6 +++---
 charms/slurmd/src/interface_slurmctld.py  | 4 ----
 5 files changed, 6 insertions(+), 11 deletions(-)

diff --git a/charms/slurmctld/charmcraft.yaml b/charms/slurmctld/charmcraft.yaml
index c5470e7..3f58b65 100644
--- a/charms/slurmctld/charmcraft.yaml
+++ b/charms/slurmctld/charmcraft.yaml
@@ -67,7 +67,7 @@ config:
   options:
     cluster-name:
       type: string
-      default: osd-cluster
+      default: "osd-cluster"
       description: |
         Name to be recorded in database for jobs from this cluster.
 
diff --git a/charms/slurmctld/src/charm.py b/charms/slurmctld/src/charm.py
index 99ec654..80ffea3 100755
--- a/charms/slurmctld/src/charm.py
+++ b/charms/slurmctld/src/charm.py
@@ -302,7 +302,7 @@ def _assemble_slurmctld_parameters() -> dict[str, Any]:
             }
 
         slurm_conf = SlurmConfig(
-            ClusterName=self.cluster_name,
+            ClusterName=self._cluster_name,
             SlurmctldAddr=self._slurmd_ingress_address,
             SlurmctldHost=[self._slurmctld.hostname],
             SlurmctldParameters=_assemble_slurmctld_parameters(),
@@ -377,7 +377,7 @@ def _resume_nodes(self, nodelist: List[str]) -> None:
         self._slurmctld.scontrol(update_cmd)
 
     @property
-    def cluster_name(self) -> str:
+    def _cluster_name(self) -> str:
         """Return the cluster name."""
         cluster_name = "charmedhpc"
         if cluster_name_from_config := self.config.get("cluster-name"):
diff --git a/charms/slurmctld/src/interface_slurmd.py b/charms/slurmctld/src/interface_slurmd.py
index dba0c13..84dcaae 100644
--- a/charms/slurmctld/src/interface_slurmd.py
+++ b/charms/slurmctld/src/interface_slurmd.py
@@ -89,7 +89,6 @@ def _on_relation_created(self, event: RelationCreatedEvent) -> None:
             {
                 "munge_key": self._charm.get_munge_key(),
                 "slurmctld_host": self._charm.hostname,
-                "cluster_name": self._charm.cluster_name,
                 "nhc_params": health_check_params,
             }
         )
diff --git a/charms/slurmctld/tests/unit/test_charm.py b/charms/slurmctld/tests/unit/test_charm.py
index 353b3ff..3f886ef 100644
--- a/charms/slurmctld/tests/unit/test_charm.py
+++ b/charms/slurmctld/tests/unit/test_charm.py
@@ -34,12 +34,12 @@ def setUp(self):
         self.harness.begin()
 
     def test_cluster_name(self) -> None:
-        """Test that the cluster_name property works."""
-        self.assertEqual(self.harness.charm.cluster_name, "osd-cluster")
+        """Test that the _cluster_name property works."""
+        self.assertEqual(self.harness.charm._cluster_name, "osd-cluster")
 
     def test_cluster_info(self) -> None:
         """Test the cluster_info property works."""
-        self.assertEqual(type(self.harness.charm.cluster_name), str)
+        self.assertEqual(type(self.harness.charm._cluster_name), str)
 
     def test_is_slurm_installed(self) -> None:
         """Test that the is_slurm_installed method works."""
diff --git a/charms/slurmd/src/interface_slurmctld.py b/charms/slurmd/src/interface_slurmctld.py
index 50b0e9e..1aac04f 100644
--- a/charms/slurmd/src/interface_slurmctld.py
+++ b/charms/slurmd/src/interface_slurmctld.py
@@ -24,14 +24,12 @@ class SlurmctldAvailableEvent(EventBase):
     def __init__(
         self,
         handle,
-        cluster_name,
         munge_key,
         nhc_params,
         slurmctld_host,
     ):
         super().__init__(handle)
 
-        self.cluster_name = cluster_name
         self.munge_key = munge_key
         self.nhc_params = nhc_params
         self.slurmctld_host = slurmctld_host
@@ -39,7 +37,6 @@ def __init__(
     def snapshot(self):
         """Snapshot the event data."""
         return {
-            "cluster_name": self.cluster_name,
             "munge_key": self.munge_key,
             "nhc_params": self.nhc_params,
             "slurmctld_host": self.slurmctld_host,
@@ -47,7 +44,6 @@ def snapshot(self):
 
     def restore(self, snapshot):
         """Restore the snapshot of the event data."""
-        self.cluster_name = snapshot.get("cluster_name")
         self.munge_key = snapshot.get("munge_key")
         self.nhc_params = snapshot.get("nhc_params")
         self.slurmctld_host = snapshot.get("slurmctld_host")