HTTP API: dashboard

Jeden fakt na dashboardu: hodnota přečtená z odpovědi jedné schopnosti, verdikt, který jí zdroj dává, kam se čtenář zanoří a co na ni působí.

use majordomus_cli::capability::builtin::dashboard::DashboardCard;
use serde_json::json;

let card: DashboardCard = serde_json::from_value(json!({
    "id": "health-status",
    "title": "Health",
    "value": "ok",
    "status": "ok",
    "detail": "the worst of 8 check(s)",
    "source": { "capability": "health.report", "input": {}, "pointer": "/status", "measure": "exact" },
    "route": "/cockpit/health",
})).unwrap();
// the value is the source's: reading the pointer out of its answer gives it back
assert_eq!(card.source.measure.read(&json!({ "status": "ok" }), &card.source.pointer), card.value);
assert!(card.action.is_none());

Jak se hodnota karty čte z odpovědi jejího zdroje. Ani jedno čtení není aritmetikou jménem zdroje.

use majordomus_cli::capability::builtin::dashboard::DashboardMeasure;
use serde_json::json;

let answer = json!({ "status": "warn", "tallies": { "ok": 6 }, "overlaps": [1, 2] });
// exact: the value at the pointer, null when there is none
assert_eq!(DashboardMeasure::Exact.read(&answer, "/status"), json!("warn"));
assert_eq!(DashboardMeasure::Exact.read(&answer, "/tallies/fail"), json!(null));
// count: a number as it stands, a list or map by its length, and an omitted one is none
assert_eq!(DashboardMeasure::Count.read(&answer, "/tallies/ok"), json!(6));
assert_eq!(DashboardMeasure::Count.read(&answer, "/overlaps"), json!(2));
assert_eq!(DashboardMeasure::Count.read(&answer, "/tallies/fail"), json!(0));

Přehled: čtyři otázky, každá zodpovězená fakty, které drží jiné schopnosti.

use majordomus_cli::capability::builtin::dashboard::DashboardOverview;
use majordomus_cli::capability::builtin::HealthStatus;
use serde_json::json;

let o: DashboardOverview = serde_json::from_value(json!({ "status": "unknown", "questions": [] })).unwrap();
assert_eq!(o.status, HealthStatus::Unknown);

Jedna ze čtyř otázek, na které Přehled odpovídá, s kartami, které na ni odpovídají.

use majordomus_cli::capability::builtin::dashboard::DashboardQuestion;
use majordomus_cli::capability::builtin::HealthStatus;
use serde_json::json;

let q: DashboardQuestion = serde_json::from_value(json!({
    "id": "healthy", "title": "Is it healthy?", "status": "ok", "cards": [],
})).unwrap();
assert_eq!(q.status, HealthStatus::Ok);

Odkud hodnota karty pochází: schopnost, na kterou se ptalo, vstup, s nímž se ptalo, a ukazatel do její odpovědi. Položením téže otázky schopnosti a přečtením ukazatele stejnou mírou získáte hodnotu karty; to je celý kontrakt.

use majordomus_cli::capability::builtin::dashboard::{DashboardMeasure, DashboardSource};
use serde_json::json;

let s: DashboardSource = serde_json::from_value(json!({
    "capability": "health.report",
    "input": {},
    "pointer": "/status",
    "measure": "exact",
})).unwrap();
assert_eq!(s.measure, DashboardMeasure::Exact);
assert_eq!(s.measure.read(&json!({ "status": "ok" }), &s.pointer), json!("ok"));