Merge ~mthaddon/charm-k8s-ingress/+git/charm-k8s-ingress:unknown-message into charm-k8s-ingress:master

[Tom Haddon]

If we have unknown fields in the relation, return appropriate error

If we have unknown fields in the relation, return appropriate error.

Previous to this change we'd check for unknown fields, but also check for missing required fields. We should only ever return the first error message to avoid confusion.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[🤖 prod-jenkaas-is (prod-jenkaas-is)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-is (prod-jenkaas-is)]

PASSED: Continuous integration, rev:3c6185e53e11c29b3e1d313e0f2d236a4a7c46ec
https://jenkins.canonical.com/is/job/lp-charm-k8s-ingress-ci/41/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/is/job/lp-charm-test/81/
    None: https://jenkins.canonical.com/is/job/lp-update-mp/100115/

Click here to trigger a rebuild:
https://jenkins.canonical.com/is/job/lp-charm-k8s-ingress-ci/41//rebuild

review: Approve (continuous-integration)

[🤖 prod-jenkaas-is (prod-jenkaas-is)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-is (prod-jenkaas-is)]

PASSED: Continuous integration, rev:80c0ad31f0d12fba98a85322d5955752a2bc9fe5
https://jenkins.canonical.com/is/job/lp-charm-k8s-ingress-ci/42/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/is/job/lp-charm-test/82/
    None: https://jenkins.canonical.com/is/job/lp-update-mp/100137/

Click here to trigger a rebuild:
https://jenkins.canonical.com/is/job/lp-charm-k8s-ingress-ci/42//rebuild

review: Approve (continuous-integration)

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 36e7314e2ed5e03f992cfe4a5fa37ae1afb59ca5

diff --git a/lib/charms/nginx_ingress_integrator/v0/ingress.py b/lib/charms/nginx_ingress_integrator/v0/ingress.py
index bbb8a71..a935d5a 100644
--- a/lib/charms/nginx_ingress_integrator/v0/ingress.py
+++ b/lib/charms/nginx_ingress_integrator/v0/ingress.py
@@ -53,9 +53,9 @@ LIBID = "db0af4367506491c91663468fb5caa4c"
 # Increment this major API version when introducing breaking changes
 LIBAPI = 0
 
-# Increment this PATCH version before using `charmcraft push-lib` or reset
+# Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 2
+LIBPATCH = 3
 
 logger = logging.getLogger(__name__)
 
@@ -102,21 +102,21 @@ class IngressRequires(Object):
 
     def _config_dict_errors(self, update_only=False):
         """Check our config dict for errors."""
-        block_status = False
+        blocked_message = "Error in ingress relation, check `juju debug-log`"
         unknown = [
             x for x in self.config_dict if x not in REQUIRED_INGRESS_RELATION_FIELDS | OPTIONAL_INGRESS_RELATION_FIELDS
         ]
         if unknown:
-            logger.error("Unknown key(s) in config dictionary found: %s", ", ".join(unknown))
-            block_status = True
+            logger.error("Ingress relation error, unknown key(s) in config dictionary found: %s", ", ".join(unknown))
+            self.model.unit.status = BlockedStatus(blocked_message)
+            return True
         if not update_only:
             missing = [x for x in REQUIRED_INGRESS_RELATION_FIELDS if x not in self.config_dict]
             if missing:
-                logger.error("Missing required key(s) in config dictionary: %s", ", ".join(missing))
-                block_status = True
-        if block_status:
-            self.model.unit.status = BlockedStatus("Error in ingress relation, check `juju debug-log`")
-            return True
+                logger.error(
+                    "Ingress relation error, missing required key(s) in config dictionary: %s", ", ".join(missing))
+                self.model.unit.status = BlockedStatus(blocked_message)
+                return True
         return False
 
     def _on_relation_changed(self, event):