Improve exceptions handling and add can_connect guards (#433)

* improve exceptions handling and add can_connect guards * always remove certs to avoid they stay on disk forever * revert changes in charm.py. See #434 * add comment * move can_connect() guard to `_update_logging` * Update lib/charms/loki_k8s/v1/loki_push_api.py Co-authored-by: Leon <[email protected]> * Use binary pip packages for loki-tester charm * Update charmcraft.yaml * Update charmcraft.yaml * Update charmcraft.yaml --------- Co-authored-by: Leon <[email protected]>
canonical · Jul 26, 2024 · 4fdbf25 · 4fdbf25
1 parent 5dd8dc8
commit 4fdbf25
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 4 deletions.
diff --git a/lib/charms/loki_k8s/v1/loki_push_api.py b/lib/charms/loki_k8s/v1/loki_push_api.py
@@ -527,7 +527,7 @@ def _alert_rules_error(self, event):
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 11
+LIBPATCH = 12
 
 PYDEPS = ["cosl"]
 
@@ -2562,7 +2562,9 @@ def _update_logging(self, _):
             return
 
         for container in self._charm.unit.containers.values():
-            self._update_endpoints(container, loki_endpoints)
+            if container.can_connect():
+                self._update_endpoints(container, loki_endpoints)
+            # else: `_update_endpoints` will be called on pebble-ready anyway.
 
     def _retrieve_endpoints_from_relation(self) -> dict:
         loki_endpoints = {}

diff --git a/src/charm.py b/src/charm.py
@@ -566,6 +566,9 @@ def _update_config(self, config: dict) -> bool:
         return False
 
     def _update_cert(self):
+        # If Pebble is not ready, we do not proceed.
+        # This code will end up running anyway when Pebble is ready, because
+        # it will eventually be called from the `_configure()` method.
         if not self._loki_container.can_connect():
             return
 

diff --git a/tests/integration/log-forwarder-tester/charmcraft.yaml b/tests/integration/log-forwarder-tester/charmcraft.yaml
@@ -13,3 +13,13 @@ parts:
   charm:
     build-packages:
       - git
+
+    charm-binary-python-packages:
+      # For v2.tls_certificates
+      - cryptography
+      - jsonschema
+
+      # For v1.alertmanager_dispatch & v1.tracing
+      - pydantic>=2
+
+      - cosl
diff --git a/tests/integration/log-proxy-tester/charmcraft.yaml b/tests/integration/log-proxy-tester/charmcraft.yaml
@@ -13,3 +13,13 @@ parts:
   charm:
     build-packages:
       - git
+
+    charm-binary-python-packages:
+      # For v2.tls_certificates
+      - cryptography
+      - jsonschema
+
+      # For v1.alertmanager_dispatch & v1.tracing
+      - pydantic>=2
+
+      - cosl
diff --git a/tests/integration/loki-tester/charmcraft.yaml b/tests/integration/loki-tester/charmcraft.yaml
@@ -8,3 +8,14 @@ bases:
     run-on:
     - name: "ubuntu"
       channel: "20.04"
+parts:
+  charm:
+    charm-binary-python-packages:
+      # For v2.tls_certificates
+      - cryptography
+      - jsonschema
+
+      # For v1.alertmanager_dispatch & v1.tracing
+      - pydantic>=2
+
+      - cosl
diff --git a/tests/unit/helpers.py b/tests/unit/helpers.py
@@ -23,3 +23,6 @@ def __init__(self, args):
 
     def wait_output(self):
         return ("v0.1.0", "")
+
+    def wait(self):
+        return ("v0.1.0", "")
diff --git a/tox.ini b/tox.ini
@@ -33,7 +33,7 @@ deps =
     black
     ruff
 commands =
-    ruff --fix {[vars]all_path}
+    ruff check --fix {[vars]all_path}
     black {[vars]all_path}
 
 # codespell pinned cause version 2.3.0 mistakenly considers joined words such as "assertIn" invalid
@@ -46,7 +46,7 @@ deps =
 commands =
     codespell {[vars]lib_path}
     codespell . --skip .git --skip .tox --skip build --skip lib --skip venv --skip .mypy_cache
-    ruff {[vars]all_path}
+    ruff check {[vars]all_path}
     black --check --diff {[vars]all_path}
 
 [testenv:static-{charm,lib}]