Merge branch 'main' into da-176-requested-entities

Author: dragomirp

.github/workflows/dispatch-matrix-tests.yaml

@@ -46,7 +46,7 @@ jobs:
       - name: Set up python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: '3.10'
       - name: Install dependencies
         run: pip install tox uv poetry
       - name: Run tests

docs/json_schemas/profiling/v0/provider.json

@@ -0,0 +1,56 @@
+{
+  "$defs": {
+    "BaseModel": {
+      "properties": {},
+      "title": "BaseModel",
+      "type": "object"
+    },
+    "ProviderAppSchema": {
+      "description": "Application databag schema for the provider side of the profiling interface.",
+      "properties": {
+        "otlp_grpc_endpoint_url": {
+          "description": "Grpc ingestion endpoint for profiles using otlp_grpc.",
+          "examples": [
+            "some.hostname:1234",
+            "10.64.140.43:42424"
+          ],
+          "title": "Otlp Grpc Endpoint Url",
+          "type": "string"
+        },
+        "insecure": {
+          "default": false,
+          "description": "Whether the ingestion endpoints should be accessed without TLS (insecure connection).",
+          "title": "Insecure",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "otlp_grpc_endpoint_url"
+      ],
+      "title": "ProviderAppSchema",
+      "type": "object"
+    }
+  },
+  "description": "The schema for the provider side of this interface.",
+  "properties": {
+    "unit": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/BaseModel"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null
+    },
+    "app": {
+      "$ref": "#/$defs/ProviderAppSchema"
+    }
+  },
+  "required": [
+    "app"
+  ],
+  "title": "ProviderSchema",
+  "type": "object"
+}

docs/json_schemas/profiling/v0/requirer.json

@@ -0,0 +1,36 @@
+{
+  "$defs": {
+    "BaseModel": {
+      "properties": {},
+      "title": "BaseModel",
+      "type": "object"
+    }
+  },
+  "description": "The schema for the requirer side of this interface.",
+  "properties": {
+    "unit": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/BaseModel"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null
+    },
+    "app": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/BaseModel"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null
+    }
+  },
+  "title": "RequirerSchema",
+  "type": "object"
+}

index.json

@@ -214,6 +214,11 @@
     "version": 0,
     "status": "draft"
   },
+  {
+    "name": "profiling",
+    "version": 0,
+    "status": "draft"
+  },
   {
     "name": "prometheus_remote_write",
     "version": 0,

interfaces/profiling/v0/README.md

@@ -0,0 +1,63 @@
+# `profiling`
+
+## Usage
+
+This interface can be used by an application able to ingest profiling data to expose the ingestion 
+endpoint(s) to any application able to push into them.
+
+The reference implementation of this interface (v0) can be found at [this address](https://github.com/canonical/pyroscope-k8s-operator/blob/main/coordinator/lib/charms/pyroscope_coordinator_k8s/v0/profiling.py).
+
+## Direction
+
+This interface implements a provider/requirer pattern. As is customary, the provider is the server 
+(the profiling data ingester) and the requirer is the profiling data source.
+
+The interface is unidirectional: the provider doesn't need any information from the requirer.
+The provider shares any and all supported ingestion endpoints.
+
+```mermaid
+flowchart TD
+    Provider -- ProfilingEndpoints --> Requirer
+```
+
+## Behavior
+### Provider
+
+- Must publish all active ingestion endpoints.
+- Must accept data on those endpoints
+- If ingress is available, the provider must advertise its ingressed hostname, 
+  otherwise fall back to using its own cluster-internal fqdn.
+- Must pass `insecure=True` if the ingestion endpoints are running with insecure connection.
+
+## Relation Data
+
+[\[Pydantic Schema\]](./schema.py)
+
+#### Example
+A yaml/json example of a valid databag state (for the whole relation), in absence of an ingress 
+integration for the provider:
+```yaml
+provider:
+  app: {
+         otlp_grpc_endpoint_url: "my.fqdn.cluster.local:1234",
+         insecure: False,
+  }
+  unit: {}
+requirer:
+  app: {}
+  unit: {}
+```
+
+If the provider is ingressed:
+```yaml
+provider:
+  app: {
+         # `10.0.0.1` is the ingress hostname of the provider charm
+         otlp_grpc_endpoint_url: "10.0.0.1:1234",
+         insecure: False,
+  }
+  unit: {}
+requirer:
+  app: {}
+  unit: {}
+```

interfaces/profiling/v0/interface.yaml

@@ -0,0 +1,25 @@
+name: profiling
+
+# `version` starts at `0` and increments with every breaking change in the interface specification.
+version: 0
+
+# `status` describes where the interface is in its lifecycle. Valid values are described in LEGEND.md.
+status: draft
+
+providers:
+  - name: pyroscope-coordinator-k8s
+    url: https://github.com/canonical/pyroscope-operators
+    branch: feat/interface-tests-profiling
+    test_setup:
+      charm_root: coordinator
+      location: tests/interface/conftest.py
+      identifier: profiling_tester
+      pre_run: uv pip compile pyproject.toml --quiet --output-file requirements.txt
+
+requirers:
+  - name: opentelemetry-collector-k8s
+    url: https://github.com/canonical/opentelemetry-collector-k8s-operator
+    test_setup:
+      pre_run: uv pip compile pyproject.toml --quiet --output-file requirements.txt
+
+maintainer: "observability"

interfaces/profiling/v0/interface_tests/test_provider.py

@@ -0,0 +1,23 @@
+# Copyright 2024 Canonical
+# See LICENSE file for licensing details.
+import json
+
+from interface_tester.interface_test import Tester
+
+# on created, joined, changed: the provider is expected to publish all data
+def test_data_on_created():
+    tester = Tester()
+    tester.run('profiling-relation-created')
+    tester.assert_schema_valid()
+
+
+def test_data_on_joined():
+    tester = Tester()
+    tester.run('profiling-relation-joined')
+    tester.assert_schema_valid()
+
+
+def test_data_on_changed():
+    tester = Tester()
+    tester.run('profiling-relation-changed')
+    tester.assert_schema_valid()

interfaces/profiling/v0/interface_tests/test_requirer.py

@@ -0,0 +1,46 @@
+# Copyright 2024 Canonical
+# See LICENSE file for licensing details.
+import json
+
+from interface_tester.interface_test import Tester
+from scenario import State, Relation
+
+# on created, joined, changed: the requirer is expected to publish no data
+def test_no_data_on_created():
+    tester = Tester()
+    tester.run('tracing-relation-created')
+    tester.assert_relation_data_empty()
+
+
+def test_no_data_on_joined():
+    tester = Tester()
+    tester.run('tracing-relation-joined')
+    tester.assert_relation_data_empty()
+
+
+def test_no_data_on_changed():
+    tester = Tester()
+    tester.run('tracing-relation-changed')
+    tester.assert_relation_data_empty()
+
+
+# if the remote end has sent their side of the deal, we're happy
+def test_data_on_changed():
+    tester = Tester(
+        state_in=State(
+            relations=[
+                Relation(
+                    endpoint='profiling',
+                    interface='profiling',
+                    remote_app_name='remote',
+                    remote_app_data={
+                        "otlp_grpc_endpoint_url": json.dumps("my.fqdn.cluster.local:1234"),
+                        "insecure": json.dumps(False),
+                    }
+                    )
+            ]
+        )
+    )
+    tester.run('tracing-relation-changed')
+    tester.assert_schema_valid()
+

interfaces/profiling/v0/schema.py

@@ -0,0 +1,32 @@
+"""This file defines the schemas for the provider and requirer sides of this relation interface.
+
+It must expose two interfaces.schema_base.DataBagSchema subclasses called:
+- ProviderSchema
+- RequirerSchema
+"""
+
+from interface_tester.schema_base import DataBagSchema
+from pydantic import BaseModel, Field
+
+
+class ProviderAppSchema(BaseModel):
+    """Application databag schema for the provider side of the profiling interface."""
+
+    otlp_grpc_endpoint_url: str = Field(
+        description="Grpc ingestion endpoint for profiles using otlp_grpc.",
+        examples=["some.hostname:1234", "10.64.140.43:42424"],
+    )
+    insecure: bool = Field(
+        description="Whether the ingestion endpoints should be accessed without TLS (insecure connection).",
+        default=False,
+    )
+
+
+class ProviderSchema(DataBagSchema):
+    """The schema for the provider side of this interface."""
+
+    app: ProviderAppSchema
+
+
+class RequirerSchema(DataBagSchema):
+    """The schema for the requirer side of this interface."""

run_matrix.py

@@ -89,7 +89,9 @@ def _prepare_repo(
     repo_root_path = root / charm_config.name
 
     # multi-charm repos might have multiple charms in a single repo.
-    if charm_root_cfg := charm_config.test_setup.get("charm_root"):
+    if charm_config.test_setup and (
+        charm_root_cfg := charm_config.test_setup.get("charm_root")
+    ):
         charm_root_path = repo_root_path / charm_root_cfg
         if not charm_root_path.resolve().is_relative_to(repo_root_path):
             raise SetupError(
@@ -168,10 +170,9 @@ def _get_fixture(charm_config: "_CharmTestConfig", charm_path: Path) -> FixtureS
     fixture_path = charm_path / FIXTURE_PATH
     fixture_id = FIXTURE_IDENTIFIER
     if charm_config.test_setup:
-        if charm_config.test_setup["location"]:
-            fixture_path = charm_path / Path(charm_config.test_setup["location"])
-        if charm_config.test_setup["identifier"]:
-            fixture_id = charm_config.test_setup["identifier"]
+        if location := charm_config.test_setup.get("location"):
+            fixture_path = charm_path / Path(location)
+        fixture_id = charm_config.test_setup.get("identifier", fixture_id)
     return FixtureSpec(fixture_path, fixture_id)