cf-gears-toolkit 0.10.0

Core ToolKit library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

//! Tests for the readiness subsystem.

use super::*;
use crate::healthcheck::{Healthcheck, HealthcheckResult, HealthcheckStatus};
use async_trait::async_trait;

/// A healthcheck that always returns a fixed result.
struct StaticCheck {
    name: &'static str,
    result: HealthcheckResult,
}

#[async_trait]
impl Healthcheck for StaticCheck {
    fn name(&self) -> &'static str {
        self.name
    }
    async fn check(&self) -> HealthcheckResult {
        self.result.clone()
    }
}

fn empty_registry() -> Arc<RestHealthcheckRegistry> {
    Arc::new(RestHealthcheckRegistry::new())
}

/// A registry seeded with a single gear healthcheck.
fn registry_with(
    gear: &'static str,
    name: &'static str,
    result: HealthcheckResult,
) -> Arc<RestHealthcheckRegistry> {
    let registry = Arc::new(RestHealthcheckRegistry::new());
    registry.register(gear, Arc::new(StaticCheck { name, result }));
    registry
}

#[tokio::test]
async fn no_deps_no_checks_is_ready() {
    let state = ReadinessState::new(Vec::<String>::new(), empty_registry());

    let report = state.evaluate().await;
    assert!(!report.ready);
    assert_eq!(report.state, ReadinessLifecycle::Starting);

    state.mark_startup_complete();
    let report = state.evaluate().await;
    let health = state.health_report().await;
    assert!(report.ready);
    assert_eq!(report.state, ReadinessLifecycle::Ready);
    assert!(report.unresolved_deps.is_empty());
    assert!(health.components.is_empty());
    assert_eq!(health.status, HealthcheckStatus::Healthy);
}

#[tokio::test]
async fn unresolved_deps_block_readiness_until_resolved() {
    let state = ReadinessState::new(["billing", "catalog"], empty_registry());

    let report = state.evaluate().await;
    assert!(!report.ready);
    assert_eq!(report.state, ReadinessLifecycle::Starting);
    assert_eq!(report.unresolved_deps, vec!["billing", "catalog"]);

    state.mark_dep_resolved("billing");
    let report = state.evaluate().await;
    assert!(!report.ready);
    assert_eq!(report.unresolved_deps, vec!["catalog"]);

    state.mark_dep_resolved("catalog");
    state.mark_startup_complete();
    let report = state.evaluate().await;
    assert!(report.ready);
    assert!(report.unresolved_deps.is_empty());
}

#[tokio::test]
async fn mark_unknown_dep_is_ignored() {
    let state = ReadinessState::new(["billing"], empty_registry());
    state.mark_dep_resolved("does-not-exist");
    assert!(!state.all_deps_resolved());
    let report = state.evaluate().await;
    assert!(!report.ready);
    assert_eq!(report.unresolved_deps, vec!["billing"]);
}

#[tokio::test]
async fn unhealthy_check_forces_not_ready() {
    let state = ReadinessState::new(
        Vec::<String>::new(),
        registry_with(
            "cache",
            "cache-warm",
            HealthcheckResult::unhealthy("cache cold"),
        ),
    );

    state.mark_startup_complete();
    let report = state.evaluate().await;
    let health = state.health_report().await;
    assert!(!report.ready);
    assert_eq!(report.state, ReadinessLifecycle::Starting);
    assert_eq!(health.status, HealthcheckStatus::Unhealthy);
    assert_eq!(health.components.len(), 1);
    assert_eq!(health.components[0].check, "cache-warm");
}

#[tokio::test]
async fn degraded_check_stays_ready_but_reported() {
    let state = ReadinessState::new(
        Vec::<String>::new(),
        registry_with(
            "indexer",
            "index",
            HealthcheckResult::degraded("rebuilding index"),
        ),
    );

    state.mark_startup_complete();
    let report = state.evaluate().await;
    let health = state.health_report().await;
    assert!(report.ready, "degraded must still be ready (200)");
    assert_eq!(report.state, ReadinessLifecycle::Degraded);
    assert_eq!(health.status, HealthcheckStatus::Degraded);
    assert_eq!(health.components.len(), 1);
    assert_eq!(health.components[0].check, "index");
}

#[tokio::test]
async fn unresolved_dep_beats_healthy_check() {
    let state = ReadinessState::new(
        ["billing"],
        registry_with("gear", "ok", HealthcheckResult::healthy()),
    );
    state.mark_startup_complete();
    let report = state.evaluate().await;
    let health = state.health_report().await;
    assert!(
        !report.ready,
        "an unresolved dep must gate readiness even when checks are healthy"
    );
    assert_eq!(health.status, HealthcheckStatus::Healthy);
}

#[tokio::test]
async fn draining_flips_to_not_ready() {
    let state = ReadinessState::new(Vec::<String>::new(), empty_registry());
    state.mark_startup_complete();
    assert!(state.evaluate().await.ready);

    state.set_draining(true);
    let report = state.evaluate().await;
    assert!(!report.ready);
    assert_eq!(report.state, ReadinessLifecycle::Draining);
}