OXYGENHUB
# 59338826539c oxygenhub / crates / hub / tests / flow.rs
130.6 KiB · Rust · last changed Pin oxygenflow 08d0082d: artifacts when "always" 1 month ago source blame history raw
1
//! OxygenFlow on the hub (hub spec §13.2), end to end: a real `oxy` push
2
//! starts a run, a runner claims jobs through the API in dependency order,
3
//! job tokens read only their repository, results become checks and pages.
4
5
use axum::body::Body;
6
use axum::http::{header, Request, StatusCode};
7
use http_body_util::BodyExt;
8
use oxy_core::protocol::{open_remote, RemoteOptions};
9
use oxy_core::repo::Repo;
10
use oxygenhub::config::Config;
11
use oxygenhub::repos::RepoName;
12
use oxygenhub::{db, Shared};
13
use std::path::Path;
14
use tower::ServiceExt;
15
16
const ROOTFS: &str = "36fc4e3238044e424219a2b9002bf61bbe1805fec14d52cf37e17fae77c9ff16";
17
18
fn hermetic() {
19
    static ONCE: std::sync::Once = std::sync::Once::new();
20
    static DIR: std::sync::OnceLock<tempfile::TempDir> = std::sync::OnceLock::new();
21
    ONCE.call_once(|| {
22
        let d = tempfile::tempdir().unwrap();
23
        std::env::set_var("OXY_HOME", d.path());
24
        DIR.set(d).ok();
25
    });
26
}
27
28
fn write(root: &Path, rel: &str, content: &str) {
29
    let p = root.join(rel);
30
    std::fs::create_dir_all(p.parent().unwrap()).unwrap();
31
    std::fs::write(p, content).unwrap();
32
}
33
34
struct Hub {
35
    app: Shared,
36
    base: String,
37
    _dir: tempfile::TempDir,
38
}
39
40
async fn hub() -> Hub {
41
    hermetic();
42
    let dir = tempfile::tempdir().unwrap();
43
    let mut config = Config::load(dir.path()).unwrap();
44
    config.auth.push_tokens = vec!["site".into()];
45
    config.flow.runner_tokens = vec!["runner-secret".into(), "runner-two".into(), "runner-three".into()];
46
    config.flow.repos = vec!["andy/*".into()];
47
    config.registration.mode = "open".into();
48
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
49
    let port = listener.local_addr().unwrap().port();
50
    config.server.base_url = format!("http://127.0.0.1:{port}");
51
    let app = oxygenhub::build(config).await.unwrap();
52
    let router = oxygenhub::router(app.clone());
53
    tokio::spawn(async move { axum::serve(listener, router).await.unwrap() });
54
    Hub { app, base: format!("http://127.0.0.1:{port}"), _dir: dir }
55
}
56
57
async fn call(app: &Shared, method: &str, path: &str, bearer: Option<&str>, json: Option<String>) -> (StatusCode, String) {
58
    let mut req = Request::builder().method(method).uri(path);
59
    if let Some(b) = bearer {
60
        req = req.header(header::AUTHORIZATION, format!("Bearer {b}"));
61
    }
62
    let body = match json {
63
        Some(j) => {
64
            req = req.header(header::CONTENT_TYPE, "application/json");
65
            Body::from(j)
66
        }
67
        None => Body::empty(),
68
    };
69
    let res = oxygenhub::router(app.clone()).oneshot(req.body(body).unwrap()).await.unwrap();
70
    let status = res.status();
71
    let bytes = res.into_body().collect().await.unwrap().to_bytes();
72
    (status, String::from_utf8_lossy(&bytes).into_owned())
73
}
74
75
/// A GET's status, `Location` and `Content-Type`.
76
async fn head(app: &Shared, path: &str) -> (StatusCode, String, String) {
77
    let res = oxygenhub::router(app.clone()).oneshot(Request::get(path).body(Body::empty()).unwrap()).await.unwrap();
78
    let h = |k: header::HeaderName| res.headers().get(k).and_then(|v| v.to_str().ok()).unwrap_or("").to_string();
79
    (res.status(), h(header::LOCATION), h(header::CONTENT_TYPE))
80
}
81
82
async fn claim(app: &Shared) -> Option<serde_json::Value> {
83
    let (st, body) =
84
        call(app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(r#"{"runner":"test-1","runtimes":["microvm"]}"#.into())).await;
85
    match st {
86
        StatusCode::NO_CONTENT => None,
87
        StatusCode::OK => Some(serde_json::from_str(&body).unwrap()),
88
        other => panic!("claim: {other} {body}"),
89
    }
90
}
91
92
fn receipt(job: &str, pipeline_hash: &str, exit: u32) -> serde_json::Value {
93
    serde_json::json!({
94
        "job_name": job, "pipeline_hash": pipeline_hash, "scope_tree_hash": "11".repeat(32),
95
        "inputs": [], "environment": "22".repeat(32), "outputs": [], "exit_code": exit, "duration_ms": 640
96
    })
97
}
98
99
async fn finish(app: &Shared, id: i64, body: serde_json::Value) -> StatusCode {
100
    call(app, "POST", &format!("/api/v1/flow/jobs/{id}/finish"), Some("runner-secret"), Some(body.to_string())).await.0
101
}
102
103
async fn create(app: &Shared, owner: &str, name: &str) {
104
    app.repos.create(&RepoName::parse(&format!("{owner}/{name}")).unwrap(), None).unwrap();
105
    db::repos::create(&app.db, owner, name, "", hub_api::Visibility::Public).await.unwrap();
106
}
107
108
fn client(url: &str, work: &Path) -> Repo {
109
    let mut c = Repo::init(work).unwrap();
110
    c.config.set("remote.origin.url", url).unwrap();
111
    c.config.set("remote.origin.token", "site").unwrap();
112
    c.save_config().unwrap();
113
    c
114
}
115
116
fn pipeline(extra: &str) -> String {
117
    format!(
118
        "schema-version 1\nsandbox \"alpine\" {{\n    rootfs \"cas://blob/{ROOTFS}\"\n}}\njob \"build\" {{\n    sandbox \"alpine\"\n    exec \"make\"\n}}\njob \"test\" {{\n    sandbox \"alpine\"\n    depends-on \"build\"\n    exec \"sh\" \"-eu\" \"test.sh\"\n}}\njob \"lint\" {{\n    sandbox \"alpine\"\n    exec \"true\"\n}}\n{extra}"
119
    )
120
}
121
122
async fn runs_of(app: &Shared, owner: &str, name: &str) -> Vec<db::flow::Run> {
123
    let row = db::repos::get(&app.db, owner, name).await.unwrap().unwrap();
124
    for _ in 0..100 {
125
        let r = db::flow::runs(&app.db, row.id, 10, None).await.unwrap();
126
        if !r.is_empty() {
127
            return r;
128
        }
129
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
130
    }
131
    vec![]
132
}
133
134
/// The checks on a state once there are `n` of them (they follow the run).
135
async fn checks_when(app: &Shared, repo_id: i64, state: &str, n: usize) -> Vec<db::hooks::Check> {
136
    for _ in 0..100 {
137
        let c = db::hooks::checks_for_state(&app.db, repo_id, state).await.unwrap();
138
        if c.len() >= n {
139
            return c;
140
        }
141
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
142
    }
143
    db::hooks::checks_for_state(&app.db, repo_id, state).await.unwrap()
144
}
145
146
#[tokio::test(flavor = "multi_thread")]
147
async fn a_push_runs_the_pipeline_through_a_runner() {
148
    let h = hub().await;
149
    create(&h.app, "andy", "demo").await;
150
    create(&h.app, "andy", "secret").await;
151
    create(&h.app, "other", "plain").await;
152
    let url = format!("{}/andy/demo", h.base);
153
    let work = tempfile::tempdir().unwrap();
154
    let mut c = client(&url, work.path());
155
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
156
    write(work.path(), "test.sh", "echo ok\n");
157
    c.snapshot("test").unwrap();
158
    c.commit("Add a pipeline", &[]).unwrap();
159
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
160
161
    // The push started a run with three queued jobs, and checks for them.
162
    let runs = runs_of(&h.app, "andy", "demo").await;
163
    assert_eq!(runs.len(), 1);
164
    let run = &runs[0];
165
    assert_eq!((run.bookmark.as_str(), run.status.as_str(), run.actor.as_str()), ("main", "queued", "site token"));
166
    assert_eq!(run.pipeline_hash.len(), 64);
167
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
168
    assert_eq!(jobs.iter().map(|j| (j.name.as_str(), j.depth)).collect::<Vec<_>>(), [("build", 0), ("lint", 0), ("test", 1)]);
169
    // The checks are reported just after the run is recorded.
170
    let checks = checks_when(&h.app, run.repo_id, &run.state, 3).await;
171
    assert_eq!(
172
        checks.iter().map(|c| (c.name.as_str(), c.status.as_str())).collect::<Vec<_>>(),
173
        [("flow/build", "queued"), ("flow/lint", "queued"), ("flow/test", "queued")]
174
    );
175
176
    // Runners need a runner token.
177
    assert_eq!(
178
        call(&h.app, "POST", "/api/v1/flow/claim", Some("site"), Some(r#"{"runner":"x","runtimes":["microvm"]}"#.into())).await.0,
179
        StatusCode::UNAUTHORIZED
180
    );
181
    assert_eq!(
182
        call(&h.app, "POST", "/api/v1/flow/claim", None, Some(r#"{"runner":"x","runtimes":["microvm"]}"#.into())).await.0,
183
        StatusCode::UNAUTHORIZED
184
    );
185
    // A runner without the tier gets nothing.
186
    let (st, _) =
187
        call(&h.app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(r#"{"runner":"x","runtimes":["wasm"]}"#.into())).await;
188
    assert_eq!(st, StatusCode::NO_CONTENT);
189
190
    // Claims come in dependency order; `test` waits for `build`.
191
    let a = claim(&h.app).await.unwrap();
192
    let b = claim(&h.app).await.unwrap();
193
    assert_eq!((a["job"]["name"].as_str(), b["job"]["name"].as_str()), (Some("build"), Some("lint")));
194
    assert!(claim(&h.app).await.is_none(), "test waits for build");
195
    assert_eq!(a["repo"], "andy/demo");
196
    assert_eq!(a["clone_url"], url.as_str());
197
    assert_eq!(a["sandbox"]["rootfs"], ROOTFS);
198
    assert_eq!(a["job"]["exec"], serde_json::json!(["make"]));
199
    assert_eq!(a["timeout_s"], 3600);
200
    // The job is told what it builds (FLOW_STATE, FLOW_BOOKMARK, FLOW_RUN).
201
    assert_eq!(
202
        (a["state"].as_str(), a["bookmark"].as_str(), a["run_number"].as_i64()),
203
        (Some(run.state.as_str()), Some("main"), Some(run.number))
204
    );
205
    let heads: Vec<String> = a["heads"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_string()).collect();
206
    assert_eq!(heads.join("+"), run.heads);
207
    let checks = db::hooks::checks_for_state(&h.app.db, run.repo_id, &run.state).await.unwrap();
208
    assert_eq!(checks.iter().find(|c| c.name == "flow/build").unwrap().status, "running");
209
210
    // The job token reads this repository over the wire, and nothing else.
211
    let token = a["token"].as_str().unwrap().to_string();
212
    assert!(token.starts_with("flowjob_"));
213
    let opts = RemoteOptions { token: Some(token.clone()), ca: None, repo_id: None, cache_dir: None };
214
    open_remote(&url, &opts).unwrap().refs().unwrap();
215
    assert!(open_remote(&format!("{}/andy/secret", h.base), &opts).unwrap().refs().is_err(), "another repository");
216
    let bad = RemoteOptions { token: Some("flowjob_00".into()), ca: None, repo_id: None, cache_dir: None };
217
    assert!(open_remote(&url, &bad).unwrap().refs().is_err(), "an unknown job token");
218
    // … and cannot push.
219
    c.config.set("remote.origin.token", &token).unwrap();
220
    c.save_config().unwrap();
221
    write(work.path(), "more.txt", "x\n");
222
    c.snapshot("test").unwrap();
223
    c.commit("More", &[]).unwrap();
224
    let pushed = c.push("origin", false);
225
    assert!(pushed.is_err() || pushed.unwrap().iter().all(|r| !r.ok), "a job token cannot push");
226
    c.config.set("remote.origin.token", "site").unwrap();
227
    c.save_config().unwrap();
228
229
    // Logs, then results with receipts.
230
    let a_id = a["job_id"].as_i64().unwrap();
231
    let b_id = b["job_id"].as_i64().unwrap();
232
    let log = serde_json::json!({ "records": [
233
        { "t": 5, "stream": "flow", "text": "booting" },
234
        { "t": 120, "stream": "out", "text": "cc -o demo demo.c" },
235
        { "t": 130, "stream": "weird", "text": "x".repeat(20_000) },
236
    ]});
237
    assert_eq!(
238
        call(&h.app, "POST", &format!("/api/v1/flow/jobs/{a_id}/log"), Some("runner-secret"), Some(log.to_string())).await.0,
239
        StatusCode::NO_CONTENT
240
    );
241
    let lines = db::flow::log(&h.app.db, a_id, 0, 100).await.unwrap();
242
    assert_eq!(lines.len(), 3);
243
    assert_eq!((lines[2].stream.as_str(), lines[2].text.len()), ("console", 16 * 1024), "streams are known ones, text is capped");
244
    let ph = a["pipeline_hash"].as_str().unwrap();
245
    assert_eq!(
246
        finish(&h.app, a_id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": receipt("lint", ph, 0) })).await,
247
        StatusCode::BAD_REQUEST,
248
        "a receipt for another job"
249
    );
250
    assert_eq!(
251
        finish(&h.app, a_id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": receipt("build", ph, 0) })).await,
252
        StatusCode::NO_CONTENT
253
    );
254
    assert_eq!(finish(&h.app, a_id, serde_json::json!({ "exit_code": 0, "duration_ms": 700 })).await, StatusCode::CONFLICT, "only once");
255
    assert!(open_remote(&url, &opts).unwrap().refs().is_err(), "the token ends with its job");
256
    assert_eq!(
257
        finish(&h.app, b_id, serde_json::json!({ "exit_code": 0, "duration_ms": 300, "receipt": receipt("lint", ph, 0) })).await,
258
        StatusCode::NO_CONTENT
259
    );
260
    let t = claim(&h.app).await.unwrap();
261
    assert_eq!(t["job"]["name"], "test");
262
    let t_id = t["job_id"].as_i64().unwrap();
263
    assert_eq!(
264
        finish(&h.app, t_id, serde_json::json!({ "exit_code": 3, "duration_ms": 500, "receipt": receipt("test", ph, 3) })).await,
265
        StatusCode::NO_CONTENT
266
    );
267
268
    let run = db::flow::run_by_id(&h.app.db, run.id).await.unwrap().unwrap();
269
    assert_eq!(run.status, "failed");
270
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
271
    let build = jobs.iter().find(|j| j.name == "build").unwrap();
272
    assert_eq!((build.status.as_str(), build.exit_code, build.receipt_hash.len()), ("passed", Some(0), 64));
273
    assert_eq!(jobs.iter().find(|j| j.name == "test").unwrap().status, "failed");
274
    let checks = db::hooks::checks_for_state(&h.app.db, run.repo_id, &run.state).await.unwrap();
275
    assert_eq!(
276
        checks.iter().map(|c| (c.name.as_str(), c.status.as_str())).collect::<Vec<_>>(),
277
        [("flow/build", "passed"), ("flow/lint", "passed"), ("flow/test", "failed")]
278
    );
279
    assert!(checks[2].summary.contains("exit 3") && checks[2].url.ends_with(&format!("/andy/demo/flow/{}", run.number)));
280
281
    // Pages: the list, the run with its graph and logs, and the live view.
282
    let (st, list) = call(&h.app, "GET", "/andy/demo/flow", None, None).await;
283
    assert_eq!(st, StatusCode::OK);
284
    assert!(list.contains(&format!("/andy/demo/flow/{}", run.number)) && list.contains("st-failed"), "{list}");
285
    let (st, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", run.number), None, None).await;
286
    assert_eq!(st, StatusCode::OK);
287
    assert!(page.contains("<svg class=\"flow-graph\""), "graph");
288
    assert_eq!(page.matches("data-job-node=").count(), 3);
289
    assert_eq!(page.matches("<path class=\"edge").count(), 1, "one dependency edge");
290
    assert!(page.contains("cc -o demo demo.c"), "log shown");
291
    assert!(!page.contains("data-flow-live"), "a finished run does not poll");
292
    let (st, live) = call(&h.app, "GET", &format!("/andy/demo/flow/{}/live?after={a_id}:1", run.number), None, None).await;
293
    assert_eq!(st, StatusCode::OK);
294
    let live: serde_json::Value = serde_json::from_str(&live).unwrap();
295
    assert_eq!(live["status"], "failed");
296
    let build_live = live["jobs"].as_array().unwrap().iter().find(|j| j["name"] == "build").unwrap().clone();
297
    assert_eq!(build_live["lines"].as_array().unwrap().len(), 2, "lines after seq 1");
298
    assert_eq!(call(&h.app, "GET", "/andy/demo/flow/999", None, None).await.0, StatusCode::NOT_FOUND);
299
300
    // A failed dependency skips what follows; an unrun job is an error.
301
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
302
    write(work.path(), "test.sh", "echo changed\n");
303
    c.snapshot("test").unwrap();
304
    c.commit("Change the test", &[]).unwrap();
305
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
306
    let mut second = None;
307
    for _ in 0..100 {
308
        let r = runs_of(&h.app, "andy", "demo").await;
309
        if r.len() == 2 {
310
            second = Some(r[0].clone());
311
            break;
312
        }
313
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
314
    }
315
    let second = second.expect("a second run");
316
    let x = claim(&h.app).await.unwrap();
317
    let y = claim(&h.app).await.unwrap();
318
    let (build_id, lint_id) = if x["job"]["name"] == "build" {
319
        (x["job_id"].as_i64().unwrap(), y["job_id"].as_i64().unwrap())
320
    } else {
321
        (y["job_id"].as_i64().unwrap(), x["job_id"].as_i64().unwrap())
322
    };
323
    assert_eq!(
324
        finish(&h.app, build_id, serde_json::json!({ "exit_code": null, "duration_ms": 10, "error": "rootfs is not on this runner" }))
325
            .await,
326
        StatusCode::NO_CONTENT
327
    );
328
    assert_eq!(finish(&h.app, lint_id, serde_json::json!({ "exit_code": 0, "duration_ms": 10 })).await, StatusCode::NO_CONTENT);
329
    assert!(claim(&h.app).await.is_none(), "test was skipped");
330
    let jobs = db::flow::jobs(&h.app.db, second.id).await.unwrap();
331
    assert_eq!(
332
        jobs.iter().map(|j| (j.name.as_str(), j.status.as_str())).collect::<Vec<_>>(),
333
        [("build", "error"), ("lint", "passed"), ("test", "skipped")]
334
    );
335
    assert_eq!(db::flow::run_by_id(&h.app.db, second.id).await.unwrap().unwrap().status, "failed");
336
337
    // An invalid pipeline is a run in error with the line.
338
    write(work.path(), ".flow/pipeline.kdl", &pipeline("job \"broken\" {\n    sandbox \"missing\"\n    exec \"x\"\n}\n"));
339
    c.snapshot("test").unwrap();
340
    c.commit("Break the pipeline", &[]).unwrap();
341
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
342
    let mut third = None;
343
    for _ in 0..100 {
344
        let r = runs_of(&h.app, "andy", "demo").await;
345
        if r.len() == 3 {
346
            third = Some(r[0].clone());
347
            break;
348
        }
349
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
350
    }
351
    let third = third.expect("a third run");
352
    assert_eq!(third.status, "error");
353
    assert!(third.error.contains("line 18") && third.error.contains("\"missing\""), "{}", third.error);
354
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", third.number), None, None).await;
355
    assert!(page.contains("The pipeline is not valid"));
356
357
    // State stamps (hub spec §13.2) and images in READMEs.
358
    write(work.path(), "README.md", "# Demo\n\n[![flow](.flow/stamp)](.flow/run)\n\n![logo](img/logo.png)\n");
359
    std::fs::create_dir_all(work.path().join("img")).unwrap();
360
    std::fs::write(work.path().join("img/logo.png"), b"\x89PNG\r\n\x1a\n\0\0\0\rIHDR\0\0\0\x01\0\0\0\x01\x08\x06\0\0\0\x1f\x15\xc4\x89")
361
        .unwrap();
362
    c.snapshot("test").unwrap();
363
    c.commit("A README with a stamp", &[]).unwrap();
364
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
365
    let mut fourth = None;
366
    for _ in 0..100 {
367
        let r = runs_of(&h.app, "andy", "demo").await;
368
        if r.len() == 4 {
369
            fourth = Some(r[0].clone());
370
            break;
371
        }
372
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
373
    }
374
    let fourth = fourth.expect("a fourth run");
375
    let (_, overview) = call(&h.app, "GET", "/andy/demo", None, None).await;
376
    assert!(overview.contains("src=\"/andy/demo/raw/main/.flow/stamp\""), "{overview}");
377
    assert!(overview.contains("href=\"/andy/demo/file/main/.flow/run\""));
378
    assert!(overview.contains("src=\"/andy/demo/raw/main/img/logo.png\""), "images use the raw route");
379
    let (st, _, ct) = head(&h.app, "/andy/demo/raw/main/img/logo.png").await;
380
    assert_eq!((st, ct.as_str()), (StatusCode::OK, "image/png"));
381
    let (st, loc, _) = head(&h.app, "/andy/demo/raw/main/.flow/stamp").await;
382
    assert!(st.is_redirection() && loc == "/andy/demo/flow/stamp/main", "{st} {loc}");
383
    let (st, loc, _) = head(&h.app, "/andy/demo/flow/stamp/main").await;
384
    assert!(st.is_redirection() && loc == format!("/andy/demo/flow/stamp/{}", fourth.heads), "a bookmark's stamp names its state: {loc}");
385
    let (st, _, ct) = head(&h.app, &loc).await;
386
    assert_eq!((st, ct.as_str()), (StatusCode::OK, "image/svg+xml; charset=utf-8"));
387
    let (_, svg) = call(&h.app, "GET", &loc, None, None).await;
388
    assert!(svg.starts_with("<svg") && svg.contains("error ·") && svg.contains(&fourth.heads[..12]), "{svg}");
389
    let (_, svg1) = call(&h.app, "GET", &format!("/andy/demo/flow/stamp/{}", run.heads), None, None).await;
390
    assert!(svg1.contains("failed ·") && svg1.contains(&format!("run #{} failed", run.id)), "an older state keeps its own result: {svg1}");
391
    assert!(svg1.contains(&build.receipt_hash), "receipt hashes in the metadata");
392
    assert_eq!(svg1.matches("text-anchor=\"middle\"").count(), 3, "one glyph per job");
393
    let (st, loc, _) = head(&h.app, "/andy/demo/file/main/.flow/run").await;
394
    assert!(st.is_redirection() && loc == "/andy/demo/flow/at/main", "{loc}");
395
    let (st, loc, _) = head(&h.app, "/andy/demo/flow/at/main").await;
396
    assert!(st.is_redirection() && loc == format!("/andy/demo/flow/{}", fourth.id), "{loc}");
397
398
    // A repository outside [flow] repos starts nothing.
399
    let work2 = tempfile::tempdir().unwrap();
400
    let c2 = client(&format!("{}/other/plain", h.base), work2.path());
401
    write(work2.path(), ".flow/pipeline.kdl", &pipeline(""));
402
    c2.snapshot("test").unwrap();
403
    c2.commit("Pipeline", &[]).unwrap();
404
    assert!(c2.push("origin", false).unwrap().iter().all(|r| r.ok));
405
    tokio::time::sleep(std::time::Duration::from_millis(500)).await;
406
    let row = db::repos::get(&h.app.db, "other", "plain").await.unwrap().unwrap();
407
    assert!(db::flow::runs(&h.app.db, row.id, 10, None).await.unwrap().is_empty());
408
    let (_, page) = call(&h.app, "GET", "/other/plain/flow", None, None).await;
409
    assert!(page.contains("not enabled for this repository"));
410
    let (_, loc, _) = head(&h.app, "/other/plain/flow/stamp/main").await;
411
    let (_, svg) = call(&h.app, "GET", &loc, None, None).await;
412
    assert!(svg.contains("no run ·"), "{svg}");
413
    let (_, loc, _) = head(&h.app, "/other/plain/flow/at/main").await;
414
    assert_eq!(loc, "/other/plain/flow");
415
}
416
417
#[tokio::test(flavor = "multi_thread")]
418
async fn claims_carry_pinned_subrepos_and_the_job_token_reads_only_those() {
419
    let h = hub().await;
420
    for n in ["base", "lib", "vault", "other", "app"] {
421
        create(&h.app, "andy", n).await;
422
    }
423
    let push = |name: &str, file: &str| {
424
        let work = tempfile::tempdir().unwrap();
425
        let c = client(&format!("{}/andy/{name}", h.base), work.path());
426
        write(work.path(), file, "x\n");
427
        c.snapshot("t").unwrap();
428
        c.commit("first", &[]).unwrap();
429
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
430
        let heads = c.bookmark_heads().unwrap();
431
        (work, heads)
432
    };
433
    let (_b, base_heads) = push("base", "base.rs");
434
    // lib pins base in turn: a subrepo of a subrepo.
435
    let lib_work = tempfile::tempdir().unwrap();
436
    let lib = client(&format!("{}/andy/lib", h.base), lib_work.path());
437
    lib.submodule_add(&format!("{}/andy/base", h.base), "deps/base", Some("main")).unwrap();
438
    write(lib_work.path(), "lib.rs", "x\n");
439
    lib.snapshot("t").unwrap();
440
    lib.commit("lib on base", &[]).unwrap();
441
    assert!(lib.push("origin", false).unwrap().iter().all(|r| r.ok));
442
    let lib_heads = lib.bookmark_heads().unwrap();
443
    let (_v, _) = push("vault", "secret.rs");
444
    let (_o, _) = push("other", "o.rs");
445
446
    // The app pins lib and vault as subrepos and pushes as the site token.
447
    let work = tempfile::tempdir().unwrap();
448
    let app = client(&format!("{}/andy/app", h.base), work.path());
449
    app.submodule_add(&format!("{}/andy/lib", h.base), "deps/lib", Some("main")).unwrap();
450
    // Vault is private: a checkout with no token for this hub cannot add
451
    // it, but the app's remote on the same hub lends its token (oxygen#32).
452
    // The subrepo keeps no copy: its own fetches find the parent's (oxygen#47).
453
    sqlx::query("UPDATE repositories SET visibility = 'private' WHERE name = 'vault'").execute(&h.app.db).await.unwrap();
454
    let bare_work = tempfile::tempdir().unwrap();
455
    let mut bare = Repo::init(bare_work.path()).unwrap();
456
    bare.config.set("remote.origin.url", &format!("{}/andy/bare", h.base)).unwrap();
457
    bare.save_config().unwrap();
458
    assert!(bare.submodule_add(&format!("{}/andy/vault", h.base), "deps/vault", Some("main")).is_err(), "not without a token");
459
    app.submodule_add(&format!("{}/andy/vault", h.base), "deps/vault", Some("main")).unwrap();
460
    let nested = Repo::open(&work.path().join("deps/vault")).unwrap();
461
    assert!(nested.config.remote_tokens.is_empty(), "no token is copied into a subrepo");
462
    nested.fetch("origin").unwrap();
463
    // The pusher below is the site token, which has no account: it cannot read vault.
464
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
465
    write(work.path(), "Makefile", "all:\n");
466
    app.snapshot("t").unwrap();
467
    app.commit("app with deps", &[]).unwrap();
468
    assert!(app.push("origin", false).unwrap().iter().all(|r| r.ok));
469
    assert!(!runs_of(&h.app, "andy", "app").await.is_empty());
470
471
    let job = claim(&h.app).await.unwrap();
472
    let subs = job["subrepos"].as_array().cloned().unwrap_or_default();
473
    assert_eq!(subs.len(), 2, "lib and what lib pins; vault is private and the pusher has no account: {subs:?}");
474
    assert_eq!(subs[1]["path"], "deps/lib/deps/base", "nested under its parent, after it");
475
    assert_eq!(subs[1]["heads"], serde_json::json!(base_heads.iter().map(|h| h.to_hex()).collect::<Vec<_>>()));
476
    let _ = std::fs::remove_dir_all(work.path().join("deps/vault2"));
477
    assert_eq!(subs[0]["path"], "deps/lib");
478
    assert_eq!(subs[0]["repo"], "andy/lib");
479
    assert_eq!(subs[0]["heads"], serde_json::json!(lib_heads.iter().map(|h| h.to_hex()).collect::<Vec<_>>()));
480
    assert!(subs[0]["clone_url"].as_str().unwrap().ends_with("/andy/lib"));
481
    // The job's log says vault was left out, and why (oxygenhub#56).
482
    let job_id = job["job_id"].as_i64().unwrap();
483
    let lines = db::flow::log(&h.app.db, job_id, 0, 100).await.unwrap();
484
    assert!(
485
        lines.iter().any(|l| l.stream == "flow" && l.text.contains("subrepo deps/vault (andy/vault) is left out")),
486
        "{:?}",
487
        lines.iter().map(|l| &l.text).collect::<Vec<_>>()
488
    );
489
490
    // The job token reads its repository and the pinned lib, nothing else.
491
    let token = job["token"].as_str().unwrap().to_string();
492
    let read = |name: &str| {
493
        let opts = RemoteOptions { token: Some(token.clone()), ..Default::default() };
494
        open_remote(&format!("{}/andy/{name}", h.base), &opts).and_then(|r| r.refs()).is_ok()
495
    };
496
    assert!(read("app") && read("lib") && read("base"));
497
    assert!(!read("vault"), "not pinned for this pusher");
498
    assert!(!read("other"), "public, but not the job's to read");
499
}
500
501
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
502
async fn concurrent_log_appends_never_fail_on_a_locked_database() {
503
    let h = hub().await;
504
    create(&h.app, "andy", "demo").await;
505
    let work = tempfile::tempdir().unwrap();
506
    let c = client(&format!("{}/andy/demo", h.base), work.path());
507
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
508
    write(work.path(), "Makefile", "all:\n");
509
    c.snapshot("t").unwrap();
510
    c.commit("pipeline", &[]).unwrap();
511
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
512
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
513
    let job = db::flow::jobs(&h.app.db, run.id).await.unwrap().remove(0);
514
    // Many writers at once, each reading the count and then inserting: a
515
    // deferred transaction would fail with "database is locked".
516
    let mut tasks = Vec::new();
517
    for w in 0..16 {
518
        let pool = h.app.db.clone();
519
        tasks.push(tokio::spawn(async move {
520
            let records: Vec<flow_core::api::Record> =
521
                (0..20).map(|i| flow_core::api::Record { t: i, stream: "out".into(), text: format!("writer {w} line {i}") }).collect();
522
            db::flow::append_log(&pool, job.id, &records, 100_000).await
523
        }));
524
    }
525
    for t in tasks {
526
        assert_eq!(t.await.unwrap().unwrap(), 20, "every append succeeds");
527
    }
528
    let lines = db::flow::log(&h.app.db, job.id, 0, 1_000).await.unwrap();
529
    assert_eq!(lines.len(), 320);
530
    let seqs: std::collections::BTreeSet<i64> = lines.iter().map(|l| l.seq).collect();
531
    assert_eq!(seqs.len(), 320, "sequence numbers are unique");
532
}
533
534
/// A repository's own Flow setting overrides hub.toml either way.
535
#[tokio::test(flavor = "multi_thread")]
536
async fn a_repository_setting_turns_flow_on_or_off() {
537
    let h = hub().await;
538
    create(&h.app, "other", "plain").await;
539
    create(&h.app, "andy", "quiet").await;
540
    // A run elsewhere first, so hub-wide ids and per-repository numbers differ.
541
    create(&h.app, "andy", "first").await;
542
    {
543
        let work = tempfile::tempdir().unwrap();
544
        let c = client(&format!("{}/andy/first", h.base), work.path());
545
        write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
546
        write(work.path(), "test.sh", "echo ok\n");
547
        c.commit("Add a pipeline", &[]).unwrap();
548
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
549
        assert_eq!(runs_of(&h.app, "andy", "first").await.len(), 1);
550
    }
551
    let row = db::repos::get(&h.app.db, "other", "plain").await.unwrap().unwrap();
552
    db::repos::set_flow(&h.app.db, row.id, "on").await.unwrap();
553
    let quiet = db::repos::get(&h.app.db, "andy", "quiet").await.unwrap().unwrap();
554
    db::repos::set_flow(&h.app.db, quiet.id, "off").await.unwrap();
555
    for (owner, name) in [("other", "plain"), ("andy", "quiet")] {
556
        let work = tempfile::tempdir().unwrap();
557
        let c = client(&format!("{}/{owner}/{name}", h.base), work.path());
558
        write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
559
        write(work.path(), "test.sh", "echo ok\n");
560
        c.commit("Add a pipeline", &[]).unwrap();
561
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
562
    }
563
    let plain = runs_of(&h.app, "other", "plain").await;
564
    assert_eq!(plain.len(), 1, "turned on");
565
    // With andy/first's jobs ahead, plain's run says where it stands.
566
    let a = claim(&h.app).await.unwrap();
567
    assert_eq!(a["repo"], "andy/first");
568
    let (_, page) = call(&h.app, "GET", "/other/plain/flow/1", None, None).await;
569
    assert!(page.contains("Waiting for a runner: 3rd in line") && page.contains("Running now: andy/first #1"), "{page}");
570
    let (_, body) = call(&h.app, "GET", "/api/v1/repos/other/plain/flow/runs/1", None, None).await;
571
    assert_eq!(serde_json::from_str::<serde_json::Value>(&body).unwrap()["queue_position"], 3);
572
    let (_, list) = call(&h.app, "GET", "/other/plain/flow", None, None).await;
573
    assert!(list.contains("queued, 3rd in line"), "{list}");
574
    // Runs are numbered per repository: this is plain's first, whatever
575
    // other repositories ran before.
576
    assert_eq!(plain[0].number, 1);
577
    let checks = checks_when(&h.app, row.id, &plain[0].state, 3).await;
578
    assert!(checks.iter().all(|c| c.url.ends_with("/other/plain/flow/1")), "{checks:?}");
579
    let (st, page) = call(&h.app, "GET", "/other/plain/flow/1", None, None).await;
580
    assert!(st == StatusCode::OK && page.contains("Run #1"), "{st}");
581
    assert!(runs_of(&h.app, "andy", "quiet").await.is_empty(), "turned off despite andy/*");
582
}
583
584
/// "Run pipeline" and "Re-run" (hub spec §13.2): runs that move no
585
/// bookmark, through the API and the pages.
586
#[tokio::test(flavor = "multi_thread")]
587
async fn runs_start_without_a_push_and_finished_runs_re_run() {
588
    let h = hub().await;
589
    // The site token acts as the first site administrator.
590
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
591
    create(&h.app, "andy", "demo").await;
592
    let url = format!("{}/andy/demo", h.base);
593
    let work = tempfile::tempdir().unwrap();
594
    let c = client(&url, work.path());
595
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
596
    write(work.path(), "test.sh", "echo ok\n");
597
    c.commit("Add a pipeline", &[]).unwrap();
598
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
599
    let first = runs_of(&h.app, "andy", "demo").await;
600
    assert_eq!((first.len(), first[0].trigger.as_str()), (1, "push"));
601
602
    // Run pipeline on the default bookmark: a new run of the same state.
603
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some("{}".into())).await;
604
    assert_eq!(st, StatusCode::CREATED, "{body}");
605
    let v: serde_json::Value = serde_json::from_str(&body).unwrap();
606
    assert_eq!(v["number"], 2);
607
    assert!(v["url"].as_str().unwrap().ends_with("/andy/demo/flow/2"));
608
    let second = db::flow::run(&h.app.db, first[0].repo_id, 2).await.unwrap().unwrap();
609
    assert_eq!((second.trigger.as_str(), second.actor.as_str(), second.state.as_str()), ("manual", "andy", first[0].state.as_str()));
610
    assert_eq!(db::flow::jobs(&h.app.db, second.id).await.unwrap().len(), 3);
611
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/2", None, None).await;
612
    assert!(page.contains("started by andy"), "the run page says what started it");
613
614
    // Run pipeline on one change: its state, with no bookmark.
615
    let head = first[0].head_list()[0].to_string();
616
    let (st, body) =
617
        call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some(format!(r#"{{"change":"{head}"}}"#))).await;
618
    assert_eq!(st, StatusCode::CREATED, "{body}");
619
    let on_change = db::flow::run(&h.app.db, first[0].repo_id, 3).await.unwrap().unwrap();
620
    assert_eq!(
621
        (on_change.bookmark.as_str(), on_change.heads.as_str(), on_change.state.as_str()),
622
        ("", head.as_str(), first[0].state.as_str())
623
    );
624
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/3", None, None).await;
625
    assert!(page.contains("title=\"Run on one change, not a bookmark\">change</span>"), "run page");
626
    let (st, body) =
627
        call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some(format!(r#"{{"change":"{}"}}"#, "ab".repeat(32))))
628
            .await;
629
    assert!(st == StatusCode::CONFLICT && body.contains("no change"), "{st} {body}");
630
    // Viewers who cannot start runs are told why, and get no button.
631
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow", None, None).await;
632
    assert!(page.contains("Sign in with write access to run the pipeline.") && !page.contains("primary-btn"));
633
    let (_, page) = call(&h.app, "GET", "/andy/demo/bookmarks", None, None).await;
634
    assert!(!page.contains("/flow/start"), "no run buttons for anonymous viewers");
635
636
    // A live run is not re-run; unknown bookmarks and runs are refused.
637
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/1/rerun", Some("site"), None).await;
638
    assert!(st == StatusCode::CONFLICT && body.contains("still queued"), "{st} {body}");
639
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some(r#"{"bookmark":"nope"}"#.into())).await;
640
    assert_eq!(st, StatusCode::CONFLICT);
641
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/99/rerun", Some("site"), None).await;
642
    assert_eq!(st, StatusCode::NOT_FOUND);
643
    // Anonymous callers cannot start runs.
644
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", None, Some("{}".into())).await;
645
    assert_ne!(st, StatusCode::CREATED);
646
647
    // A finished run re-runs as a new run of the same state.
648
    let row = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
649
    for r in [&first[0], &second] {
650
        for j in db::flow::jobs(&h.app.db, r.id).await.unwrap() {
651
            sqlx::query("UPDATE flow_jobs SET status = 'passed' WHERE id = ?").bind(j.id).execute(&h.app.db).await.unwrap();
652
        }
653
        sqlx::query("UPDATE flow_runs SET status = 'passed', finished_ms = 1 WHERE id = ?").bind(r.id).execute(&h.app.db).await.unwrap();
654
    }
655
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/1/rerun", Some("site"), None).await;
656
    assert_eq!(st, StatusCode::CREATED, "{body}");
657
    let third = db::flow::run(&h.app.db, row.id, 4).await.unwrap().unwrap();
658
    assert_eq!(
659
        (third.trigger_label().as_str(), third.status.as_str(), third.state.as_str()),
660
        ("rerun:1", "queued", first[0].state.as_str())
661
    );
662
    assert_eq!(third.trigger, "rerun:1:push", "a rerun keeps the event it repeats");
663
    let checks = db::hooks::checks_for_state(&h.app.db, row.id, &third.state).await.unwrap();
664
    assert!(
665
        checks.iter().all(|c| c.status == "queued" && c.url.ends_with("/flow/4")),
666
        "the re-run's checks replace the old ones: {checks:?}"
667
    );
668
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/4", None, None).await;
669
    assert!(page.contains("re-run of #1 by andy"));
670
    assert!(!page.contains("RE-RUN"), "anonymous viewers get no button");
671
672
    // With Flow off, nothing starts.
673
    db::repos::set_flow(&h.app.db, row.id, "off").await.unwrap();
674
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some("{}".into())).await;
675
    assert!(st == StatusCode::CONFLICT && body.contains("not enabled"), "{body}");
676
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow", None, None).await;
677
    assert!(page.contains("Flow is off for this repository"), "and the Flow tab says so");
678
}
679
680
/// The Flow API (hub spec §13.2): runs, a run with its jobs, a job's log,
681
/// checks by the heads a client has, and JSON for unknown API routes.
682
#[tokio::test(flavor = "multi_thread")]
683
async fn runs_jobs_and_logs_are_in_the_api() {
684
    let h = hub().await;
685
    create(&h.app, "andy", "demo").await;
686
    let url = format!("{}/andy/demo", h.base);
687
    let work = tempfile::tempdir().unwrap();
688
    let c = client(&url, work.path());
689
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
690
    write(work.path(), "test.sh", "echo ok\n");
691
    let head = c.commit("Add a pipeline", &[]).unwrap();
692
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
693
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
694
695
    // A job runs and logs.
696
    let a = claim(&h.app).await.unwrap();
697
    let id = a["job_id"].as_i64().unwrap();
698
    let recs =
699
        serde_json::json!({ "records": [{ "t": 1, "stream": "stdout", "text": "one" }, { "t": 3, "stream": "stderr", "text": "three" }] });
700
    let (st, _) = call(&h.app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(recs.to_string())).await;
701
    assert!(st.is_success(), "{st}");
702
703
    let (st, body) = call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs", None, None).await;
704
    assert_eq!(st, StatusCode::OK, "{body}");
705
    let runs: Vec<hub_api::FlowRun> = serde_json::from_str(&body).unwrap();
706
    assert_eq!(runs.len(), 1);
707
    assert_eq!((runs[0].number, runs[0].state.as_str(), runs[0].trigger.as_str()), (1, run.state.as_str(), "push"));
708
    assert!(runs[0].url.ends_with("/andy/demo/flow/1") && runs[0].jobs.is_empty());
709
710
    let (_, body) = call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs/1", None, None).await;
711
    let one: hub_api::FlowRun = serde_json::from_str(&body).unwrap();
712
    let names: Vec<(&str, &str)> = one.jobs.iter().map(|j| (j.name.as_str(), j.status.as_str())).collect();
713
    assert_eq!(names.len(), 3);
714
    let running = one.jobs.iter().find(|j| j.status == "running").unwrap();
715
    assert_eq!(running.name, a["job"]["name"].as_str().unwrap());
716
    assert!(one.jobs.iter().any(|j| j.name == "test" && j.depends_on == ["build"]));
717
718
    let job = running.name.clone();
719
    let (st, body) = call(&h.app, "GET", &format!("/api/v1/repos/andy/demo/flow/runs/1/jobs/{job}/log"), None, None).await;
720
    assert_eq!(st, StatusCode::OK, "{body}");
721
    let lines: Vec<hub_api::FlowLogLine> = serde_json::from_str(&body).unwrap();
722
    assert!(lines.iter().any(|l| l.text == "three"), "{body}");
723
    let last = lines.last().unwrap().seq;
724
    let (_, body) = call(&h.app, "GET", &format!("/api/v1/repos/andy/demo/flow/runs/1/jobs/{job}/log?after={last}"), None, None).await;
725
    assert_eq!(body, "[]", "nothing after the last line");
726
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs/9", None, None).await.0, StatusCode::NOT_FOUND);
727
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs/1/jobs/nope/log", None, None).await.0, StatusCode::NOT_FOUND);
728
729
    // Checks by the state hash, by the head `oxy log` shows, and by bookmark.
730
    let by = |key: String| {
731
        let app = h.app.clone();
732
        async move {
733
            let (st, body) = call(&app, "GET", &format!("/api/v1/repos/andy/demo/checks/{key}"), None, None).await;
734
            assert_eq!(st, StatusCode::OK, "{key}: {body}");
735
            serde_json::from_str::<Vec<hub_api::Check>>(&body).unwrap().len()
736
        }
737
    };
738
    checks_when(&h.app, run.repo_id, &run.state, 3).await;
739
    assert_eq!(by(run.state.clone()).await, 3);
740
    assert_eq!(by(head.to_hex()).await, 3, "a single head names its state");
741
    assert_eq!(by("main".into()).await, 3);
742
    let (st, _) = call(&h.app, "GET", "/api/v1/repos/andy/demo/checks/no-such-bookmark", None, None).await;
743
    assert_eq!(st, StatusCode::NOT_FOUND);
744
745
    // An unknown API route answers with a problem document.
746
    let (st, body) = call(&h.app, "GET", "/api/v1/users/andy/repos", None, None).await;
747
    assert_eq!(st, StatusCode::NOT_FOUND);
748
    let v: serde_json::Value = serde_json::from_str(&body).unwrap();
749
    assert_eq!(v["status"], 404, "{body}");
750
}
751
752
async fn get_bytes(app: &Shared, path: &str) -> (StatusCode, Vec<u8>) {
753
    let res = oxygenhub::router(app.clone()).oneshot(Request::get(path).body(Body::empty()).unwrap()).await.unwrap();
754
    let status = res.status();
755
    (status, res.into_body().collect().await.unwrap().to_bytes().to_vec())
756
}
757
758
#[tokio::test(flavor = "multi_thread")]
759
async fn signed_receipts_are_checked_kept_and_shown() {
760
    use oxy_core::hash::{hash_object, ChangeHash, ObjectRef, ObjectType};
761
    use oxy_core::identity::SecretKey;
762
    use oxy_core::objects::StateObject;
763
    use oxy_core::receipt::SignedReceipt;
764
    let h = hub().await;
765
    create(&h.app, "andy", "demo").await;
766
    let url = format!("{}/andy/demo", h.base);
767
    let work = tempfile::tempdir().unwrap();
768
    let c = client(&url, work.path());
769
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
770
    c.snapshot("test").unwrap();
771
    c.commit("Add a pipeline", &[]).unwrap();
772
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
773
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
774
    let heads: Vec<ChangeHash> = run.head_list().into_iter().filter_map(ChangeHash::from_hex).collect();
775
    let state = hash_object(ObjectType::State, &StateObject::new(heads.clone()).encode());
776
    let repo_id = h.app.repos.open(&RepoName::parse("andy/demo").unwrap()).unwrap().id().unwrap();
777
    let sk = SecretKey::generate();
778
    let runner = sk.identity("test-1 (OxygenFlow runner)", "", 1);
779
    let sign = |r: &serde_json::Value, state: ObjectRef, sk: &SecretKey, id: &oxy_core::identity::Identity| {
780
        let r: flow_core::Receipt = serde_json::from_value(r.clone()).unwrap();
781
        let run_url = format!("{url}/flow/{}", run.number);
782
        hex::encode(SignedReceipt::sign(r.to_oxy(), repo_id, state, &run_url, id, sk).encode())
783
    };
784
785
    let a = claim(&h.app).await.unwrap();
786
    let b = claim(&h.app).await.unwrap();
787
    let ph = a["pipeline_hash"].as_str().unwrap().to_string();
788
    let (a_id, b_id) = (a["job_id"].as_i64().unwrap(), b["job_id"].as_i64().unwrap());
789
    // The first signed receipt binds the runner token to its key, and is kept.
790
    let rb = receipt("build", &ph, 0);
791
    let body = serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": rb, "signed_receipt": sign(&rb, state, &sk, &runner) });
792
    assert_eq!(finish(&h.app, a_id, body).await, StatusCode::NO_CONTENT);
793
    // Another key under the same token: the result counts, the receipt is not kept.
794
    let other = SecretKey::generate();
795
    let rl = receipt("lint", &ph, 0);
796
    let body = serde_json::json!({ "exit_code": 0, "duration_ms": 300, "receipt": rl,
797
        "signed_receipt": sign(&rl, state, &other, &other.identity("mallory", "", 1)) });
798
    assert_eq!(finish(&h.app, b_id, body).await, StatusCode::NO_CONTENT);
799
    // The right key, but for another state.
800
    let t = claim(&h.app).await.unwrap();
801
    let rt = receipt("test", &ph, 0);
802
    let body = serde_json::json!({ "exit_code": 0, "duration_ms": 500, "receipt": rt,
803
        "signed_receipt": sign(&rt, ObjectRef([9; 32]), &sk, &runner) });
804
    assert_eq!(finish(&h.app, t["job_id"].as_i64().unwrap(), body).await, StatusCode::NO_CONTENT);
805
806
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
807
    let job = |n: &str| jobs.iter().find(|j| j.name == n).unwrap().clone();
808
    assert_eq!(job("build").status, "passed");
809
    assert_eq!((job("build").receipt_attest.len(), job("build").receipt_signer.as_str()), (64, "test-1 (OxygenFlow runner)"));
810
    assert_eq!(job("lint").status, "passed", "the job's result stands");
811
    assert!(job("lint").receipt_attest.is_empty());
812
    assert!(job("lint").receipt_note.contains("not the key this runner signs with"), "{}", job("lint").receipt_note);
813
    assert!(job("test").receipt_note.contains("another state"), "{}", job("test").receipt_note);
814
815
    // The repository keeps it, and anyone who can read the repository can
816
    // download it and check it on their own.
817
    let kept = h.app.repos.open(&RepoName::parse("andy/demo").unwrap()).unwrap().receipts(&heads).unwrap();
818
    assert_eq!(kept.len(), 1);
819
    let attest = job("build").receipt_attest;
820
    let (st, bytes) = get_bytes(&h.app, &format!("/andy/demo/receipts/{attest}")).await;
821
    assert_eq!(st, StatusCode::OK);
822
    let sr = SignedReceipt::decode(&bytes).unwrap();
823
    sr.verify().unwrap();
824
    assert_eq!((sr.state(), sr.receipt.job_name.as_str()), (state, "build"));
825
    assert_eq!(get_bytes(&h.app, &format!("/andy/demo/receipts/{}", "0".repeat(64))).await.0, StatusCode::NOT_FOUND);
826
827
    // Pages: the run names the signer or why a receipt was not kept; the
828
    // change whose state it is lists it.
829
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", run.number), None, None).await;
830
    assert!(page.contains("signed receipt</a> by test-1"), "run page");
831
    assert!(page.contains("receipt not kept"), "run page");
832
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/change/{}", heads[0].to_hex()), None, None).await;
833
    assert!(page.contains("<dt>Receipts</dt>") && page.contains(&format!("/andy/demo/receipts/{attest}")), "change page");
834
}
835
836
async fn upload(app: &Shared, job: i64, name: &str, bytes: &[u8]) -> (StatusCode, String) {
837
    let req = Request::post(format!("/api/v1/flow/jobs/{job}/artifacts/{name}"))
838
        .header(header::AUTHORIZATION, "Bearer runner-secret")
839
        .header(header::CONTENT_TYPE, "application/octet-stream")
840
        .body(Body::from(bytes.to_vec()))
841
        .unwrap();
842
    let res = oxygenhub::router(app.clone()).oneshot(req).await.unwrap();
843
    let status = res.status();
844
    (status, String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned())
845
}
846
847
#[tokio::test(flavor = "multi_thread")]
848
async fn artifacts_are_kept_named_by_the_receipt_and_served() {
849
    let h = hub().await;
850
    create(&h.app, "andy", "demo").await;
851
    let url = format!("{}/andy/demo", h.base);
852
    let work = tempfile::tempdir().unwrap();
853
    let c = client(&url, work.path());
854
    write(
855
        work.path(),
856
        ".flow/pipeline.kdl",
857
        &format!(
858
            "schema-version 1\nsandbox \"alpine\" {{\n    rootfs \"cas://blob/{ROOTFS}\"\n}}\njob \"build\" {{\n    sandbox \"alpine\"\n    exec \"make\"\n    output {{\n        artifact \"tool\" {{\n            path \"/src/out/tool\"\n        }}\n    }}\n}}\n"
859
        ),
860
    );
861
    c.snapshot("test").unwrap();
862
    c.commit("Build a tool", &[]).unwrap();
863
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
864
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
865
    let a = claim(&h.app).await.unwrap();
866
    assert_eq!(a["job"]["outputs"], serde_json::json!([{ "name": "tool", "path": "/src/out/tool" }]), "the runner is told");
867
    let id = a["job_id"].as_i64().unwrap();
868
869
    let body: Vec<u8> = (0..300_000u32).map(|i| (i % 253) as u8).collect();
870
    let (st, text) = upload(&h.app, id, "other", &body).await;
871
    assert_eq!(st, StatusCode::BAD_REQUEST, "an undeclared artifact: {text}");
872
    let (st, text) = upload(&h.app, id, "tool", &body).await;
873
    assert_eq!(st, StatusCode::OK, "{text}");
874
    let blob = serde_json::from_str::<serde_json::Value>(&text).unwrap()["blob"].as_str().unwrap().to_string();
875
    assert_eq!(blob, oxy_core::repo::Repo::blob_ref(&body).to_hex(), "the same blob the runner computes");
876
877
    // The receipt must name exactly the uploaded artifacts.
878
    let mut r = receipt("build", a["pipeline_hash"].as_str().unwrap(), 0);
879
    assert_eq!(
880
        finish(&h.app, id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": r.clone() })).await,
881
        StatusCode::BAD_REQUEST
882
    );
883
    r["outputs"] = serde_json::json!([blob]);
884
    assert_eq!(finish(&h.app, id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": r })).await, StatusCode::NO_CONTENT);
885
886
    // The run page lists it; anyone who can read the repository downloads it.
887
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", run.number), None, None).await;
888
    let link = format!("/andy/demo/flow/{}/artifacts/build/tool", run.number);
889
    assert!(page.contains(&link), "run page lists the artifact");
890
    let (st, got) = get_bytes(&h.app, &link).await;
891
    assert_eq!((st, got == body), (StatusCode::OK, true));
892
    assert_eq!(get_bytes(&h.app, &format!("/andy/demo/flow/{}/artifacts/build/none", run.number)).await.0, StatusCode::NOT_FOUND);
893
894
    // A writer attaches the artifact to a release from the run page; the
895
    // release then names the run and job that built it, as does the API.
896
    let form = |f: String| {
897
        Request::post("/register").header(header::CONTENT_TYPE, "application/x-www-form-urlencoded").body(Body::from(f)).unwrap()
898
    };
899
    let res = oxygenhub::router(h.app.clone())
900
        .oneshot(form("username=andy&email=a%40example.com&password=correct-horse-battery".into()))
901
        .await
902
        .unwrap();
903
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
904
    let with_cookie = |method: &str, path: &str, body: Option<String>| {
905
        let mut req = Request::builder().method(method).uri(path).header(header::COOKIE, cookie.clone());
906
        if body.is_some() {
907
            req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
908
        }
909
        req.body(body.map(Body::from).unwrap_or_else(Body::empty)).unwrap()
910
    };
911
    let row = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
912
    db::releases::create(&h.app.db, row.id, "v1", "One", "", false, None).await.unwrap();
913
    let res = oxygenhub::router(h.app.clone()).oneshot(with_cookie("GET", &format!("/andy/demo/flow/{}", run.number), None)).await.unwrap();
914
    let page = String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned();
915
    let attach = format!("/andy/demo/flow/{}/artifacts/build/tool/attach", run.number);
916
    assert!(page.contains(&attach), "a writer is offered the release");
917
    let i = page.find("name=\"_csrf\" value=\"").unwrap() + "name=\"_csrf\" value=\"".len();
918
    let csrf = page[i..].split('"').next().unwrap().to_string();
919
    let release_id = db::releases::list(&h.app.db, row.id).await.unwrap()[0].id;
920
    let res = oxygenhub::router(h.app.clone())
921
        .oneshot(with_cookie("POST", &attach, Some(format!("_csrf={csrf}&release={release_id}"))))
922
        .await
923
        .unwrap();
924
    assert_eq!(res.status(), StatusCode::SEE_OTHER);
925
    let (_, page) = call(&h.app, "GET", "/andy/demo/releases/tag/v1", None, None).await;
926
    assert!(
927
        page.contains(">tool</a>") && page.contains(&format!("built by <a href=\"/andy/demo/flow/{0}\">run #{0}</a> build", run.number)),
928
        "{page}"
929
    );
930
    let (_, api) = call(&h.app, "GET", "/api/v1/repos/andy/demo/releases", None, None).await;
931
    let api: serde_json::Value = serde_json::from_str(&api).unwrap();
932
    let asset = &api[0]["assets"][0];
933
    assert_eq!(
934
        (asset["name"].as_str(), asset["built_by"]["run"].as_i64(), asset["built_by"]["job"].as_str()),
935
        (Some("tool"), Some(run.number), Some("build"))
936
    );
937
    assert!(asset["built_by"]["receipt"].is_null(), "that receipt was not signed");
938
}
939
940
/// oxygenflow#37: a failing job keeps a `when "always"` artifact; its
941
/// receipt names none, and the run page says the file is outside it.
942
#[tokio::test(flavor = "multi_thread")]
943
async fn a_failing_job_keeps_an_artifact_outside_its_receipt() {
944
    let h = hub().await;
945
    create(&h.app, "andy", "demo").await;
946
    let url = format!("{}/andy/demo", h.base);
947
    let work = tempfile::tempdir().unwrap();
948
    let c = client(&url, work.path());
949
    write(
950
        work.path(),
951
        ".flow/pipeline.kdl",
952
        &format!(
953
            "schema-version 1\nsandbox \"alpine\" {{\n    rootfs \"cas://blob/{ROOTFS}\"\n}}\njob \"test\" {{\n    sandbox \"alpine\"\n    exec \"make\" \"test\"\n    output {{\n        artifact \"junit\" {{\n            path \"/src/out/junit.xml\"\n            when \"always\"\n        }}\n    }}\n}}\n"
954
        ),
955
    );
956
    c.snapshot("test").unwrap();
957
    c.commit("Test", &[]).unwrap();
958
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
959
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
960
    let a = claim(&h.app).await.unwrap();
961
    assert_eq!(a["job"]["outputs"][0]["always"], true, "the runner is told to keep it from a failing job");
962
    let id = a["job_id"].as_i64().unwrap();
963
    // A JUnit report (#114): parsed on upload, counted, failures listed.
964
    let xml = br#"<testsuites><testsuite name="pytest"><testcase classname="tests.test_io" name="test_read" time="0.5"/><testcase classname="tests.test_io" name="test_write" time="1.5"><failure message="disk full">E   OSError: disk full</failure></testcase></testsuite></testsuites>"#;
965
    let (st, text) = upload(&h.app, id, "junit", xml).await;
966
    assert_eq!(st, StatusCode::OK, "{text}");
967
    let blob = serde_json::from_str::<serde_json::Value>(&text).unwrap()["blob"].as_str().unwrap().to_string();
968
    let mut r = receipt("test", a["pipeline_hash"].as_str().unwrap(), 1);
969
    r["outputs"] = serde_json::json!([blob]);
970
    assert_eq!(
971
        finish(&h.app, id, serde_json::json!({ "exit_code": 1, "duration_ms": 700, "receipt": r.clone() })).await,
972
        StatusCode::BAD_REQUEST,
973
        "a failing receipt names no outputs"
974
    );
975
    r["outputs"] = serde_json::json!([]);
976
    assert_eq!(finish(&h.app, id, serde_json::json!({ "exit_code": 1, "duration_ms": 700, "receipt": r })).await, StatusCode::NO_CONTENT);
977
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", run.number), None, None).await;
978
    assert!(page.contains(&format!("/andy/demo/flow/{}/artifacts/test/junit", run.number)), "listed");
979
    assert!(page.contains("not in its receipt"), "marked");
980
    assert!(page.contains("2 tests: 1 failed"), "counts beside the job");
981
    assert!(page.contains("tests.test_io::test_write") && page.contains("disk full") && page.contains("OSError"), "the failure");
982
    assert!(page.contains("tests: 2 tests: 1 failed in 2.0 s"), "said in the job's log");
983
}
984
985
/// A release's trust report (hub spec §9.1): a signed tag, an asset built
986
/// by a job with a signed receipt from the tagged state, and one uploaded
987
/// by hand; the page, its JSON export and the API.
988
#[tokio::test(flavor = "multi_thread")]
989
async fn a_release_is_audited_from_authors_to_receipts() {
990
    use oxy_core::hash::{hash_object, ChangeHash, ObjectType};
991
    use oxy_core::identity::SecretKey;
992
    use oxy_core::objects::StateObject;
993
    use oxy_core::receipt::SignedReceipt;
994
    let h = hub().await;
995
    create(&h.app, "andy", "demo").await;
996
    let url = format!("{}/andy/demo", h.base);
997
    let work = tempfile::tempdir().unwrap();
998
    let mut c = client(&url, work.path());
999
    c.create_identity("Andy", "[email protected]", oxy_core::repo::IdentityScope::Repo).unwrap();
1000
    write(
1001
        work.path(),
1002
        ".flow/pipeline.kdl",
1003
        &format!(
1004
            "schema-version 1\nsandbox \"alpine\" {{\n    rootfs \"cas://blob/{ROOTFS}\"\n}}\njob \"build\" {{\n    sandbox \"alpine\"\n    exec \"make\"\n    output {{\n        artifact \"tool\" {{\n            path \"/src/out/tool\"\n        }}\n    }}\n}}\n"
1005
        ),
1006
    );
1007
    c.snapshot("test").unwrap();
1008
    c.commit("Build a tool", &[]).unwrap();
1009
    let heads = c.bookmark_heads().unwrap();
1010
    c.tag_create("v1", &heads, "first").unwrap();
1011
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1012
1013
    // The runner builds, uploads the artifact and signs its receipt.
1014
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
1015
    let a = claim(&h.app).await.unwrap();
1016
    let id = a["job_id"].as_i64().unwrap();
1017
    let body: Vec<u8> = b"#!/bin/sh\necho tool\n".to_vec();
1018
    let (_, text) = upload(&h.app, id, "tool", &body).await;
1019
    let blob = serde_json::from_str::<serde_json::Value>(&text).unwrap()["blob"].as_str().unwrap().to_string();
1020
    let mut r = receipt("build", a["pipeline_hash"].as_str().unwrap(), 0);
1021
    r["outputs"] = serde_json::json!([blob]);
1022
    let heads_run: Vec<ChangeHash> = run.head_list().into_iter().filter_map(ChangeHash::from_hex).collect();
1023
    let state = hash_object(ObjectType::State, &StateObject::new(heads_run).encode());
1024
    let repo_id = h.app.repos.open(&RepoName::parse("andy/demo").unwrap()).unwrap().id().unwrap();
1025
    let sk = SecretKey::generate();
1026
    let runner = sk.identity("test-1 (OxygenFlow runner)", "", 1);
1027
    let fr: flow_core::Receipt = serde_json::from_value(r.clone()).unwrap();
1028
    let signed = hex::encode(SignedReceipt::sign(fr.to_oxy(), repo_id, state, &format!("{url}/flow/1"), &runner, &sk).encode());
1029
    let done = serde_json::json!({ "exit_code": 0, "duration_ms": 900, "receipt": r, "signed_receipt": signed });
1030
    assert_eq!(finish(&h.app, id, done).await, StatusCode::NO_CONTENT);
1031
1032
    // A release with the built asset and a file uploaded by hand.
1033
    let row = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
1034
    let rel = db::releases::create(&h.app.db, row.id, "v1", "One", "", false, None).await.unwrap();
1035
    oxygenhub::web::releases::store_asset(&h.app, rel.id, "tool", "", &body).await.unwrap();
1036
    oxygenhub::web::releases::store_asset(&h.app, rel.id, "notes.txt", "", b"by hand\n").await.unwrap();
1037
1038
    let (st, page) = call(&h.app, "GET", "/andy/demo/releases/trust/v1", None, None).await;
1039
    assert_eq!(st, StatusCode::OK);
1040
    for want in [
1041
        "Tag v1 is signed",
1042
        "The one change in the release is authenticated",
1043
        "tool: signed receipt from run #1 build",
1044
        "a runner key of this hub",
1045
        "tool: built from the tagged state",
1046
        "tool: pinned environment",
1047
        "notes.txt: no build found",
1048
        "<svg class=\"trust-graph\"",
1049
        // oxygenhub#79: a summary of badges, badges in the graph, and the
1050
        // graph drawn at its own size rather than stretched to the page.
1051
        "Tag signed by",
1052
        "1 of 1 changes signed or sealed",
1053
        "1 of 2 assets built and attested by OxygenFlow",
1054
        "attested build",
1055
        "uploaded by hand",
1056
        "receipt verified",
1057
        "class=\"shackle\"",
1058
        "<title>notes.txt:",
1059
    ] {
1060
        assert!(page.contains(want), "missing {want:?}");
1061
    }
1062
    let svg = &page[page.find("<svg class=\"trust-graph\"").unwrap()..];
1063
    assert!(svg[..200].contains(" width=\"") && svg[..200].contains(" height=\""), "the graph has its own size: {}", &svg[..200]);
1064
    let (_, releases) = call(&h.app, "GET", "/andy/demo/releases", None, None).await;
1065
    assert!(releases.contains("/andy/demo/releases/trust/v1"), "the release links its audit");
1066
1067
    // The export carries the signed receipt, which checks on its own.
1068
    let (st, json) = call(&h.app, "GET", "/andy/demo/releases/trust/v1?format=json", None, None).await;
1069
    assert_eq!(st, StatusCode::OK);
1070
    let t: serde_json::Value = serde_json::from_str(&json).unwrap();
1071
    assert_eq!((t["tag"].as_str(), t["tag_signature"].as_str(), t["changes"].as_i64()), (Some("v1"), Some("valid"), Some(1)));
1072
    assert_eq!(t["authors"][0]["who"]["name"], "Andy");
1073
    let tool = t["assets"].as_array().unwrap().iter().find(|a| a["name"] == "tool").unwrap();
1074
    let hex_receipt = tool["build"]["signed_receipt"].as_str().unwrap();
1075
    let sr = SignedReceipt::decode(&hex::decode(hex_receipt).unwrap()).unwrap();
1076
    sr.verify().unwrap();
1077
    assert_eq!(sr.receipt.outputs[0].to_hex(), blob);
1078
    let audit = t["audit"].as_array().unwrap();
1079
    assert!(audit.iter().any(|c| c["verdict"] == "warn" && c["title"].as_str().unwrap().starts_with("notes.txt")));
1080
    assert!(!audit.iter().any(|c| c["verdict"] == "fail"), "{audit:?}");
1081
    // The API gives the same report; an unknown release is a 404.
1082
    let (st, api) = call(&h.app, "GET", "/api/v1/repos/andy/demo/releases/trust/v1", None, None).await;
1083
    assert_eq!(st, StatusCode::OK);
1084
    assert_eq!(serde_json::from_str::<serde_json::Value>(&api).unwrap()["assets"].as_array().unwrap().len(), 2);
1085
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/demo/releases/trust/v9", None, None).await.0, StatusCode::NOT_FOUND);
1086
    assert_eq!(call(&h.app, "GET", "/andy/demo/releases/trust/v9", None, None).await.0, StatusCode::NOT_FOUND);
1087
}
1088
1089
/// Runners (hub spec §13.2): an administrator makes a registration token,
1090
/// a runner registers with it (binding its key), claims, shows on Admin →
1091
/// Runners with its history, and is drained, disabled and removed.
1092
#[tokio::test(flavor = "multi_thread")]
1093
async fn runners_register_show_their_history_and_are_drained_and_removed() {
1094
    use oxy_core::identity::SecretKey;
1095
    let h = hub().await;
1096
    create(&h.app, "andy", "demo").await;
1097
    // A signed-in site administrator.
1098
    let res = oxygenhub::router(h.app.clone())
1099
        .oneshot(
1100
            Request::post("/register")
1101
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1102
                .body(Body::from("username=carol&email=carol%40example.com&password=correct-horse-battery"))
1103
                .unwrap(),
1104
        )
1105
        .await
1106
        .unwrap();
1107
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1108
    let admin = db::accounts::account_by_name(&h.app.db, "carol").await.unwrap().unwrap();
1109
    db::accounts::set_admin(&h.app.db, admin.id, true).await.unwrap();
1110
    let web = |method: &'static str, path: String, body: Option<String>| {
1111
        let (app, cookie) = (h.app.clone(), cookie.clone());
1112
        async move {
1113
            let mut req = Request::builder().method(method).uri(path).header(header::COOKIE, cookie);
1114
            if body.is_some() {
1115
                req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1116
            }
1117
            let res = oxygenhub::router(app).oneshot(req.body(body.map(Body::from).unwrap_or_else(Body::empty)).unwrap()).await.unwrap();
1118
            let st = res.status();
1119
            (st, String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned())
1120
        }
1121
    };
1122
    let csrf_of = |page: &str| {
1123
        let i = page.find("name=\"_csrf\" value=\"").unwrap() + "name=\"_csrf\" value=\"".len();
1124
        page[i..].split('"').next().unwrap().to_string()
1125
    };
1126
    let (st, page) = web("GET", "/admin/runners".into(), None).await;
1127
    assert_eq!(st, StatusCode::OK);
1128
    assert!(page.contains("No runners yet"));
1129
    assert_eq!(call(&h.app, "GET", "/admin/runners", None, None).await.0, StatusCode::NOT_FOUND, "administrators only");
1130
1131
    // A one-time registration token, shown once with the command.
1132
    let (_, page) = web("POST", "/admin/runners/token".into(), Some(format!("_csrf={}", csrf_of(&page)))).await;
1133
    let i = page.find("--token ").unwrap() + "--token ".len();
1134
    let token: String = page[i..].chars().take_while(|c| !c.is_whitespace()).collect();
1135
    assert!(token.starts_with("flowreg_"), "{token}");
1136
1137
    // The runner registers, binding its key; the token then is spent.
1138
    let sk = SecretKey::generate();
1139
    let identity = sk.identity("plex (OxygenFlow runner)", "", 1);
1140
    let info = serde_json::json!({ "arch": "x86_64", "os": "linux", "version": "0.1.0", "labels": ["big-disk"], "max_jobs": 2, "memory_mib": 16384, "cpus": 4 });
1141
    let reg = serde_json::json!({ "token": token, "name": "plex", "identity": hex::encode(identity.encode()), "info": info });
1142
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1143
    assert_eq!(st, StatusCode::OK, "{body}");
1144
    let credential = serde_json::from_str::<serde_json::Value>(&body).unwrap()["credential"].as_str().unwrap().to_string();
1145
    assert!(credential.starts_with("flowrunner_"));
1146
    assert_eq!(
1147
        call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await.0,
1148
        StatusCode::FORBIDDEN,
1149
        "used once"
1150
    );
1151
1152
    // It claims with its credential; the hub.toml runner shows too.
1153
    let claim_as = |who: String| {
1154
        let app = h.app.clone();
1155
        let info = info.clone();
1156
        async move {
1157
            let body = serde_json::json!({ "runner": "ignored", "runtimes": ["microvm"], "info": info }).to_string();
1158
            call(&app, "POST", "/api/v1/flow/claim", Some(&who), Some(body)).await
1159
        }
1160
    };
1161
    assert_eq!(claim_as(credential.clone()).await.0, StatusCode::NO_CONTENT, "nothing queued");
1162
    assert_eq!(claim(&h.app).await, None);
1163
    let (_, page) = web("GET", "/admin/runners".into(), None).await;
1164
    assert!(
1165
        page.contains(">plex</strong>") && page.contains("st-online") && page.contains("x86_64 · linux") && page.contains("big-disk"),
1166
        "{page}"
1167
    );
1168
    assert!(page.contains(">test-1</strong>") && page.contains("hub.toml"), "the configured runner, by its claimed name");
1169
    let plex = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "plex").unwrap();
1170
    assert_eq!(plex.key, identity.hash().to_hex(), "bound at registration");
1171
1172
    // A run: plex takes a job, and its history shows it.
1173
    let url = format!("{}/andy/demo", h.base);
1174
    let work = tempfile::tempdir().unwrap();
1175
    let c = client(&url, work.path());
1176
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1177
    c.snapshot("test").unwrap();
1178
    c.commit("Add a pipeline", &[]).unwrap();
1179
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1180
    runs_of(&h.app, "andy", "demo").await;
1181
    let (st, body) = claim_as(credential.clone()).await;
1182
    assert_eq!(st, StatusCode::OK, "{body}");
1183
    let job: serde_json::Value = serde_json::from_str(&body).unwrap();
1184
    let (_, page) = web("GET", format!("/admin/runners/{}", plex.id), None).await;
1185
    assert!(
1186
        page.contains("andy/demo") && page.contains(job["job"]["name"].as_str().unwrap()) && page.contains("Running now</dt><dd>1 job"),
1187
        "{page}"
1188
    );
1189
    // The queue on Admin → Runners and through the API (#41, part 4).
1190
    let (_, page) = web("GET", "/admin/runners".into(), None).await;
1191
    assert!(page.contains("<h2>Queue</h2>") && page.contains("<td>plex</td>"), "{page}");
1192
    let (_, tokens) = web("GET", "/settings/tokens".into(), None).await;
1193
    let (_, made) = web("POST", "/settings/tokens".into(), Some(format!("_csrf={}&name=admin&scopes=user%3Aread", csrf_of(&tokens)))).await;
1194
    let i = made.find("oxyhub_").unwrap();
1195
    let admin_token: String = made[i..].chars().take_while(|c| c.is_ascii_alphanumeric() || *c == '_').collect();
1196
    let (st, body) = call(&h.app, "GET", "/api/v1/runners", Some(&admin_token), None).await;
1197
    assert_eq!(st, StatusCode::OK, "{body}");
1198
    let listed: serde_json::Value = serde_json::from_str(&body).unwrap();
1199
    let plex_row = listed.as_array().unwrap().iter().find(|r| r["name"] == "plex").unwrap();
1200
    assert_eq!((plex_row["running"].as_i64(), plex_row["arch"].as_str()), (Some(1), Some("x86_64")));
1201
    // A runner's own labels and time limit from its page (#98).
1202
    let (_, page) = web("GET", format!("/admin/runners/{}", plex.id), None).await;
1203
    let (st, _) = web(
1204
        "POST",
1205
        format!("/admin/runners/{}/limits", plex.id),
1206
        Some(format!("_csrf={}&labels=gpu%2C+plex&timeout_minutes=5", csrf_of(&page))),
1207
    )
1208
    .await;
1209
    assert_eq!(st, StatusCode::SEE_OTHER);
1210
    let (_, page) = web("GET", format!("/admin/runners/{}", plex.id), None).await;
1211
    assert!(page.contains(">gpu<") && page.contains("5 min for its jobs"), "{page}");
1212
    let (_, body) = call(&h.app, "GET", "/api/v1/runners", Some(&admin_token), None).await;
1213
    let listed: serde_json::Value = serde_json::from_str(&body).unwrap();
1214
    let plex_row = listed.as_array().unwrap().iter().find(|r| r["name"] == "plex").unwrap();
1215
    assert!(plex_row["labels"].as_array().unwrap().iter().any(|l| l == "gpu"), "{plex_row}");
1216
    let (st, _) = web(
1217
        "POST",
1218
        format!("/admin/runners/{}/limits", plex.id),
1219
        Some(format!("_csrf={}&labels=bad%20label%21&timeout_minutes=", csrf_of(&page))),
1220
    )
1221
    .await;
1222
    assert_eq!(st, StatusCode::BAD_REQUEST, "a label with a space or punctuation is refused");
1223
    let (_, body) = call(&h.app, "GET", "/api/v1/runners/queue", Some(&admin_token), None).await;
1224
    let queue: serde_json::Value = serde_json::from_str(&body).unwrap();
1225
    assert!(queue.as_array().unwrap().iter().any(|q| q["status"] == "running" && q["runner"] == "plex"), "{queue}");
1226
    let (_, body) = call(&h.app, "GET", &format!("/api/v1/runners/{}/jobs", plex.id), Some(&admin_token), None).await;
1227
    let jobs: serde_json::Value = serde_json::from_str(&body).unwrap();
1228
    assert_eq!(jobs[0]["repo"], "andy/demo", "{jobs}");
1229
    assert_eq!(call(&h.app, "GET", "/api/v1/runners", None, None).await.0, StatusCode::NOT_FOUND, "administrators only");
1230
1231
    // Draining: no new work; removing while busy is refused.
1232
    let (_, page) = web("GET", "/admin/runners".into(), None).await;
1233
    let csrf = csrf_of(&page);
1234
    web("POST", format!("/admin/runners/{}/state", plex.id), Some(format!("_csrf={csrf}&state=draining"))).await;
1235
    assert_eq!(claim_as(credential.clone()).await.0, StatusCode::NO_CONTENT, "a draining runner takes nothing");
1236
    let (_, page) = web("POST", format!("/admin/runners/{}/remove", plex.id), Some(format!("_csrf={csrf}"))).await;
1237
    assert!(page.contains("is running jobs: drain it first"), "{page}");
1238
    // Its job finishes; disabled, it is refused; removed, its credential is dead.
1239
    let id = job["job_id"].as_i64().unwrap();
1240
    let done = call(
1241
        &h.app,
1242
        "POST",
1243
        &format!("/api/v1/flow/jobs/{id}/finish"),
1244
        Some(&credential),
1245
        Some(r#"{"exit_code":0,"duration_ms":5}"#.into()),
1246
    )
1247
    .await;
1248
    assert_eq!(done.0, StatusCode::NO_CONTENT);
1249
    web("POST", format!("/admin/runners/{}/state", plex.id), Some(format!("_csrf={csrf}&state=disabled"))).await;
1250
    assert_eq!(claim_as(credential.clone()).await.0, StatusCode::FORBIDDEN);
1251
    let (_, page) = web("POST", format!("/admin/runners/{}/remove", plex.id), Some(format!("_csrf={csrf}"))).await;
1252
    assert!(page.contains("Removed plex."), "{page}");
1253
    assert_eq!(claim_as(credential).await.0, StatusCode::UNAUTHORIZED);
1254
}
1255
1256
/// Runner scopes (oxygenhub#41): a runner registered for one repository, or
1257
/// one owner, takes only those jobs; a site runner takes any.
1258
#[tokio::test(flavor = "multi_thread")]
1259
async fn scoped_runners_take_only_their_scope() {
1260
    use oxy_core::identity::SecretKey;
1261
    let h = hub().await;
1262
    create(&h.app, "andy", "demo").await;
1263
    create(&h.app, "andy", "other").await;
1264
    let register = |scope: db::runners::Scope, name: &'static str| {
1265
        let app = h.app.clone();
1266
        async move {
1267
            let token = format!("flowreg_{name}");
1268
            db::runners::add_registration(&app.db, &blake3::hash(token.as_bytes()).to_hex(), "admin", &scope).await.unwrap();
1269
            let identity = SecretKey::generate().identity(name, "", 1);
1270
            let info = serde_json::json!({ "arch": "x86_64", "os": "linux", "version": "0.1.0", "labels": [], "max_jobs": 1 });
1271
            let reg = serde_json::json!({ "token": token, "name": name, "identity": hex::encode(identity.encode()), "info": info });
1272
            let (st, body) = call(&app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1273
            assert_eq!(st, StatusCode::OK, "{body}");
1274
            serde_json::from_str::<serde_json::Value>(&body).unwrap()["credential"].as_str().unwrap().to_string()
1275
        }
1276
    };
1277
    let demo = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
1278
    let only_demo = register(db::runners::Scope { owner: "andy".into(), repo_id: Some(demo.id) }, "demo-runner").await;
1279
    let carols = register(db::runners::Scope { owner: "carol".into(), repo_id: None }, "carol-runner").await;
1280
    let andys = register(db::runners::Scope { owner: "andy".into(), repo_id: None }, "andy-runner").await;
1281
    let claim_as = |who: String| {
1282
        let app = h.app.clone();
1283
        async move {
1284
            let body = serde_json::json!({ "runner": "x", "runtimes": ["microvm"] }).to_string();
1285
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some(&who), Some(body)).await;
1286
            (st == StatusCode::OK).then(|| serde_json::from_str::<serde_json::Value>(&body).unwrap()["repo"].as_str().unwrap().to_string())
1287
        }
1288
    };
1289
    // Jobs queued in andy/other only.
1290
    let work = tempfile::tempdir().unwrap();
1291
    let c = client(&format!("{}/andy/other", h.base), work.path());
1292
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1293
    c.snapshot("t").unwrap();
1294
    c.commit("pipeline", &[]).unwrap();
1295
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1296
    assert!(!runs_of(&h.app, "andy", "other").await.is_empty());
1297
    assert_eq!(claim_as(only_demo.clone()).await, None, "nothing of andy/demo is queued");
1298
    assert_eq!(claim_as(carols).await, None, "nothing of carol's");
1299
    assert_eq!(claim_as(andys).await.as_deref(), Some("andy/other"), "the owner's runner takes its repositories' jobs");
1300
    // The site runner (hub.toml) takes any.
1301
    assert_eq!(claim(&h.app).await.unwrap()["repo"], "andy/other");
1302
    assert_eq!(claim_as(only_demo).await, None, "still nothing of its own");
1303
}
1304
1305
/// Settings → Runners (oxygenhub#41, part 2b): a repository's admin adds a
1306
/// runner for that repository alone, sees which runners serve it, and
1307
/// removes only its own.
1308
#[tokio::test(flavor = "multi_thread")]
1309
async fn repository_admins_add_and_remove_their_own_runners() {
1310
    use oxy_core::identity::SecretKey;
1311
    let h = hub().await;
1312
    let res = oxygenhub::router(h.app.clone())
1313
        .oneshot(
1314
            Request::post("/register")
1315
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1316
                .body(Body::from("username=andy&email=andy%40example.com&password=correct-horse-battery"))
1317
                .unwrap(),
1318
        )
1319
        .await
1320
        .unwrap();
1321
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1322
    create(&h.app, "andy", "demo").await;
1323
    let demo = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
1324
    let web = |method: &'static str, path: String, body: Option<String>| {
1325
        let (app, cookie) = (h.app.clone(), cookie.clone());
1326
        async move {
1327
            let mut req = Request::builder().method(method).uri(path).header(header::COOKIE, cookie);
1328
            if body.is_some() {
1329
                req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1330
            }
1331
            let res = oxygenhub::router(app).oneshot(req.body(body.map(Body::from).unwrap_or_else(Body::empty)).unwrap()).await.unwrap();
1332
            let st = res.status();
1333
            (st, String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned())
1334
        }
1335
    };
1336
    let csrf_of = |page: &str| {
1337
        let i = page.find("name=\"_csrf\" value=\"").unwrap() + "name=\"_csrf\" value=\"".len();
1338
        page[i..].split('"').next().unwrap().to_string()
1339
    };
1340
    let (st, page) = web("GET", "/andy/demo/settings".into(), None).await;
1341
    assert_eq!(st, StatusCode::OK);
1342
    assert!(page.contains("<h2>Runners</h2>"), "the owner sees the section");
1343
    let (_, page) = web("POST", "/andy/demo/settings/runners/token".into(), Some(format!("_csrf={}", csrf_of(&page)))).await;
1344
    let i = page.find("--token ").unwrap() + "--token ".len();
1345
    let token: String = page[i..].chars().take_while(|c| !c.is_whitespace()).collect();
1346
    let identity = SecretKey::generate().identity("mine", "", 1);
1347
    let info = serde_json::json!({ "arch": "x86_64", "os": "linux", "version": "0.1.0", "labels": [], "max_jobs": 1 });
1348
    let reg = serde_json::json!({ "token": token, "name": "mine", "identity": hex::encode(identity.encode()), "info": info });
1349
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1350
    assert_eq!(st, StatusCode::OK, "{body}");
1351
    let mine = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "mine").unwrap();
1352
    assert_eq!(mine.scope(), db::runners::Scope { owner: "andy".into(), repo_id: Some(demo.id) });
1353
    // The site's runner (hub.toml, from its first claim) serves it too, but is not the owner's to remove.
1354
    claim(&h.app).await;
1355
    let site = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "test-1").unwrap();
1356
    let (_, page) = web("GET", "/andy/demo/settings".into(), None).await;
1357
    assert!(page.contains("<strong>mine</strong>") && page.contains("this repository"), "{page}");
1358
    assert!(page.contains("<strong>test-1</strong>") && page.contains("the whole site"), "{page}");
1359
    let csrf = csrf_of(&page);
1360
    let (st, _) = web("POST", format!("/andy/demo/settings/runners/{}/remove", site.id), Some(format!("_csrf={csrf}"))).await;
1361
    assert_eq!(st, StatusCode::NOT_FOUND, "not the repository's own");
1362
    let (_, page) = web("POST", format!("/andy/demo/settings/runners/{}/remove", mine.id), Some(format!("_csrf={csrf}"))).await;
1363
    assert!(page.contains("mine removed"), "{page}");
1364
    assert!(db::runners::get(&h.app.db, mine.id).await.unwrap().is_none());
1365
1366
    // The same for an organisation's owner.
1367
    let (_, page) = web("GET", "/orgs/new".into(), None).await;
1368
    web("POST", "/orgs/new".into(), Some(format!("_csrf={}&name=acme&display_name=Acme", csrf_of(&page)))).await;
1369
    let (st, page) = web("GET", "/orgs/acme/settings".into(), None).await;
1370
    assert_eq!(st, StatusCode::OK);
1371
    let (_, page) = web("POST", "/orgs/acme/settings/runners/token".into(), Some(format!("_csrf={}", csrf_of(&page)))).await;
1372
    let i = page.find("--token ").unwrap() + "--token ".len();
1373
    let token: String = page[i..].chars().take_while(|c| !c.is_whitespace()).collect();
1374
    let identity = SecretKey::generate().identity("acme-runner", "", 1);
1375
    let reg = serde_json::json!({ "token": token, "name": "acme-runner", "identity": hex::encode(identity.encode()), "info": info });
1376
    assert_eq!(call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await.0, StatusCode::OK);
1377
    let acme = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "acme-runner").unwrap();
1378
    assert_eq!(acme.scope(), db::runners::Scope { owner: "acme".into(), repo_id: None });
1379
    let (_, page) = web("GET", "/orgs/acme/settings".into(), None).await;
1380
    assert!(page.contains("<strong>acme-runner</strong>") && page.contains("the organisation's repositories"), "{page}");
1381
    let (_, page) = web("POST", format!("/orgs/acme/settings/runners/{}/remove", acme.id), Some(format!("_csrf={}", csrf_of(&page)))).await;
1382
    assert!(page.contains("acme-runner removed"), "{page}");
1383
}
1384
1385
/// runs-on (oxygenhub#41, part 3): a job that asks for a label goes only to
1386
/// a runner that has it, and waits for one otherwise.
1387
#[tokio::test(flavor = "multi_thread")]
1388
async fn jobs_that_ask_for_labels_wait_for_a_runner_with_them() {
1389
    use oxy_core::identity::SecretKey;
1390
    let h = hub().await;
1391
    create(&h.app, "andy", "demo").await;
1392
    let work = tempfile::tempdir().unwrap();
1393
    let c = client(&format!("{}/andy/demo", h.base), work.path());
1394
    let cross = "job \"cross\" {\n    sandbox \"alpine\"\n    runs-on \"riscv64\"\n    exec \"true\"\n}\n";
1395
    write(work.path(), ".flow/pipeline.kdl", &pipeline(cross));
1396
    c.snapshot("t").unwrap();
1397
    c.commit("pipeline", &[]).unwrap();
1398
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1399
    assert!(!runs_of(&h.app, "andy", "demo").await.is_empty());
1400
    // The site runner has no labels: it takes the others, never cross.
1401
    let mut taken = Vec::new();
1402
    while let Some(j) = claim(&h.app).await {
1403
        taken.push(j["job"]["name"].as_str().unwrap().to_string());
1404
    }
1405
    assert!(!taken.contains(&"cross".to_string()) && taken.contains(&"lint".to_string()), "{taken:?}");
1406
    let queue = db::flow::queue(&h.app.db).await.unwrap();
1407
    let waiting = queue.iter().find(|q| q.job == "cross").unwrap();
1408
    assert_eq!((waiting.status.as_str(), waiting.needs()), ("queued", vec!["riscv64".to_string()]));
1409
    // A runner registered with the label takes it.
1410
    let token = "flowreg_riscv";
1411
    db::runners::add_registration(&h.app.db, &blake3::hash(token.as_bytes()).to_hex(), "admin", &Default::default()).await.unwrap();
1412
    let identity = SecretKey::generate().identity("visionfive", "", 1);
1413
    let info = serde_json::json!({ "arch": "riscv64", "os": "linux", "version": "0.1.0", "labels": ["riscv64"], "max_jobs": 1 });
1414
    let reg = serde_json::json!({ "token": token, "name": "visionfive", "identity": hex::encode(identity.encode()), "info": info });
1415
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1416
    assert_eq!(st, StatusCode::OK, "{body}");
1417
    let credential = serde_json::from_str::<serde_json::Value>(&body).unwrap()["credential"].as_str().unwrap().to_string();
1418
    let claim_body = serde_json::json!({ "runner": "x", "runtimes": ["microvm"], "info": info }).to_string();
1419
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/claim", Some(&credential), Some(claim_body)).await;
1420
    assert_eq!(st, StatusCode::OK, "{body}");
1421
    assert_eq!(serde_json::from_str::<serde_json::Value>(&body).unwrap()["job"]["name"], "cross");
1422
}
1423
1424
/// oxygenhub#71: a job its runner stopped reporting (restarted, or lost
1425
/// the hub as the job ended) is ended once it has run past the time limit
1426
/// and a grace: an error with the reason, its dependents skipped and its
1427
/// run settled, as if the runner had reported the error.
1428
#[tokio::test(flavor = "multi_thread")]
1429
async fn a_job_no_runner_reports_is_ended_after_the_time_limit() {
1430
    let h = hub().await;
1431
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1432
    create(&h.app, "andy", "lost").await;
1433
    let url = format!("{}/andy/lost", h.base);
1434
    let work = tempfile::tempdir().unwrap();
1435
    let c = client(&url, work.path());
1436
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1437
    write(work.path(), "test.sh", "echo ok\n");
1438
    c.commit("Add a pipeline", &[]).unwrap();
1439
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1440
    assert_eq!(runs_of(&h.app, "andy", "lost").await.len(), 1);
1441
    let job = claim(&h.app).await.expect("a job to claim");
1442
    let id = job["job_id"].as_i64().unwrap();
1443
1444
    // Running, but well within the limit: left alone.
1445
    assert_eq!(oxygenhub::flow::reap_lost_jobs(&h.app).await.unwrap(), 0);
1446
    // Started long ago and never reported: ended.
1447
    let old = db::now_ms() - 24 * 3600 * 1000;
1448
    sqlx::query("UPDATE flow_jobs SET started_ms = ? WHERE id = ?").bind(old).bind(id).execute(&h.app.db).await.unwrap();
1449
    assert_eq!(oxygenhub::flow::reap_lost_jobs(&h.app).await.unwrap(), 1);
1450
    let j = db::flow::job(&h.app.db, id).await.unwrap().unwrap();
1451
    assert_eq!(j.status, "error");
1452
    assert!(j.error.starts_with("lost:"), "{}", j.error);
1453
    let run = &runs_of(&h.app, "andy", "lost").await[0];
1454
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
1455
    assert!(jobs.iter().all(|j| j.status != "running"), "nothing left running");
1456
    // A late report, should one come, does not overwrite the ending.
1457
    assert_ne!(finish(&h.app, id, serde_json::json!({ "exit_code": 0 })).await, StatusCode::NO_CONTENT);
1458
    assert_eq!(db::flow::job(&h.app.db, id).await.unwrap().unwrap().status, "error");
1459
}
1460
1461
/// oxygenhub#73: a runner that lists the images it holds is offered only
1462
/// the jobs whose rootfs is among them; one that does not say gets any.
1463
#[tokio::test(flavor = "multi_thread")]
1464
async fn a_runner_is_offered_only_jobs_whose_image_it_holds() {
1465
    let h = hub().await;
1466
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1467
    create(&h.app, "andy", "images").await;
1468
    let url = format!("{}/andy/images", h.base);
1469
    let work = tempfile::tempdir().unwrap();
1470
    let c = client(&url, work.path());
1471
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1472
    write(work.path(), "test.sh", "echo ok\n");
1473
    c.commit("Add a pipeline", &[]).unwrap();
1474
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1475
    assert_eq!(runs_of(&h.app, "andy", "images").await.len(), 1);
1476
    let claim_with = |images: Vec<String>| {
1477
        let body = serde_json::json!({ "runner": "test-1", "runtimes": ["microvm"], "images": images }).to_string();
1478
        let app = h.app.clone();
1479
        async move {
1480
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(body)).await;
1481
            (st, body)
1482
        }
1483
    };
1484
    let (st, _) = claim_with(vec!["ab".repeat(32)]).await;
1485
    assert_eq!(st, StatusCode::NO_CONTENT, "no job for a runner without the image");
1486
    let jobs = db::flow::jobs(&h.app.db, runs_of(&h.app, "andy", "images").await[0].id).await.unwrap();
1487
    let rootfs: serde_json::Value = serde_json::from_str(&jobs[0].sandbox).unwrap();
1488
    let rootfs = rootfs["rootfs"].as_str().unwrap().to_string();
1489
    let (st, body) = claim_with(vec!["ab".repeat(32), rootfs]).await;
1490
    assert_eq!(st, StatusCode::OK, "{body}");
1491
}
1492
1493
/// oxygenhub#71: a runner that lists the jobs it holds has the others it
1494
/// was given ended at once (it restarted, or never received them), not at
1495
/// the time limit; a held job is left alone.
1496
#[tokio::test(flavor = "multi_thread")]
1497
async fn a_job_its_runner_no_longer_holds_is_ended_at_its_next_claim() {
1498
    let h = hub().await;
1499
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1500
    create(&h.app, "andy", "held").await;
1501
    let url = format!("{}/andy/held", h.base);
1502
    let work = tempfile::tempdir().unwrap();
1503
    let c = client(&url, work.path());
1504
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1505
    write(work.path(), "test.sh", "echo ok\n");
1506
    c.commit("Add a pipeline", &[]).unwrap();
1507
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1508
    assert_eq!(runs_of(&h.app, "andy", "held").await.len(), 1);
1509
    let id = claim(&h.app).await.expect("a job to claim")["job_id"].as_i64().unwrap();
1510
    let claim_holding = |holding: Vec<i64>| {
1511
        let body = serde_json::json!({ "runner": "test-1", "runtimes": ["microvm"], "holding": holding }).to_string();
1512
        let app = h.app.clone();
1513
        async move { call(&app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(body)).await.0 }
1514
    };
1515
    claim_holding(vec![id]).await;
1516
    assert_eq!(db::flow::job(&h.app.db, id).await.unwrap().unwrap().status, "running", "a held job stays");
1517
    claim_holding(vec![]).await;
1518
    let j = db::flow::job(&h.app.db, id).await.unwrap().unwrap();
1519
    assert_eq!(j.status, "error");
1520
    assert!(j.error.starts_with("lost:") && j.error.contains("no longer holds"), "{}", j.error);
1521
    let run = &runs_of(&h.app, "andy", "held").await[0];
1522
    assert!(db::flow::jobs(&h.app.db, run.id).await.unwrap().iter().all(|j| j.status != "running"), "the run settles");
1523
}
1524
1525
/// oxygen#59: a job with a `scope` runs on a push only when the push's
1526
/// changes touch a path it names (a release job, when Cargo.toml's version
1527
/// moves); a bookmark's first run and manual runs have every job.
1528
#[tokio::test(flavor = "multi_thread")]
1529
async fn a_scoped_job_runs_only_when_a_push_touches_its_paths() {
1530
    let h = hub().await;
1531
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1532
    create(&h.app, "andy", "scoped").await;
1533
    let url = format!("{}/andy/scoped", h.base);
1534
    let work = tempfile::tempdir().unwrap();
1535
    let c = client(&url, work.path());
1536
    let extra = "job \"dist\" {\n    sandbox \"alpine\"\n    scope \"Cargo.toml\" \"packaging/**\"\n    exec \"true\"\n}\n";
1537
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1538
    write(work.path(), "test.sh", "echo ok\n");
1539
    write(work.path(), "Cargo.toml", "version = \"0.1.0\"\n");
1540
    c.commit("Start", &[]).unwrap();
1541
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1542
    let names = |app: Shared, n: usize| async move {
1543
        let mut runs = Vec::new();
1544
        for _ in 0..100 {
1545
            runs = runs_of(&app, "andy", "scoped").await;
1546
            if runs.len() >= n {
1547
                break;
1548
            }
1549
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1550
        }
1551
        assert_eq!(runs.len(), n, "runs");
1552
        let mut j: Vec<String> = db::flow::jobs(&app.db, runs[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1553
        j.sort();
1554
        // Passed, so the next push is scoped against it, not superseding it.
1555
        sqlx::query("UPDATE flow_runs SET status = 'passed' WHERE id = ?").bind(runs[0].id).execute(&app.db).await.unwrap();
1556
        j
1557
    };
1558
    assert_eq!(names(h.app.clone(), 1).await, ["build", "dist", "lint", "test"], "the first run has every job");
1559
    write(work.path(), "test.sh", "echo still ok\n");
1560
    c.commit("Edit the test", &[]).unwrap();
1561
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1562
    assert_eq!(names(h.app.clone(), 2).await, ["build", "lint", "test"], "dist is out of scope");
1563
    write(work.path(), "Cargo.toml", "version = \"0.1.1\"\n");
1564
    c.commit("Release 0.1.1", &[]).unwrap();
1565
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1566
    assert_eq!(names(h.app.clone(), 3).await, ["build", "dist", "lint", "test"], "a version bump runs dist");
1567
}
1568
1569
/// oxygenflow#32: a run still going is cancelled from the API, the web or
1570
/// by a newer push to its bookmark; its runner is refused from then on,
1571
/// and the next push is scoped past the cancelled run.
1572
#[tokio::test(flavor = "multi_thread")]
1573
async fn runs_are_cancelled_by_hand_or_by_a_newer_push() {
1574
    let h = hub().await;
1575
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1576
    create(&h.app, "andy", "stop").await;
1577
    let url = format!("{}/andy/stop", h.base);
1578
    let work = tempfile::tempdir().unwrap();
1579
    let c = client(&url, work.path());
1580
    let extra = "job \"dist\" {\n    sandbox \"alpine\"\n    scope \"Cargo.toml\"\n    exec \"true\"\n}\n";
1581
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1582
    write(work.path(), "test.sh", "echo ok\n");
1583
    write(work.path(), "Cargo.toml", "version = \"0.1.0\"\n");
1584
    c.commit("Start", &[]).unwrap();
1585
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1586
    let wait_runs = |app: Shared, n: usize| async move {
1587
        for _ in 0..100 {
1588
            let runs = runs_of(&app, "andy", "stop").await;
1589
            if runs.len() >= n {
1590
                return runs;
1591
            }
1592
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1593
        }
1594
        panic!("no run {n}");
1595
    };
1596
    let first = wait_runs(h.app.clone(), 1).await;
1597
    sqlx::query("UPDATE flow_runs SET status = 'passed' WHERE id = ?").bind(first[0].id).execute(&h.app.db).await.unwrap();
1598
    sqlx::query("UPDATE flow_jobs SET status = 'passed' WHERE run_id = ?").bind(first[0].id).execute(&h.app.db).await.unwrap();
1599
1600
    // Run 2 (a version bump) has a job running when run 3 is pushed.
1601
    write(work.path(), "Cargo.toml", "version = \"0.1.1\"\n");
1602
    c.commit("Release 0.1.1", &[]).unwrap();
1603
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1604
    wait_runs(h.app.clone(), 2).await;
1605
    let job = claim(&h.app).await.expect("a job of run 2");
1606
    let id = job["job_id"].as_i64().unwrap();
1607
    write(work.path(), "test.sh", "echo still ok\n");
1608
    c.commit("Edit the test", &[]).unwrap();
1609
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1610
    let runs = wait_runs(h.app.clone(), 3).await;
1611
    let third = &runs[0];
1612
    let mut second = runs[1].clone();
1613
    for _ in 0..100 {
1614
        second = db::flow::run_by_id(&h.app.db, runs[1].id).await.unwrap().unwrap();
1615
        if !second.live() {
1616
            break;
1617
        }
1618
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1619
    }
1620
    assert_eq!(second.status, "cancelled", "a newer push supersedes a run still going");
1621
    let jobs = db::flow::jobs(&h.app.db, second.id).await.unwrap();
1622
    assert!(jobs.iter().all(|j| j.status == "cancelled" && j.error == "superseded by run #3"), "{jobs:?}");
1623
    let mut names: Vec<String> = db::flow::jobs(&h.app.db, third.id).await.unwrap().into_iter().map(|j| j.name).collect();
1624
    names.sort();
1625
    assert_eq!(names, ["build", "dist", "lint", "test"], "run 3 also checks what run 2 would have: the version bump");
1626
    let mut checks = vec![];
1627
    for _ in 0..100 {
1628
        checks = db::hooks::checks_for_state(&h.app.db, second.repo_id, &second.state).await.unwrap();
1629
        if checks.iter().all(|c| c.status == "cancelled") {
1630
            break;
1631
        }
1632
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1633
    }
1634
    assert!(checks.iter().all(|c| c.status == "cancelled"), "{checks:?}");
1635
    // The runner of the cancelled job is refused, so it stops the job.
1636
    let (st, _) =
1637
        call(&h.app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(r#"{"records":[]}"#.into())).await;
1638
    assert_eq!(st, StatusCode::CONFLICT);
1639
1640
    // By hand: the API, then a run already ended is refused.
1641
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/stop/flow/runs/3/cancel", Some("site"), None).await;
1642
    assert_eq!(st, StatusCode::OK, "{body}");
1643
    let third = db::flow::run_by_id(&h.app.db, third.id).await.unwrap().unwrap();
1644
    assert_eq!(third.status, "cancelled");
1645
    assert!(db::flow::jobs(&h.app.db, third.id).await.unwrap().iter().all(|j| j.error == "cancelled by andy"));
1646
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/stop/flow/runs/3/cancel", Some("site"), None).await;
1647
    assert!(st == StatusCode::CONFLICT && body.contains("already cancelled"), "{st} {body}");
1648
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/stop/flow/runs/3/cancel", None, None).await;
1649
    assert_ne!(st, StatusCode::OK, "anonymous callers cannot cancel");
1650
    let (_, page) = call(&h.app, "GET", "/andy/stop/flow/3", None, None).await;
1651
    assert!(page.contains("⊘") && !page.contains("CANCEL</button>"), "a cancelled run shows so, with no button");
1652
}
1653
1654
/// oxygenflow#23 and oxygenhub#89: a job runs under its pipeline's
1655
/// timeout, capped at the site's maximum, else the site's default; and the
1656
/// hub gives a job up only past its own limit.
1657
#[tokio::test(flavor = "multi_thread")]
1658
async fn a_job_runs_under_its_own_time_limit_within_the_sites() {
1659
    let h = hub().await;
1660
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1661
    db::accounts::set_setting(&h.app.db, oxygenhub::flow::SETTING_DEFAULT, "30").await.unwrap();
1662
    db::accounts::set_setting(&h.app.db, oxygenhub::flow::SETTING_MAX, "120").await.unwrap();
1663
    create(&h.app, "andy", "limits").await;
1664
    let url = format!("{}/andy/limits", h.base);
1665
    let work = tempfile::tempdir().unwrap();
1666
    let c = client(&url, work.path());
1667
    let extra = "job \"slow\" {\n    sandbox \"alpine\"\n    timeout \"90m\"\n    exec \"true\"\n}\njob \"huge\" {\n    sandbox \"alpine\"\n    timeout \"5h\"\n    exec \"true\"\n}\n";
1668
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1669
    write(work.path(), "test.sh", "echo ok\n");
1670
    c.commit("Add a pipeline", &[]).unwrap();
1671
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1672
    assert_eq!(runs_of(&h.app, "andy", "limits").await.len(), 1);
1673
    let mut limits = std::collections::HashMap::new();
1674
    let mut ids = std::collections::HashMap::new();
1675
    while let Some(j) = claim(&h.app).await {
1676
        let name = j["job"]["name"].as_str().unwrap().to_string();
1677
        limits.insert(name.clone(), j["timeout_s"].as_u64().unwrap());
1678
        ids.insert(name, j["job_id"].as_i64().unwrap());
1679
    }
1680
    assert_eq!(limits["slow"], 5400, "its own");
1681
    assert_eq!(limits["huge"], 7200, "cut to the site's maximum");
1682
    assert_eq!(limits["build"], 1800, "the site's default");
1683
    // 40 minutes in: past the default and its grace, within slow's limit.
1684
    let started = db::now_ms() - 40 * 60 * 1000;
1685
    sqlx::query("UPDATE flow_jobs SET started_ms = ?").bind(started).execute(&h.app.db).await.unwrap();
1686
    oxygenhub::flow::reap_lost_jobs(&h.app).await.unwrap();
1687
    let status = |id: i64| {
1688
        let app = h.app.clone();
1689
        async move { db::flow::job(&app.db, id).await.unwrap().unwrap().status }
1690
    };
1691
    assert_eq!(status(ids["build"]).await, "error", "past its 30 minutes");
1692
    assert_eq!(status(ids["slow"]).await, "running", "within its 90");
1693
    assert_eq!(status(ids["huge"]).await, "running", "within its 120");
1694
}
1695
1696
/// oxygenflow#24: a job's `on` decides which events start it: a pushed
1697
/// tag runs only the jobs that name it; a push to a bookmark the pipeline
1698
/// does not name starts no run; a rerun repeats its run's event.
1699
#[tokio::test(flavor = "multi_thread")]
1700
async fn on_decides_which_events_start_a_job() {
1701
    let h = hub().await;
1702
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1703
    create(&h.app, "andy", "events").await;
1704
    let url = format!("{}/andy/events", h.base);
1705
    let work = tempfile::tempdir().unwrap();
1706
    let c = client(&url, work.path());
1707
    let text = format!(
1708
        "on {{\n    push \"main\"\n    manual\n}}\n{}job \"dist\" {{\n    sandbox \"alpine\"\n    on {{\n        tag \"v*\"\n    }}\n    exec \"true\"\n}}\n",
1709
        pipeline("")
1710
    );
1711
    // `on` must come after schema-version; pipeline() starts with it.
1712
    let text = text.replacen(
1713
        "on {\n    push \"main\"\n    manual\n}\nschema-version 1\n",
1714
        "schema-version 1\non {\n    push \"main\"\n    manual\n}\n",
1715
        1,
1716
    );
1717
    write(work.path(), ".flow/pipeline.kdl", &text);
1718
    write(work.path(), "test.sh", "echo ok\n");
1719
    c.commit("Start", &[]).unwrap();
1720
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1721
    let jobs_of_latest = |app: Shared, n: usize| async move {
1722
        let mut runs = Vec::new();
1723
        for _ in 0..100 {
1724
            runs = runs_of(&app, "andy", "events").await;
1725
            if runs.len() >= n {
1726
                break;
1727
            }
1728
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1729
        }
1730
        assert_eq!(runs.len(), n, "runs");
1731
        let mut j: Vec<String> = db::flow::jobs(&app.db, runs[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1732
        j.sort();
1733
        (runs[0].clone(), j)
1734
    };
1735
    let (_, j) = jobs_of_latest(h.app.clone(), 1).await;
1736
    assert_eq!(j, ["build", "lint", "test"], "a push to main: no dist");
1737
    // A tag: only dist.
1738
    let heads = c.bookmark_heads().unwrap();
1739
    c.tag_create("v1.0.0", &heads, "first").unwrap();
1740
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1741
    let (run, j) = jobs_of_latest(h.app.clone(), 2).await;
1742
    assert_eq!(j, ["dist"], "a tag runs only what names it");
1743
    assert_eq!(run.trigger, "tag:v1.0.0");
1744
    // A rerun repeats the tag's event.
1745
    let row = db::repos::get(&h.app.db, "andy", "events").await.unwrap().unwrap();
1746
    db::flow::finish(
1747
        &h.app.db,
1748
        db::flow::jobs(&h.app.db, run.id).await.unwrap()[0].id,
1749
        db::flow::Outcome { status: "passed", exit_code: Some(0), error: "", receipt: "", receipt_hash: "" },
1750
    )
1751
    .await
1752
    .unwrap();
1753
    let run = db::flow::run_by_id(&h.app.db, run.id).await.unwrap().unwrap();
1754
    oxygenhub::flow::rerun(&h.app, &row, &run, "andy").await.unwrap();
1755
    let (_, j) = jobs_of_latest(h.app.clone(), 3).await;
1756
    assert_eq!(j, ["dist"], "the rerun is the tag's run again");
1757
    // A bookmark the pipeline does not name starts nothing.
1758
    c.bookmark_create("develop", None).unwrap();
1759
    assert!(c.push_bookmark("origin", "develop", false).unwrap().iter().all(|r| r.ok));
1760
    tokio::time::sleep(std::time::Duration::from_millis(300)).await;
1761
    assert_eq!(runs_of(&h.app, "andy", "events").await.len(), 3, "no run for develop");
1762
}
1763
1764
/// oxygenflow#24: a job with a `schedule` line runs on the default
1765
/// bookmark when the line comes due, and only then; other jobs stay out.
1766
#[tokio::test(flavor = "multi_thread")]
1767
async fn scheduled_jobs_run_when_due() {
1768
    let h = hub().await;
1769
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1770
    create(&h.app, "andy", "nightly").await;
1771
    let url = format!("{}/andy/nightly", h.base);
1772
    let work = tempfile::tempdir().unwrap();
1773
    let c = client(&url, work.path());
1774
    // An odd minute, so the hub's own ticker cannot fire it during the test.
1775
    let extra = "job \"nightly\" {\n    sandbox \"alpine\"\n    on {\n        schedule \"17 4 29 2 *\"\n    }\n    exec \"true\"\n}\n";
1776
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1777
    write(work.path(), "test.sh", "echo ok\n");
1778
    c.commit("Start", &[]).unwrap();
1779
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1780
    assert_eq!(runs_of(&h.app, "andy", "nightly").await.len(), 1);
1781
    let first = runs_of(&h.app, "andy", "nightly").await;
1782
    let names: Vec<String> = db::flow::jobs(&h.app.db, first[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1783
    assert!(!names.contains(&"nightly".to_string()), "a push does not run a scheduled job");
1784
    use flow_core::pipeline::When;
1785
    let not_yet = When { minute: 16, hour: 4, day: 29, month: 2, weekday: 4 };
1786
    assert_eq!(oxygenhub::flow::run_due(&h.app, not_yet).await, 0);
1787
    let due = When { minute: 17, ..not_yet };
1788
    assert_eq!(oxygenhub::flow::run_due(&h.app, due).await, 1);
1789
    let runs = runs_of(&h.app, "andy", "nightly").await;
1790
    assert_eq!(runs.len(), 2);
1791
    assert_eq!(runs[0].trigger, "schedule");
1792
    let names: Vec<String> = db::flow::jobs(&h.app.db, runs[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1793
    assert_eq!(names, ["nightly"]);
1794
    assert_eq!(runs[0].bookmark, "main", "on the default bookmark");
1795
}
1796
1797
#[tokio::test(flavor = "multi_thread")]
1798
async fn variables_from_three_levels_reach_a_job_inner_overriding_outer() {
1799
    use oxygenhub::levels::Scope;
1800
    use oxygenhub::variables;
1801
    let h = hub().await;
1802
    let app = &h.app;
1803
    // Andy, the site's administrator, owns the acme organisation.
1804
    let res = oxygenhub::router(app.clone())
1805
        .oneshot(
1806
            Request::post("/register")
1807
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1808
                .body(Body::from("username=andy&email=a%40example.com&password=correct-horse-battery"))
1809
                .unwrap(),
1810
        )
1811
        .await
1812
        .unwrap();
1813
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1814
    let andy = db::accounts::account_by_name(&app.db, "andy").await.unwrap().unwrap();
1815
    db::accounts::create_org(&app.db, "acme", "Acme", andy.id).await.unwrap();
1816
    create(app, "acme", "app").await;
1817
    let page = |path: &str, form: Option<String>| {
1818
        let mut req =
1819
            Request::builder().method(if form.is_some() { "POST" } else { "GET" }).uri(path).header(header::COOKIE, cookie.clone());
1820
        if form.is_some() {
1821
            req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1822
        }
1823
        let req = req.body(Body::from(form.unwrap_or_default())).unwrap();
1824
        let app = app.clone();
1825
        async move {
1826
            let res = oxygenhub::router(app).oneshot(req).await.unwrap();
1827
            let status = res.status();
1828
            let body = String::from_utf8(res.into_body().collect().await.unwrap().to_bytes().to_vec()).unwrap();
1829
            (status, body)
1830
        }
1831
    };
1832
    let csrf_of = |page: &str| {
1833
        let i = page.find("name=\"_csrf\" value=\"").expect("csrf field") + "name=\"_csrf\" value=\"".len();
1834
        page[i..].split('"').next().unwrap().to_string()
1835
    };
1836
1837
    // The site sets CC and LANG, the organisation its own CC, the
1838
    // repository RUST_LOG from its settings page.
1839
    variables::set(&app.db, Scope::Site, "CC", "gcc").await.unwrap();
1840
    variables::set(&app.db, Scope::Site, "LANG", "C").await.unwrap();
1841
    let org = db::accounts::org_by_name(&app.db, "acme").await.unwrap().unwrap();
1842
    variables::set(&app.db, Scope::Org(org.id), "CC", "clang").await.unwrap();
1843
    let (st, settings) = page("/acme/app/settings", None).await;
1844
    assert_eq!(st, StatusCode::OK, "{settings}");
1845
    assert!(settings.contains("Inherited") && settings.contains("the acme organisation") && settings.contains("overridden"), "{settings}");
1846
    let csrf = csrf_of(&settings);
1847
    let (_, body) = page("/acme/app/settings/variables", Some(format!("_csrf={csrf}&action=set&name=RUST_LOG&value=debug"))).await;
1848
    assert!(body.contains("RUST_LOG set.") && body.contains("<code>debug</code>"), "{body}");
1849
    let (_, body) = page("/acme/app/settings/variables", Some(format!("_csrf={csrf}&action=set&name=FLOW_REPO&value=x"))).await;
1850
    assert!(body.contains("not FLOW_"), "{body}");
1851
    let repo = db::repos::get(&app.db, "acme", "app").await.unwrap().unwrap();
1852
    db::repos::set_flow(&app.db, repo.id, "on").await.unwrap();
1853
    let env = variables::env_for_repo(&app.db, &repo).await.unwrap();
1854
    assert_eq!(
1855
        env.iter().map(|(k, v)| (k.as_str(), v.as_str())).collect::<Vec<_>>(),
1856
        [("CC", "clang"), ("LANG", "C"), ("RUST_LOG", "debug")],
1857
        "the organisation's CC wins over the site's"
1858
    );
1859
1860
    // A claim carries them.
1861
    let url = format!("{}/acme/app", h.base);
1862
    let work = tempfile::tempdir().unwrap();
1863
    let c = client(&url, work.path());
1864
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1865
    write(work.path(), "test.sh", "echo ok\n");
1866
    c.snapshot("test").unwrap();
1867
    c.commit("Add a pipeline", &[]).unwrap();
1868
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1869
    let runs = runs_of(app, "acme", "app").await;
1870
    assert_eq!(runs.len(), 1, "{runs:?}");
1871
    let got = claim(app).await.unwrap_or_else(|| panic!("a job: {:?}", runs[0]));
1872
    assert_eq!(got["env"], serde_json::json!({ "CC": "clang", "LANG": "C", "RUST_LOG": "debug" }), "{got}");
1873
1874
    // Removing a site variable from the admin page takes effect at the next claim.
1875
    let (_, admin) = page("/admin", None).await;
1876
    assert!(admin.contains("Variables") && admin.contains("<code>gcc</code>"), "{admin}");
1877
    let (_, body) = page("/admin/variables", Some(format!("_csrf={}&action=delete&name=LANG", csrf_of(&admin)))).await;
1878
    assert!(body.contains("LANG removed."), "{body}");
1879
    let got = claim(app).await.expect("another job");
1880
    assert_eq!(got["env"], serde_json::json!({ "CC": "clang", "RUST_LOG": "debug" }), "{got}");
1881
}
1882
1883
#[tokio::test(flavor = "multi_thread")]
1884
async fn secrets_a_job_declares_come_with_the_claim_and_never_reach_the_log() {
1885
    let h = hub().await;
1886
    let app = &h.app;
1887
    let res = oxygenhub::router(app.clone())
1888
        .oneshot(
1889
            Request::post("/register")
1890
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1891
                .body(Body::from("username=andy&email=a%40example.com&password=correct-horse-battery"))
1892
                .unwrap(),
1893
        )
1894
        .await
1895
        .unwrap();
1896
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1897
    let page = |path: &str, form: Option<String>| {
1898
        let mut req =
1899
            Request::builder().method(if form.is_some() { "POST" } else { "GET" }).uri(path).header(header::COOKIE, cookie.clone());
1900
        if form.is_some() {
1901
            req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1902
        }
1903
        let req = req.body(Body::from(form.unwrap_or_default())).unwrap();
1904
        let app = app.clone();
1905
        async move {
1906
            let res = oxygenhub::router(app).oneshot(req).await.unwrap();
1907
            let status = res.status();
1908
            let body = String::from_utf8(res.into_body().collect().await.unwrap().to_bytes().to_vec()).unwrap();
1909
            (status, body)
1910
        }
1911
    };
1912
    let csrf_of = |page: &str| {
1913
        let i = page.find("name=\"_csrf\" value=\"").expect("csrf field") + "name=\"_csrf\" value=\"".len();
1914
        page[i..].split('"').next().unwrap().to_string()
1915
    };
1916
    create(app, "andy", "demo").await;
1917
    // The site sets deploy-token; the repository overrides it. Neither
1918
    // page shows a value, only that it is set.
1919
    let (_, admin) = page("/admin", None).await;
1920
    let csrf = csrf_of(&admin);
1921
    let (_, body) = page("/admin/secrets", Some(format!("_csrf={csrf}&action=set&name=deploy-token&value=site-level-value"))).await;
1922
    assert!(body.contains("deploy-token set.") && !body.contains("site-level-value"), "{body}");
1923
    let (_, body) = page("/admin/secrets", Some(format!("_csrf={csrf}&action=set&name=bad+name&value=x"))).await;
1924
    assert!(body.contains("name is 1 to 64 of"), "{body}");
1925
    let (_, settings) = page("/andy/demo/settings", None).await;
1926
    assert!(
1927
        settings.contains("Secrets") && settings.contains("<code>deploy-token</code>") && settings.contains("the site</td>"),
1928
        "{settings}"
1929
    );
1930
    let csrf_r = csrf_of(&settings);
1931
    let (_, body) =
1932
        page("/andy/demo/settings/secrets", Some(format!("_csrf={csrf_r}&action=set&name=deploy-token&value=hunter22-repo-value"))).await;
1933
    assert!(body.contains("deploy-token set.") && body.contains("overridden") && !body.contains("hunter22"), "{body}");
1934
    let repo = db::repos::get(&app.db, "andy", "demo").await.unwrap().unwrap();
1935
    assert!(
1936
        !String::from_utf8_lossy(&oxygenhub::secrets::list(&app.db, oxygenhub::levels::Scope::Repo(repo.id)).await.unwrap()[0].value)
1937
            .contains("hunter22"),
1938
        "sealed at rest"
1939
    );
1940
1941
    // A job that declares the secret, and one the levels do not hold.
1942
    let url = format!("{}/andy/demo", h.base);
1943
    let work = tempfile::tempdir().unwrap();
1944
    let c = client(&url, work.path());
1945
    write(
1946
        work.path(),
1947
        ".flow/pipeline.kdl",
1948
        &pipeline("job \"deploy\" {\n    sandbox \"alpine\"\n    secret \"deploy-token\" {\n        mount-path \"/run/secrets/token\"\n    }\n    secret \"missing\" {\n        mount-path \"/run/secrets/missing\"\n    }\n    exec \"deploy\"\n}\n"),
1949
    );
1950
    write(work.path(), "test.sh", "echo ok\n");
1951
    c.snapshot("test").unwrap();
1952
    c.commit("Add a pipeline", &[]).unwrap();
1953
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1954
    let runs = runs_of(app, "andy", "demo").await;
1955
    let jobs = match runs.first() {
1956
        Some(r) => db::flow::jobs(&app.db, r.id).await.unwrap().iter().map(|j| format!("{}:{}", j.name, j.status)).collect::<Vec<_>>(),
1957
        None => vec![],
1958
    };
1959
    let mut deploy = None;
1960
    for _ in 0..50 {
1961
        let Some(got) = claim(app).await else {
1962
            tokio::time::sleep(std::time::Duration::from_millis(100)).await;
1963
            continue;
1964
        };
1965
        if got["job"]["name"] == "deploy" {
1966
            deploy = Some(got);
1967
            break;
1968
        }
1969
        assert_eq!(got["secrets"], serde_json::Value::Null, "{got}");
1970
    }
1971
    let got = deploy.unwrap_or_else(|| panic!("the deploy job: runs {runs:?} jobs {jobs:?}"));
1972
    assert_eq!(
1973
        got["secrets"],
1974
        serde_json::json!([{ "name": "deploy-token", "path": "/run/secrets/token", "value": "hunter22-repo-value" }]),
1975
        "the repository's value, the missing one left out: {got}"
1976
    );
1977
    let id = got["job_id"].as_i64().unwrap();
1978
    let log = db::flow::log(&app.db, id, 0, 100).await.unwrap();
1979
    assert!(log.iter().any(|l| l.stream == "flow" && l.text.contains("secret \"missing\" is not set")), "{log:?}");
1980
1981
    // The value never reaches the stored log, plain or base64.
1982
    let records = serde_json::json!({ "records": [
1983
        { "t": 1, "stream": "out", "text": "token=hunter22-repo-value" },
1984
        { "t": 2, "stream": "err", "text": "b64 aHVudGVyMjItcmVwby12YWx1ZQ== end" },
1985
    ] });
1986
    let (st, _) = call(app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(records.to_string())).await;
1987
    assert_eq!(st, StatusCode::NO_CONTENT);
1988
    let log = db::flow::log(&app.db, id, 0, 100).await.unwrap();
1989
    let texts: Vec<&str> = log.iter().map(|l| l.text.as_str()).collect();
1990
    assert!(texts.contains(&"token=***") && texts.contains(&"b64 *** end"), "{texts:?}");
1991
    assert!(!texts.iter().any(|t| t.contains("hunter22")), "{texts:?}");
1992
}
1993
1994
#[tokio::test(flavor = "multi_thread")]
1995
async fn a_job_s_identity_is_a_signed_token_the_discovery_document_lets_anyone_verify() {
1996
    let h = hub().await;
1997
    let app = &h.app;
1998
    let (st, disc) = call(app, "GET", "/.well-known/openid-configuration", None, None).await;
1999
    assert_eq!(st, StatusCode::OK, "{disc}");
2000
    let disc: serde_json::Value = serde_json::from_str(&disc).unwrap();
2001
    assert_eq!(disc["issuer"], h.base.as_str());
2002
    assert_eq!(disc["jwks_uri"], format!("{}/.well-known/jwks.json", h.base));
2003
    let (st, jwks) = call(app, "GET", "/.well-known/jwks.json", None, None).await;
2004
    assert_eq!(st, StatusCode::OK, "{jwks}");
2005
    let jwks: serde_json::Value = serde_json::from_str(&jwks).unwrap();
2006
    assert_eq!(jwks["keys"][0]["alg"], "RS256");
2007
    let kid = jwks["keys"][0]["kid"].as_str().unwrap().to_string();
2008
2009
    create(app, "andy", "demo").await;
2010
    let url = format!("{}/andy/demo", h.base);
2011
    let work = tempfile::tempdir().unwrap();
2012
    let c = client(&url, work.path());
2013
    write(
2014
        work.path(),
2015
        ".flow/pipeline.kdl",
2016
        &pipeline("job \"deploy\" {\n    sandbox \"alpine\"\n    identity \"sts.amazonaws.com\" {\n        mount-path \"/run/secrets/aws-token\"\n    }\n    exec \"deploy\"\n}\n"),
2017
    );
2018
    write(work.path(), "test.sh", "echo ok\n");
2019
    c.snapshot("test").unwrap();
2020
    c.commit("Add a pipeline", &[]).unwrap();
2021
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
2022
    let mut deploy = None;
2023
    for _ in 0..50 {
2024
        let Some(got) = claim(app).await else {
2025
            tokio::time::sleep(std::time::Duration::from_millis(100)).await;
2026
            continue;
2027
        };
2028
        if got["job"]["name"] == "deploy" {
2029
            deploy = Some(got);
2030
            break;
2031
        }
2032
    }
2033
    let got = deploy.expect("the deploy job");
2034
    let secrets = got["secrets"].as_array().expect("secrets");
2035
    assert_eq!(secrets.len(), 1);
2036
    assert_eq!(
2037
        (secrets[0]["name"].as_str(), secrets[0]["path"].as_str()),
2038
        (Some("identity:sts.amazonaws.com"), Some("/run/secrets/aws-token"))
2039
    );
2040
    let token = secrets[0]["value"].as_str().unwrap().to_string();
2041
    let issuer = app.oidc().await.unwrap();
2042
    assert_eq!(issuer.kid, kid, "the key the JWKS publishes signed it");
2043
    let claims = issuer.verify(&token, "sts.amazonaws.com", db::now_ms()).expect("verifies");
2044
    assert_eq!(claims["sub"], "repo:andy/demo:bookmark:main");
2045
    assert_eq!(claims["repository"], "andy/demo");
2046
    assert_eq!(claims["job"], "deploy");
2047
    assert_eq!(claims["run_number"], 1);
2048
    assert_eq!(claims["runner"], "test-1");
2049
    assert_eq!(claims["iss"], h.base.as_str());
2050
    assert!(claims["state"].as_str().unwrap().len() == 64);
2051
    // A job that prints its token leaves *** in the log.
2052
    let id = got["job_id"].as_i64().unwrap();
2053
    let records = serde_json::json!({ "records": [{ "t": 1, "stream": "out", "text": format!("TOKEN={token} end") }] });
2054
    let (st, _) = call(app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(records.to_string())).await;
2055
    assert_eq!(st, StatusCode::NO_CONTENT);
2056
    let log = db::flow::log(&app.db, id, 0, 100).await.unwrap();
2057
    assert!(log.iter().any(|l| l.text == "TOKEN=*** end"), "{log:?}");
2058
}
2059
2060
#[tokio::test(flavor = "multi_thread")]
2061
async fn jobs_are_offered_only_to_runners_of_their_architecture() {
2062
    let h = hub().await;
2063
    let app = &h.app;
2064
    create(app, "andy", "demo").await;
2065
    let url = format!("{}/andy/demo", h.base);
2066
    let work = tempfile::tempdir().unwrap();
2067
    let c = client(&url, work.path());
2068
    write(work.path(), ".flow/pipeline.kdl", &pipeline("sandbox \"board\" {\n    rootfs \"cas://blob/{ROOTFS}\"\n    arch \"riscv64\"\n}\njob \"flash\" {\n    sandbox \"board\"\n    exec \"flash\"\n}\n").replace("{ROOTFS}", &"ab".repeat(32)));
2069
    write(work.path(), "test.sh", "echo ok\n");
2070
    c.snapshot("test").unwrap();
2071
    c.commit("Add a pipeline", &[]).unwrap();
2072
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
2073
    let claim_as = |arch: &'static str, archs: serde_json::Value| {
2074
        let app = app.clone();
2075
        async move {
2076
            let body = serde_json::json!({
2077
                "runner": format!("{arch}-1"), "runtimes": ["microvm"],
2078
                "info": { "arch": arch, "os": "linux", "version": "t", "labels": [], "max_jobs": 1 },
2079
                "image_archs": archs,
2080
            });
2081
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(body.to_string())).await;
2082
            match st {
2083
                StatusCode::NO_CONTENT => None,
2084
                StatusCode::OK => {
2085
                    Some(serde_json::from_str::<serde_json::Value>(&body).unwrap()["job"]["name"].as_str().unwrap().to_string())
2086
                }
2087
                other => panic!("claim: {other} {body}"),
2088
            }
2089
        }
2090
    };
2091
    // An x86_64 runner that says the alpine image is x86_64: it takes the
2092
    // alpine jobs, never the one that asks for riscv64.
2093
    let rootfs = pipeline("").split("cas://blob/").nth(1).unwrap()[..64].to_string();
2094
    for _ in 0..50 {
2095
        if !runs_of(app, "andy", "demo").await.is_empty() {
2096
            break;
2097
        }
2098
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;
2099
    }
2100
    let runs = runs_of(app, "andy", "demo").await;
2101
    assert_eq!(runs.len(), 1, "{runs:?}");
2102
    let mut taken = vec![];
2103
    while let Some(j) = claim_as("x86_64", serde_json::json!({ rootfs.clone(): "x86_64" })).await {
2104
        taken.push(j);
2105
    }
2106
    assert_eq!(taken, ["build", "lint"], "test waits for build; flash is for riscv64");
2107
    // A riscv64 runner: the alpine image is known to be x86_64, so only flash.
2108
    assert_eq!(claim_as("riscv64", serde_json::json!({})).await.as_deref(), Some("flash"));
2109
    assert_eq!(claim_as("riscv64", serde_json::json!({})).await, None);
2110
    let (_, queue) = call(app, "GET", "/admin/runners", None, None).await;
2111
    let _ = queue;
2112
}
2113
2114
/// OxygenFlow spec §11.5: a runner hands back a job it cannot run. The
2115
/// job is queued again and not offered to that runner again, the decline
2116
/// shows on the run's page and is kept for the runner's, and once three
2117
/// runners have declined it the job ends as unplaceable with their reasons.
2118
#[tokio::test(flavor = "multi_thread")]
2119
async fn a_declined_job_goes_to_another_runner_or_ends_unplaceable() {
2120
    let h = hub().await;
2121
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
2122
    create(&h.app, "andy", "declines").await;
2123
    let url = format!("{}/andy/declines", h.base);
2124
    let work = tempfile::tempdir().unwrap();
2125
    let c = client(&url, work.path());
2126
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
2127
    write(work.path(), "test.sh", "echo ok\n");
2128
    c.commit("Add a pipeline", &[]).unwrap();
2129
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
2130
    let run = runs_of(&h.app, "andy", "declines").await[0].clone();
2131
    let claim_as = |token: &'static str, name: &'static str| {
2132
        let app = h.app.clone();
2133
        async move {
2134
            let body = serde_json::json!({ "runner": name, "runtimes": ["microvm"] }).to_string();
2135
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some(token), Some(body)).await;
2136
            (st == StatusCode::OK).then(|| serde_json::from_str::<serde_json::Value>(&body).unwrap()["job_id"].as_i64().unwrap())
2137
        }
2138
    };
2139
    let decline = |token: &'static str, id: i64, reason: &'static str| {
2140
        let app = h.app.clone();
2141
        async move {
2142
            let body = serde_json::json!({ "reason": reason }).to_string();
2143
            call(&app, "POST", &format!("/api/v1/flow/jobs/{id}/decline"), Some(token), Some(body)).await.0
2144
        }
2145
    };
2146
    let job = claim_as("runner-secret", "earth-1").await.expect("a job");
2147
    // The other runners are known to the hub before they decline anything.
2148
    assert_eq!(decline("runner-two", job, "not mine").await, StatusCode::CONFLICT, "only the runner it runs on may decline it");
2149
    assert_eq!(decline("runner-secret", job, "the MicroVM tier needs /dev/kvm").await, StatusCode::NO_CONTENT);
2150
    let j = db::flow::job(&h.app.db, job).await.unwrap().unwrap();
2151
    assert_eq!((j.status.as_str(), j.runner.as_str()), ("queued", ""));
2152
    assert_eq!(j.waiting, "declined by earth-1: the MicroVM tier needs /dev/kvm; waiting for another runner");
2153
    // earth-1 is offered the other ready job, not this one, while it stays the same.
2154
    let next = claim_as("runner-secret", "earth-1").await.expect("the other ready job");
2155
    assert_ne!(next, job);
2156
    let page = call(&h.app, "GET", &format!("/andy/declines/flow/{}", run.number), None, None).await.1;
2157
    assert!(page.contains("Waiting: declined by earth-1: the MicroVM tier needs /dev/kvm"), "{page}");
2158
    assert_eq!(claim_as("runner-two", "plex-1").await, Some(job), "another runner takes it");
2159
    assert_eq!(decline("runner-two", job, "rootfs 36fc4e323804 is not on this runner").await, StatusCode::NO_CONTENT);
2160
    assert_eq!(claim_as("runner-three", "narvi").await, Some(job));
2161
    assert_eq!(decline("runner-three", job, "rootfs 36fc4e323804 is for x86_64; this runner is riscv64").await, StatusCode::NO_CONTENT);
2162
    let j = db::flow::job(&h.app.db, job).await.unwrap().unwrap();
2163
    assert_eq!(j.status, "error");
2164
    assert_eq!(
2165
        j.error,
2166
        "unplaceable: declined by 3 runners: earth-1: the MicroVM tier needs /dev/kvm; plex-1: rootfs 36fc4e323804 is not on this runner; narvi: rootfs 36fc4e323804 is for x86_64; this runner is riscv64"
2167
    );
2168
    let r = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "plex-1").unwrap();
2169
    let declined = db::flow::declines_of_runner(&h.app.db, r.id, 10).await.unwrap();
2170
    assert_eq!(declined.len(), 1);
2171
    assert_eq!((declined[0].job_id, declined[0].reason.as_str()), (job, "rootfs 36fc4e323804 is not on this runner"));
2172
    assert_eq!(r.tier_list(), vec!["microvm"]);
2173
}
2174
2175
/// oxygenhub#113: a job's artifact named `coverage` (LCOV) is read when
2176
/// it is uploaded. The job's log says what it found; the Coverage tab,
2177
/// the file view, the badge and the run page show it.
2178
#[tokio::test(flavor = "multi_thread")]
2179
async fn a_coverage_artifact_becomes_a_coverage_report() {
2180
    let h = hub().await;
2181
    create(&h.app, "andy", "cov").await;
2182
    let url = format!("{}/andy/cov", h.base);
2183
    let work = tempfile::tempdir().unwrap();
2184
    let c = client(&url, work.path());
2185
    write(
2186
        work.path(),
2187
        ".flow/pipeline.kdl",
2188
        &format!(
2189
            "schema-version 1\nsandbox \"alpine\" {{\n    rootfs \"cas://blob/{ROOTFS}\"\n}}\njob \"coverage\" {{\n    sandbox \"alpine\"\n    exec \"make\" \"coverage\"\n    output {{\n        artifact \"coverage\" {{\n            path \"/src/lcov.info\"\n        }}\n    }}\n}}\n"
2190
        ),
2191
    );
2192
    write(work.path(), "src/lib.rs", "pub fn add(a: u32, b: u32) -> u32 {\n    a + b\n}\n\npub fn unused() {\n    todo!()\n}\n");
2193
    c.snapshot("test").unwrap();
2194
    c.commit("Code and coverage", &[]).unwrap();
2195
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
2196
    let run = runs_of(&h.app, "andy", "cov").await.remove(0);
2197
    assert!(!call(&h.app, "GET", "/andy/cov", None, None).await.1.contains(">Coverage</a>"), "no tab before a report");
2198
    let id = claim(&h.app).await.unwrap()["job_id"].as_i64().unwrap();
2199
2200
    let (st, text) = upload(&h.app, id, "coverage", b"this is not a report").await;
2201
    assert_eq!(st, StatusCode::OK, "a bad report never fails the upload: {text}");
2202
    let lcov = "TN:\nSF:/src/src/lib.rs\nFN:1,add\nFN:5,unused\nFNDA:3,add\nFNDA:0,unused\nDA:1,3\nDA:2,3\nDA:5,0\nDA:6,0\nend_of_record\n\
2203
SF:/src/src/gone.rs\nDA:1,1\nend_of_record\nSF:/usr/lib/rustlib/x.rs\nDA:1,1\nend_of_record\n";
2204
    let (st, text) = upload(&h.app, id, "coverage", lcov.as_bytes()).await;
2205
    assert_eq!(st, StatusCode::OK, "{text}");
2206
    let log: Vec<String> = db::flow::log(&h.app.db, id, 0, 50).await.unwrap().into_iter().map(|l| l.text).collect();
2207
    assert!(log.iter().any(|l| l.contains("coverage: this is not an LCOV report")), "{log:?}");
2208
    assert!(
2209
        log.iter().any(|l| l == "coverage: 50.0% of lines (2 of 4) in 1 files (2 named files are not in this state and were left out)"),
2210
        "{log:?}"
2211
    );
2212
2213
    let (st, page) = call(&h.app, "GET", "/andy/cov/coverage", None, None).await;
2214
    assert_eq!(st, StatusCode::OK);
2215
    assert!(
2216
        page.contains(">Coverage</a>")
2217
            && page.contains("50.0%")
2218
            && page.contains("<strong>2</strong> of <strong>4</strong> relevant lines covered"),
2219
        "{page}"
2220
    );
2221
    assert!(page.contains("1 of 2") && page.contains("/andy/cov/coverage/") && page.contains("/file/src/lib.rs"), "{page}");
2222
    let report = crate_report(&h.app, run.id).await;
2223
    let (st, file) = call(&h.app, "GET", &format!("/andy/cov/coverage/{report}/file/src/lib.rs"), None, None).await;
2224
    assert_eq!(st, StatusCode::OK, "{file}");
2225
    assert_eq!(file.matches("class=\"cov-hit\"").count(), 2, "{file}");
2226
    assert_eq!(file.matches("class=\"cov-miss\"").count(), 2, "{file}");
2227
    assert!(file.contains("3×"), "{file}");
2228
    assert_eq!(call(&h.app, "GET", &format!("/andy/cov/coverage/{report}/file/src/gone.rs"), None, None).await.0, StatusCode::NOT_FOUND);
2229
    let (_, badge) = call(&h.app, "GET", "/andy/cov/coverage/badge.svg", None, None).await;
2230
    assert!(badge.contains("coverage: 50.0%"), "{badge}");
2231
    let (_, run_page) = call(&h.app, "GET", &format!("/andy/cov/flow/{}", run.number), None, None).await;
2232
    assert!(run_page.contains("coverage 50.0%"), "{run_page}");
2233
    // The API (#113).
2234
    let (_, list) = call(&h.app, "GET", "/api/v1/repos/andy/cov/coverage", None, None).await;
2235
    let list: serde_json::Value = serde_json::from_str(&list).unwrap();
2236
    assert_eq!((list[0]["percent"].as_f64(), list[0]["format"].as_str()), (Some(50.0), Some("lcov")), "{list}");
2237
    let (_, one) = call(&h.app, "GET", &format!("/api/v1/repos/andy/cov/coverage/{report}"), None, None).await;
2238
    let one: serde_json::Value = serde_json::from_str(&one).unwrap();
2239
    assert_eq!((one["files"][0]["path"].as_str(), one["files"][0]["lines_hit"].as_i64()), (Some("src/lib.rs"), Some(2)), "{one}");
2240
2241
    // The `coverage` check on the run's state: it reports, and with a
2242
    // minimum the repository sets, it fails below it.
2243
    let row = db::repos::get(&h.app.db, "andy", "cov").await.unwrap().unwrap();
2244
    let check = |checks: Vec<db::hooks::Check>| checks.into_iter().find(|c| c.name == "coverage").expect("a coverage check");
2245
    let c = check(db::hooks::checks_for_state(&h.app.db, row.id, &run.state).await.unwrap());
2246
    assert_eq!((c.status.as_str(), c.summary.as_str()), ("passed", "50.0%"));
2247
    assert!(c.url.ends_with(&format!("/andy/cov/coverage?report={report}")), "{}", c.url);
2248
    oxygenhub::coverage::set_rules(&h.app.db, row.id, oxygenhub::coverage::Rules { min: Some(60.0), max_drop: None }).await.unwrap();
2249
    assert_eq!(upload(&h.app, id, "coverage", lcov.as_bytes()).await.0, StatusCode::OK);
2250
    let c = check(db::hooks::checks_for_state(&h.app.db, row.id, &run.state).await.unwrap());
2251
    assert_eq!((c.status.as_str(), c.summary.as_str()), ("failed", "50.0%: below the minimum of 60%"));
2252
}
2253
2254
async fn crate_report(app: &Shared, run_id: i64) -> i64 {
2255
    oxygenhub::coverage::for_run(&app.db, run_id).await.unwrap()[0].id
2256
}
2257
2258
/// The Tests tab (#114): three runs' JUnit reports on a bookmark; a test
2259
/// breaks in the second and is fixed in the third.
2260
#[tokio::test(flavor = "multi_thread")]
2261
async fn junit_reports_make_a_tests_tab() {
2262
    let h = hub().await;
2263
    create(&h.app, "andy", "t").await;
2264
    let url = format!("{}/andy/t", h.base);
2265
    let work = tempfile::tempdir().unwrap();
2266
    let c = client(&url, work.path());
2267
    write(
2268
        work.path(),
2269
        ".flow/pipeline.kdl",
2270
        &format!(
2271
            "schema-version 1\nsandbox \"alpine\" {{\n    rootfs \"cas://blob/{ROOTFS}\"\n}}\njob \"test\" {{\n    sandbox \"alpine\"\n    exec \"make\" \"test\"\n    output {{\n        artifact \"junit\" {{\n            path \"/src/junit.xml\"\n        }}\n    }}\n}}\n"
2272
        ),
2273
    );
2274
    assert!(!call(&h.app, "GET", "/andy/t", None, None).await.1.contains(">Tests</a>"));
2275
    let case = |name: &str, ok: bool, secs: &str| {
2276
        if ok {
2277
            format!(r#"<testcase classname="t.suite" name="{name}" time="{secs}"/>"#)
2278
        } else {
2279
            format!(
2280
                r#"<testcase classname="t.suite" name="{name}" time="{secs}"><failure message="{name} broke">AssertionError</failure></testcase>"#
2281
            )
2282
        }
2283
    };
2284
    let runs = [
2285
        vec![case("a", true, "0.1"), case("b", true, "2.5"), case("c", true, "0.2")],
2286
        vec![case("a", true, "0.1"), case("b", false, "2.6"), case("c", true, "0.2"), case("d", true, "0.3")],
2287
        vec![case("a", true, "0.1"), case("b", true, "2.4"), case("c", true, "0.2"), case("d", true, "0.3")],
2288
    ];
2289
    for (i, cases) in runs.iter().enumerate() {
2290
        write(work.path(), "n.txt", &i.to_string());
2291
        c.snapshot("test").unwrap();
2292
        c.commit(&format!("Run {i}"), &[]).unwrap();
2293
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
2294
        // The run is made after the push answers.
2295
        let mut a = None;
2296
        for _ in 0..100 {
2297
            a = claim(&h.app).await;
2298
            if a.is_some() {
2299
                break;
2300
            }
2301
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
2302
        }
2303
        let a = a.expect("a job to claim");
2304
        let id = a["job_id"].as_i64().unwrap();
2305
        let xml = format!("<testsuites><testsuite name=\"t\">{}</testsuite></testsuites>", cases.concat());
2306
        assert_eq!(upload(&h.app, id, "junit", xml.as_bytes()).await.0, StatusCode::OK);
2307
        let failed = cases.iter().any(|c| c.contains("<failure"));
2308
        let mut r = receipt("test", a["pipeline_hash"].as_str().unwrap(), failed as u32);
2309
        if !failed {
2310
            r["outputs"] = serde_json::json!([oxy_core::repo::Repo::blob_ref(xml.as_bytes()).to_hex()]);
2311
        }
2312
        let code = failed as i32;
2313
        assert_eq!(
2314
            finish(&h.app, id, serde_json::json!({ "exit_code": code, "duration_ms": 700, "receipt": r })).await,
2315
            StatusCode::NO_CONTENT
2316
        );
2317
    }
2318
    let (st, page) = call(&h.app, "GET", "/andy/t/tests", None, None).await;
2319
    assert_eq!(st, StatusCode::OK, "{page}");
2320
    if let Some(out) = std::env::var_os("OXYHUB_DUMP_TESTS_PAGE") {
2321
        std::fs::write(out, &page).unwrap();
2322
    }
2323
    assert!(page.contains(">Tests</a>"), "the tab");
2324
    assert!(page.contains("100%") && page.contains("of 4 tests passed"), "the latest run passes");
2325
    assert!(page.contains("1 fixed") && page.contains("t.suite::b"), "b fixed against the run before");
2326
    assert!(page.contains("1 ✕") && page.contains("2 ✓"), "b is flaky: {page}");
2327
    assert!(page.contains("<svg class=\"cov-chart\""), "charts");
2328
    // The slowest first.
2329
    let slow = page.find("Slowest tests").unwrap();
2330
    assert!(page[slow..].find("t.suite::b").unwrap() < page[slow..].find("t.suite::d").unwrap());
2331
    // The second run, picked: b newly failing, its failure listed.
2332
    let row = db::repos::get(&h.app.db, "andy", "t").await.unwrap().unwrap();
2333
    let second = oxygenhub::junit::on_bookmark(&h.app.db, row.id, "main", 10).await.unwrap()[1].id;
2334
    let (_, page) = call(&h.app, "GET", &format!("/andy/t/tests?report={second}"), None, None).await;
2335
    assert!(page.contains("1 failing") && page.contains("Newly failing") && page.contains("b broke"), "{page}");
2336
    assert!(page.contains("1 new tests"), "d is new");
2337
2338
    // The API (#114): the bookmark's reports newest first, and one with
2339
    // its failed cases.
2340
    let (st, list) = call(&h.app, "GET", "/api/v1/repos/andy/t/tests", None, None).await;
2341
    assert_eq!(st, StatusCode::OK, "{list}");
2342
    let list: serde_json::Value = serde_json::from_str(&list).unwrap();
2343
    assert_eq!(list.as_array().unwrap().len(), 3);
2344
    assert_eq!((list[0]["tests"].as_i64(), list[1]["failed"].as_i64()), (Some(4), Some(1)));
2345
    let (_, one) = call(&h.app, "GET", &format!("/api/v1/repos/andy/t/tests/{second}?status=failed"), None, None).await;
2346
    let one: serde_json::Value = serde_json::from_str(&one).unwrap();
2347
    assert_eq!(one["cases"].as_array().unwrap().len(), 1);
2348
    assert_eq!((one["cases"][0]["name"].as_str(), one["cases"][0]["message"].as_str()), (Some("b"), Some("b broke")));
2349
    let (_, all) = call(&h.app, "GET", &format!("/api/v1/repos/andy/t/tests/{second}"), None, None).await;
2350
    assert_eq!(serde_json::from_str::<serde_json::Value>(&all).unwrap()["cases"].as_array().unwrap().len(), 4);
2351
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/t/tests/99999", None, None).await.0, StatusCode::NOT_FOUND);
2352
}