Merge pull request #485 from pehala/rework_tracing

Rework tracing

testsuite/tests/conftest.py

@@ -16,7 +16,8 @@
 from testsuite.oidc import OIDCProvider
 from testsuite.oidc.auth0 import Auth0Provider
 from testsuite.oidc.keycloak import Keycloak
-from testsuite.tracing import TracingClient
+from testsuite.tracing.jaeger import JaegerClient
+from testsuite.tracing.tempo import RemoteTempoClient
 from testsuite.utils import randomize, _whoami
 
 
@@ -170,14 +171,17 @@ def tracing(testconfig, skip_or_fail):
     """Returns tracing client for tracing tests"""
     try:
         testconfig.validators.validate(only=["tracing"])
-        return TracingClient(
-            testconfig["tracing"]["backend"] == "jaeger",
+    except (KeyError, ValidationError) as exc:
+        skip_or_fail(f"Tracing configuration item is missing: {exc}")
+
+    cls = JaegerClient if testconfig["tracing"]["backend"] == "jaeger" else RemoteTempoClient
+    # Authorino needs to have verify disabled because it doesn't trust local service URLs
+    with KuadrantClient(verify=False) as client:
+        yield cls(
             testconfig["tracing"]["collector_url"],
             testconfig["tracing"]["query_url"],
-            KuadrantClient(verify=False),
+            client,
         )
-    except (KeyError, ValidationError) as exc:
-        return skip_or_fail(f"Tracing configuration item is missing: {exc}")
 
 
 @pytest.fixture(scope="session")

testsuite/tests/singlecluster/authorino/operator/tracing/conftest.py

@@ -8,8 +8,7 @@
 @pytest.fixture(scope="module")
 def authorino_parameters(authorino_parameters, tracing):
     """Deploy authorino with tracing enabled"""
-    insecure_tracing = not tracing.client.verify
-    authorino_parameters["tracing"] = TracingOptions(endpoint=tracing.collector_url, insecure=insecure_tracing)
+    authorino_parameters["tracing"] = TracingOptions(endpoint=tracing.collector_url, insecure=tracing.insecure)
     return authorino_parameters
 
 

testsuite/tests/singlecluster/authorino/operator/tracing/test_tracing.py

@@ -15,5 +15,5 @@ def test_tracing(client, auth, tracing):
     request_id = extract_response(response) % None
     assert request_id is not None
 
-    trace = tracing.find_trace(request_id, "authorino")
+    trace = tracing.search(request_id, "authorino")
     assert len(trace) == 1

testsuite/tests/singlecluster/authorino/operator/tracing/test_tracing_tags.py

@@ -27,5 +27,5 @@ def test_tracing_tags(client, auth, tracing):
     request_id = extract_response(response) % None
     assert request_id is not None
 
-    trace = tracing.find_tagged_trace(request_id, "authorino", {TAG_KEY: TAG_VALUE})
+    trace = tracing.search(request_id, "authorino", {TAG_KEY: TAG_VALUE})
     assert len(trace) == 1

testsuite/tracing/__init__.py

@@ -0,0 +1,26 @@
+"""Module with Abstract Tracing client for traces management"""
+
+import abc
+
+
+class TracingClient(abc.ABC):
+    """Tracing client for traces management"""
+
+    @property
+    @abc.abstractmethod
+    def insecure(self):
+        """Returns True, if the connection to the client is insecure"""
+
+    @property
+    @abc.abstractmethod
+    def query_url(self):
+        """Returns URL for clients to query"""
+
+    @property
+    @abc.abstractmethod
+    def collector_url(self):
+        """Returns URL for application to deposit traces"""
+
+    @abc.abstractmethod
+    def search(self, request_id: str, service: str, tags: dict) -> list:
+        """Search traces in tracing client by tags service name, `authorino.request_id` and tag"""

testsuite/tracing/jaeger.py

@@ -0,0 +1,38 @@
+"""Jaeger Tracing client"""
+
+import backoff
+from apyproxy import ApyProxy
+from httpx import Client
+
+from testsuite.tracing import TracingClient
+
+
+class JaegerClient(TracingClient):
+    """Tracing client for traces management"""
+
+    def __init__(self, collector_url: str, query_url: str, client: Client):
+        self._collector_url = collector_url
+        self._query_url = query_url
+        self.query = ApyProxy(self.query_url, session=client)
+
+    @property
+    def insecure(self):
+        """So far, we only support insecure tracing as we depend on internal service which is insecure by default"""
+        return True
+
+    @property
+    def collector_url(self):
+        return self._collector_url
+
+    @property
+    def query_url(self):
+        return self._query_url
+
+    @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_tries=7, jitter=None)
+    def search(self, request_id: str, service: str, tags=None):
+        """Gets trace from tracing backend Tempo or Jaeger"""
+        if tags is None:
+            tags = {}
+
+        tags.update({"service": service, "tags": f'{{"authorino.request_id":"{request_id}"}}'})
+        return self.query.api.traces.get(params=tags).json()["data"]

testsuite/tracing/tempo.py

@@ -0,0 +1,17 @@
+"""Tempo tracing"""
+
+import backoff
+
+from testsuite.tracing.jaeger import JaegerClient
+
+
+class RemoteTempoClient(JaegerClient):
+    """Client to a Tempo that is deployed remotely"""
+
+    @backoff.on_predicate(backoff.fibo, lambda x: x == [], max_tries=7, jitter=None)
+    def search(self, request_id: str, service: str, tags=None):
+        if tags is None:
+            tags = {}
+
+        tags.update({"service.name": service, "authorino.request_id": request_id})
+        return self.query.api.search.get(params=tags).json()["traces"]