Merge ~mthaddon/charm-k8s-ingress/+git/charm-k8s-ingress:relation-interfaces into charm-k8s-ingress:master

[Tom Haddon]

Conform to charm-relation-interfaces for ingress

Conform to charm-relation-interfaces for ingress

867586d... by Tom Haddon on 2022-06-28

Correct field name and variable names

Unmerged commits

867586d... by Tom Haddon on 2022-06-28

Correct field name and variable names

71ec359... by Tom Haddon on 2022-06-23

Reply to relation with URL of app

ea1b325... by Tom Haddon on 2022-06-23

Set relation data to conform to charm-relation-interfaces

diff --git a/lib/charms/nginx_ingress_integrator/v0/ingress.py b/lib/charms/nginx_ingress_integrator/v0/ingress.py
index fea2e50..20bc238 100644
--- a/lib/charms/nginx_ingress_integrator/v0/ingress.py
+++ b/lib/charms/nginx_ingress_integrator/v0/ingress.py
@@ -66,7 +66,7 @@ LIBAPI = 0
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 10
+LIBPATCH = 11
 
 logger = logging.getLogger(__name__)
 
@@ -91,6 +91,13 @@ OPTIONAL_INGRESS_RELATION_FIELDS = {
     "tls-secret-name",
 }
 
+RELATION_INTERFACES_MAPPINGS = {
+    "service-hostname": "host",
+    "service-name": "name",
+    "service-port": "port",
+    "service-namespace": "model",
+}
+
 
 class IngressAvailableEvent(EventBase):
     pass
@@ -119,6 +126,19 @@ class IngressRequires(Object):
 
         self.framework.observe(charm.on["ingress"].relation_changed, self._on_relation_changed)
 
+        # Set default values.
+        DEFAULT_RELATION_FIELDS = {
+            "service-namespace": self.model.name,
+        }
+        for k, v in DEFAULT_RELATION_FIELDS.items():
+            if k not in config_dict or not config_dict[k]:
+                config_dict[k] = v
+
+        # And now populate data for conformity with charm-relation-interfaces.
+        for k, v in RELATION_INTERFACES_MAPPINGS.items():
+            if k in config_dict and config_dict[k]:
+                config_dict[v] = config_dict[k]
+
         self.config_dict = config_dict
 
     def _config_dict_errors(self, update_only=False):
@@ -127,7 +147,10 @@ class IngressRequires(Object):
         unknown = [
             x
             for x in self.config_dict
-            if x not in REQUIRED_INGRESS_RELATION_FIELDS | OPTIONAL_INGRESS_RELATION_FIELDS
+            if x
+            not in REQUIRED_INGRESS_RELATION_FIELDS
+            | OPTIONAL_INGRESS_RELATION_FIELDS
+            | {v for v in RELATION_INTERFACES_MAPPINGS.values()}
         ]
         if unknown:
             logger.error(
@@ -214,6 +237,15 @@ class IngressProvides(Object):
                 "Missing fields for ingress: {}".format(", ".join(missing_fields))
             )
 
+        # Conform to charm-relation-interfaces.
+        if "name" in ingress_data and "port" in ingress_data:
+            name = ingress_data["name"]
+            port = ingress_data["port"]
+        else:
+            name = ingress_data["service-name"]
+            port = ingress_data["service-port"]
+        event.relation.data[self.model.app]["url"] = "http://{}:{}/".format(name, port)
+
         # Create an event that our charm can use to decide it's okay to
         # configure the ingress.
         self.charm.on.ingress_available.emit()
diff --git a/src/charm.py b/src/charm.py
index d580aff..e27acd4 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -10,6 +10,7 @@ import kubernetes.client
 from charms.nginx_ingress_integrator.v0.ingress import (
     IngressCharmEvents,
     IngressProvides,
+    RELATION_INTERFACES_MAPPINGS,
     REQUIRED_INGRESS_RELATION_FIELDS,
 )
 from ops.charm import CharmBase
@@ -75,7 +76,15 @@ class _ConfigOrRelation(object):
         """Helper method to get data from the relation, if any."""
         if self.relation:
             try:
-                return self.relation.data[self.relation.app][field]
+                # We want to prioritise relation-interfaces data if we have it.
+                if field in RELATION_INTERFACES_MAPPINGS.values():
+                    new_field = RELATION_INTERFACES_MAPPINGS[field]
+                    try:
+                        return self.relation.data[self.relation.app][new_field]
+                    except KeyError:
+                        return self.relation.data[self.relation.app][field]
+                else:
+                    return self.relation.data[self.relation.app][field]
             except KeyError:
                 # Our relation isn't passing the information we're querying.
                 return None