Add integration and unit tests for monitoring JSON API endpoints by gimballock · Pull Request #373 · stratum-mining/sv2-apps

gimballock · 2026-03-24T21:54:48Z

Closes #329

Exercise every JSON REST API endpoint against live SV2 topologies and strengthen unit-test coverage for edge cases.

Integration tests (monitoring_integration.rs):

15 new tests covering /, /api/v1/global, /api/v1/server, /api/v1/server/channels, /api/v1/clients, /api/v1/clients/{id}, /api/v1/clients/{id}/channels, /api/v1/sv1/clients, and /api/v1/sv1/clients/{id} for both Pool and tProxy topologies
Topology setup helpers (PoolWithSv2Miner, TproxyWithSv1Miner) eliminate duplicated boilerplate across tests
404 endpoints assert both HTTP status code and JSON error body via new assert_api_not_found helper

Assertion helpers (prometheus_metrics_assertions.rs):

fetch_api_json: parse JSON API response
fetch_api_with_status: return (status_code, json) without panicking on non-2xx, enabling 404 testing
poll_until_api_field_gte: poll JSON endpoint until a field reaches a threshold (analogous to poll_until_metric_gte for Prometheus)
assert_api_root, assert_api_global: reusable structure checks
assert_api_not_found: verify HTTP 404 + error field
POLL_TIMEOUT constant to reduce repetition

HTTP helper (utils.rs):

make_get_request_with_status: returns (status, body) without panicking on 4xx responses, unlike make_get_request

Unit tests (http_server.rs):

11 new tests for pagination boundaries (limit=0, offset beyond total, limit exceeding MAX_LIMIT), missing data sources returning 404, invalid/non-existent client IDs, SV1 data in global endpoint, and Prometheus metrics with no sources

Dependencies:

Add serde_json to integration-tests for JSON parsing

Shourya742

Shouldn't monitoring module have abstractions for most of these?

Shourya742 · 2026-04-05T09:09:38Z

integration-tests/lib/prometheus_metrics_assertions.rs

+    tokio::task::spawn_blocking(move || {
+        let (status, bytes) = crate::utils::http::make_get_request_with_status(&url, 5);
+        let body = String::from_utf8(bytes).expect("api response should be valid UTF-8");
+        let json: serde_json::Value = serde_json::from_str(&body).unwrap_or_else(|e| {
+            panic!(
+                "Failed to parse JSON from {} (status {}): {}\nBody: {}",
+                url, status, e, body
+            )
+        });
+        (status, json)
+    })
+    .await
+    .expect("spawn_blocking for fetch_api_with_status panicked")


doesn't minreq provide async variant?

minreq does not provide an async variant - it's a synchronous HTTP client by design. We use tokio::task::spawn_blocking to run it without blocking the async runtime. If we want true async HTTP, we'd need to switch to reqwest or similar, but minreq was chosen for its simplicity and minimal dependencies in tests.

Shourya742 · 2026-04-05T09:10:13Z

integration-tests/lib/prometheus_metrics_assertions.rs

+/// Assert that an endpoint returns HTTP 404 with a JSON `{"error": "..."}` body.
+pub async fn assert_api_not_found(monitoring_addr: SocketAddr, path: &str) {
+    let (status, json) = fetch_api_with_status(monitoring_addr, path).await;
+    assert_eq!(
+        status, 404,
+        "{} should return HTTP 404, got {} with body: {}",
+        path, status, json
+    );
+    assert!(
+        json["error"].is_string(),
+        "{} should return JSON with 'error' field, got: {}",
+        path,
+        json
+    );
+}


Not a good idea to move asserts in a helper method, makes debugging painful when something goes wrong.

Fixed - removed the assert helper methods. Assertions are now inlined directly in each test for better debugging.

Shourya742 · 2026-04-05T09:11:15Z

integration-tests/lib/prometheus_metrics_assertions.rs

+pub async fn assert_api_root(monitoring_addr: SocketAddr) {
+    let json = fetch_api_json(monitoring_addr, "/").await;
+    assert_eq!(
+        json["service"], "SRI Monitoring API",
+        "Root endpoint should return service name, got: {}",
+        json
+    );
+    assert!(
+        json["endpoints"].is_object(),
+        "Root endpoint should list endpoints, got: {}",
+        json
+    );
+}
+
+/// Assert that `/api/v1/global` returns a valid response with the expected structure.
+/// Returns the parsed JSON for further assertions.
+pub async fn assert_api_global(monitoring_addr: SocketAddr) -> serde_json::Value {
+    let json = fetch_api_json(monitoring_addr, "/api/v1/global").await;
+    assert!(
+        json["uptime_secs"].as_u64().is_some(),
+        "Global endpoint should contain uptime_secs, got: {}",
+        json
+    );
+    json
+}


Same for this.

Fixed - removed this helper as well.

Shourya742 · 2026-04-05T09:14:52Z