OXYGENHUB
# 4bae285c6ed8 oxygenhub / crates / hub / tests / flow.rs
119.4 KiB · Rust · last changed Pin oxygenflow 08d0082d: artifacts when "always" 29 days 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
    let (st, text) = upload(&h.app, id, "junit", b"<testsuites/>").await;
964
    assert_eq!(st, StatusCode::OK, "{text}");
965
    let blob = serde_json::from_str::<serde_json::Value>(&text).unwrap()["blob"].as_str().unwrap().to_string();
966
    let mut r = receipt("test", a["pipeline_hash"].as_str().unwrap(), 1);
967
    r["outputs"] = serde_json::json!([blob]);
968
    assert_eq!(
969
        finish(&h.app, id, serde_json::json!({ "exit_code": 1, "duration_ms": 700, "receipt": r.clone() })).await,
970
        StatusCode::BAD_REQUEST,
971
        "a failing receipt names no outputs"
972
    );
973
    r["outputs"] = serde_json::json!([]);
974
    assert_eq!(finish(&h.app, id, serde_json::json!({ "exit_code": 1, "duration_ms": 700, "receipt": r })).await, StatusCode::NO_CONTENT);
975
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", run.number), None, None).await;
976
    assert!(page.contains(&format!("/andy/demo/flow/{}/artifacts/test/junit", run.number)), "listed");
977
    assert!(page.contains("not in its receipt"), "marked");
978
}
979
980
/// A release's trust report (hub spec §9.1): a signed tag, an asset built
981
/// by a job with a signed receipt from the tagged state, and one uploaded
982
/// by hand; the page, its JSON export and the API.
983
#[tokio::test(flavor = "multi_thread")]
984
async fn a_release_is_audited_from_authors_to_receipts() {
985
    use oxy_core::hash::{hash_object, ChangeHash, ObjectType};
986
    use oxy_core::identity::SecretKey;
987
    use oxy_core::objects::StateObject;
988
    use oxy_core::receipt::SignedReceipt;
989
    let h = hub().await;
990
    create(&h.app, "andy", "demo").await;
991
    let url = format!("{}/andy/demo", h.base);
992
    let work = tempfile::tempdir().unwrap();
993
    let mut c = client(&url, work.path());
994
    c.create_identity("Andy", "[email protected]", oxy_core::repo::IdentityScope::Repo).unwrap();
995
    write(
996
        work.path(),
997
        ".flow/pipeline.kdl",
998
        &format!(
999
            "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"
1000
        ),
1001
    );
1002
    c.snapshot("test").unwrap();
1003
    c.commit("Build a tool", &[]).unwrap();
1004
    let heads = c.bookmark_heads().unwrap();
1005
    c.tag_create("v1", &heads, "first").unwrap();
1006
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1007
1008
    // The runner builds, uploads the artifact and signs its receipt.
1009
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
1010
    let a = claim(&h.app).await.unwrap();
1011
    let id = a["job_id"].as_i64().unwrap();
1012
    let body: Vec<u8> = b"#!/bin/sh\necho tool\n".to_vec();
1013
    let (_, text) = upload(&h.app, id, "tool", &body).await;
1014
    let blob = serde_json::from_str::<serde_json::Value>(&text).unwrap()["blob"].as_str().unwrap().to_string();
1015
    let mut r = receipt("build", a["pipeline_hash"].as_str().unwrap(), 0);
1016
    r["outputs"] = serde_json::json!([blob]);
1017
    let heads_run: Vec<ChangeHash> = run.head_list().into_iter().filter_map(ChangeHash::from_hex).collect();
1018
    let state = hash_object(ObjectType::State, &StateObject::new(heads_run).encode());
1019
    let repo_id = h.app.repos.open(&RepoName::parse("andy/demo").unwrap()).unwrap().id().unwrap();
1020
    let sk = SecretKey::generate();
1021
    let runner = sk.identity("test-1 (OxygenFlow runner)", "", 1);
1022
    let fr: flow_core::Receipt = serde_json::from_value(r.clone()).unwrap();
1023
    let signed = hex::encode(SignedReceipt::sign(fr.to_oxy(), repo_id, state, &format!("{url}/flow/1"), &runner, &sk).encode());
1024
    let done = serde_json::json!({ "exit_code": 0, "duration_ms": 900, "receipt": r, "signed_receipt": signed });
1025
    assert_eq!(finish(&h.app, id, done).await, StatusCode::NO_CONTENT);
1026
1027
    // A release with the built asset and a file uploaded by hand.
1028
    let row = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
1029
    let rel = db::releases::create(&h.app.db, row.id, "v1", "One", "", false, None).await.unwrap();
1030
    oxygenhub::web::releases::store_asset(&h.app, rel.id, "tool", "", &body).await.unwrap();
1031
    oxygenhub::web::releases::store_asset(&h.app, rel.id, "notes.txt", "", b"by hand\n").await.unwrap();
1032
1033
    let (st, page) = call(&h.app, "GET", "/andy/demo/releases/trust/v1", None, None).await;
1034
    assert_eq!(st, StatusCode::OK);
1035
    for want in [
1036
        "Tag v1 is signed",
1037
        "The one change in the release is authenticated",
1038
        "tool: signed receipt from run #1 build",
1039
        "a runner key of this hub",
1040
        "tool: built from the tagged state",
1041
        "tool: pinned environment",
1042
        "notes.txt: no build found",
1043
        "<svg class=\"trust-graph\"",
1044
        // oxygenhub#79: a summary of badges, badges in the graph, and the
1045
        // graph drawn at its own size rather than stretched to the page.
1046
        "Tag signed by",
1047
        "1 of 1 changes signed or sealed",
1048
        "1 of 2 assets built and attested by OxygenFlow",
1049
        "attested build",
1050
        "uploaded by hand",
1051
        "receipt verified",
1052
        "class=\"shackle\"",
1053
        "<title>notes.txt:",
1054
    ] {
1055
        assert!(page.contains(want), "missing {want:?}");
1056
    }
1057
    let svg = &page[page.find("<svg class=\"trust-graph\"").unwrap()..];
1058
    assert!(svg[..200].contains(" width=\"") && svg[..200].contains(" height=\""), "the graph has its own size: {}", &svg[..200]);
1059
    let (_, releases) = call(&h.app, "GET", "/andy/demo/releases", None, None).await;
1060
    assert!(releases.contains("/andy/demo/releases/trust/v1"), "the release links its audit");
1061
1062
    // The export carries the signed receipt, which checks on its own.
1063
    let (st, json) = call(&h.app, "GET", "/andy/demo/releases/trust/v1?format=json", None, None).await;
1064
    assert_eq!(st, StatusCode::OK);
1065
    let t: serde_json::Value = serde_json::from_str(&json).unwrap();
1066
    assert_eq!((t["tag"].as_str(), t["tag_signature"].as_str(), t["changes"].as_i64()), (Some("v1"), Some("valid"), Some(1)));
1067
    assert_eq!(t["authors"][0]["who"]["name"], "Andy");
1068
    let tool = t["assets"].as_array().unwrap().iter().find(|a| a["name"] == "tool").unwrap();
1069
    let hex_receipt = tool["build"]["signed_receipt"].as_str().unwrap();
1070
    let sr = SignedReceipt::decode(&hex::decode(hex_receipt).unwrap()).unwrap();
1071
    sr.verify().unwrap();
1072
    assert_eq!(sr.receipt.outputs[0].to_hex(), blob);
1073
    let audit = t["audit"].as_array().unwrap();
1074
    assert!(audit.iter().any(|c| c["verdict"] == "warn" && c["title"].as_str().unwrap().starts_with("notes.txt")));
1075
    assert!(!audit.iter().any(|c| c["verdict"] == "fail"), "{audit:?}");
1076
    // The API gives the same report; an unknown release is a 404.
1077
    let (st, api) = call(&h.app, "GET", "/api/v1/repos/andy/demo/releases/trust/v1", None, None).await;
1078
    assert_eq!(st, StatusCode::OK);
1079
    assert_eq!(serde_json::from_str::<serde_json::Value>(&api).unwrap()["assets"].as_array().unwrap().len(), 2);
1080
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/demo/releases/trust/v9", None, None).await.0, StatusCode::NOT_FOUND);
1081
    assert_eq!(call(&h.app, "GET", "/andy/demo/releases/trust/v9", None, None).await.0, StatusCode::NOT_FOUND);
1082
}
1083
1084
/// Runners (hub spec §13.2): an administrator makes a registration token,
1085
/// a runner registers with it (binding its key), claims, shows on Admin →
1086
/// Runners with its history, and is drained, disabled and removed.
1087
#[tokio::test(flavor = "multi_thread")]
1088
async fn runners_register_show_their_history_and_are_drained_and_removed() {
1089
    use oxy_core::identity::SecretKey;
1090
    let h = hub().await;
1091
    create(&h.app, "andy", "demo").await;
1092
    // A signed-in site administrator.
1093
    let res = oxygenhub::router(h.app.clone())
1094
        .oneshot(
1095
            Request::post("/register")
1096
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1097
                .body(Body::from("username=carol&email=carol%40example.com&password=correct-horse-battery"))
1098
                .unwrap(),
1099
        )
1100
        .await
1101
        .unwrap();
1102
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1103
    let admin = db::accounts::account_by_name(&h.app.db, "carol").await.unwrap().unwrap();
1104
    db::accounts::set_admin(&h.app.db, admin.id, true).await.unwrap();
1105
    let web = |method: &'static str, path: String, body: Option<String>| {
1106
        let (app, cookie) = (h.app.clone(), cookie.clone());
1107
        async move {
1108
            let mut req = Request::builder().method(method).uri(path).header(header::COOKIE, cookie);
1109
            if body.is_some() {
1110
                req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1111
            }
1112
            let res = oxygenhub::router(app).oneshot(req.body(body.map(Body::from).unwrap_or_else(Body::empty)).unwrap()).await.unwrap();
1113
            let st = res.status();
1114
            (st, String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned())
1115
        }
1116
    };
1117
    let csrf_of = |page: &str| {
1118
        let i = page.find("name=\"_csrf\" value=\"").unwrap() + "name=\"_csrf\" value=\"".len();
1119
        page[i..].split('"').next().unwrap().to_string()
1120
    };
1121
    let (st, page) = web("GET", "/admin/runners".into(), None).await;
1122
    assert_eq!(st, StatusCode::OK);
1123
    assert!(page.contains("No runners yet"));
1124
    assert_eq!(call(&h.app, "GET", "/admin/runners", None, None).await.0, StatusCode::NOT_FOUND, "administrators only");
1125
1126
    // A one-time registration token, shown once with the command.
1127
    let (_, page) = web("POST", "/admin/runners/token".into(), Some(format!("_csrf={}", csrf_of(&page)))).await;
1128
    let i = page.find("--token ").unwrap() + "--token ".len();
1129
    let token: String = page[i..].chars().take_while(|c| !c.is_whitespace()).collect();
1130
    assert!(token.starts_with("flowreg_"), "{token}");
1131
1132
    // The runner registers, binding its key; the token then is spent.
1133
    let sk = SecretKey::generate();
1134
    let identity = sk.identity("plex (OxygenFlow runner)", "", 1);
1135
    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 });
1136
    let reg = serde_json::json!({ "token": token, "name": "plex", "identity": hex::encode(identity.encode()), "info": info });
1137
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1138
    assert_eq!(st, StatusCode::OK, "{body}");
1139
    let credential = serde_json::from_str::<serde_json::Value>(&body).unwrap()["credential"].as_str().unwrap().to_string();
1140
    assert!(credential.starts_with("flowrunner_"));
1141
    assert_eq!(
1142
        call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await.0,
1143
        StatusCode::FORBIDDEN,
1144
        "used once"
1145
    );
1146
1147
    // It claims with its credential; the hub.toml runner shows too.
1148
    let claim_as = |who: String| {
1149
        let app = h.app.clone();
1150
        let info = info.clone();
1151
        async move {
1152
            let body = serde_json::json!({ "runner": "ignored", "runtimes": ["microvm"], "info": info }).to_string();
1153
            call(&app, "POST", "/api/v1/flow/claim", Some(&who), Some(body)).await
1154
        }
1155
    };
1156
    assert_eq!(claim_as(credential.clone()).await.0, StatusCode::NO_CONTENT, "nothing queued");
1157
    assert_eq!(claim(&h.app).await, None);
1158
    let (_, page) = web("GET", "/admin/runners".into(), None).await;
1159
    assert!(
1160
        page.contains(">plex</strong>") && page.contains("st-online") && page.contains("x86_64 · linux") && page.contains("big-disk"),
1161
        "{page}"
1162
    );
1163
    assert!(page.contains(">test-1</strong>") && page.contains("hub.toml"), "the configured runner, by its claimed name");
1164
    let plex = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "plex").unwrap();
1165
    assert_eq!(plex.key, identity.hash().to_hex(), "bound at registration");
1166
1167
    // A run: plex takes a job, and its history shows it.
1168
    let url = format!("{}/andy/demo", h.base);
1169
    let work = tempfile::tempdir().unwrap();
1170
    let c = client(&url, work.path());
1171
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1172
    c.snapshot("test").unwrap();
1173
    c.commit("Add a pipeline", &[]).unwrap();
1174
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1175
    runs_of(&h.app, "andy", "demo").await;
1176
    let (st, body) = claim_as(credential.clone()).await;
1177
    assert_eq!(st, StatusCode::OK, "{body}");
1178
    let job: serde_json::Value = serde_json::from_str(&body).unwrap();
1179
    let (_, page) = web("GET", format!("/admin/runners/{}", plex.id), None).await;
1180
    assert!(
1181
        page.contains("andy/demo") && page.contains(job["job"]["name"].as_str().unwrap()) && page.contains("Running now</dt><dd>1 job"),
1182
        "{page}"
1183
    );
1184
    // The queue on Admin → Runners and through the API (#41, part 4).
1185
    let (_, page) = web("GET", "/admin/runners".into(), None).await;
1186
    assert!(page.contains("<h2>Queue</h2>") && page.contains("<td>plex</td>"), "{page}");
1187
    let (_, tokens) = web("GET", "/settings/tokens".into(), None).await;
1188
    let (_, made) = web("POST", "/settings/tokens".into(), Some(format!("_csrf={}&name=admin&scopes=user%3Aread", csrf_of(&tokens)))).await;
1189
    let i = made.find("oxyhub_").unwrap();
1190
    let admin_token: String = made[i..].chars().take_while(|c| c.is_ascii_alphanumeric() || *c == '_').collect();
1191
    let (st, body) = call(&h.app, "GET", "/api/v1/runners", Some(&admin_token), None).await;
1192
    assert_eq!(st, StatusCode::OK, "{body}");
1193
    let listed: serde_json::Value = serde_json::from_str(&body).unwrap();
1194
    let plex_row = listed.as_array().unwrap().iter().find(|r| r["name"] == "plex").unwrap();
1195
    assert_eq!((plex_row["running"].as_i64(), plex_row["arch"].as_str()), (Some(1), Some("x86_64")));
1196
    // A runner's own labels and time limit from its page (#98).
1197
    let (_, page) = web("GET", format!("/admin/runners/{}", plex.id), None).await;
1198
    let (st, _) = web(
1199
        "POST",
1200
        format!("/admin/runners/{}/limits", plex.id),
1201
        Some(format!("_csrf={}&labels=gpu%2C+plex&timeout_minutes=5", csrf_of(&page))),
1202
    )
1203
    .await;
1204
    assert_eq!(st, StatusCode::SEE_OTHER);
1205
    let (_, page) = web("GET", format!("/admin/runners/{}", plex.id), None).await;
1206
    assert!(page.contains(">gpu<") && page.contains("5 min for its jobs"), "{page}");
1207
    let (_, body) = call(&h.app, "GET", "/api/v1/runners", Some(&admin_token), None).await;
1208
    let listed: serde_json::Value = serde_json::from_str(&body).unwrap();
1209
    let plex_row = listed.as_array().unwrap().iter().find(|r| r["name"] == "plex").unwrap();
1210
    assert!(plex_row["labels"].as_array().unwrap().iter().any(|l| l == "gpu"), "{plex_row}");
1211
    let (st, _) = web(
1212
        "POST",
1213
        format!("/admin/runners/{}/limits", plex.id),
1214
        Some(format!("_csrf={}&labels=bad%20label%21&timeout_minutes=", csrf_of(&page))),
1215
    )
1216
    .await;
1217
    assert_eq!(st, StatusCode::BAD_REQUEST, "a label with a space or punctuation is refused");
1218
    let (_, body) = call(&h.app, "GET", "/api/v1/runners/queue", Some(&admin_token), None).await;
1219
    let queue: serde_json::Value = serde_json::from_str(&body).unwrap();
1220
    assert!(queue.as_array().unwrap().iter().any(|q| q["status"] == "running" && q["runner"] == "plex"), "{queue}");
1221
    let (_, body) = call(&h.app, "GET", &format!("/api/v1/runners/{}/jobs", plex.id), Some(&admin_token), None).await;
1222
    let jobs: serde_json::Value = serde_json::from_str(&body).unwrap();
1223
    assert_eq!(jobs[0]["repo"], "andy/demo", "{jobs}");
1224
    assert_eq!(call(&h.app, "GET", "/api/v1/runners", None, None).await.0, StatusCode::NOT_FOUND, "administrators only");
1225
1226
    // Draining: no new work; removing while busy is refused.
1227
    let (_, page) = web("GET", "/admin/runners".into(), None).await;
1228
    let csrf = csrf_of(&page);
1229
    web("POST", format!("/admin/runners/{}/state", plex.id), Some(format!("_csrf={csrf}&state=draining"))).await;
1230
    assert_eq!(claim_as(credential.clone()).await.0, StatusCode::NO_CONTENT, "a draining runner takes nothing");
1231
    let (_, page) = web("POST", format!("/admin/runners/{}/remove", plex.id), Some(format!("_csrf={csrf}"))).await;
1232
    assert!(page.contains("is running jobs: drain it first"), "{page}");
1233
    // Its job finishes; disabled, it is refused; removed, its credential is dead.
1234
    let id = job["job_id"].as_i64().unwrap();
1235
    let done = call(
1236
        &h.app,
1237
        "POST",
1238
        &format!("/api/v1/flow/jobs/{id}/finish"),
1239
        Some(&credential),
1240
        Some(r#"{"exit_code":0,"duration_ms":5}"#.into()),
1241
    )
1242
    .await;
1243
    assert_eq!(done.0, StatusCode::NO_CONTENT);
1244
    web("POST", format!("/admin/runners/{}/state", plex.id), Some(format!("_csrf={csrf}&state=disabled"))).await;
1245
    assert_eq!(claim_as(credential.clone()).await.0, StatusCode::FORBIDDEN);
1246
    let (_, page) = web("POST", format!("/admin/runners/{}/remove", plex.id), Some(format!("_csrf={csrf}"))).await;
1247
    assert!(page.contains("Removed plex."), "{page}");
1248
    assert_eq!(claim_as(credential).await.0, StatusCode::UNAUTHORIZED);
1249
}
1250
1251
/// Runner scopes (oxygenhub#41): a runner registered for one repository, or
1252
/// one owner, takes only those jobs; a site runner takes any.
1253
#[tokio::test(flavor = "multi_thread")]
1254
async fn scoped_runners_take_only_their_scope() {
1255
    use oxy_core::identity::SecretKey;
1256
    let h = hub().await;
1257
    create(&h.app, "andy", "demo").await;
1258
    create(&h.app, "andy", "other").await;
1259
    let register = |scope: db::runners::Scope, name: &'static str| {
1260
        let app = h.app.clone();
1261
        async move {
1262
            let token = format!("flowreg_{name}");
1263
            db::runners::add_registration(&app.db, &blake3::hash(token.as_bytes()).to_hex(), "admin", &scope).await.unwrap();
1264
            let identity = SecretKey::generate().identity(name, "", 1);
1265
            let info = serde_json::json!({ "arch": "x86_64", "os": "linux", "version": "0.1.0", "labels": [], "max_jobs": 1 });
1266
            let reg = serde_json::json!({ "token": token, "name": name, "identity": hex::encode(identity.encode()), "info": info });
1267
            let (st, body) = call(&app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1268
            assert_eq!(st, StatusCode::OK, "{body}");
1269
            serde_json::from_str::<serde_json::Value>(&body).unwrap()["credential"].as_str().unwrap().to_string()
1270
        }
1271
    };
1272
    let demo = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
1273
    let only_demo = register(db::runners::Scope { owner: "andy".into(), repo_id: Some(demo.id) }, "demo-runner").await;
1274
    let carols = register(db::runners::Scope { owner: "carol".into(), repo_id: None }, "carol-runner").await;
1275
    let andys = register(db::runners::Scope { owner: "andy".into(), repo_id: None }, "andy-runner").await;
1276
    let claim_as = |who: String| {
1277
        let app = h.app.clone();
1278
        async move {
1279
            let body = serde_json::json!({ "runner": "x", "runtimes": ["microvm"] }).to_string();
1280
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some(&who), Some(body)).await;
1281
            (st == StatusCode::OK).then(|| serde_json::from_str::<serde_json::Value>(&body).unwrap()["repo"].as_str().unwrap().to_string())
1282
        }
1283
    };
1284
    // Jobs queued in andy/other only.
1285
    let work = tempfile::tempdir().unwrap();
1286
    let c = client(&format!("{}/andy/other", h.base), work.path());
1287
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1288
    c.snapshot("t").unwrap();
1289
    c.commit("pipeline", &[]).unwrap();
1290
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1291
    assert!(!runs_of(&h.app, "andy", "other").await.is_empty());
1292
    assert_eq!(claim_as(only_demo.clone()).await, None, "nothing of andy/demo is queued");
1293
    assert_eq!(claim_as(carols).await, None, "nothing of carol's");
1294
    assert_eq!(claim_as(andys).await.as_deref(), Some("andy/other"), "the owner's runner takes its repositories' jobs");
1295
    // The site runner (hub.toml) takes any.
1296
    assert_eq!(claim(&h.app).await.unwrap()["repo"], "andy/other");
1297
    assert_eq!(claim_as(only_demo).await, None, "still nothing of its own");
1298
}
1299
1300
/// Settings → Runners (oxygenhub#41, part 2b): a repository's admin adds a
1301
/// runner for that repository alone, sees which runners serve it, and
1302
/// removes only its own.
1303
#[tokio::test(flavor = "multi_thread")]
1304
async fn repository_admins_add_and_remove_their_own_runners() {
1305
    use oxy_core::identity::SecretKey;
1306
    let h = hub().await;
1307
    let res = oxygenhub::router(h.app.clone())
1308
        .oneshot(
1309
            Request::post("/register")
1310
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1311
                .body(Body::from("username=andy&email=andy%40example.com&password=correct-horse-battery"))
1312
                .unwrap(),
1313
        )
1314
        .await
1315
        .unwrap();
1316
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1317
    create(&h.app, "andy", "demo").await;
1318
    let demo = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
1319
    let web = |method: &'static str, path: String, body: Option<String>| {
1320
        let (app, cookie) = (h.app.clone(), cookie.clone());
1321
        async move {
1322
            let mut req = Request::builder().method(method).uri(path).header(header::COOKIE, cookie);
1323
            if body.is_some() {
1324
                req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1325
            }
1326
            let res = oxygenhub::router(app).oneshot(req.body(body.map(Body::from).unwrap_or_else(Body::empty)).unwrap()).await.unwrap();
1327
            let st = res.status();
1328
            (st, String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned())
1329
        }
1330
    };
1331
    let csrf_of = |page: &str| {
1332
        let i = page.find("name=\"_csrf\" value=\"").unwrap() + "name=\"_csrf\" value=\"".len();
1333
        page[i..].split('"').next().unwrap().to_string()
1334
    };
1335
    let (st, page) = web("GET", "/andy/demo/settings".into(), None).await;
1336
    assert_eq!(st, StatusCode::OK);
1337
    assert!(page.contains("<h2>Runners</h2>"), "the owner sees the section");
1338
    let (_, page) = web("POST", "/andy/demo/settings/runners/token".into(), Some(format!("_csrf={}", csrf_of(&page)))).await;
1339
    let i = page.find("--token ").unwrap() + "--token ".len();
1340
    let token: String = page[i..].chars().take_while(|c| !c.is_whitespace()).collect();
1341
    let identity = SecretKey::generate().identity("mine", "", 1);
1342
    let info = serde_json::json!({ "arch": "x86_64", "os": "linux", "version": "0.1.0", "labels": [], "max_jobs": 1 });
1343
    let reg = serde_json::json!({ "token": token, "name": "mine", "identity": hex::encode(identity.encode()), "info": info });
1344
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1345
    assert_eq!(st, StatusCode::OK, "{body}");
1346
    let mine = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "mine").unwrap();
1347
    assert_eq!(mine.scope(), db::runners::Scope { owner: "andy".into(), repo_id: Some(demo.id) });
1348
    // The site's runner (hub.toml, from its first claim) serves it too, but is not the owner's to remove.
1349
    claim(&h.app).await;
1350
    let site = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "test-1").unwrap();
1351
    let (_, page) = web("GET", "/andy/demo/settings".into(), None).await;
1352
    assert!(page.contains("<strong>mine</strong>") && page.contains("this repository"), "{page}");
1353
    assert!(page.contains("<strong>test-1</strong>") && page.contains("the whole site"), "{page}");
1354
    let csrf = csrf_of(&page);
1355
    let (st, _) = web("POST", format!("/andy/demo/settings/runners/{}/remove", site.id), Some(format!("_csrf={csrf}"))).await;
1356
    assert_eq!(st, StatusCode::NOT_FOUND, "not the repository's own");
1357
    let (_, page) = web("POST", format!("/andy/demo/settings/runners/{}/remove", mine.id), Some(format!("_csrf={csrf}"))).await;
1358
    assert!(page.contains("mine removed"), "{page}");
1359
    assert!(db::runners::get(&h.app.db, mine.id).await.unwrap().is_none());
1360
1361
    // The same for an organisation's owner.
1362
    let (_, page) = web("GET", "/orgs/new".into(), None).await;
1363
    web("POST", "/orgs/new".into(), Some(format!("_csrf={}&name=acme&display_name=Acme", csrf_of(&page)))).await;
1364
    let (st, page) = web("GET", "/orgs/acme/settings".into(), None).await;
1365
    assert_eq!(st, StatusCode::OK);
1366
    let (_, page) = web("POST", "/orgs/acme/settings/runners/token".into(), Some(format!("_csrf={}", csrf_of(&page)))).await;
1367
    let i = page.find("--token ").unwrap() + "--token ".len();
1368
    let token: String = page[i..].chars().take_while(|c| !c.is_whitespace()).collect();
1369
    let identity = SecretKey::generate().identity("acme-runner", "", 1);
1370
    let reg = serde_json::json!({ "token": token, "name": "acme-runner", "identity": hex::encode(identity.encode()), "info": info });
1371
    assert_eq!(call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await.0, StatusCode::OK);
1372
    let acme = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "acme-runner").unwrap();
1373
    assert_eq!(acme.scope(), db::runners::Scope { owner: "acme".into(), repo_id: None });
1374
    let (_, page) = web("GET", "/orgs/acme/settings".into(), None).await;
1375
    assert!(page.contains("<strong>acme-runner</strong>") && page.contains("the organisation's repositories"), "{page}");
1376
    let (_, page) = web("POST", format!("/orgs/acme/settings/runners/{}/remove", acme.id), Some(format!("_csrf={}", csrf_of(&page)))).await;
1377
    assert!(page.contains("acme-runner removed"), "{page}");
1378
}
1379
1380
/// runs-on (oxygenhub#41, part 3): a job that asks for a label goes only to
1381
/// a runner that has it, and waits for one otherwise.
1382
#[tokio::test(flavor = "multi_thread")]
1383
async fn jobs_that_ask_for_labels_wait_for_a_runner_with_them() {
1384
    use oxy_core::identity::SecretKey;
1385
    let h = hub().await;
1386
    create(&h.app, "andy", "demo").await;
1387
    let work = tempfile::tempdir().unwrap();
1388
    let c = client(&format!("{}/andy/demo", h.base), work.path());
1389
    let cross = "job \"cross\" {\n    sandbox \"alpine\"\n    runs-on \"riscv64\"\n    exec \"true\"\n}\n";
1390
    write(work.path(), ".flow/pipeline.kdl", &pipeline(cross));
1391
    c.snapshot("t").unwrap();
1392
    c.commit("pipeline", &[]).unwrap();
1393
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1394
    assert!(!runs_of(&h.app, "andy", "demo").await.is_empty());
1395
    // The site runner has no labels: it takes the others, never cross.
1396
    let mut taken = Vec::new();
1397
    while let Some(j) = claim(&h.app).await {
1398
        taken.push(j["job"]["name"].as_str().unwrap().to_string());
1399
    }
1400
    assert!(!taken.contains(&"cross".to_string()) && taken.contains(&"lint".to_string()), "{taken:?}");
1401
    let queue = db::flow::queue(&h.app.db).await.unwrap();
1402
    let waiting = queue.iter().find(|q| q.job == "cross").unwrap();
1403
    assert_eq!((waiting.status.as_str(), waiting.needs()), ("queued", vec!["riscv64".to_string()]));
1404
    // A runner registered with the label takes it.
1405
    let token = "flowreg_riscv";
1406
    db::runners::add_registration(&h.app.db, &blake3::hash(token.as_bytes()).to_hex(), "admin", &Default::default()).await.unwrap();
1407
    let identity = SecretKey::generate().identity("visionfive", "", 1);
1408
    let info = serde_json::json!({ "arch": "riscv64", "os": "linux", "version": "0.1.0", "labels": ["riscv64"], "max_jobs": 1 });
1409
    let reg = serde_json::json!({ "token": token, "name": "visionfive", "identity": hex::encode(identity.encode()), "info": info });
1410
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1411
    assert_eq!(st, StatusCode::OK, "{body}");
1412
    let credential = serde_json::from_str::<serde_json::Value>(&body).unwrap()["credential"].as_str().unwrap().to_string();
1413
    let claim_body = serde_json::json!({ "runner": "x", "runtimes": ["microvm"], "info": info }).to_string();
1414
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/claim", Some(&credential), Some(claim_body)).await;
1415
    assert_eq!(st, StatusCode::OK, "{body}");
1416
    assert_eq!(serde_json::from_str::<serde_json::Value>(&body).unwrap()["job"]["name"], "cross");
1417
}
1418
1419
/// oxygenhub#71: a job its runner stopped reporting (restarted, or lost
1420
/// the hub as the job ended) is ended once it has run past the time limit
1421
/// and a grace: an error with the reason, its dependents skipped and its
1422
/// run settled, as if the runner had reported the error.
1423
#[tokio::test(flavor = "multi_thread")]
1424
async fn a_job_no_runner_reports_is_ended_after_the_time_limit() {
1425
    let h = hub().await;
1426
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1427
    create(&h.app, "andy", "lost").await;
1428
    let url = format!("{}/andy/lost", h.base);
1429
    let work = tempfile::tempdir().unwrap();
1430
    let c = client(&url, work.path());
1431
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1432
    write(work.path(), "test.sh", "echo ok\n");
1433
    c.commit("Add a pipeline", &[]).unwrap();
1434
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1435
    assert_eq!(runs_of(&h.app, "andy", "lost").await.len(), 1);
1436
    let job = claim(&h.app).await.expect("a job to claim");
1437
    let id = job["job_id"].as_i64().unwrap();
1438
1439
    // Running, but well within the limit: left alone.
1440
    assert_eq!(oxygenhub::flow::reap_lost_jobs(&h.app).await.unwrap(), 0);
1441
    // Started long ago and never reported: ended.
1442
    let old = db::now_ms() - 24 * 3600 * 1000;
1443
    sqlx::query("UPDATE flow_jobs SET started_ms = ? WHERE id = ?").bind(old).bind(id).execute(&h.app.db).await.unwrap();
1444
    assert_eq!(oxygenhub::flow::reap_lost_jobs(&h.app).await.unwrap(), 1);
1445
    let j = db::flow::job(&h.app.db, id).await.unwrap().unwrap();
1446
    assert_eq!(j.status, "error");
1447
    assert!(j.error.starts_with("lost:"), "{}", j.error);
1448
    let run = &runs_of(&h.app, "andy", "lost").await[0];
1449
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
1450
    assert!(jobs.iter().all(|j| j.status != "running"), "nothing left running");
1451
    // A late report, should one come, does not overwrite the ending.
1452
    assert_ne!(finish(&h.app, id, serde_json::json!({ "exit_code": 0 })).await, StatusCode::NO_CONTENT);
1453
    assert_eq!(db::flow::job(&h.app.db, id).await.unwrap().unwrap().status, "error");
1454
}
1455
1456
/// oxygenhub#73: a runner that lists the images it holds is offered only
1457
/// the jobs whose rootfs is among them; one that does not say gets any.
1458
#[tokio::test(flavor = "multi_thread")]
1459
async fn a_runner_is_offered_only_jobs_whose_image_it_holds() {
1460
    let h = hub().await;
1461
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1462
    create(&h.app, "andy", "images").await;
1463
    let url = format!("{}/andy/images", h.base);
1464
    let work = tempfile::tempdir().unwrap();
1465
    let c = client(&url, work.path());
1466
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1467
    write(work.path(), "test.sh", "echo ok\n");
1468
    c.commit("Add a pipeline", &[]).unwrap();
1469
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1470
    assert_eq!(runs_of(&h.app, "andy", "images").await.len(), 1);
1471
    let claim_with = |images: Vec<String>| {
1472
        let body = serde_json::json!({ "runner": "test-1", "runtimes": ["microvm"], "images": images }).to_string();
1473
        let app = h.app.clone();
1474
        async move {
1475
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(body)).await;
1476
            (st, body)
1477
        }
1478
    };
1479
    let (st, _) = claim_with(vec!["ab".repeat(32)]).await;
1480
    assert_eq!(st, StatusCode::NO_CONTENT, "no job for a runner without the image");
1481
    let jobs = db::flow::jobs(&h.app.db, runs_of(&h.app, "andy", "images").await[0].id).await.unwrap();
1482
    let rootfs: serde_json::Value = serde_json::from_str(&jobs[0].sandbox).unwrap();
1483
    let rootfs = rootfs["rootfs"].as_str().unwrap().to_string();
1484
    let (st, body) = claim_with(vec!["ab".repeat(32), rootfs]).await;
1485
    assert_eq!(st, StatusCode::OK, "{body}");
1486
}
1487
1488
/// oxygenhub#71: a runner that lists the jobs it holds has the others it
1489
/// was given ended at once (it restarted, or never received them), not at
1490
/// the time limit; a held job is left alone.
1491
#[tokio::test(flavor = "multi_thread")]
1492
async fn a_job_its_runner_no_longer_holds_is_ended_at_its_next_claim() {
1493
    let h = hub().await;
1494
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1495
    create(&h.app, "andy", "held").await;
1496
    let url = format!("{}/andy/held", h.base);
1497
    let work = tempfile::tempdir().unwrap();
1498
    let c = client(&url, work.path());
1499
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1500
    write(work.path(), "test.sh", "echo ok\n");
1501
    c.commit("Add a pipeline", &[]).unwrap();
1502
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1503
    assert_eq!(runs_of(&h.app, "andy", "held").await.len(), 1);
1504
    let id = claim(&h.app).await.expect("a job to claim")["job_id"].as_i64().unwrap();
1505
    let claim_holding = |holding: Vec<i64>| {
1506
        let body = serde_json::json!({ "runner": "test-1", "runtimes": ["microvm"], "holding": holding }).to_string();
1507
        let app = h.app.clone();
1508
        async move { call(&app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(body)).await.0 }
1509
    };
1510
    claim_holding(vec![id]).await;
1511
    assert_eq!(db::flow::job(&h.app.db, id).await.unwrap().unwrap().status, "running", "a held job stays");
1512
    claim_holding(vec![]).await;
1513
    let j = db::flow::job(&h.app.db, id).await.unwrap().unwrap();
1514
    assert_eq!(j.status, "error");
1515
    assert!(j.error.starts_with("lost:") && j.error.contains("no longer holds"), "{}", j.error);
1516
    let run = &runs_of(&h.app, "andy", "held").await[0];
1517
    assert!(db::flow::jobs(&h.app.db, run.id).await.unwrap().iter().all(|j| j.status != "running"), "the run settles");
1518
}
1519
1520
/// oxygen#59: a job with a `scope` runs on a push only when the push's
1521
/// changes touch a path it names (a release job, when Cargo.toml's version
1522
/// moves); a bookmark's first run and manual runs have every job.
1523
#[tokio::test(flavor = "multi_thread")]
1524
async fn a_scoped_job_runs_only_when_a_push_touches_its_paths() {
1525
    let h = hub().await;
1526
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1527
    create(&h.app, "andy", "scoped").await;
1528
    let url = format!("{}/andy/scoped", h.base);
1529
    let work = tempfile::tempdir().unwrap();
1530
    let c = client(&url, work.path());
1531
    let extra = "job \"dist\" {\n    sandbox \"alpine\"\n    scope \"Cargo.toml\" \"packaging/**\"\n    exec \"true\"\n}\n";
1532
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1533
    write(work.path(), "test.sh", "echo ok\n");
1534
    write(work.path(), "Cargo.toml", "version = \"0.1.0\"\n");
1535
    c.commit("Start", &[]).unwrap();
1536
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1537
    let names = |app: Shared, n: usize| async move {
1538
        let mut runs = Vec::new();
1539
        for _ in 0..100 {
1540
            runs = runs_of(&app, "andy", "scoped").await;
1541
            if runs.len() >= n {
1542
                break;
1543
            }
1544
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1545
        }
1546
        assert_eq!(runs.len(), n, "runs");
1547
        let mut j: Vec<String> = db::flow::jobs(&app.db, runs[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1548
        j.sort();
1549
        // Passed, so the next push is scoped against it, not superseding it.
1550
        sqlx::query("UPDATE flow_runs SET status = 'passed' WHERE id = ?").bind(runs[0].id).execute(&app.db).await.unwrap();
1551
        j
1552
    };
1553
    assert_eq!(names(h.app.clone(), 1).await, ["build", "dist", "lint", "test"], "the first run has every job");
1554
    write(work.path(), "test.sh", "echo still ok\n");
1555
    c.commit("Edit the test", &[]).unwrap();
1556
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1557
    assert_eq!(names(h.app.clone(), 2).await, ["build", "lint", "test"], "dist is out of scope");
1558
    write(work.path(), "Cargo.toml", "version = \"0.1.1\"\n");
1559
    c.commit("Release 0.1.1", &[]).unwrap();
1560
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1561
    assert_eq!(names(h.app.clone(), 3).await, ["build", "dist", "lint", "test"], "a version bump runs dist");
1562
}
1563
1564
/// oxygenflow#32: a run still going is cancelled from the API, the web or
1565
/// by a newer push to its bookmark; its runner is refused from then on,
1566
/// and the next push is scoped past the cancelled run.
1567
#[tokio::test(flavor = "multi_thread")]
1568
async fn runs_are_cancelled_by_hand_or_by_a_newer_push() {
1569
    let h = hub().await;
1570
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1571
    create(&h.app, "andy", "stop").await;
1572
    let url = format!("{}/andy/stop", h.base);
1573
    let work = tempfile::tempdir().unwrap();
1574
    let c = client(&url, work.path());
1575
    let extra = "job \"dist\" {\n    sandbox \"alpine\"\n    scope \"Cargo.toml\"\n    exec \"true\"\n}\n";
1576
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1577
    write(work.path(), "test.sh", "echo ok\n");
1578
    write(work.path(), "Cargo.toml", "version = \"0.1.0\"\n");
1579
    c.commit("Start", &[]).unwrap();
1580
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1581
    let wait_runs = |app: Shared, n: usize| async move {
1582
        for _ in 0..100 {
1583
            let runs = runs_of(&app, "andy", "stop").await;
1584
            if runs.len() >= n {
1585
                return runs;
1586
            }
1587
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1588
        }
1589
        panic!("no run {n}");
1590
    };
1591
    let first = wait_runs(h.app.clone(), 1).await;
1592
    sqlx::query("UPDATE flow_runs SET status = 'passed' WHERE id = ?").bind(first[0].id).execute(&h.app.db).await.unwrap();
1593
    sqlx::query("UPDATE flow_jobs SET status = 'passed' WHERE run_id = ?").bind(first[0].id).execute(&h.app.db).await.unwrap();
1594
1595
    // Run 2 (a version bump) has a job running when run 3 is pushed.
1596
    write(work.path(), "Cargo.toml", "version = \"0.1.1\"\n");
1597
    c.commit("Release 0.1.1", &[]).unwrap();
1598
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1599
    wait_runs(h.app.clone(), 2).await;
1600
    let job = claim(&h.app).await.expect("a job of run 2");
1601
    let id = job["job_id"].as_i64().unwrap();
1602
    write(work.path(), "test.sh", "echo still ok\n");
1603
    c.commit("Edit the test", &[]).unwrap();
1604
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1605
    let runs = wait_runs(h.app.clone(), 3).await;
1606
    let third = &runs[0];
1607
    let mut second = runs[1].clone();
1608
    for _ in 0..100 {
1609
        second = db::flow::run_by_id(&h.app.db, runs[1].id).await.unwrap().unwrap();
1610
        if !second.live() {
1611
            break;
1612
        }
1613
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1614
    }
1615
    assert_eq!(second.status, "cancelled", "a newer push supersedes a run still going");
1616
    let jobs = db::flow::jobs(&h.app.db, second.id).await.unwrap();
1617
    assert!(jobs.iter().all(|j| j.status == "cancelled" && j.error == "superseded by run #3"), "{jobs:?}");
1618
    let mut names: Vec<String> = db::flow::jobs(&h.app.db, third.id).await.unwrap().into_iter().map(|j| j.name).collect();
1619
    names.sort();
1620
    assert_eq!(names, ["build", "dist", "lint", "test"], "run 3 also checks what run 2 would have: the version bump");
1621
    let mut checks = vec![];
1622
    for _ in 0..100 {
1623
        checks = db::hooks::checks_for_state(&h.app.db, second.repo_id, &second.state).await.unwrap();
1624
        if checks.iter().all(|c| c.status == "cancelled") {
1625
            break;
1626
        }
1627
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1628
    }
1629
    assert!(checks.iter().all(|c| c.status == "cancelled"), "{checks:?}");
1630
    // The runner of the cancelled job is refused, so it stops the job.
1631
    let (st, _) =
1632
        call(&h.app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(r#"{"records":[]}"#.into())).await;
1633
    assert_eq!(st, StatusCode::CONFLICT);
1634
1635
    // By hand: the API, then a run already ended is refused.
1636
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/stop/flow/runs/3/cancel", Some("site"), None).await;
1637
    assert_eq!(st, StatusCode::OK, "{body}");
1638
    let third = db::flow::run_by_id(&h.app.db, third.id).await.unwrap().unwrap();
1639
    assert_eq!(third.status, "cancelled");
1640
    assert!(db::flow::jobs(&h.app.db, third.id).await.unwrap().iter().all(|j| j.error == "cancelled by andy"));
1641
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/stop/flow/runs/3/cancel", Some("site"), None).await;
1642
    assert!(st == StatusCode::CONFLICT && body.contains("already cancelled"), "{st} {body}");
1643
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/stop/flow/runs/3/cancel", None, None).await;
1644
    assert_ne!(st, StatusCode::OK, "anonymous callers cannot cancel");
1645
    let (_, page) = call(&h.app, "GET", "/andy/stop/flow/3", None, None).await;
1646
    assert!(page.contains("⊘") && !page.contains("CANCEL</button>"), "a cancelled run shows so, with no button");
1647
}
1648
1649
/// oxygenflow#23 and oxygenhub#89: a job runs under its pipeline's
1650
/// timeout, capped at the site's maximum, else the site's default; and the
1651
/// hub gives a job up only past its own limit.
1652
#[tokio::test(flavor = "multi_thread")]
1653
async fn a_job_runs_under_its_own_time_limit_within_the_sites() {
1654
    let h = hub().await;
1655
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1656
    db::accounts::set_setting(&h.app.db, oxygenhub::flow::SETTING_DEFAULT, "30").await.unwrap();
1657
    db::accounts::set_setting(&h.app.db, oxygenhub::flow::SETTING_MAX, "120").await.unwrap();
1658
    create(&h.app, "andy", "limits").await;
1659
    let url = format!("{}/andy/limits", h.base);
1660
    let work = tempfile::tempdir().unwrap();
1661
    let c = client(&url, work.path());
1662
    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";
1663
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1664
    write(work.path(), "test.sh", "echo ok\n");
1665
    c.commit("Add a pipeline", &[]).unwrap();
1666
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1667
    assert_eq!(runs_of(&h.app, "andy", "limits").await.len(), 1);
1668
    let mut limits = std::collections::HashMap::new();
1669
    let mut ids = std::collections::HashMap::new();
1670
    while let Some(j) = claim(&h.app).await {
1671
        let name = j["job"]["name"].as_str().unwrap().to_string();
1672
        limits.insert(name.clone(), j["timeout_s"].as_u64().unwrap());
1673
        ids.insert(name, j["job_id"].as_i64().unwrap());
1674
    }
1675
    assert_eq!(limits["slow"], 5400, "its own");
1676
    assert_eq!(limits["huge"], 7200, "cut to the site's maximum");
1677
    assert_eq!(limits["build"], 1800, "the site's default");
1678
    // 40 minutes in: past the default and its grace, within slow's limit.
1679
    let started = db::now_ms() - 40 * 60 * 1000;
1680
    sqlx::query("UPDATE flow_jobs SET started_ms = ?").bind(started).execute(&h.app.db).await.unwrap();
1681
    oxygenhub::flow::reap_lost_jobs(&h.app).await.unwrap();
1682
    let status = |id: i64| {
1683
        let app = h.app.clone();
1684
        async move { db::flow::job(&app.db, id).await.unwrap().unwrap().status }
1685
    };
1686
    assert_eq!(status(ids["build"]).await, "error", "past its 30 minutes");
1687
    assert_eq!(status(ids["slow"]).await, "running", "within its 90");
1688
    assert_eq!(status(ids["huge"]).await, "running", "within its 120");
1689
}
1690
1691
/// oxygenflow#24: a job's `on` decides which events start it: a pushed
1692
/// tag runs only the jobs that name it; a push to a bookmark the pipeline
1693
/// does not name starts no run; a rerun repeats its run's event.
1694
#[tokio::test(flavor = "multi_thread")]
1695
async fn on_decides_which_events_start_a_job() {
1696
    let h = hub().await;
1697
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1698
    create(&h.app, "andy", "events").await;
1699
    let url = format!("{}/andy/events", h.base);
1700
    let work = tempfile::tempdir().unwrap();
1701
    let c = client(&url, work.path());
1702
    let text = format!(
1703
        "on {{\n    push \"main\"\n    manual\n}}\n{}job \"dist\" {{\n    sandbox \"alpine\"\n    on {{\n        tag \"v*\"\n    }}\n    exec \"true\"\n}}\n",
1704
        pipeline("")
1705
    );
1706
    // `on` must come after schema-version; pipeline() starts with it.
1707
    let text = text.replacen(
1708
        "on {\n    push \"main\"\n    manual\n}\nschema-version 1\n",
1709
        "schema-version 1\non {\n    push \"main\"\n    manual\n}\n",
1710
        1,
1711
    );
1712
    write(work.path(), ".flow/pipeline.kdl", &text);
1713
    write(work.path(), "test.sh", "echo ok\n");
1714
    c.commit("Start", &[]).unwrap();
1715
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1716
    let jobs_of_latest = |app: Shared, n: usize| async move {
1717
        let mut runs = Vec::new();
1718
        for _ in 0..100 {
1719
            runs = runs_of(&app, "andy", "events").await;
1720
            if runs.len() >= n {
1721
                break;
1722
            }
1723
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1724
        }
1725
        assert_eq!(runs.len(), n, "runs");
1726
        let mut j: Vec<String> = db::flow::jobs(&app.db, runs[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1727
        j.sort();
1728
        (runs[0].clone(), j)
1729
    };
1730
    let (_, j) = jobs_of_latest(h.app.clone(), 1).await;
1731
    assert_eq!(j, ["build", "lint", "test"], "a push to main: no dist");
1732
    // A tag: only dist.
1733
    let heads = c.bookmark_heads().unwrap();
1734
    c.tag_create("v1.0.0", &heads, "first").unwrap();
1735
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1736
    let (run, j) = jobs_of_latest(h.app.clone(), 2).await;
1737
    assert_eq!(j, ["dist"], "a tag runs only what names it");
1738
    assert_eq!(run.trigger, "tag:v1.0.0");
1739
    // A rerun repeats the tag's event.
1740
    let row = db::repos::get(&h.app.db, "andy", "events").await.unwrap().unwrap();
1741
    db::flow::finish(
1742
        &h.app.db,
1743
        db::flow::jobs(&h.app.db, run.id).await.unwrap()[0].id,
1744
        db::flow::Outcome { status: "passed", exit_code: Some(0), error: "", receipt: "", receipt_hash: "" },
1745
    )
1746
    .await
1747
    .unwrap();
1748
    let run = db::flow::run_by_id(&h.app.db, run.id).await.unwrap().unwrap();
1749
    oxygenhub::flow::rerun(&h.app, &row, &run, "andy").await.unwrap();
1750
    let (_, j) = jobs_of_latest(h.app.clone(), 3).await;
1751
    assert_eq!(j, ["dist"], "the rerun is the tag's run again");
1752
    // A bookmark the pipeline does not name starts nothing.
1753
    c.bookmark_create("develop", None).unwrap();
1754
    assert!(c.push_bookmark("origin", "develop", false).unwrap().iter().all(|r| r.ok));
1755
    tokio::time::sleep(std::time::Duration::from_millis(300)).await;
1756
    assert_eq!(runs_of(&h.app, "andy", "events").await.len(), 3, "no run for develop");
1757
}
1758
1759
/// oxygenflow#24: a job with a `schedule` line runs on the default
1760
/// bookmark when the line comes due, and only then; other jobs stay out.
1761
#[tokio::test(flavor = "multi_thread")]
1762
async fn scheduled_jobs_run_when_due() {
1763
    let h = hub().await;
1764
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1765
    create(&h.app, "andy", "nightly").await;
1766
    let url = format!("{}/andy/nightly", h.base);
1767
    let work = tempfile::tempdir().unwrap();
1768
    let c = client(&url, work.path());
1769
    // An odd minute, so the hub's own ticker cannot fire it during the test.
1770
    let extra = "job \"nightly\" {\n    sandbox \"alpine\"\n    on {\n        schedule \"17 4 29 2 *\"\n    }\n    exec \"true\"\n}\n";
1771
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1772
    write(work.path(), "test.sh", "echo ok\n");
1773
    c.commit("Start", &[]).unwrap();
1774
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1775
    assert_eq!(runs_of(&h.app, "andy", "nightly").await.len(), 1);
1776
    let first = runs_of(&h.app, "andy", "nightly").await;
1777
    let names: Vec<String> = db::flow::jobs(&h.app.db, first[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1778
    assert!(!names.contains(&"nightly".to_string()), "a push does not run a scheduled job");
1779
    use flow_core::pipeline::When;
1780
    let not_yet = When { minute: 16, hour: 4, day: 29, month: 2, weekday: 4 };
1781
    assert_eq!(oxygenhub::flow::run_due(&h.app, not_yet).await, 0);
1782
    let due = When { minute: 17, ..not_yet };
1783
    assert_eq!(oxygenhub::flow::run_due(&h.app, due).await, 1);
1784
    let runs = runs_of(&h.app, "andy", "nightly").await;
1785
    assert_eq!(runs.len(), 2);
1786
    assert_eq!(runs[0].trigger, "schedule");
1787
    let names: Vec<String> = db::flow::jobs(&h.app.db, runs[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1788
    assert_eq!(names, ["nightly"]);
1789
    assert_eq!(runs[0].bookmark, "main", "on the default bookmark");
1790
}
1791
1792
#[tokio::test(flavor = "multi_thread")]
1793
async fn variables_from_three_levels_reach_a_job_inner_overriding_outer() {
1794
    use oxygenhub::levels::Scope;
1795
    use oxygenhub::variables;
1796
    let h = hub().await;
1797
    let app = &h.app;
1798
    // Andy, the site's administrator, owns the acme organisation.
1799
    let res = oxygenhub::router(app.clone())
1800
        .oneshot(
1801
            Request::post("/register")
1802
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1803
                .body(Body::from("username=andy&email=a%40example.com&password=correct-horse-battery"))
1804
                .unwrap(),
1805
        )
1806
        .await
1807
        .unwrap();
1808
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1809
    let andy = db::accounts::account_by_name(&app.db, "andy").await.unwrap().unwrap();
1810
    db::accounts::create_org(&app.db, "acme", "Acme", andy.id).await.unwrap();
1811
    create(app, "acme", "app").await;
1812
    let page = |path: &str, form: Option<String>| {
1813
        let mut req =
1814
            Request::builder().method(if form.is_some() { "POST" } else { "GET" }).uri(path).header(header::COOKIE, cookie.clone());
1815
        if form.is_some() {
1816
            req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1817
        }
1818
        let req = req.body(Body::from(form.unwrap_or_default())).unwrap();
1819
        let app = app.clone();
1820
        async move {
1821
            let res = oxygenhub::router(app).oneshot(req).await.unwrap();
1822
            let status = res.status();
1823
            let body = String::from_utf8(res.into_body().collect().await.unwrap().to_bytes().to_vec()).unwrap();
1824
            (status, body)
1825
        }
1826
    };
1827
    let csrf_of = |page: &str| {
1828
        let i = page.find("name=\"_csrf\" value=\"").expect("csrf field") + "name=\"_csrf\" value=\"".len();
1829
        page[i..].split('"').next().unwrap().to_string()
1830
    };
1831
1832
    // The site sets CC and LANG, the organisation its own CC, the
1833
    // repository RUST_LOG from its settings page.
1834
    variables::set(&app.db, Scope::Site, "CC", "gcc").await.unwrap();
1835
    variables::set(&app.db, Scope::Site, "LANG", "C").await.unwrap();
1836
    let org = db::accounts::org_by_name(&app.db, "acme").await.unwrap().unwrap();
1837
    variables::set(&app.db, Scope::Org(org.id), "CC", "clang").await.unwrap();
1838
    let (st, settings) = page("/acme/app/settings", None).await;
1839
    assert_eq!(st, StatusCode::OK, "{settings}");
1840
    assert!(settings.contains("Inherited") && settings.contains("the acme organisation") && settings.contains("overridden"), "{settings}");
1841
    let csrf = csrf_of(&settings);
1842
    let (_, body) = page("/acme/app/settings/variables", Some(format!("_csrf={csrf}&action=set&name=RUST_LOG&value=debug"))).await;
1843
    assert!(body.contains("RUST_LOG set.") && body.contains("<code>debug</code>"), "{body}");
1844
    let (_, body) = page("/acme/app/settings/variables", Some(format!("_csrf={csrf}&action=set&name=FLOW_REPO&value=x"))).await;
1845
    assert!(body.contains("not FLOW_"), "{body}");
1846
    let repo = db::repos::get(&app.db, "acme", "app").await.unwrap().unwrap();
1847
    db::repos::set_flow(&app.db, repo.id, "on").await.unwrap();
1848
    let env = variables::env_for_repo(&app.db, &repo).await.unwrap();
1849
    assert_eq!(
1850
        env.iter().map(|(k, v)| (k.as_str(), v.as_str())).collect::<Vec<_>>(),
1851
        [("CC", "clang"), ("LANG", "C"), ("RUST_LOG", "debug")],
1852
        "the organisation's CC wins over the site's"
1853
    );
1854
1855
    // A claim carries them.
1856
    let url = format!("{}/acme/app", h.base);
1857
    let work = tempfile::tempdir().unwrap();
1858
    let c = client(&url, work.path());
1859
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1860
    write(work.path(), "test.sh", "echo ok\n");
1861
    c.snapshot("test").unwrap();
1862
    c.commit("Add a pipeline", &[]).unwrap();
1863
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1864
    let runs = runs_of(app, "acme", "app").await;
1865
    assert_eq!(runs.len(), 1, "{runs:?}");
1866
    let got = claim(app).await.unwrap_or_else(|| panic!("a job: {:?}", runs[0]));
1867
    assert_eq!(got["env"], serde_json::json!({ "CC": "clang", "LANG": "C", "RUST_LOG": "debug" }), "{got}");
1868
1869
    // Removing a site variable from the admin page takes effect at the next claim.
1870
    let (_, admin) = page("/admin", None).await;
1871
    assert!(admin.contains("Variables") && admin.contains("<code>gcc</code>"), "{admin}");
1872
    let (_, body) = page("/admin/variables", Some(format!("_csrf={}&action=delete&name=LANG", csrf_of(&admin)))).await;
1873
    assert!(body.contains("LANG removed."), "{body}");
1874
    let got = claim(app).await.expect("another job");
1875
    assert_eq!(got["env"], serde_json::json!({ "CC": "clang", "RUST_LOG": "debug" }), "{got}");
1876
}
1877
1878
#[tokio::test(flavor = "multi_thread")]
1879
async fn secrets_a_job_declares_come_with_the_claim_and_never_reach_the_log() {
1880
    let h = hub().await;
1881
    let app = &h.app;
1882
    let res = oxygenhub::router(app.clone())
1883
        .oneshot(
1884
            Request::post("/register")
1885
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1886
                .body(Body::from("username=andy&email=a%40example.com&password=correct-horse-battery"))
1887
                .unwrap(),
1888
        )
1889
        .await
1890
        .unwrap();
1891
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1892
    let page = |path: &str, form: Option<String>| {
1893
        let mut req =
1894
            Request::builder().method(if form.is_some() { "POST" } else { "GET" }).uri(path).header(header::COOKIE, cookie.clone());
1895
        if form.is_some() {
1896
            req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1897
        }
1898
        let req = req.body(Body::from(form.unwrap_or_default())).unwrap();
1899
        let app = app.clone();
1900
        async move {
1901
            let res = oxygenhub::router(app).oneshot(req).await.unwrap();
1902
            let status = res.status();
1903
            let body = String::from_utf8(res.into_body().collect().await.unwrap().to_bytes().to_vec()).unwrap();
1904
            (status, body)
1905
        }
1906
    };
1907
    let csrf_of = |page: &str| {
1908
        let i = page.find("name=\"_csrf\" value=\"").expect("csrf field") + "name=\"_csrf\" value=\"".len();
1909
        page[i..].split('"').next().unwrap().to_string()
1910
    };
1911
    create(app, "andy", "demo").await;
1912
    // The site sets deploy-token; the repository overrides it. Neither
1913
    // page shows a value, only that it is set.
1914
    let (_, admin) = page("/admin", None).await;
1915
    let csrf = csrf_of(&admin);
1916
    let (_, body) = page("/admin/secrets", Some(format!("_csrf={csrf}&action=set&name=deploy-token&value=site-level-value"))).await;
1917
    assert!(body.contains("deploy-token set.") && !body.contains("site-level-value"), "{body}");
1918
    let (_, body) = page("/admin/secrets", Some(format!("_csrf={csrf}&action=set&name=bad+name&value=x"))).await;
1919
    assert!(body.contains("name is 1 to 64 of"), "{body}");
1920
    let (_, settings) = page("/andy/demo/settings", None).await;
1921
    assert!(
1922
        settings.contains("Secrets") && settings.contains("<code>deploy-token</code>") && settings.contains("the site</td>"),
1923
        "{settings}"
1924
    );
1925
    let csrf_r = csrf_of(&settings);
1926
    let (_, body) =
1927
        page("/andy/demo/settings/secrets", Some(format!("_csrf={csrf_r}&action=set&name=deploy-token&value=hunter22-repo-value"))).await;
1928
    assert!(body.contains("deploy-token set.") && body.contains("overridden") && !body.contains("hunter22"), "{body}");
1929
    let repo = db::repos::get(&app.db, "andy", "demo").await.unwrap().unwrap();
1930
    assert!(
1931
        !String::from_utf8_lossy(&oxygenhub::secrets::list(&app.db, oxygenhub::levels::Scope::Repo(repo.id)).await.unwrap()[0].value)
1932
            .contains("hunter22"),
1933
        "sealed at rest"
1934
    );
1935
1936
    // A job that declares the secret, and one the levels do not hold.
1937
    let url = format!("{}/andy/demo", h.base);
1938
    let work = tempfile::tempdir().unwrap();
1939
    let c = client(&url, work.path());
1940
    write(
1941
        work.path(),
1942
        ".flow/pipeline.kdl",
1943
        &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"),
1944
    );
1945
    write(work.path(), "test.sh", "echo ok\n");
1946
    c.snapshot("test").unwrap();
1947
    c.commit("Add a pipeline", &[]).unwrap();
1948
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1949
    let runs = runs_of(app, "andy", "demo").await;
1950
    let jobs = match runs.first() {
1951
        Some(r) => db::flow::jobs(&app.db, r.id).await.unwrap().iter().map(|j| format!("{}:{}", j.name, j.status)).collect::<Vec<_>>(),
1952
        None => vec![],
1953
    };
1954
    let mut deploy = None;
1955
    for _ in 0..50 {
1956
        let Some(got) = claim(app).await else {
1957
            tokio::time::sleep(std::time::Duration::from_millis(100)).await;
1958
            continue;
1959
        };
1960
        if got["job"]["name"] == "deploy" {
1961
            deploy = Some(got);
1962
            break;
1963
        }
1964
        assert_eq!(got["secrets"], serde_json::Value::Null, "{got}");
1965
    }
1966
    let got = deploy.unwrap_or_else(|| panic!("the deploy job: runs {runs:?} jobs {jobs:?}"));
1967
    assert_eq!(
1968
        got["secrets"],
1969
        serde_json::json!([{ "name": "deploy-token", "path": "/run/secrets/token", "value": "hunter22-repo-value" }]),
1970
        "the repository's value, the missing one left out: {got}"
1971
    );
1972
    let id = got["job_id"].as_i64().unwrap();
1973
    let log = db::flow::log(&app.db, id, 0, 100).await.unwrap();
1974
    assert!(log.iter().any(|l| l.stream == "flow" && l.text.contains("secret \"missing\" is not set")), "{log:?}");
1975
1976
    // The value never reaches the stored log, plain or base64.
1977
    let records = serde_json::json!({ "records": [
1978
        { "t": 1, "stream": "out", "text": "token=hunter22-repo-value" },
1979
        { "t": 2, "stream": "err", "text": "b64 aHVudGVyMjItcmVwby12YWx1ZQ== end" },
1980
    ] });
1981
    let (st, _) = call(app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(records.to_string())).await;
1982
    assert_eq!(st, StatusCode::NO_CONTENT);
1983
    let log = db::flow::log(&app.db, id, 0, 100).await.unwrap();
1984
    let texts: Vec<&str> = log.iter().map(|l| l.text.as_str()).collect();
1985
    assert!(texts.contains(&"token=***") && texts.contains(&"b64 *** end"), "{texts:?}");
1986
    assert!(!texts.iter().any(|t| t.contains("hunter22")), "{texts:?}");
1987
}
1988
1989
#[tokio::test(flavor = "multi_thread")]
1990
async fn a_job_s_identity_is_a_signed_token_the_discovery_document_lets_anyone_verify() {
1991
    let h = hub().await;
1992
    let app = &h.app;
1993
    let (st, disc) = call(app, "GET", "/.well-known/openid-configuration", None, None).await;
1994
    assert_eq!(st, StatusCode::OK, "{disc}");
1995
    let disc: serde_json::Value = serde_json::from_str(&disc).unwrap();
1996
    assert_eq!(disc["issuer"], h.base.as_str());
1997
    assert_eq!(disc["jwks_uri"], format!("{}/.well-known/jwks.json", h.base));
1998
    let (st, jwks) = call(app, "GET", "/.well-known/jwks.json", None, None).await;
1999
    assert_eq!(st, StatusCode::OK, "{jwks}");
2000
    let jwks: serde_json::Value = serde_json::from_str(&jwks).unwrap();
2001
    assert_eq!(jwks["keys"][0]["alg"], "RS256");
2002
    let kid = jwks["keys"][0]["kid"].as_str().unwrap().to_string();
2003
2004
    create(app, "andy", "demo").await;
2005
    let url = format!("{}/andy/demo", h.base);
2006
    let work = tempfile::tempdir().unwrap();
2007
    let c = client(&url, work.path());
2008
    write(
2009
        work.path(),
2010
        ".flow/pipeline.kdl",
2011
        &pipeline("job \"deploy\" {\n    sandbox \"alpine\"\n    identity \"sts.amazonaws.com\" {\n        mount-path \"/run/secrets/aws-token\"\n    }\n    exec \"deploy\"\n}\n"),
2012
    );
2013
    write(work.path(), "test.sh", "echo ok\n");
2014
    c.snapshot("test").unwrap();
2015
    c.commit("Add a pipeline", &[]).unwrap();
2016
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
2017
    let mut deploy = None;
2018
    for _ in 0..50 {
2019
        let Some(got) = claim(app).await else {
2020
            tokio::time::sleep(std::time::Duration::from_millis(100)).await;
2021
            continue;
2022
        };
2023
        if got["job"]["name"] == "deploy" {
2024
            deploy = Some(got);
2025
            break;
2026
        }
2027
    }
2028
    let got = deploy.expect("the deploy job");
2029
    let secrets = got["secrets"].as_array().expect("secrets");
2030
    assert_eq!(secrets.len(), 1);
2031
    assert_eq!(
2032
        (secrets[0]["name"].as_str(), secrets[0]["path"].as_str()),
2033
        (Some("identity:sts.amazonaws.com"), Some("/run/secrets/aws-token"))
2034
    );
2035
    let token = secrets[0]["value"].as_str().unwrap().to_string();
2036
    let issuer = app.oidc().await.unwrap();
2037
    assert_eq!(issuer.kid, kid, "the key the JWKS publishes signed it");
2038
    let claims = issuer.verify(&token, "sts.amazonaws.com", db::now_ms()).expect("verifies");
2039
    assert_eq!(claims["sub"], "repo:andy/demo:bookmark:main");
2040
    assert_eq!(claims["repository"], "andy/demo");
2041
    assert_eq!(claims["job"], "deploy");
2042
    assert_eq!(claims["run_number"], 1);
2043
    assert_eq!(claims["runner"], "test-1");
2044
    assert_eq!(claims["iss"], h.base.as_str());
2045
    assert!(claims["state"].as_str().unwrap().len() == 64);
2046
    // A job that prints its token leaves *** in the log.
2047
    let id = got["job_id"].as_i64().unwrap();
2048
    let records = serde_json::json!({ "records": [{ "t": 1, "stream": "out", "text": format!("TOKEN={token} end") }] });
2049
    let (st, _) = call(app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(records.to_string())).await;
2050
    assert_eq!(st, StatusCode::NO_CONTENT);
2051
    let log = db::flow::log(&app.db, id, 0, 100).await.unwrap();
2052
    assert!(log.iter().any(|l| l.text == "TOKEN=*** end"), "{log:?}");
2053
}
2054
2055
#[tokio::test(flavor = "multi_thread")]
2056
async fn jobs_are_offered_only_to_runners_of_their_architecture() {
2057
    let h = hub().await;
2058
    let app = &h.app;
2059
    create(app, "andy", "demo").await;
2060
    let url = format!("{}/andy/demo", h.base);
2061
    let work = tempfile::tempdir().unwrap();
2062
    let c = client(&url, work.path());
2063
    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)));
2064
    write(work.path(), "test.sh", "echo ok\n");
2065
    c.snapshot("test").unwrap();
2066
    c.commit("Add a pipeline", &[]).unwrap();
2067
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
2068
    let claim_as = |arch: &'static str, archs: serde_json::Value| {
2069
        let app = app.clone();
2070
        async move {
2071
            let body = serde_json::json!({
2072
                "runner": format!("{arch}-1"), "runtimes": ["microvm"],
2073
                "info": { "arch": arch, "os": "linux", "version": "t", "labels": [], "max_jobs": 1 },
2074
                "image_archs": archs,
2075
            });
2076
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(body.to_string())).await;
2077
            match st {
2078
                StatusCode::NO_CONTENT => None,
2079
                StatusCode::OK => {
2080
                    Some(serde_json::from_str::<serde_json::Value>(&body).unwrap()["job"]["name"].as_str().unwrap().to_string())
2081
                }
2082
                other => panic!("claim: {other} {body}"),
2083
            }
2084
        }
2085
    };
2086
    // An x86_64 runner that says the alpine image is x86_64: it takes the
2087
    // alpine jobs, never the one that asks for riscv64.
2088
    let rootfs = pipeline("").split("cas://blob/").nth(1).unwrap()[..64].to_string();
2089
    for _ in 0..50 {
2090
        if !runs_of(app, "andy", "demo").await.is_empty() {
2091
            break;
2092
        }
2093
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;
2094
    }
2095
    let runs = runs_of(app, "andy", "demo").await;
2096
    assert_eq!(runs.len(), 1, "{runs:?}");
2097
    let mut taken = vec![];
2098
    while let Some(j) = claim_as("x86_64", serde_json::json!({ rootfs.clone(): "x86_64" })).await {
2099
        taken.push(j);
2100
    }
2101
    assert_eq!(taken, ["build", "lint"], "test waits for build; flash is for riscv64");
2102
    // A riscv64 runner: the alpine image is known to be x86_64, so only flash.
2103
    assert_eq!(claim_as("riscv64", serde_json::json!({})).await.as_deref(), Some("flash"));
2104
    assert_eq!(claim_as("riscv64", serde_json::json!({})).await, None);
2105
    let (_, queue) = call(app, "GET", "/admin/runners", None, None).await;
2106
    let _ = queue;
2107
}
2108
2109
/// OxygenFlow spec §11.5: a runner hands back a job it cannot run. The
2110
/// job is queued again and not offered to that runner again, the decline
2111
/// shows on the run's page and is kept for the runner's, and once three
2112
/// runners have declined it the job ends as unplaceable with their reasons.
2113
#[tokio::test(flavor = "multi_thread")]
2114
async fn a_declined_job_goes_to_another_runner_or_ends_unplaceable() {
2115
    let h = hub().await;
2116
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
2117
    create(&h.app, "andy", "declines").await;
2118
    let url = format!("{}/andy/declines", h.base);
2119
    let work = tempfile::tempdir().unwrap();
2120
    let c = client(&url, work.path());
2121
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
2122
    write(work.path(), "test.sh", "echo ok\n");
2123
    c.commit("Add a pipeline", &[]).unwrap();
2124
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
2125
    let run = runs_of(&h.app, "andy", "declines").await[0].clone();
2126
    let claim_as = |token: &'static str, name: &'static str| {
2127
        let app = h.app.clone();
2128
        async move {
2129
            let body = serde_json::json!({ "runner": name, "runtimes": ["microvm"] }).to_string();
2130
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some(token), Some(body)).await;
2131
            (st == StatusCode::OK).then(|| serde_json::from_str::<serde_json::Value>(&body).unwrap()["job_id"].as_i64().unwrap())
2132
        }
2133
    };
2134
    let decline = |token: &'static str, id: i64, reason: &'static str| {
2135
        let app = h.app.clone();
2136
        async move {
2137
            let body = serde_json::json!({ "reason": reason }).to_string();
2138
            call(&app, "POST", &format!("/api/v1/flow/jobs/{id}/decline"), Some(token), Some(body)).await.0
2139
        }
2140
    };
2141
    let job = claim_as("runner-secret", "earth-1").await.expect("a job");
2142
    // The other runners are known to the hub before they decline anything.
2143
    assert_eq!(decline("runner-two", job, "not mine").await, StatusCode::CONFLICT, "only the runner it runs on may decline it");
2144
    assert_eq!(decline("runner-secret", job, "the MicroVM tier needs /dev/kvm").await, StatusCode::NO_CONTENT);
2145
    let j = db::flow::job(&h.app.db, job).await.unwrap().unwrap();
2146
    assert_eq!((j.status.as_str(), j.runner.as_str()), ("queued", ""));
2147
    assert_eq!(j.waiting, "declined by earth-1: the MicroVM tier needs /dev/kvm; waiting for another runner");
2148
    // earth-1 is offered the other ready job, not this one, while it stays the same.
2149
    let next = claim_as("runner-secret", "earth-1").await.expect("the other ready job");
2150
    assert_ne!(next, job);
2151
    let page = call(&h.app, "GET", &format!("/andy/declines/flow/{}", run.number), None, None).await.1;
2152
    assert!(page.contains("Waiting: declined by earth-1: the MicroVM tier needs /dev/kvm"), "{page}");
2153
    assert_eq!(claim_as("runner-two", "plex-1").await, Some(job), "another runner takes it");
2154
    assert_eq!(decline("runner-two", job, "rootfs 36fc4e323804 is not on this runner").await, StatusCode::NO_CONTENT);
2155
    assert_eq!(claim_as("runner-three", "narvi").await, Some(job));
2156
    assert_eq!(decline("runner-three", job, "rootfs 36fc4e323804 is for x86_64; this runner is riscv64").await, StatusCode::NO_CONTENT);
2157
    let j = db::flow::job(&h.app.db, job).await.unwrap().unwrap();
2158
    assert_eq!(j.status, "error");
2159
    assert_eq!(
2160
        j.error,
2161
        "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"
2162
    );
2163
    let r = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "plex-1").unwrap();
2164
    let declined = db::flow::declines_of_runner(&h.app.db, r.id, 10).await.unwrap();
2165
    assert_eq!(declined.len(), 1);
2166
    assert_eq!((declined[0].job_id, declined[0].reason.as_str()), (job, "rootfs 36fc4e323804 is not on this runner"));
2167
    assert_eq!(r.tier_list(), vec!["microvm"]);
2168
}