chore: Change the interface name from fiveg-nrf to fiveg_nrf (#74)

Signed-off-by: gatici <[email protected]>
canonical · Feb 14, 2024 · f885155 · f885155
1 parent b5c00fb
commit f885155
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 19 deletions.
diff --git a/lib/charms/sdcore_nrf_k8s/v0/fiveg_nrf.py b/lib/charms/sdcore_nrf_k8s/v0/fiveg_nrf.py
@@ -37,7 +37,7 @@ class DummyFiveGNRFRequirerCharm(CharmBase):
 
     def __init__(self, *args):
         super().__init__(*args)
-        self.nrf_requirer = NRFRequires(self, "fiveg-nrf")
+        self.nrf_requirer = NRFRequires(self, "fiveg_nrf")
         self.framework.observe(self.nrf_requirer.on.nrf_available, self._on_nrf_available)
 
     def _on_nrf_available(self, event: NRFAvailableEvent):
@@ -67,7 +67,7 @@ class DummyFiveGNRFProviderCharm(CharmBase):
 
     def __init__(self, *args):
         super().__init__(*args)
-        self.nrf_provider = NRFProvides(self, "fiveg-nrf")
+        self.nrf_provider = NRFProvides(self, "fiveg_nrf")
         self.framework.observe(
             self.on.fiveg_nrf_relation_joined, self._on_fiveg_nrf_relation_joined
         )
@@ -110,7 +110,7 @@ def _on_nrf_url_changed(
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 1
+LIBPATCH = 2
 
 PYDEPS = ["pydantic", "pytest-interface-tester"]
 

diff --git a/metadata.yaml b/metadata.yaml
@@ -36,7 +36,7 @@ requires:
     interface: tls-certificates
 
 provides:
-  fiveg-nrf:
+  fiveg_nrf:
     interface: fiveg_nrf
 
 assumes:

diff --git a/src/charm.py b/src/charm.py
@@ -31,7 +31,7 @@
 DATABASE_NAME = "free5gc"
 NRF_SBI_PORT = 29510
 DATABASE_RELATION_NAME = "database"
-NRF_RELATION_NAME = "fiveg-nrf"
+NRF_RELATION_NAME = "fiveg_nrf"
 CERTS_DIR_PATH = "/support/TLS"  # Certificate paths are hardcoded in NRF code
 PRIVATE_KEY_NAME = "nrf.key"
 CSR_NAME = "nrf.csr"
@@ -354,7 +354,7 @@ def _config_file_content_matches(self, content: str) -> bool:
         return True
 
     def _on_fiveg_nrf_relation_joined(self, event: RelationJoinedEvent) -> None:
-        """Handle fiveg-nrf relation joined event.
+        """Handle fiveg_nrf relation joined event.
 
         Args:
             event: RelationJoinedEvent

diff --git a/terraform/outputs.tf b/terraform/outputs.tf
@@ -18,5 +18,5 @@ output "certificates_endpoint" {
 
 output "fiveg_nrf_endpoint" {
   description = "Name of the endpoint to provide fiveg_nrf interface."
-  value       = "fiveg-nrf"
+  value       = "fiveg_nrf"
 }
diff --git a/tests/unit/charms/sdcore_nrf/v0/dummy_provider_charm/metadata.yaml b/tests/unit/charms/sdcore_nrf/v0/dummy_provider_charm/metadata.yaml
@@ -9,5 +9,5 @@ summary: |
   Dummy SD-Core NRF provider charm.
 
 provides:
-  fiveg-nrf:
-    interface: fiveg-nrf
+  fiveg_nrf:
+    interface: fiveg_nrf
diff --git a/tests/unit/charms/sdcore_nrf/v0/dummy_provider_charm/src/dummy_provider_charm.py b/tests/unit/charms/sdcore_nrf/v0/dummy_provider_charm/src/dummy_provider_charm.py
@@ -19,7 +19,7 @@ class DummyFiveGNRFProviderCharm(CharmBase):
     def __init__(self, *args):
         """Init."""
         super().__init__(*args)
-        self.nrf_provider = NRFProvides(self, "fiveg-nrf")
+        self.nrf_provider = NRFProvides(self, "fiveg_nrf")
         self.framework.observe(
             self.on.fiveg_nrf_relation_joined, self._on_fiveg_nrf_relation_joined
         )

diff --git a/tests/unit/charms/sdcore_nrf/v0/dummy_requirer_charm/metadata.yaml b/tests/unit/charms/sdcore_nrf/v0/dummy_requirer_charm/metadata.yaml
@@ -9,5 +9,5 @@ summary: |
   Dummy SD-Core NRF requirer charm.
 
 requires:
-  fiveg-nrf:
-    interface: fiveg-nrf
+  fiveg_nrf:
+    interface: fiveg_nrf
diff --git a/tests/unit/charms/sdcore_nrf/v0/dummy_requirer_charm/src/dummy_requirer_charm.py b/tests/unit/charms/sdcore_nrf/v0/dummy_requirer_charm/src/dummy_requirer_charm.py
@@ -21,7 +21,7 @@ class DummyFiveGNRFRequirerCharm(CharmBase):
     def __init__(self, *args):
         """Init."""
         super().__init__(*args)
-        self.nrf_requirer = NRFRequires(self, "fiveg-nrf")
+        self.nrf_requirer = NRFRequires(self, "fiveg_nrf")
         self.framework.observe(self.nrf_requirer.on.nrf_available, self._on_nrf_available)
         self.framework.observe(self.nrf_requirer.on.nrf_broken, self._on_nrf_broken)
 

diff --git a/tests/unit/charms/sdcore_nrf/v0/test_fiveg_nrf_provider_interface.py b/tests/unit/charms/sdcore_nrf/v0/test_fiveg_nrf_provider_interface.py
@@ -16,7 +16,7 @@
 
 class TestFiveGNRFProvider(unittest.TestCase):
     def setUp(self):
-        self.relation_name = "fiveg-nrf"
+        self.relation_name = "fiveg_nrf"
         self.remote_app_name = "dummy-nrf-requirer"
         self.remote_unit_name = f"{self.remote_app_name}/0"
         self.harness = testing.Harness(DummyFiveGNRFProviderCharm)
@@ -78,7 +78,7 @@ def test_given_unit_is_leader_and_fiveg_nrf_relation_is_not_created_when_set_nrf
             self.harness.charm.nrf_provider.set_nrf_information(
                 url="https://nrf.example.com", relation_id=relation_id_for_unexsistant_relation
             )
-        self.assertEqual(str(e.value), "Relation fiveg-nrf not created yet.")
+        self.assertEqual(str(e.value), "Relation fiveg_nrf not created yet.")
 
     def test_given_unit_is_leader_when_multiple_fiveg_nrf_relation_joined_then_data_in_application_databag(  # noqa: E501
         self,

diff --git a/tests/unit/charms/sdcore_nrf/v0/test_fiveg_nrf_requirer_interface.py b/tests/unit/charms/sdcore_nrf/v0/test_fiveg_nrf_requirer_interface.py
@@ -15,7 +15,7 @@
 
 class TestFiveGNRFRequirer(unittest.TestCase):
     def setUp(self):
-        self.relation_name = "fiveg-nrf"
+        self.relation_name = "fiveg_nrf"
         self.remote_app_name = "dummy-nrf-provider"
         self.remote_unit_name = f"{self.remote_app_name}/0"
         self.harness = testing.Harness(DummyFiveGNRFRequirerCharm)

diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
@@ -338,7 +338,7 @@ def test_given_https_nrf_url_and_service_is_running_when_fiveg_nrf_relation_join
         self.harness.container_pebble_ready("nrf")
 
         relation_id = self.harness.add_relation(
-            relation_name="fiveg-nrf",
+            relation_name="fiveg_nrf",
             remote_app="nrf-requirer",
         )
         self.harness.add_relation_unit(relation_id=relation_id, remote_unit_name="nrf-requirer/0")
@@ -364,12 +364,12 @@ def test_service_starts_running_after_nrf_relation_joined_when_fiveg_pebble_read
         self.harness.set_can_connect(container="nrf", val=False)
 
         relation_1_id = self.harness.add_relation(
-            relation_name="fiveg-nrf",
+            relation_name="fiveg_nrf",
             remote_app="nrf-requirer-1",
         )
 
         relation_2_id = self.harness.add_relation(
-            relation_name="fiveg-nrf",
+            relation_name="fiveg_nrf",
             remote_app="nrf-requirer-2",
         )
         self.harness.add_relation_unit(