isb-apps 1.5.2

isb's apps over stacks: deployments, builds, jobs, backups, templates and notifications. Use the `isb` crate.
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
use super::*;
use crate::client::Client;
use crate::stack::Controller;
use std::io::{Read, Write};
use std::net::TcpListener;
use std::sync::atomic::AtomicU16;

/// A service over a controller with no incusd behind it.
fn service(dir: &Path) -> (Monitors, Controller) {
    let k = crate::secrets::Keyring::new(age::x25519::Identity::generate(), vec![]);
    let secrets = Arc::new(Secrets::new(crate::secrets::LocalDriver::new(
        dir,
        Arc::new(k),
    )));
    let client = Client::with_socket("/nonexistent/isb-test/incus.sock");
    let store = crate::stack::Store::open(dir).unwrap();
    let ctl = Controller::start(
        client.clone(),
        store,
        Duration::from_secs(60),
        secrets.clone(),
    )
    .unwrap();
    let apps = Apps::new(dir, client, ctl.clone(), secrets.clone());
    let m = Monitors::new(
        dir,
        apps,
        secrets,
        Arc::new(|| true),
        Some("https://isb.example.com/".into()),
    );
    (m, ctl)
}

/// An HTTP server answering with whatever status `status` holds.
fn flappy() -> (u16, Arc<AtomicU16>) {
    let l = TcpListener::bind("127.0.0.1:0").unwrap();
    let port = l.local_addr().unwrap().port();
    let status = Arc::new(AtomicU16::new(200));
    let st = status.clone();
    std::thread::spawn(move || {
        for s in l.incoming() {
            let Ok(mut s) = s else { continue };
            let mut b = [0u8; 4096];
            let _ = s.read(&mut b);
            let code = st.load(Ordering::SeqCst);
            let _ = write!(s, "HTTP/1.1 {code} X\r\nContent-Length: 2\r\n\r\nok");
        }
    });
    (port, status)
}

fn kinds(ctl: &Controller) -> Vec<(String, String)> {
    ctl.events(0, 1000)
        .1
        .into_iter()
        .filter_map(|e| Some((e.kind?, e.message)))
        .filter(|(k, _)| k.starts_with("monitor."))
        .collect()
}

#[test]
fn down_once_up_once_with_details() {
    let dir = tempfile::tempdir().unwrap();
    let (svc, ctl) = service(dir.path());
    let org = OrgId::new("acme").unwrap();
    let (port, status) = flappy();
    let mut m = Monitor::new("shop", Kind::Http);
    m.url = Some(format!("http://127.0.0.1:{port}/?token=s3cret"));
    m.interval = 30;
    svc.create(&org, m.clone()).unwrap();
    let run = |n: usize| {
        for _ in 0..n {
            let o = svc.check(&org, &m);
            svc.record(&org, &m, o).unwrap();
        }
    };
    run(2);
    assert!(kinds(&ctl).is_empty());
    status.store(503, Ordering::SeqCst);
    run(5);
    let k = kinds(&ctl);
    assert_eq!(k.len(), 1, "{k:?}");
    assert_eq!(k[0].0, "monitor.down");
    assert!(k[0].1.contains("HTTP 503 (expected 200-399)"), "{}", k[0].1);
    // The query (a token, maybe) is never in a message.
    assert!(!k[0].1.contains("s3cret"));
    let d = svc.details(&org, "monitor.down", &k[0].1).unwrap();
    assert_eq!(d["status"], 503);
    assert_eq!(d["monitor"], "shop");
    assert_eq!(d["link"], "https://isb.example.com/orgs/acme/uptime/shop");
    assert!(d["latency_ms"].is_u64());
    status.store(200, Ordering::SeqCst);
    run(4);
    let k = kinds(&ctl);
    assert_eq!(
        k.iter().map(|x| x.0.as_str()).collect::<Vec<_>>(),
        ["monitor.down", "monitor.up"]
    );
    let d = svc.details(&org, "monitor.up", &k[1].1).unwrap();
    assert!(d["downtime_ms"].is_u64() && d["downtime"].is_string());
    // One incident, closed; eleven checks kept.
    let db = svc.db(&org).unwrap();
    let db = db.lock().unwrap();
    let inc = db.incidents(None, 10, now_ms()).unwrap();
    assert_eq!(inc.len(), 1);
    assert!(inc[0].ended.is_some());
    assert_eq!(db.recent("shop", 100).unwrap().len(), 11);
    // Events go to the org's `@monitors` stack, service = the monitor.
    let e = ctl.events(0, 1000).1;
    let e = e
        .iter()
        .find(|e| e.kind.as_deref() == Some("monitor.up"))
        .unwrap();
    assert_eq!(
        (e.stack.as_str(), e.service.as_str()),
        ("acme/@monitors", "shop")
    );
}

#[test]
fn edits_pause_and_delete() {
    let dir = tempfile::tempdir().unwrap();
    let (svc, _) = service(dir.path());
    let org = OrgId::new("acme").unwrap();
    let mut m = Monitor::new("db", Kind::Tcp);
    (m.host, m.port) = (Some("db.example.com".into()), Some(5432));
    svc.create(&org, m.clone()).unwrap();
    assert!(svc.create(&org, m.clone()).is_err(), "duplicate");
    let mut p = serde_json::Map::new();
    p.insert("interval".into(), json!(120));
    p.insert("auto".into(), json!(true));
    let n = svc.update(&org, "db", p).unwrap();
    assert_eq!(n.interval, 120);
    assert!(!n.auto, "auto is not the caller's to set");
    let mut p = serde_json::Map::new();
    p.insert("interval".into(), Value::Null);
    assert_eq!(svc.update(&org, "db", p).unwrap().interval, 60);
    let mut p = serde_json::Map::new();
    p.insert("keyword".into(), json!("x"));
    assert!(
        svc.update(&org, "db", p).is_err(),
        "a keyword on a tcp monitor"
    );
    let mut p = serde_json::Map::new();
    p.insert("name".into(), json!("db2"));
    assert!(svc.update(&org, "db", p).is_err());
    assert!(svc.set_paused(&org, "db", true).unwrap().paused);
    // A paused monitor's results are dropped.
    svc.record(
        &org,
        &m,
        Outcome {
            at: 1,
            ..Default::default()
        },
    )
    .unwrap();
    assert!(svc.stored(&org, "db").unwrap().last.is_none());
    assert!(!svc.set_paused(&org, "db", false).unwrap().paused);
    // Secrets and apps must exist.
    let mut h = Monitor::new("h", Kind::Http);
    h.url = Some("https://a.example.com/".into());
    h.headers = vec![super::super::Header {
        name: "X-Key".into(),
        value: None,
        secret: Some("NOPE".into()),
    }];
    assert!(
        svc.create(&org, h)
            .unwrap_err()
            .to_string()
            .contains("no secret NOPE")
    );
    let mut a = Monitor::new("a", Kind::App);
    a.app = Some("ghost".into());
    assert!(svc.create(&org, a).is_err());
    svc.delete(&org, "db").unwrap();
    assert!(svc.get(&org, "db").is_err());
    assert!(svc.list(&OrgId::new("beta").unwrap()).unwrap().is_empty());
}

#[test]
fn an_apps_own_monitor_stays_deleted() {
    let dir = tempfile::tempdir().unwrap();
    let (svc, _) = service(dir.path());
    let org = OrgId::default_org();
    // An auto monitor whose app is gone is removed by the sync.
    let mut m = Monitor::new("app-shop", Kind::App);
    m.app = Some("shop".into());
    m.auto = true;
    svc.save(&org, &[m.clone()]).unwrap();
    svc.sync_auto(&org).unwrap();
    assert!(svc.list(&org).unwrap().is_empty());
    // Deleting one excludes its app from then on.
    svc.save(&org, &[m]).unwrap();
    svc.delete(&org, "app-shop").unwrap();
    assert_eq!(svc.settings(&org).unwrap().exclude_apps, ["shop"]);
    assert!(svc.orgs().contains(&org));
}

#[test]
fn the_scheduler_queues_each_check_once() {
    let dir = tempfile::tempdir().unwrap();
    let (svc, _) = service(dir.path());
    let org = OrgId::new("acme").unwrap();
    for n in ["a", "b", "c"] {
        let mut m = Monitor::new(n, Kind::Tcp);
        (m.host, m.port) = (Some("127.0.0.1".into()), Some(9));
        svc.create(&org, m).unwrap();
    }
    svc.set_paused(&org, "c", true).unwrap();
    let (tx, rx) = std::sync::mpsc::sync_channel(QUEUE);
    // Created monitors are due within a second.
    let now = now_ms() + 2000;
    svc.tick(now, &tx);
    let got: Vec<String> = rx.try_iter().map(|j| j.monitor.name).collect();
    assert_eq!(got, ["a", "b"]);
    // Running checks are not queued again.
    svc.tick(now + 5000, &tx);
    assert_eq!(rx.try_iter().count(), 0);
    // A full queue leaves the rest for the next tick.
    let (tx1, rx1) = std::sync::mpsc::sync_channel(1);
    svc.inner
        .slots
        .lock()
        .unwrap()
        .values_mut()
        .for_each(|s| s.running = false);
    svc.tick(now + 6000, &tx1);
    assert_eq!(rx1.try_iter().count(), 1);
    // A deleted monitor's slot goes.
    svc.delete(&org, "a").unwrap();
    svc.tick(now + 7000, &tx);
    assert!(
        !svc.inner
            .slots
            .lock()
            .unwrap()
            .keys()
            .any(|(_, n)| n == "a")
    );
    // A first check's phase is within the interval (a minute at most).
    assert!(jitter(0) == 0 && jitter(100).abs() <= 100);
}

#[test]
fn certificates_are_warned_about_once() {
    let dir = tempfile::tempdir().unwrap();
    let (svc, _) = service(dir.path());
    let mut m = Monitor::new("x", Kind::Http);
    m.url = Some("https://a.example.com/".into());
    let mut s = State::default();
    let now = 1_800_000_000_000u64;
    let o = |days: u64| Outcome {
        at: now,
        ok: true,
        cert_expires: Some(now / 1000 + days * 86_400 + 60),
        url: Some("https://a.example.com/".into()),
        ..Default::default()
    };
    assert_eq!(svc.cert_due(&m, &o(30), &mut s), None);
    assert_eq!(svc.cert_due(&m, &o(9), &mut s), Some(9));
    assert_eq!(
        svc.cert_due(&m, &o(9), &mut s),
        None,
        "once per certificate"
    );
    assert_eq!(
        svc.cert_due(&m, &o(8), &mut s),
        Some(8),
        "a new certificate"
    );
    m.cert_expiry_days = 0;
    assert_eq!(svc.cert_due(&m, &o(1), &mut s), None);
    let msg = cert_message(&m, &o(9), 9);
    assert!(msg.contains("expires in 9 days (2027-01-"), "{msg}");
    assert_eq!(civil(0), (1970, 1, 1));
    assert_eq!(
        civil(super::super::probe::days_from_civil(2024, 2, 29)),
        (2024, 2, 29)
    );
}

#[test]
fn messages() {
    let mut m = Monitor::new("web", Kind::Tcp);
    (m.host, m.port) = (Some("db".into()), Some(5432));
    let o = Outcome {
        error: Some("timed out connecting".into()),
        ..Default::default()
    };
    let d = down_message(&m, &o, 2, false);
    assert_eq!(
        d,
        "Monitor web is DOWN: db:5432: timed out connecting (2 failed checks in a row)"
    );
    assert!(down_message(&m, &o, 1, true).contains("flapping"));
    let o = Outcome {
        latency_ms: Some(12),
        url: Some("db:5432".into()),
        ..Default::default()
    };
    assert_eq!(
        up_message(&m, &o, 252_000),
        "Monitor web is UP again after 4m 12s: db:5432 answered in 12 ms"
    );
}

fn failed(at: u64) -> Outcome {
    Outcome {
        at,
        ok: false,
        error: Some("connection refused".into()),
        ..Default::default()
    }
}

#[test]
fn failures_before_the_first_success_are_pending_not_downtime() {
    let dir = tempfile::tempdir().unwrap();
    let (svc, ctl) = service(dir.path());
    let org = OrgId::new("acme").unwrap();
    let (port, status) = flappy();
    status.store(503, Ordering::SeqCst);
    let mut m = Monitor::new("shop", Kind::Http);
    m.url = Some(format!("http://127.0.0.1:{port}/"));
    svc.create(&org, m.clone()).unwrap();
    let run = |n: usize| {
        for _ in 0..n {
            let o = svc.check(&org, &m);
            svc.record(&org, &m, o).unwrap();
        }
    };
    run(5);
    let s = svc.summary(&org, &m).unwrap();
    assert_eq!(s["status"], "pending");
    assert_eq!(s["never_up"], false);
    assert!(s["incident"].is_null());
    assert_eq!(s["uptime"]["24h"], Value::Null);
    assert!(kinds(&ctl).is_empty(), "{:?}", kinds(&ctl));
    {
        let db = svc.db(&org).unwrap();
        let db = db.lock().unwrap();
        assert!(db.incidents(None, 10, now_ms()).unwrap().is_empty());
        assert!(db.recent("shop", 10).unwrap().iter().all(|c| c.pending));
    }
    // The first success: up, quietly, and 100% (the pending ones count for nothing).
    status.store(200, Ordering::SeqCst);
    run(1);
    let s = svc.summary(&org, &m).unwrap();
    assert_eq!(s["status"], "up");
    assert_eq!(s["uptime"]["24h"], 100.0);
    assert!(kinds(&ctl).is_empty());
    // Real downtime after that pages as usual.
    status.store(503, Ordering::SeqCst);
    run(2);
    let k = kinds(&ctl);
    assert_eq!(k.len(), 1, "{k:?}");
    assert_eq!(k[0].0, "monitor.down");
}

#[test]
fn a_monitor_that_never_comes_up_says_so_once() {
    let dir = tempfile::tempdir().unwrap();
    let (svc, ctl) = service(dir.path());
    let org = OrgId::new("acme").unwrap();
    let mut m = Monitor::new("db", Kind::Tcp);
    (m.host, m.port) = (Some("db.example.com".into()), Some(5432));
    svc.create(&org, m.clone()).unwrap();
    let t0 = now_ms();
    svc.record(&org, &m, failed(t0)).unwrap();
    svc.record(&org, &m, failed(t0 + 10 * 60_000)).unwrap();
    assert!(kinds(&ctl).is_empty());
    let late = t0 + super::super::state::NEVER_UP_MS + 1000;
    svc.record(&org, &m, failed(late)).unwrap();
    svc.record(&org, &m, failed(late + 60_000)).unwrap();
    let k = kinds(&ctl);
    assert_eq!(k.len(), 1, "{k:?}");
    assert_eq!(k[0].0, "monitor.down");
    assert!(k[0].1.contains("never came up"), "{}", k[0].1);
    let d = svc.details(&org, "monitor.down", &k[0].1).unwrap();
    assert_eq!(d["never_up"], true);
    let s = svc.summary(&org, &m).unwrap();
    assert_eq!(
        (s["status"].as_str(), s["never_up"].as_bool()),
        (Some("pending"), Some(true))
    );
    // Its first success clears the flag, closes the incident and says up.
    let ok = Outcome {
        at: late + 120_000,
        ok: true,
        latency_ms: Some(5),
        ..Default::default()
    };
    svc.record(&org, &m, ok).unwrap();
    let k = kinds(&ctl);
    assert_eq!(
        k.iter().map(|x| x.0.as_str()).collect::<Vec<_>>(),
        ["monitor.down", "monitor.up"]
    );
    let db = svc.db(&org).unwrap();
    let inc = db.lock().unwrap().incidents(None, 10, now_ms()).unwrap();
    assert_eq!(inc.len(), 1);
    assert!(inc[0].ended.is_some());
}

#[test]
fn an_app_monitor_waits_for_a_live_deployment() {
    let dir = tempfile::tempdir().unwrap();
    let (svc, ctl) = service(dir.path());
    let org = OrgId::new("acme").unwrap();
    let mut m = Monitor::new("app-web", Kind::App);
    m.app = Some("web".into());
    m.auto = true;
    svc.save(&org, &[m.clone()]).unwrap();
    // No app, so nothing live: the check is a wait, kept as pending.
    let o = svc.check(&org, &m);
    assert_eq!(o.error.as_deref(), Some(WAITING_FOR_APP));
    svc.record(&org, &m, o).unwrap();
    let st = svc.stored(&org, "app-web").unwrap();
    assert_eq!(st.state.status, Status::Pending);
    assert!(kinds(&ctl).is_empty());
    let db = svc.db(&org).unwrap();
    let c = db.lock().unwrap().recent("app-web", 5).unwrap();
    assert!(c[0].pending);
}