From 2953db263f8ac843f64281d01f413d7a71285220 Mon Sep 17 00:00:00 2001 From: bencekov Date: Thu, 17 Aug 2023 14:30:30 -0600 Subject: [PATCH] feat: updated hydra_endpoints relation name to hydra-endpoint-info --- lib/charms/hydra/v0/hydra_endpoints.py | 16 ++++++++-------- metadata.yaml | 2 +- tests/unit/test_charm.py | 6 +++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/lib/charms/hydra/v0/hydra_endpoints.py b/lib/charms/hydra/v0/hydra_endpoints.py index 53367b5e..de8e5a69 100644 --- a/lib/charms/hydra/v0/hydra_endpoints.py +++ b/lib/charms/hydra/v0/hydra_endpoints.py @@ -15,7 +15,7 @@ In the `metadata.yaml` of the charm, add the following: ```yaml requires: - endpoint-info: + hydra-endpoint-info: interface: hydra_endpoints limit: 1 ``` @@ -52,9 +52,9 @@ def some_event_function(): # Increment this PATCH version before using `charmcraft publish-lib` or reset # to 0 if you are raising the major API version -LIBPATCH = 4 +LIBPATCH = 5 -RELATION_NAME = "endpoint-info" +RELATION_NAME = "hydra-endpoint-info" INTERFACE_NAME = "hydra_endpoints" logger = logging.getLogger(__name__) @@ -70,7 +70,7 @@ class HydraEndpointsProviderEvents(ObjectEvents): class HydraEndpointsProvider(Object): - """Provider side of the endpoint-info relation.""" + """Provider side of the hydra-endpoint-info relation.""" on = HydraEndpointsProviderEvents() @@ -93,7 +93,7 @@ def send_endpoint_relation_data(self, admin_endpoint: str, public_endpoint: str) if not self._charm.unit.is_leader(): return - relations = self.model.relations[RELATION_NAME] + relations = self.model.relations[self._relation_name] for relation in relations: relation.data[self._charm.app].update( { @@ -113,7 +113,7 @@ class HydraEndpointsRelationMissingError(HydraEndpointsRelationError): """Raised when the relation is missing.""" def __init__(self) -> None: - self.message = "Missing endpoint-info relation with hydra" + self.message = "Missing hydra-endpoint-info relation with hydra" super().__init__(self.message) @@ -126,7 +126,7 @@ def __init__(self, message: str) -> None: class HydraEndpointsRequirer(Object): - """Requirer side of the endpoint-info relation.""" + """Requirer side of the hydra-endpoint-info relation.""" def __init__(self, charm: CharmBase, relation_name: str = RELATION_NAME) -> None: super().__init__(charm, relation_name) @@ -143,7 +143,7 @@ def get_hydra_endpoints(self) -> Dict: if "admin_endpoint" not in data: raise HydraEndpointsRelationDataMissingError( - "Missing admin endpoint in endpoint-info relation data" + "Missing admin endpoint in hydra-endpoint-info relation data" ) return { diff --git a/metadata.yaml b/metadata.yaml index f821ecd2..c84a78e9 100644 --- a/metadata.yaml +++ b/metadata.yaml @@ -36,7 +36,7 @@ requires: description: | Provides traces to COS Tempo instance provides: - endpoint-info: + hydra-endpoint-info: interface: hydra_endpoints description: | Provides API endpoints to a related application diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py index 6b3b1064..243b690e 100644 --- a/tests/unit/test_charm.py +++ b/tests/unit/test_charm.py @@ -486,15 +486,15 @@ def test_hydra_endpoint_info_relation_data_without_ingress_relation_data(harness admin_ingress_relation_id = harness.add_relation("admin-ingress", "admin-traefik") harness.add_relation_unit(admin_ingress_relation_id, "admin-traefik/0") - endpoint_info_relation_id = harness.add_relation("endpoint-info", "kratos") - harness.add_relation_unit(endpoint_info_relation_id, "kratos/0") + hydra_endpoint_info_relation_id = harness.add_relation("hydra-endpoint-info", "kratos") + harness.add_relation_unit(hydra_endpoint_info_relation_id, "kratos/0") expected_data = { "admin_endpoint": "http://hydra.testing.svc.cluster.local:4445", "public_endpoint": "http://hydra.testing.svc.cluster.local:4444", } - assert harness.get_relation_data(endpoint_info_relation_id, "hydra") == expected_data + assert harness.get_relation_data(hydra_endpoint_info_relation_id, "hydra") == expected_data def test_provider_info_in_databag_when_ingress_then_oauth_relation(