Merge pull request #1 from grafana/integration-tests

Author: sd2k

.github/workflows/cloud.yml

@@ -0,0 +1,39 @@
+name: Cloud tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  uv-example:
+    name: python
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          # Install a specific version of uv.
+          version: "0.5.13"
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+          
+      - name: Install the project
+        run: uv sync --all-extras --all-groups
+
+      - name: Run ruff
+        run: uv run ruff check .
+
+      - name: Run tests
+        run: uv run pytest tests --cloud
+        env:
+          # E.g. https://mcptests.grafana-dev.net.
+          GRAFANA_URL: ${{ vars.CLOUD_GRAFANA_URL }}
+          GRAFANA_API_KEY: ${{ secrets.CLOUD_GRAFANA_API_KEY }}

.github/workflows/python.yml

@@ -14,6 +14,14 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      # Start the Grafana server.
+      # Do this early so that it can start up in time for the tests to run.
+      # We may need to add a wait here.
+      - name: Start docker-compose services
+        uses: hoverkraft-tech/[email protected]
+        with:
+          compose-file: "docker-compose.yaml"
+
       - name: Install uv
         uses: astral-sh/setup-uv@v5
         with:
@@ -32,4 +40,4 @@ jobs:
         run: uv run ruff check .
 
       - name: Run tests
-        run: uv run pytest tests
+        run: uv run pytest tests --integration

docker-compose.yaml

@@ -9,9 +9,8 @@ services:
     ports:
       - 3000:3000/tcp
     volumes:
-      # - ./provisioning:/etc/grafana/provisioning
-      # persist data in /var/lib/grafana so that jobs still work between re-ups
-      - "var-lib-grafana:/var/lib/grafana"
+      - ./tests/provisioning:/etc/grafana/provisioning
+      - ./tests/dashboards:/var/lib/grafana/dashboards
 
 volumes:
   var-lib-grafana:

pyproject.toml

@@ -22,6 +22,7 @@ mcp-grafana = "mcp_grafana.cli:app"
 [dependency-groups]
 dev = [
     "pytest>=8.3.4",
+    "pytest-asyncio>=0.25.2",
 ]
 lint = [
     "ruff>=0.8.5",
@@ -30,3 +31,6 @@ lint = [
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "session"

tests/conftest.py

@@ -0,0 +1,31 @@
+def pytest_addoption(parser):
+    """
+    Add command line options for integration and cloud tests.
+
+    This is used as an alternative to relying on custom markers,
+    which do not stop the tests running by default.
+
+    To run integration tests, use:
+
+        pytest --integration
+
+    To run cloud tests, use:
+
+        pytest --integration --cloud
+
+    These two can be combined.
+    """
+    parser.addoption(
+        "--integration",
+        action="store_true",
+        dest="integration",
+        default=False,
+        help="enable integration tests",
+    )
+    parser.addoption(
+        "--cloud",
+        action="store_true",
+        dest="cloud",
+        default=False,
+        help="enable cloud integration tests",
+    )

tests/dashboards/demo.json

@@ -0,0 +1,140 @@
+{
+  "annotations": {
+    "list": [
+      {
+        "builtIn": 1,
+        "datasource": {
+          "type": "grafana",
+          "uid": "-- Grafana --"
+        },
+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations & Alerts",
+        "type": "dashboard"
+      }
+    ]
+  },
+  "editable": true,
+  "fiscalYearStartMonth": 0,
+  "graphTooltip": 0,
+  "id": 1,
+  "isStarred": true,
+  "links": [],
+  "panels": [
+    {
+      "datasource": {
+        "default": true,
+        "type": "prometheus",
+        "uid": "robustperception"
+      },
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "palette-classic"
+          },
+          "custom": {
+            "axisBorderShow": false,
+            "axisCenteredZero": false,
+            "axisColorMode": "text",
+            "axisLabel": "",
+            "axisPlacement": "auto",
+            "barAlignment": 0,
+            "barWidthFactor": 0.6,
+            "drawStyle": "line",
+            "fillOpacity": 0,
+            "gradientMode": "none",
+            "hideFrom": {
+              "legend": false,
+              "tooltip": false,
+              "viz": false
+            },
+            "insertNulls": false,
+            "lineInterpolation": "linear",
+            "lineWidth": 1,
+            "pointSize": 5,
+            "scaleDistribution": {
+              "type": "linear"
+            },
+            "showPoints": "auto",
+            "spanNulls": false,
+            "stacking": {
+              "group": "A",
+              "mode": "none"
+            },
+            "thresholdsStyle": {
+              "mode": "off"
+            }
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 8,
+        "w": 12,
+        "x": 0,
+        "y": 0
+      },
+      "id": 1,
+      "options": {
+        "legend": {
+          "calcs": [],
+          "displayMode": "list",
+          "placement": "bottom",
+          "showLegend": true
+        },
+        "tooltip": {
+          "mode": "single",
+          "sort": "none"
+        }
+      },
+      "targets": [
+        {
+          "datasource": {
+            "type": "prometheus",
+            "uid": "robustperception"
+          },
+          "editorMode": "code",
+          "expr": "node_load1",
+          "instant": false,
+          "legendFormat": "__auto",
+          "range": true,
+          "refId": "A"
+        }
+      ],
+      "title": "Node Load",
+      "type": "timeseries"
+    }
+  ],
+  "schemaVersion": 39,
+  "tags": [
+    "demo"
+  ],
+  "templating": {
+    "list": []
+  },
+  "time": {
+    "from": "now-6h",
+    "to": "now"
+  },
+  "timepicker": {},
+  "timezone": "browser",
+  "title": "Demo",
+  "uid": "fe9gm6guyzi0wd",
+  "version": 2,
+  "weekStart": ""
+}

tests/provisioning/dashboards/dashboards.yaml

@@ -0,0 +1,16 @@
+apiVersion: 1
+
+providers:
+  - name: 'docker-compose'
+    orgId: 1
+    folder: ''
+    folderUid: ''
+    type: file
+    disableDeletion: true
+    updateIntervalSeconds: 60
+    allowUiUpdates: false
+    options:
+      # <string, required> path to dashboard files on disk. Required when using the 'file' type
+      path: /var/lib/grafana/dashboards
+      # <bool> use folder names from filesystem to create folders in Grafana
+      foldersFromFilesStructure: true

tests/provisioning/datasources/datasources.yaml

@@ -0,0 +1,10 @@
+apiVersion: 1
+
+datasources:
+  - name: Robust Perception
+    id: 1
+    uid: robustperception
+    type: prometheus
+    access: proxy
+    url: http://demo.robustperception.io:9090
+    isDefault: true

tests/settings_test.py

@@ -4,6 +4,7 @@
 from mcp_grafana.settings import GrafanaSettings
 
 
+@patch.dict(os.environ, clear=True)
 def test_settings():
     # Test we can instantiate settings with defaults.
     settings = GrafanaSettings(url="http://localhost:3000")

tests/tools/__init__.py

@@ -0,0 +1,17 @@
+import pytest
+
+mark_integration = [
+    # Without marking the loop scope as session, the event loop
+    # is closed after each test runs, which causes subsequent tests
+    # to fail.
+    pytest.mark.asyncio(loop_scope="session"),
+    pytest.mark.skipif("not config.getoption('integration')"),
+]
+
+mark_cloud = [
+    # Without marking the loop scope as session, the event loop
+    # is closed after each test runs, which causes subsequent tests
+    # to fail.
+    pytest.mark.asyncio(loop_scope="session"),
+    pytest.mark.skipif("not config.getoption('cloud')"),
+]

tests/tools/datasources_test.py

@@ -0,0 +1,38 @@
+import json
+
+from mcp_grafana.tools.datasources import (
+    list_datasources,
+    get_datasource_by_uid,
+    get_datasource_by_name,
+)
+
+from . import mark_integration
+
+# All tests in this file require a running Grafana instance and
+# an asynchronous event loop.
+pytestmark = mark_integration
+
+
+async def test_list_datasources():
+    datasources_bytes = await list_datasources()
+    datasources = json.loads(datasources_bytes)
+    assert len(datasources) == 1
+    assert datasources[0]["name"] == "Robust Perception"
+    assert datasources[0]["id"] == 1
+    assert datasources[0]["uid"] == "robustperception"
+
+
+async def test_get_datasource_by_uid():
+    datasource_bytes = await get_datasource_by_uid("robustperception")
+    datasource = json.loads(datasource_bytes)
+    assert datasource["name"] == "Robust Perception"
+    assert datasource["id"] == 1
+    assert datasource["uid"] == "robustperception"
+
+
+async def test_get_datasource_by_name():
+    datasource_bytes = await get_datasource_by_name("Robust Perception")
+    datasource = json.loads(datasource_bytes)
+    assert datasource["name"] == "Robust Perception"
+    assert datasource["id"] == 1
+    assert datasource["uid"] == "robustperception"

tests/tools/incident_test.py

@@ -0,0 +1,24 @@
+import json
+
+from mcp_grafana.tools.incident import list_incidents, ListIncidentsArguments
+
+from . import mark_cloud
+
+# All tests in this file require a cloud Grafana instance and
+# an asynchronous event loop.
+pytestmark = mark_cloud
+
+
+async def test_list_incidents():
+    arguments = ListIncidentsArguments(
+        limit=2,
+        drill=False,
+        status="active",
+    )
+    incidents_bytes = await list_incidents(arguments)
+    incidents = json.loads(incidents_bytes)
+    previews = incidents["incidentPreviews"]
+    assert len(previews) <= 2
+    for preview in previews:
+        assert preview["status"] == "active"
+        assert preview["isDrill"] is False