usable Scenario tests for 1p charm lib

Author: dimaqq

ops/_tracing/api.py

@@ -92,8 +92,6 @@ def __init__(self, framework: ops.Framework):
 
     def _reconcile(self, _event: Any):
         url, ca = self._get_config()
-        print(["FIXME", url, ca])
-
         ops._tracing.set_tracing_destination(url=url, ca=ca)
 
     def _get_config(self) -> tuple[str | None, str | None]:
@@ -115,6 +113,6 @@ def _get_config(self) -> tuple[str | None, str | None]:
         ca_rel_id = ca_rel.id if ca_rel else None
 
         if ca_rel and self._certificate_transfer.is_ready(ca_rel):
-            return url, "\n".join(self._certificate_transfer.get_all_certificates(ca_rel_id))
+            return url, "\n".join(sorted(self._certificate_transfer.get_all_certificates(ca_rel_id)))
         else:
             return None, None

test/fixme_charm/metadata.yaml

@@ -1 +1,9 @@
 name: fixme_charm
+
+requires:
+  charm-tracing:
+    interface: tracing
+    limit: 1
+  send-ca-cert:
+    interface: certificate_transfer
+    limit: 1

test/fixme_charm/src/charm.py

@@ -1,18 +1,19 @@
 import ops
+import ops._tracing.api
 
 
 class Charm(ops.CharmBase):
-    def init(self, framework: ops.Framework):
+    def __init__(self, framework: ops.Framework):
         super().__init__(framework)
-        self.framework.observe(self.on.collect_app_status, self._on_collect_status)
-        self.framework.observe(self.on.collect_unit_status, self._on_collect_status)
-        return
         self._tracing = ops._tracing.api.Tracing(
             self,
             tracing_relation_name="charm-tracing",
             ca_relation_name="send-ca-cert",
         )
+        self.framework.observe(self.on.collect_app_status, self._on_collect_status)
+        self.framework.observe(self.on.collect_unit_status, self._on_collect_status)
 
+    # FIXME: not strictly necessary, only testing that charm didn't crash
     def _on_collect_status(self, event: ops.CollectStatusEvent):
         event.add_status(ops.ActiveStatus())
 

test/fixme_charm/test/test_nothing.py

@@ -1,20 +1,74 @@
-import sys
-print(sys.path)
+import json
+from unittest.mock import Mock
+
+import pytest
+
+import ops._tracing
 import ops.testing
 from test.fixme_charm.src.charm import Charm
 
+pytestmark = pytest.mark.filterwarnings("ignore::pydantic.PydanticDeprecatedSince20")
+
+
+HTTP_RELATION = ops.testing.Relation(
+    "charm-tracing",
+    remote_app_data={
+        "receivers": json.dumps([{
+            "protocol": {"name": "otlp_http", "type": "http"},
+            "url": "http://tracing.example:4318/v1/traces"}]),
+    },
+    id=1,
+)
+
+HTTPS_RELATION = ops.testing.Relation(
+    "charm-tracing",
+    remote_app_data={
+        "receivers": json.dumps([{
+            "protocol": {"name": "otlp_http", "type": "http"},
+            "url": "https://tls.example/v1/traces"}]),
+    },
+    id=2,
+)
+
+CA_RELATION = ops.testing.Relation(
+    "send-ca-cert",
+    remote_app_data={
+        "certificates": json.dumps(["BEGIN FAKE CA", "ONE MORE"]),
+    },
+    id=3,
+)
 
 def test_charm_runs():
-    # Arrange:
-    #  Create a Context to specify what code we will be running,
     ctx = ops.testing.Context(Charm)
-    #  and create a State to specify what simulated data the charm being run will access.
-    state_in = ops.testing.State(leader=True)
-
-    # Act:
-    #  Ask the context to run an event, e.g. 'start', with the state we have previously created.
+    state_in = ops.testing.State()
     state_out = ctx.run(ctx.on.start(), state_in)
+    assert isinstance(state_out.unit_status, ops.ActiveStatus)
+
+
+@pytest.fixture
+def mock_destination(monkeypatch: pytest.MonkeyPatch) -> Mock:
+    rv = Mock()
+    monkeypatch.setattr(ops._tracing, "set_tracing_destination", rv)
+    return rv
 
-    # Assert:
-    #  Verify that the output state looks like you expect it to.
-    assert state_out.unit_status == 33
+
+def test_no_tracing_destination(mock_destination: Mock):
+    ctx = ops.testing.Context(Charm)
+    state = ops.testing.State()
+    ctx.run(ctx.on.start(), state)
+    mock_destination.assert_called_with(url=None, ca=None)
+
+
+def test_http_tracing_destination(mock_destination: Mock):
+    ctx = ops.testing.Context(Charm)
+    state = ops.testing.State(relations={HTTP_RELATION})
+    ctx.run(ctx.on.relation_changed(HTTP_RELATION), state)
+    mock_destination.assert_called_with(url="http://tracing.example:4318/v1/traces", ca=None)
+
+
+@pytest.mark.parametrize("relation", [HTTPS_RELATION, CA_RELATION])
+def test_https_tracing_destination(mock_destination: Mock, relation: ops.testing.Relation):
+    ctx = ops.testing.Context(Charm)
+    state = ops.testing.State(relations={HTTPS_RELATION, CA_RELATION})
+    ctx.run(ctx.on.relation_changed(relation), state)
+    mock_destination.assert_called_with(url="https://tls.example/v1/traces", ca="BEGIN FAKE CA\nONE MORE")