OXYGENHUB
# 7d2eb590051f oxygenhub / crates / hub / tests / flow.rs
95.6 KiB · Rust · last changed The hub garbage-collects every repository nightly 1 month ago source blame history raw
1
//! OxygenFlow on the hub (hub spec §13.2), end to end: a real `oxy` push
2
//! starts a run, a runner claims jobs through the API in dependency order,
3
//! job tokens read only their repository, results become checks and pages.
4
5
use axum::body::Body;
6
use axum::http::{header, Request, StatusCode};
7
use http_body_util::BodyExt;
8
use oxy_core::protocol::{open_remote, RemoteOptions};
9
use oxy_core::repo::Repo;
10
use oxygenhub::config::Config;
11
use oxygenhub::repos::RepoName;
12
use oxygenhub::{db, Shared};
13
use std::path::Path;
14
use tower::ServiceExt;
15
16
const ROOTFS: &str = "36fc4e3238044e424219a2b9002bf61bbe1805fec14d52cf37e17fae77c9ff16";
17
18
fn hermetic() {
19
    static ONCE: std::sync::Once = std::sync::Once::new();
20
    static DIR: std::sync::OnceLock<tempfile::TempDir> = std::sync::OnceLock::new();
21
    ONCE.call_once(|| {
22
        let d = tempfile::tempdir().unwrap();
23
        std::env::set_var("OXY_HOME", d.path());
24
        DIR.set(d).ok();
25
    });
26
}
27
28
fn write(root: &Path, rel: &str, content: &str) {
29
    let p = root.join(rel);
30
    std::fs::create_dir_all(p.parent().unwrap()).unwrap();
31
    std::fs::write(p, content).unwrap();
32
}
33
34
struct Hub {
35
    app: Shared,
36
    base: String,
37
    _dir: tempfile::TempDir,
38
}
39
40
async fn hub() -> Hub {
41
    hermetic();
42
    let dir = tempfile::tempdir().unwrap();
43
    let mut config = Config::load(dir.path()).unwrap();
44
    config.auth.push_tokens = vec!["site".into()];
45
    config.flow.runner_tokens = vec!["runner-secret".into()];
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
482
    // The job token reads its repository and the pinned lib, nothing else.
483
    let token = job["token"].as_str().unwrap().to_string();
484
    let read = |name: &str| {
485
        let opts = RemoteOptions { token: Some(token.clone()), ..Default::default() };
486
        open_remote(&format!("{}/andy/{name}", h.base), &opts).and_then(|r| r.refs()).is_ok()
487
    };
488
    assert!(read("app") && read("lib") && read("base"));
489
    assert!(!read("vault"), "not pinned for this pusher");
490
    assert!(!read("other"), "public, but not the job's to read");
491
}
492
493
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
494
async fn concurrent_log_appends_never_fail_on_a_locked_database() {
495
    let h = hub().await;
496
    create(&h.app, "andy", "demo").await;
497
    let work = tempfile::tempdir().unwrap();
498
    let c = client(&format!("{}/andy/demo", h.base), work.path());
499
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
500
    write(work.path(), "Makefile", "all:\n");
501
    c.snapshot("t").unwrap();
502
    c.commit("pipeline", &[]).unwrap();
503
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
504
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
505
    let job = db::flow::jobs(&h.app.db, run.id).await.unwrap().remove(0);
506
    // Many writers at once, each reading the count and then inserting: a
507
    // deferred transaction would fail with "database is locked".
508
    let mut tasks = Vec::new();
509
    for w in 0..16 {
510
        let pool = h.app.db.clone();
511
        tasks.push(tokio::spawn(async move {
512
            let records: Vec<flow_core::api::Record> =
513
                (0..20).map(|i| flow_core::api::Record { t: i, stream: "out".into(), text: format!("writer {w} line {i}") }).collect();
514
            db::flow::append_log(&pool, job.id, &records, 100_000).await
515
        }));
516
    }
517
    for t in tasks {
518
        assert_eq!(t.await.unwrap().unwrap(), 20, "every append succeeds");
519
    }
520
    let lines = db::flow::log(&h.app.db, job.id, 0, 1_000).await.unwrap();
521
    assert_eq!(lines.len(), 320);
522
    let seqs: std::collections::BTreeSet<i64> = lines.iter().map(|l| l.seq).collect();
523
    assert_eq!(seqs.len(), 320, "sequence numbers are unique");
524
}
525
526
/// A repository's own Flow setting overrides hub.toml either way.
527
#[tokio::test(flavor = "multi_thread")]
528
async fn a_repository_setting_turns_flow_on_or_off() {
529
    let h = hub().await;
530
    create(&h.app, "other", "plain").await;
531
    create(&h.app, "andy", "quiet").await;
532
    // A run elsewhere first, so hub-wide ids and per-repository numbers differ.
533
    create(&h.app, "andy", "first").await;
534
    {
535
        let work = tempfile::tempdir().unwrap();
536
        let c = client(&format!("{}/andy/first", h.base), work.path());
537
        write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
538
        write(work.path(), "test.sh", "echo ok\n");
539
        c.commit("Add a pipeline", &[]).unwrap();
540
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
541
        assert_eq!(runs_of(&h.app, "andy", "first").await.len(), 1);
542
    }
543
    let row = db::repos::get(&h.app.db, "other", "plain").await.unwrap().unwrap();
544
    db::repos::set_flow(&h.app.db, row.id, "on").await.unwrap();
545
    let quiet = db::repos::get(&h.app.db, "andy", "quiet").await.unwrap().unwrap();
546
    db::repos::set_flow(&h.app.db, quiet.id, "off").await.unwrap();
547
    for (owner, name) in [("other", "plain"), ("andy", "quiet")] {
548
        let work = tempfile::tempdir().unwrap();
549
        let c = client(&format!("{}/{owner}/{name}", h.base), work.path());
550
        write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
551
        write(work.path(), "test.sh", "echo ok\n");
552
        c.commit("Add a pipeline", &[]).unwrap();
553
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
554
    }
555
    let plain = runs_of(&h.app, "other", "plain").await;
556
    assert_eq!(plain.len(), 1, "turned on");
557
    // With andy/first's jobs ahead, plain's run says where it stands.
558
    let a = claim(&h.app).await.unwrap();
559
    assert_eq!(a["repo"], "andy/first");
560
    let (_, page) = call(&h.app, "GET", "/other/plain/flow/1", None, None).await;
561
    assert!(page.contains("Waiting for a runner: 3rd in line") && page.contains("Running now: andy/first #1"), "{page}");
562
    let (_, body) = call(&h.app, "GET", "/api/v1/repos/other/plain/flow/runs/1", None, None).await;
563
    assert_eq!(serde_json::from_str::<serde_json::Value>(&body).unwrap()["queue_position"], 3);
564
    let (_, list) = call(&h.app, "GET", "/other/plain/flow", None, None).await;
565
    assert!(list.contains("queued, 3rd in line"), "{list}");
566
    // Runs are numbered per repository: this is plain's first, whatever
567
    // other repositories ran before.
568
    assert_eq!(plain[0].number, 1);
569
    let checks = checks_when(&h.app, row.id, &plain[0].state, 3).await;
570
    assert!(checks.iter().all(|c| c.url.ends_with("/other/plain/flow/1")), "{checks:?}");
571
    let (st, page) = call(&h.app, "GET", "/other/plain/flow/1", None, None).await;
572
    assert!(st == StatusCode::OK && page.contains("Run #1"), "{st}");
573
    assert!(runs_of(&h.app, "andy", "quiet").await.is_empty(), "turned off despite andy/*");
574
}
575
576
/// "Run pipeline" and "Re-run" (hub spec §13.2): runs that move no
577
/// bookmark, through the API and the pages.
578
#[tokio::test(flavor = "multi_thread")]
579
async fn runs_start_without_a_push_and_finished_runs_re_run() {
580
    let h = hub().await;
581
    // The site token acts as the first site administrator.
582
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
583
    create(&h.app, "andy", "demo").await;
584
    let url = format!("{}/andy/demo", h.base);
585
    let work = tempfile::tempdir().unwrap();
586
    let c = client(&url, work.path());
587
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
588
    write(work.path(), "test.sh", "echo ok\n");
589
    c.commit("Add a pipeline", &[]).unwrap();
590
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
591
    let first = runs_of(&h.app, "andy", "demo").await;
592
    assert_eq!((first.len(), first[0].trigger.as_str()), (1, "push"));
593
594
    // Run pipeline on the default bookmark: a new run of the same state.
595
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some("{}".into())).await;
596
    assert_eq!(st, StatusCode::CREATED, "{body}");
597
    let v: serde_json::Value = serde_json::from_str(&body).unwrap();
598
    assert_eq!(v["number"], 2);
599
    assert!(v["url"].as_str().unwrap().ends_with("/andy/demo/flow/2"));
600
    let second = db::flow::run(&h.app.db, first[0].repo_id, 2).await.unwrap().unwrap();
601
    assert_eq!((second.trigger.as_str(), second.actor.as_str(), second.state.as_str()), ("manual", "andy", first[0].state.as_str()));
602
    assert_eq!(db::flow::jobs(&h.app.db, second.id).await.unwrap().len(), 3);
603
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/2", None, None).await;
604
    assert!(page.contains("started by andy"), "the run page says what started it");
605
606
    // Run pipeline on one change: its state, with no bookmark.
607
    let head = first[0].head_list()[0].to_string();
608
    let (st, body) =
609
        call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some(format!(r#"{{"change":"{head}"}}"#))).await;
610
    assert_eq!(st, StatusCode::CREATED, "{body}");
611
    let on_change = db::flow::run(&h.app.db, first[0].repo_id, 3).await.unwrap().unwrap();
612
    assert_eq!(
613
        (on_change.bookmark.as_str(), on_change.heads.as_str(), on_change.state.as_str()),
614
        ("", head.as_str(), first[0].state.as_str())
615
    );
616
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/3", None, None).await;
617
    assert!(page.contains("title=\"Run on one change, not a bookmark\">change</span>"), "run page");
618
    let (st, body) =
619
        call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some(format!(r#"{{"change":"{}"}}"#, "ab".repeat(32))))
620
            .await;
621
    assert!(st == StatusCode::CONFLICT && body.contains("no change"), "{st} {body}");
622
    // Viewers who cannot start runs are told why, and get no button.
623
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow", None, None).await;
624
    assert!(page.contains("Sign in with write access to run the pipeline.") && !page.contains("primary-btn"));
625
    let (_, page) = call(&h.app, "GET", "/andy/demo/bookmarks", None, None).await;
626
    assert!(!page.contains("/flow/start"), "no run buttons for anonymous viewers");
627
628
    // A live run is not re-run; unknown bookmarks and runs are refused.
629
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/1/rerun", Some("site"), None).await;
630
    assert!(st == StatusCode::CONFLICT && body.contains("still queued"), "{st} {body}");
631
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some(r#"{"bookmark":"nope"}"#.into())).await;
632
    assert_eq!(st, StatusCode::CONFLICT);
633
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/99/rerun", Some("site"), None).await;
634
    assert_eq!(st, StatusCode::NOT_FOUND);
635
    // Anonymous callers cannot start runs.
636
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", None, Some("{}".into())).await;
637
    assert_ne!(st, StatusCode::CREATED);
638
639
    // A finished run re-runs as a new run of the same state.
640
    let row = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
641
    for r in [&first[0], &second] {
642
        for j in db::flow::jobs(&h.app.db, r.id).await.unwrap() {
643
            sqlx::query("UPDATE flow_jobs SET status = 'passed' WHERE id = ?").bind(j.id).execute(&h.app.db).await.unwrap();
644
        }
645
        sqlx::query("UPDATE flow_runs SET status = 'passed', finished_ms = 1 WHERE id = ?").bind(r.id).execute(&h.app.db).await.unwrap();
646
    }
647
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/1/rerun", Some("site"), None).await;
648
    assert_eq!(st, StatusCode::CREATED, "{body}");
649
    let third = db::flow::run(&h.app.db, row.id, 4).await.unwrap().unwrap();
650
    assert_eq!(
651
        (third.trigger_label().as_str(), third.status.as_str(), third.state.as_str()),
652
        ("rerun:1", "queued", first[0].state.as_str())
653
    );
654
    assert_eq!(third.trigger, "rerun:1:push", "a rerun keeps the event it repeats");
655
    let checks = db::hooks::checks_for_state(&h.app.db, row.id, &third.state).await.unwrap();
656
    assert!(
657
        checks.iter().all(|c| c.status == "queued" && c.url.ends_with("/flow/4")),
658
        "the re-run's checks replace the old ones: {checks:?}"
659
    );
660
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/4", None, None).await;
661
    assert!(page.contains("re-run of #1 by andy"));
662
    assert!(!page.contains("RE-RUN"), "anonymous viewers get no button");
663
664
    // With Flow off, nothing starts.
665
    db::repos::set_flow(&h.app.db, row.id, "off").await.unwrap();
666
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some("{}".into())).await;
667
    assert!(st == StatusCode::CONFLICT && body.contains("not enabled"), "{body}");
668
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow", None, None).await;
669
    assert!(page.contains("Flow is off for this repository"), "and the Flow tab says so");
670
}
671
672
/// The Flow API (hub spec §13.2): runs, a run with its jobs, a job's log,
673
/// checks by the heads a client has, and JSON for unknown API routes.
674
#[tokio::test(flavor = "multi_thread")]
675
async fn runs_jobs_and_logs_are_in_the_api() {
676
    let h = hub().await;
677
    create(&h.app, "andy", "demo").await;
678
    let url = format!("{}/andy/demo", h.base);
679
    let work = tempfile::tempdir().unwrap();
680
    let c = client(&url, work.path());
681
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
682
    write(work.path(), "test.sh", "echo ok\n");
683
    let head = c.commit("Add a pipeline", &[]).unwrap();
684
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
685
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
686
687
    // A job runs and logs.
688
    let a = claim(&h.app).await.unwrap();
689
    let id = a["job_id"].as_i64().unwrap();
690
    let recs =
691
        serde_json::json!({ "records": [{ "t": 1, "stream": "stdout", "text": "one" }, { "t": 3, "stream": "stderr", "text": "three" }] });
692
    let (st, _) = call(&h.app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(recs.to_string())).await;
693
    assert!(st.is_success(), "{st}");
694
695
    let (st, body) = call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs", None, None).await;
696
    assert_eq!(st, StatusCode::OK, "{body}");
697
    let runs: Vec<hub_api::FlowRun> = serde_json::from_str(&body).unwrap();
698
    assert_eq!(runs.len(), 1);
699
    assert_eq!((runs[0].number, runs[0].state.as_str(), runs[0].trigger.as_str()), (1, run.state.as_str(), "push"));
700
    assert!(runs[0].url.ends_with("/andy/demo/flow/1") && runs[0].jobs.is_empty());
701
702
    let (_, body) = call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs/1", None, None).await;
703
    let one: hub_api::FlowRun = serde_json::from_str(&body).unwrap();
704
    let names: Vec<(&str, &str)> = one.jobs.iter().map(|j| (j.name.as_str(), j.status.as_str())).collect();
705
    assert_eq!(names.len(), 3);
706
    let running = one.jobs.iter().find(|j| j.status == "running").unwrap();
707
    assert_eq!(running.name, a["job"]["name"].as_str().unwrap());
708
    assert!(one.jobs.iter().any(|j| j.name == "test" && j.depends_on == ["build"]));
709
710
    let job = running.name.clone();
711
    let (st, body) = call(&h.app, "GET", &format!("/api/v1/repos/andy/demo/flow/runs/1/jobs/{job}/log"), None, None).await;
712
    assert_eq!(st, StatusCode::OK, "{body}");
713
    let lines: Vec<hub_api::FlowLogLine> = serde_json::from_str(&body).unwrap();
714
    assert!(lines.iter().any(|l| l.text == "three"), "{body}");
715
    let last = lines.last().unwrap().seq;
716
    let (_, body) = call(&h.app, "GET", &format!("/api/v1/repos/andy/demo/flow/runs/1/jobs/{job}/log?after={last}"), None, None).await;
717
    assert_eq!(body, "[]", "nothing after the last line");
718
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs/9", None, None).await.0, StatusCode::NOT_FOUND);
719
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs/1/jobs/nope/log", None, None).await.0, StatusCode::NOT_FOUND);
720
721
    // Checks by the state hash, by the head `oxy log` shows, and by bookmark.
722
    let by = |key: String| {
723
        let app = h.app.clone();
724
        async move {
725
            let (st, body) = call(&app, "GET", &format!("/api/v1/repos/andy/demo/checks/{key}"), None, None).await;
726
            assert_eq!(st, StatusCode::OK, "{key}: {body}");
727
            serde_json::from_str::<Vec<hub_api::Check>>(&body).unwrap().len()
728
        }
729
    };
730
    checks_when(&h.app, run.repo_id, &run.state, 3).await;
731
    assert_eq!(by(run.state.clone()).await, 3);
732
    assert_eq!(by(head.to_hex()).await, 3, "a single head names its state");
733
    assert_eq!(by("main".into()).await, 3);
734
    let (st, _) = call(&h.app, "GET", "/api/v1/repos/andy/demo/checks/no-such-bookmark", None, None).await;
735
    assert_eq!(st, StatusCode::NOT_FOUND);
736
737
    // An unknown API route answers with a problem document.
738
    let (st, body) = call(&h.app, "GET", "/api/v1/users/andy/repos", None, None).await;
739
    assert_eq!(st, StatusCode::NOT_FOUND);
740
    let v: serde_json::Value = serde_json::from_str(&body).unwrap();
741
    assert_eq!(v["status"], 404, "{body}");
742
}
743
744
async fn get_bytes(app: &Shared, path: &str) -> (StatusCode, Vec<u8>) {
745
    let res = oxygenhub::router(app.clone()).oneshot(Request::get(path).body(Body::empty()).unwrap()).await.unwrap();
746
    let status = res.status();
747
    (status, res.into_body().collect().await.unwrap().to_bytes().to_vec())
748
}
749
750
#[tokio::test(flavor = "multi_thread")]
751
async fn signed_receipts_are_checked_kept_and_shown() {
752
    use oxy_core::hash::{hash_object, ChangeHash, ObjectRef, ObjectType};
753
    use oxy_core::identity::SecretKey;
754
    use oxy_core::objects::StateObject;
755
    use oxy_core::receipt::SignedReceipt;
756
    let h = hub().await;
757
    create(&h.app, "andy", "demo").await;
758
    let url = format!("{}/andy/demo", h.base);
759
    let work = tempfile::tempdir().unwrap();
760
    let c = client(&url, work.path());
761
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
762
    c.snapshot("test").unwrap();
763
    c.commit("Add a pipeline", &[]).unwrap();
764
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
765
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
766
    let heads: Vec<ChangeHash> = run.head_list().into_iter().filter_map(ChangeHash::from_hex).collect();
767
    let state = hash_object(ObjectType::State, &StateObject::new(heads.clone()).encode());
768
    let repo_id = h.app.repos.open(&RepoName::parse("andy/demo").unwrap()).unwrap().id().unwrap();
769
    let sk = SecretKey::generate();
770
    let runner = sk.identity("test-1 (OxygenFlow runner)", "", 1);
771
    let sign = |r: &serde_json::Value, state: ObjectRef, sk: &SecretKey, id: &oxy_core::identity::Identity| {
772
        let r: flow_core::Receipt = serde_json::from_value(r.clone()).unwrap();
773
        let run_url = format!("{url}/flow/{}", run.number);
774
        hex::encode(SignedReceipt::sign(r.to_oxy(), repo_id, state, &run_url, id, sk).encode())
775
    };
776
777
    let a = claim(&h.app).await.unwrap();
778
    let b = claim(&h.app).await.unwrap();
779
    let ph = a["pipeline_hash"].as_str().unwrap().to_string();
780
    let (a_id, b_id) = (a["job_id"].as_i64().unwrap(), b["job_id"].as_i64().unwrap());
781
    // The first signed receipt binds the runner token to its key, and is kept.
782
    let rb = receipt("build", &ph, 0);
783
    let body = serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": rb, "signed_receipt": sign(&rb, state, &sk, &runner) });
784
    assert_eq!(finish(&h.app, a_id, body).await, StatusCode::NO_CONTENT);
785
    // Another key under the same token: the result counts, the receipt is not kept.
786
    let other = SecretKey::generate();
787
    let rl = receipt("lint", &ph, 0);
788
    let body = serde_json::json!({ "exit_code": 0, "duration_ms": 300, "receipt": rl,
789
        "signed_receipt": sign(&rl, state, &other, &other.identity("mallory", "", 1)) });
790
    assert_eq!(finish(&h.app, b_id, body).await, StatusCode::NO_CONTENT);
791
    // The right key, but for another state.
792
    let t = claim(&h.app).await.unwrap();
793
    let rt = receipt("test", &ph, 0);
794
    let body = serde_json::json!({ "exit_code": 0, "duration_ms": 500, "receipt": rt,
795
        "signed_receipt": sign(&rt, ObjectRef([9; 32]), &sk, &runner) });
796
    assert_eq!(finish(&h.app, t["job_id"].as_i64().unwrap(), body).await, StatusCode::NO_CONTENT);
797
798
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
799
    let job = |n: &str| jobs.iter().find(|j| j.name == n).unwrap().clone();
800
    assert_eq!(job("build").status, "passed");
801
    assert_eq!((job("build").receipt_attest.len(), job("build").receipt_signer.as_str()), (64, "test-1 (OxygenFlow runner)"));
802
    assert_eq!(job("lint").status, "passed", "the job's result stands");
803
    assert!(job("lint").receipt_attest.is_empty());
804
    assert!(job("lint").receipt_note.contains("not the key this runner signs with"), "{}", job("lint").receipt_note);
805
    assert!(job("test").receipt_note.contains("another state"), "{}", job("test").receipt_note);
806
807
    // The repository keeps it, and anyone who can read the repository can
808
    // download it and check it on their own.
809
    let kept = h.app.repos.open(&RepoName::parse("andy/demo").unwrap()).unwrap().receipts(&heads).unwrap();
810
    assert_eq!(kept.len(), 1);
811
    let attest = job("build").receipt_attest;
812
    let (st, bytes) = get_bytes(&h.app, &format!("/andy/demo/receipts/{attest}")).await;
813
    assert_eq!(st, StatusCode::OK);
814
    let sr = SignedReceipt::decode(&bytes).unwrap();
815
    sr.verify().unwrap();
816
    assert_eq!((sr.state(), sr.receipt.job_name.as_str()), (state, "build"));
817
    assert_eq!(get_bytes(&h.app, &format!("/andy/demo/receipts/{}", "0".repeat(64))).await.0, StatusCode::NOT_FOUND);
818
819
    // Pages: the run names the signer or why a receipt was not kept; the
820
    // change whose state it is lists it.
821
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", run.number), None, None).await;
822
    assert!(page.contains("signed receipt</a> by test-1"), "run page");
823
    assert!(page.contains("receipt not kept"), "run page");
824
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/change/{}", heads[0].to_hex()), None, None).await;
825
    assert!(page.contains("<dt>Receipts</dt>") && page.contains(&format!("/andy/demo/receipts/{attest}")), "change page");
826
}
827
828
async fn upload(app: &Shared, job: i64, name: &str, bytes: &[u8]) -> (StatusCode, String) {
829
    let req = Request::post(format!("/api/v1/flow/jobs/{job}/artifacts/{name}"))
830
        .header(header::AUTHORIZATION, "Bearer runner-secret")
831
        .header(header::CONTENT_TYPE, "application/octet-stream")
832
        .body(Body::from(bytes.to_vec()))
833
        .unwrap();
834
    let res = oxygenhub::router(app.clone()).oneshot(req).await.unwrap();
835
    let status = res.status();
836
    (status, String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned())
837
}
838
839
#[tokio::test(flavor = "multi_thread")]
840
async fn artifacts_are_kept_named_by_the_receipt_and_served() {
841
    let h = hub().await;
842
    create(&h.app, "andy", "demo").await;
843
    let url = format!("{}/andy/demo", h.base);
844
    let work = tempfile::tempdir().unwrap();
845
    let c = client(&url, work.path());
846
    write(
847
        work.path(),
848
        ".flow/pipeline.kdl",
849
        &format!(
850
            "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"
851
        ),
852
    );
853
    c.snapshot("test").unwrap();
854
    c.commit("Build a tool", &[]).unwrap();
855
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
856
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
857
    let a = claim(&h.app).await.unwrap();
858
    assert_eq!(a["job"]["outputs"], serde_json::json!([{ "name": "tool", "path": "/src/out/tool" }]), "the runner is told");
859
    let id = a["job_id"].as_i64().unwrap();
860
861
    let body: Vec<u8> = (0..300_000u32).map(|i| (i % 253) as u8).collect();
862
    let (st, text) = upload(&h.app, id, "other", &body).await;
863
    assert_eq!(st, StatusCode::BAD_REQUEST, "an undeclared artifact: {text}");
864
    let (st, text) = upload(&h.app, id, "tool", &body).await;
865
    assert_eq!(st, StatusCode::OK, "{text}");
866
    let blob = serde_json::from_str::<serde_json::Value>(&text).unwrap()["blob"].as_str().unwrap().to_string();
867
    assert_eq!(blob, oxy_core::repo::Repo::blob_ref(&body).to_hex(), "the same blob the runner computes");
868
869
    // The receipt must name exactly the uploaded artifacts.
870
    let mut r = receipt("build", a["pipeline_hash"].as_str().unwrap(), 0);
871
    assert_eq!(
872
        finish(&h.app, id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": r.clone() })).await,
873
        StatusCode::BAD_REQUEST
874
    );
875
    r["outputs"] = serde_json::json!([blob]);
876
    assert_eq!(finish(&h.app, id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": r })).await, StatusCode::NO_CONTENT);
877
878
    // The run page lists it; anyone who can read the repository downloads it.
879
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", run.number), None, None).await;
880
    let link = format!("/andy/demo/flow/{}/artifacts/build/tool", run.number);
881
    assert!(page.contains(&link), "run page lists the artifact");
882
    let (st, got) = get_bytes(&h.app, &link).await;
883
    assert_eq!((st, got == body), (StatusCode::OK, true));
884
    assert_eq!(get_bytes(&h.app, &format!("/andy/demo/flow/{}/artifacts/build/none", run.number)).await.0, StatusCode::NOT_FOUND);
885
886
    // A writer attaches the artifact to a release from the run page; the
887
    // release then names the run and job that built it, as does the API.
888
    let form = |f: String| {
889
        Request::post("/register").header(header::CONTENT_TYPE, "application/x-www-form-urlencoded").body(Body::from(f)).unwrap()
890
    };
891
    let res = oxygenhub::router(h.app.clone())
892
        .oneshot(form("username=andy&email=a%40example.com&password=correct-horse-battery".into()))
893
        .await
894
        .unwrap();
895
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
896
    let with_cookie = |method: &str, path: &str, body: Option<String>| {
897
        let mut req = Request::builder().method(method).uri(path).header(header::COOKIE, cookie.clone());
898
        if body.is_some() {
899
            req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
900
        }
901
        req.body(body.map(Body::from).unwrap_or_else(Body::empty)).unwrap()
902
    };
903
    let row = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
904
    db::releases::create(&h.app.db, row.id, "v1", "One", "", false, None).await.unwrap();
905
    let res = oxygenhub::router(h.app.clone()).oneshot(with_cookie("GET", &format!("/andy/demo/flow/{}", run.number), None)).await.unwrap();
906
    let page = String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned();
907
    let attach = format!("/andy/demo/flow/{}/artifacts/build/tool/attach", run.number);
908
    assert!(page.contains(&attach), "a writer is offered the release");
909
    let i = page.find("name=\"_csrf\" value=\"").unwrap() + "name=\"_csrf\" value=\"".len();
910
    let csrf = page[i..].split('"').next().unwrap().to_string();
911
    let release_id = db::releases::list(&h.app.db, row.id).await.unwrap()[0].id;
912
    let res = oxygenhub::router(h.app.clone())
913
        .oneshot(with_cookie("POST", &attach, Some(format!("_csrf={csrf}&release={release_id}"))))
914
        .await
915
        .unwrap();
916
    assert_eq!(res.status(), StatusCode::SEE_OTHER);
917
    let (_, page) = call(&h.app, "GET", "/andy/demo/releases/tag/v1", None, None).await;
918
    assert!(
919
        page.contains(">tool</a>") && page.contains(&format!("built by <a href=\"/andy/demo/flow/{0}\">run #{0}</a> build", run.number)),
920
        "{page}"
921
    );
922
    let (_, api) = call(&h.app, "GET", "/api/v1/repos/andy/demo/releases", None, None).await;
923
    let api: serde_json::Value = serde_json::from_str(&api).unwrap();
924
    let asset = &api[0]["assets"][0];
925
    assert_eq!(
926
        (asset["name"].as_str(), asset["built_by"]["run"].as_i64(), asset["built_by"]["job"].as_str()),
927
        (Some("tool"), Some(run.number), Some("build"))
928
    );
929
    assert!(asset["built_by"]["receipt"].is_null(), "that receipt was not signed");
930
}
931
932
/// A release's trust report (hub spec §9.1): a signed tag, an asset built
933
/// by a job with a signed receipt from the tagged state, and one uploaded
934
/// by hand; the page, its JSON export and the API.
935
#[tokio::test(flavor = "multi_thread")]
936
async fn a_release_is_audited_from_authors_to_receipts() {
937
    use oxy_core::hash::{hash_object, ChangeHash, ObjectType};
938
    use oxy_core::identity::SecretKey;
939
    use oxy_core::objects::StateObject;
940
    use oxy_core::receipt::SignedReceipt;
941
    let h = hub().await;
942
    create(&h.app, "andy", "demo").await;
943
    let url = format!("{}/andy/demo", h.base);
944
    let work = tempfile::tempdir().unwrap();
945
    let mut c = client(&url, work.path());
946
    c.create_identity("Andy", "[email protected]", oxy_core::repo::IdentityScope::Repo).unwrap();
947
    write(
948
        work.path(),
949
        ".flow/pipeline.kdl",
950
        &format!(
951
            "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"
952
        ),
953
    );
954
    c.snapshot("test").unwrap();
955
    c.commit("Build a tool", &[]).unwrap();
956
    let heads = c.bookmark_heads().unwrap();
957
    c.tag_create("v1", &heads, "first").unwrap();
958
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
959
960
    // The runner builds, uploads the artifact and signs its receipt.
961
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
962
    let a = claim(&h.app).await.unwrap();
963
    let id = a["job_id"].as_i64().unwrap();
964
    let body: Vec<u8> = b"#!/bin/sh\necho tool\n".to_vec();
965
    let (_, text) = upload(&h.app, id, "tool", &body).await;
966
    let blob = serde_json::from_str::<serde_json::Value>(&text).unwrap()["blob"].as_str().unwrap().to_string();
967
    let mut r = receipt("build", a["pipeline_hash"].as_str().unwrap(), 0);
968
    r["outputs"] = serde_json::json!([blob]);
969
    let heads_run: Vec<ChangeHash> = run.head_list().into_iter().filter_map(ChangeHash::from_hex).collect();
970
    let state = hash_object(ObjectType::State, &StateObject::new(heads_run).encode());
971
    let repo_id = h.app.repos.open(&RepoName::parse("andy/demo").unwrap()).unwrap().id().unwrap();
972
    let sk = SecretKey::generate();
973
    let runner = sk.identity("test-1 (OxygenFlow runner)", "", 1);
974
    let fr: flow_core::Receipt = serde_json::from_value(r.clone()).unwrap();
975
    let signed = hex::encode(SignedReceipt::sign(fr.to_oxy(), repo_id, state, &format!("{url}/flow/1"), &runner, &sk).encode());
976
    let done = serde_json::json!({ "exit_code": 0, "duration_ms": 900, "receipt": r, "signed_receipt": signed });
977
    assert_eq!(finish(&h.app, id, done).await, StatusCode::NO_CONTENT);
978
979
    // A release with the built asset and a file uploaded by hand.
980
    let row = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
981
    let rel = db::releases::create(&h.app.db, row.id, "v1", "One", "", false, None).await.unwrap();
982
    oxygenhub::web::releases::store_asset(&h.app, rel.id, "tool", "", &body).await.unwrap();
983
    oxygenhub::web::releases::store_asset(&h.app, rel.id, "notes.txt", "", b"by hand\n").await.unwrap();
984
985
    let (st, page) = call(&h.app, "GET", "/andy/demo/releases/trust/v1", None, None).await;
986
    assert_eq!(st, StatusCode::OK);
987
    for want in [
988
        "Tag v1 is signed",
989
        "The one change in the release is authenticated",
990
        "tool: signed receipt from run #1 build",
991
        "a runner key of this hub",
992
        "tool: built from the tagged state",
993
        "tool: pinned environment",
994
        "notes.txt: no build found",
995
        "<svg class=\"trust-graph\"",
996
        // oxygenhub#79: a summary of badges, badges in the graph, and the
997
        // graph drawn at its own size rather than stretched to the page.
998
        "Tag signed by",
999
        "1 of 1 changes signed or sealed",
1000
        "1 of 2 assets built and attested by OxygenFlow",
1001
        "attested build",
1002
        "uploaded by hand",
1003
        "receipt verified",
1004
        "class=\"shackle\"",
1005
        "<title>notes.txt:",
1006
    ] {
1007
        assert!(page.contains(want), "missing {want:?}");
1008
    }
1009
    let svg = &page[page.find("<svg class=\"trust-graph\"").unwrap()..];
1010
    assert!(svg[..200].contains(" width=\"") && svg[..200].contains(" height=\""), "the graph has its own size: {}", &svg[..200]);
1011
    let (_, releases) = call(&h.app, "GET", "/andy/demo/releases", None, None).await;
1012
    assert!(releases.contains("/andy/demo/releases/trust/v1"), "the release links its audit");
1013
1014
    // The export carries the signed receipt, which checks on its own.
1015
    let (st, json) = call(&h.app, "GET", "/andy/demo/releases/trust/v1?format=json", None, None).await;
1016
    assert_eq!(st, StatusCode::OK);
1017
    let t: serde_json::Value = serde_json::from_str(&json).unwrap();
1018
    assert_eq!((t["tag"].as_str(), t["tag_signature"].as_str(), t["changes"].as_i64()), (Some("v1"), Some("valid"), Some(1)));
1019
    assert_eq!(t["authors"][0]["who"]["name"], "Andy");
1020
    let tool = t["assets"].as_array().unwrap().iter().find(|a| a["name"] == "tool").unwrap();
1021
    let hex_receipt = tool["build"]["signed_receipt"].as_str().unwrap();
1022
    let sr = SignedReceipt::decode(&hex::decode(hex_receipt).unwrap()).unwrap();
1023
    sr.verify().unwrap();
1024
    assert_eq!(sr.receipt.outputs[0].to_hex(), blob);
1025
    let audit = t["audit"].as_array().unwrap();
1026
    assert!(audit.iter().any(|c| c["verdict"] == "warn" && c["title"].as_str().unwrap().starts_with("notes.txt")));
1027
    assert!(!audit.iter().any(|c| c["verdict"] == "fail"), "{audit:?}");
1028
    // The API gives the same report; an unknown release is a 404.
1029
    let (st, api) = call(&h.app, "GET", "/api/v1/repos/andy/demo/releases/trust/v1", None, None).await;
1030
    assert_eq!(st, StatusCode::OK);
1031
    assert_eq!(serde_json::from_str::<serde_json::Value>(&api).unwrap()["assets"].as_array().unwrap().len(), 2);
1032
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/demo/releases/trust/v9", None, None).await.0, StatusCode::NOT_FOUND);
1033
    assert_eq!(call(&h.app, "GET", "/andy/demo/releases/trust/v9", None, None).await.0, StatusCode::NOT_FOUND);
1034
}
1035
1036
/// Runners (hub spec §13.2): an administrator makes a registration token,
1037
/// a runner registers with it (binding its key), claims, shows on Admin →
1038
/// Runners with its history, and is drained, disabled and removed.
1039
#[tokio::test(flavor = "multi_thread")]
1040
async fn runners_register_show_their_history_and_are_drained_and_removed() {
1041
    use oxy_core::identity::SecretKey;
1042
    let h = hub().await;
1043
    create(&h.app, "andy", "demo").await;
1044
    // A signed-in site administrator.
1045
    let res = oxygenhub::router(h.app.clone())
1046
        .oneshot(
1047
            Request::post("/register")
1048
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1049
                .body(Body::from("username=carol&email=carol%40example.com&password=correct-horse-battery"))
1050
                .unwrap(),
1051
        )
1052
        .await
1053
        .unwrap();
1054
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1055
    let admin = db::accounts::account_by_name(&h.app.db, "carol").await.unwrap().unwrap();
1056
    db::accounts::set_admin(&h.app.db, admin.id, true).await.unwrap();
1057
    let web = |method: &'static str, path: String, body: Option<String>| {
1058
        let (app, cookie) = (h.app.clone(), cookie.clone());
1059
        async move {
1060
            let mut req = Request::builder().method(method).uri(path).header(header::COOKIE, cookie);
1061
            if body.is_some() {
1062
                req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1063
            }
1064
            let res = oxygenhub::router(app).oneshot(req.body(body.map(Body::from).unwrap_or_else(Body::empty)).unwrap()).await.unwrap();
1065
            let st = res.status();
1066
            (st, String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned())
1067
        }
1068
    };
1069
    let csrf_of = |page: &str| {
1070
        let i = page.find("name=\"_csrf\" value=\"").unwrap() + "name=\"_csrf\" value=\"".len();
1071
        page[i..].split('"').next().unwrap().to_string()
1072
    };
1073
    let (st, page) = web("GET", "/admin/runners".into(), None).await;
1074
    assert_eq!(st, StatusCode::OK);
1075
    assert!(page.contains("No runners yet"));
1076
    assert_eq!(call(&h.app, "GET", "/admin/runners", None, None).await.0, StatusCode::NOT_FOUND, "administrators only");
1077
1078
    // A one-time registration token, shown once with the command.
1079
    let (_, page) = web("POST", "/admin/runners/token".into(), Some(format!("_csrf={}", csrf_of(&page)))).await;
1080
    let i = page.find("--token ").unwrap() + "--token ".len();
1081
    let token: String = page[i..].chars().take_while(|c| !c.is_whitespace()).collect();
1082
    assert!(token.starts_with("flowreg_"), "{token}");
1083
1084
    // The runner registers, binding its key; the token then is spent.
1085
    let sk = SecretKey::generate();
1086
    let identity = sk.identity("plex (OxygenFlow runner)", "", 1);
1087
    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 });
1088
    let reg = serde_json::json!({ "token": token, "name": "plex", "identity": hex::encode(identity.encode()), "info": info });
1089
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1090
    assert_eq!(st, StatusCode::OK, "{body}");
1091
    let credential = serde_json::from_str::<serde_json::Value>(&body).unwrap()["credential"].as_str().unwrap().to_string();
1092
    assert!(credential.starts_with("flowrunner_"));
1093
    assert_eq!(
1094
        call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await.0,
1095
        StatusCode::FORBIDDEN,
1096
        "used once"
1097
    );
1098
1099
    // It claims with its credential; the hub.toml runner shows too.
1100
    let claim_as = |who: String| {
1101
        let app = h.app.clone();
1102
        let info = info.clone();
1103
        async move {
1104
            let body = serde_json::json!({ "runner": "ignored", "runtimes": ["microvm"], "info": info }).to_string();
1105
            call(&app, "POST", "/api/v1/flow/claim", Some(&who), Some(body)).await
1106
        }
1107
    };
1108
    assert_eq!(claim_as(credential.clone()).await.0, StatusCode::NO_CONTENT, "nothing queued");
1109
    assert_eq!(claim(&h.app).await, None);
1110
    let (_, page) = web("GET", "/admin/runners".into(), None).await;
1111
    assert!(
1112
        page.contains(">plex</strong>") && page.contains("st-online") && page.contains("x86_64 · linux") && page.contains("big-disk"),
1113
        "{page}"
1114
    );
1115
    assert!(page.contains(">test-1</strong>") && page.contains("hub.toml"), "the configured runner, by its claimed name");
1116
    let plex = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "plex").unwrap();
1117
    assert_eq!(plex.key, identity.hash().to_hex(), "bound at registration");
1118
1119
    // A run: plex takes a job, and its history shows it.
1120
    let url = format!("{}/andy/demo", h.base);
1121
    let work = tempfile::tempdir().unwrap();
1122
    let c = client(&url, work.path());
1123
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1124
    c.snapshot("test").unwrap();
1125
    c.commit("Add a pipeline", &[]).unwrap();
1126
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1127
    runs_of(&h.app, "andy", "demo").await;
1128
    let (st, body) = claim_as(credential.clone()).await;
1129
    assert_eq!(st, StatusCode::OK, "{body}");
1130
    let job: serde_json::Value = serde_json::from_str(&body).unwrap();
1131
    let (_, page) = web("GET", format!("/admin/runners/{}", plex.id), None).await;
1132
    assert!(
1133
        page.contains("andy/demo") && page.contains(job["job"]["name"].as_str().unwrap()) && page.contains("Running now</dt><dd>1 job"),
1134
        "{page}"
1135
    );
1136
    // The queue on Admin → Runners and through the API (#41, part 4).
1137
    let (_, page) = web("GET", "/admin/runners".into(), None).await;
1138
    assert!(page.contains("<h2>Queue</h2>") && page.contains("<td>plex</td>"), "{page}");
1139
    let (_, tokens) = web("GET", "/settings/tokens".into(), None).await;
1140
    let (_, made) = web("POST", "/settings/tokens".into(), Some(format!("_csrf={}&name=admin&scopes=user%3Aread", csrf_of(&tokens)))).await;
1141
    let i = made.find("oxyhub_").unwrap();
1142
    let admin_token: String = made[i..].chars().take_while(|c| c.is_ascii_alphanumeric() || *c == '_').collect();
1143
    let (st, body) = call(&h.app, "GET", "/api/v1/runners", Some(&admin_token), None).await;
1144
    assert_eq!(st, StatusCode::OK, "{body}");
1145
    let listed: serde_json::Value = serde_json::from_str(&body).unwrap();
1146
    let plex_row = listed.as_array().unwrap().iter().find(|r| r["name"] == "plex").unwrap();
1147
    assert_eq!((plex_row["running"].as_i64(), plex_row["arch"].as_str()), (Some(1), Some("x86_64")));
1148
    let (_, body) = call(&h.app, "GET", "/api/v1/runners/queue", Some(&admin_token), None).await;
1149
    let queue: serde_json::Value = serde_json::from_str(&body).unwrap();
1150
    assert!(queue.as_array().unwrap().iter().any(|q| q["status"] == "running" && q["runner"] == "plex"), "{queue}");
1151
    let (_, body) = call(&h.app, "GET", &format!("/api/v1/runners/{}/jobs", plex.id), Some(&admin_token), None).await;
1152
    let jobs: serde_json::Value = serde_json::from_str(&body).unwrap();
1153
    assert_eq!(jobs[0]["repo"], "andy/demo", "{jobs}");
1154
    assert_eq!(call(&h.app, "GET", "/api/v1/runners", None, None).await.0, StatusCode::NOT_FOUND, "administrators only");
1155
1156
    // Draining: no new work; removing while busy is refused.
1157
    let (_, page) = web("GET", "/admin/runners".into(), None).await;
1158
    let csrf = csrf_of(&page);
1159
    web("POST", format!("/admin/runners/{}/state", plex.id), Some(format!("_csrf={csrf}&state=draining"))).await;
1160
    assert_eq!(claim_as(credential.clone()).await.0, StatusCode::NO_CONTENT, "a draining runner takes nothing");
1161
    let (_, page) = web("POST", format!("/admin/runners/{}/remove", plex.id), Some(format!("_csrf={csrf}"))).await;
1162
    assert!(page.contains("is running jobs: drain it first"), "{page}");
1163
    // Its job finishes; disabled, it is refused; removed, its credential is dead.
1164
    let id = job["job_id"].as_i64().unwrap();
1165
    let done = call(
1166
        &h.app,
1167
        "POST",
1168
        &format!("/api/v1/flow/jobs/{id}/finish"),
1169
        Some(&credential),
1170
        Some(r#"{"exit_code":0,"duration_ms":5}"#.into()),
1171
    )
1172
    .await;
1173
    assert_eq!(done.0, StatusCode::NO_CONTENT);
1174
    web("POST", format!("/admin/runners/{}/state", plex.id), Some(format!("_csrf={csrf}&state=disabled"))).await;
1175
    assert_eq!(claim_as(credential.clone()).await.0, StatusCode::FORBIDDEN);
1176
    let (_, page) = web("POST", format!("/admin/runners/{}/remove", plex.id), Some(format!("_csrf={csrf}"))).await;
1177
    assert!(page.contains("Removed plex."), "{page}");
1178
    assert_eq!(claim_as(credential).await.0, StatusCode::UNAUTHORIZED);
1179
}
1180
1181
/// Runner scopes (oxygenhub#41): a runner registered for one repository, or
1182
/// one owner, takes only those jobs; a site runner takes any.
1183
#[tokio::test(flavor = "multi_thread")]
1184
async fn scoped_runners_take_only_their_scope() {
1185
    use oxy_core::identity::SecretKey;
1186
    let h = hub().await;
1187
    create(&h.app, "andy", "demo").await;
1188
    create(&h.app, "andy", "other").await;
1189
    let register = |scope: db::runners::Scope, name: &'static str| {
1190
        let app = h.app.clone();
1191
        async move {
1192
            let token = format!("flowreg_{name}");
1193
            db::runners::add_registration(&app.db, &blake3::hash(token.as_bytes()).to_hex(), "admin", &scope).await.unwrap();
1194
            let identity = SecretKey::generate().identity(name, "", 1);
1195
            let info = serde_json::json!({ "arch": "x86_64", "os": "linux", "version": "0.1.0", "labels": [], "max_jobs": 1 });
1196
            let reg = serde_json::json!({ "token": token, "name": name, "identity": hex::encode(identity.encode()), "info": info });
1197
            let (st, body) = call(&app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1198
            assert_eq!(st, StatusCode::OK, "{body}");
1199
            serde_json::from_str::<serde_json::Value>(&body).unwrap()["credential"].as_str().unwrap().to_string()
1200
        }
1201
    };
1202
    let demo = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
1203
    let only_demo = register(db::runners::Scope { owner: "andy".into(), repo_id: Some(demo.id) }, "demo-runner").await;
1204
    let carols = register(db::runners::Scope { owner: "carol".into(), repo_id: None }, "carol-runner").await;
1205
    let andys = register(db::runners::Scope { owner: "andy".into(), repo_id: None }, "andy-runner").await;
1206
    let claim_as = |who: String| {
1207
        let app = h.app.clone();
1208
        async move {
1209
            let body = serde_json::json!({ "runner": "x", "runtimes": ["microvm"] }).to_string();
1210
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some(&who), Some(body)).await;
1211
            (st == StatusCode::OK).then(|| serde_json::from_str::<serde_json::Value>(&body).unwrap()["repo"].as_str().unwrap().to_string())
1212
        }
1213
    };
1214
    // Jobs queued in andy/other only.
1215
    let work = tempfile::tempdir().unwrap();
1216
    let c = client(&format!("{}/andy/other", h.base), work.path());
1217
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1218
    c.snapshot("t").unwrap();
1219
    c.commit("pipeline", &[]).unwrap();
1220
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1221
    assert!(!runs_of(&h.app, "andy", "other").await.is_empty());
1222
    assert_eq!(claim_as(only_demo.clone()).await, None, "nothing of andy/demo is queued");
1223
    assert_eq!(claim_as(carols).await, None, "nothing of carol's");
1224
    assert_eq!(claim_as(andys).await.as_deref(), Some("andy/other"), "the owner's runner takes its repositories' jobs");
1225
    // The site runner (hub.toml) takes any.
1226
    assert_eq!(claim(&h.app).await.unwrap()["repo"], "andy/other");
1227
    assert_eq!(claim_as(only_demo).await, None, "still nothing of its own");
1228
}
1229
1230
/// Settings → Runners (oxygenhub#41, part 2b): a repository's admin adds a
1231
/// runner for that repository alone, sees which runners serve it, and
1232
/// removes only its own.
1233
#[tokio::test(flavor = "multi_thread")]
1234
async fn repository_admins_add_and_remove_their_own_runners() {
1235
    use oxy_core::identity::SecretKey;
1236
    let h = hub().await;
1237
    let res = oxygenhub::router(h.app.clone())
1238
        .oneshot(
1239
            Request::post("/register")
1240
                .header(header::CONTENT_TYPE, "application/x-www-form-urlencoded")
1241
                .body(Body::from("username=andy&email=andy%40example.com&password=correct-horse-battery"))
1242
                .unwrap(),
1243
        )
1244
        .await
1245
        .unwrap();
1246
    let cookie = res.headers().get(header::SET_COOKIE).unwrap().to_str().unwrap().split(';').next().unwrap().to_string();
1247
    create(&h.app, "andy", "demo").await;
1248
    let demo = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
1249
    let web = |method: &'static str, path: String, body: Option<String>| {
1250
        let (app, cookie) = (h.app.clone(), cookie.clone());
1251
        async move {
1252
            let mut req = Request::builder().method(method).uri(path).header(header::COOKIE, cookie);
1253
            if body.is_some() {
1254
                req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
1255
            }
1256
            let res = oxygenhub::router(app).oneshot(req.body(body.map(Body::from).unwrap_or_else(Body::empty)).unwrap()).await.unwrap();
1257
            let st = res.status();
1258
            (st, String::from_utf8_lossy(&res.into_body().collect().await.unwrap().to_bytes()).into_owned())
1259
        }
1260
    };
1261
    let csrf_of = |page: &str| {
1262
        let i = page.find("name=\"_csrf\" value=\"").unwrap() + "name=\"_csrf\" value=\"".len();
1263
        page[i..].split('"').next().unwrap().to_string()
1264
    };
1265
    let (st, page) = web("GET", "/andy/demo/settings".into(), None).await;
1266
    assert_eq!(st, StatusCode::OK);
1267
    assert!(page.contains("<h2>Runners</h2>"), "the owner sees the section");
1268
    let (_, page) = web("POST", "/andy/demo/settings/runners/token".into(), Some(format!("_csrf={}", csrf_of(&page)))).await;
1269
    let i = page.find("--token ").unwrap() + "--token ".len();
1270
    let token: String = page[i..].chars().take_while(|c| !c.is_whitespace()).collect();
1271
    let identity = SecretKey::generate().identity("mine", "", 1);
1272
    let info = serde_json::json!({ "arch": "x86_64", "os": "linux", "version": "0.1.0", "labels": [], "max_jobs": 1 });
1273
    let reg = serde_json::json!({ "token": token, "name": "mine", "identity": hex::encode(identity.encode()), "info": info });
1274
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1275
    assert_eq!(st, StatusCode::OK, "{body}");
1276
    let mine = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "mine").unwrap();
1277
    assert_eq!(mine.scope(), db::runners::Scope { owner: "andy".into(), repo_id: Some(demo.id) });
1278
    // The site's runner (hub.toml, from its first claim) serves it too, but is not the owner's to remove.
1279
    claim(&h.app).await;
1280
    let site = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "test-1").unwrap();
1281
    let (_, page) = web("GET", "/andy/demo/settings".into(), None).await;
1282
    assert!(page.contains("<strong>mine</strong>") && page.contains("this repository"), "{page}");
1283
    assert!(page.contains("<strong>test-1</strong>") && page.contains("the whole site"), "{page}");
1284
    let csrf = csrf_of(&page);
1285
    let (st, _) = web("POST", format!("/andy/demo/settings/runners/{}/remove", site.id), Some(format!("_csrf={csrf}"))).await;
1286
    assert_eq!(st, StatusCode::NOT_FOUND, "not the repository's own");
1287
    let (_, page) = web("POST", format!("/andy/demo/settings/runners/{}/remove", mine.id), Some(format!("_csrf={csrf}"))).await;
1288
    assert!(page.contains("mine removed"), "{page}");
1289
    assert!(db::runners::get(&h.app.db, mine.id).await.unwrap().is_none());
1290
1291
    // The same for an organisation's owner.
1292
    let (_, page) = web("GET", "/orgs/new".into(), None).await;
1293
    web("POST", "/orgs/new".into(), Some(format!("_csrf={}&name=acme&display_name=Acme", csrf_of(&page)))).await;
1294
    let (st, page) = web("GET", "/orgs/acme/settings".into(), None).await;
1295
    assert_eq!(st, StatusCode::OK);
1296
    let (_, page) = web("POST", "/orgs/acme/settings/runners/token".into(), Some(format!("_csrf={}", csrf_of(&page)))).await;
1297
    let i = page.find("--token ").unwrap() + "--token ".len();
1298
    let token: String = page[i..].chars().take_while(|c| !c.is_whitespace()).collect();
1299
    let identity = SecretKey::generate().identity("acme-runner", "", 1);
1300
    let reg = serde_json::json!({ "token": token, "name": "acme-runner", "identity": hex::encode(identity.encode()), "info": info });
1301
    assert_eq!(call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await.0, StatusCode::OK);
1302
    let acme = db::runners::list(&h.app.db).await.unwrap().into_iter().find(|r| r.name == "acme-runner").unwrap();
1303
    assert_eq!(acme.scope(), db::runners::Scope { owner: "acme".into(), repo_id: None });
1304
    let (_, page) = web("GET", "/orgs/acme/settings".into(), None).await;
1305
    assert!(page.contains("<strong>acme-runner</strong>") && page.contains("the organisation's repositories"), "{page}");
1306
    let (_, page) = web("POST", format!("/orgs/acme/settings/runners/{}/remove", acme.id), Some(format!("_csrf={}", csrf_of(&page)))).await;
1307
    assert!(page.contains("acme-runner removed"), "{page}");
1308
}
1309
1310
/// runs-on (oxygenhub#41, part 3): a job that asks for a label goes only to
1311
/// a runner that has it, and waits for one otherwise.
1312
#[tokio::test(flavor = "multi_thread")]
1313
async fn jobs_that_ask_for_labels_wait_for_a_runner_with_them() {
1314
    use oxy_core::identity::SecretKey;
1315
    let h = hub().await;
1316
    create(&h.app, "andy", "demo").await;
1317
    let work = tempfile::tempdir().unwrap();
1318
    let c = client(&format!("{}/andy/demo", h.base), work.path());
1319
    let cross = "job \"cross\" {\n    sandbox \"alpine\"\n    runs-on \"riscv64\"\n    exec \"true\"\n}\n";
1320
    write(work.path(), ".flow/pipeline.kdl", &pipeline(cross));
1321
    c.snapshot("t").unwrap();
1322
    c.commit("pipeline", &[]).unwrap();
1323
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1324
    assert!(!runs_of(&h.app, "andy", "demo").await.is_empty());
1325
    // The site runner has no labels: it takes the others, never cross.
1326
    let mut taken = Vec::new();
1327
    while let Some(j) = claim(&h.app).await {
1328
        taken.push(j["job"]["name"].as_str().unwrap().to_string());
1329
    }
1330
    assert!(!taken.contains(&"cross".to_string()) && taken.contains(&"lint".to_string()), "{taken:?}");
1331
    let queue = db::flow::queue(&h.app.db).await.unwrap();
1332
    let waiting = queue.iter().find(|q| q.job == "cross").unwrap();
1333
    assert_eq!((waiting.status.as_str(), waiting.needs()), ("queued", vec!["riscv64".to_string()]));
1334
    // A runner registered with the label takes it.
1335
    let token = "flowreg_riscv";
1336
    db::runners::add_registration(&h.app.db, &blake3::hash(token.as_bytes()).to_hex(), "admin", &Default::default()).await.unwrap();
1337
    let identity = SecretKey::generate().identity("visionfive", "", 1);
1338
    let info = serde_json::json!({ "arch": "riscv64", "os": "linux", "version": "0.1.0", "labels": ["riscv64"], "max_jobs": 1 });
1339
    let reg = serde_json::json!({ "token": token, "name": "visionfive", "identity": hex::encode(identity.encode()), "info": info });
1340
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/runners/register", None, Some(reg.to_string())).await;
1341
    assert_eq!(st, StatusCode::OK, "{body}");
1342
    let credential = serde_json::from_str::<serde_json::Value>(&body).unwrap()["credential"].as_str().unwrap().to_string();
1343
    let claim_body = serde_json::json!({ "runner": "x", "runtimes": ["microvm"], "info": info }).to_string();
1344
    let (st, body) = call(&h.app, "POST", "/api/v1/flow/claim", Some(&credential), Some(claim_body)).await;
1345
    assert_eq!(st, StatusCode::OK, "{body}");
1346
    assert_eq!(serde_json::from_str::<serde_json::Value>(&body).unwrap()["job"]["name"], "cross");
1347
}
1348
1349
/// oxygenhub#71: a job its runner stopped reporting (restarted, or lost
1350
/// the hub as the job ended) is ended once it has run past the time limit
1351
/// and a grace: an error with the reason, its dependents skipped and its
1352
/// run settled, as if the runner had reported the error.
1353
#[tokio::test(flavor = "multi_thread")]
1354
async fn a_job_no_runner_reports_is_ended_after_the_time_limit() {
1355
    let h = hub().await;
1356
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1357
    create(&h.app, "andy", "lost").await;
1358
    let url = format!("{}/andy/lost", h.base);
1359
    let work = tempfile::tempdir().unwrap();
1360
    let c = client(&url, work.path());
1361
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1362
    write(work.path(), "test.sh", "echo ok\n");
1363
    c.commit("Add a pipeline", &[]).unwrap();
1364
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1365
    assert_eq!(runs_of(&h.app, "andy", "lost").await.len(), 1);
1366
    let job = claim(&h.app).await.expect("a job to claim");
1367
    let id = job["job_id"].as_i64().unwrap();
1368
1369
    // Running, but well within the limit: left alone.
1370
    assert_eq!(oxygenhub::flow::reap_lost_jobs(&h.app).await.unwrap(), 0);
1371
    // Started long ago and never reported: ended.
1372
    let old = db::now_ms() - 24 * 3600 * 1000;
1373
    sqlx::query("UPDATE flow_jobs SET started_ms = ? WHERE id = ?").bind(old).bind(id).execute(&h.app.db).await.unwrap();
1374
    assert_eq!(oxygenhub::flow::reap_lost_jobs(&h.app).await.unwrap(), 1);
1375
    let j = db::flow::job(&h.app.db, id).await.unwrap().unwrap();
1376
    assert_eq!(j.status, "error");
1377
    assert!(j.error.starts_with("lost:"), "{}", j.error);
1378
    let run = &runs_of(&h.app, "andy", "lost").await[0];
1379
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
1380
    assert!(jobs.iter().all(|j| j.status != "running"), "nothing left running");
1381
    // A late report, should one come, does not overwrite the ending.
1382
    assert_ne!(finish(&h.app, id, serde_json::json!({ "exit_code": 0 })).await, StatusCode::NO_CONTENT);
1383
    assert_eq!(db::flow::job(&h.app.db, id).await.unwrap().unwrap().status, "error");
1384
}
1385
1386
/// oxygenhub#73: a runner that lists the images it holds is offered only
1387
/// the jobs whose rootfs is among them; one that does not say gets any.
1388
#[tokio::test(flavor = "multi_thread")]
1389
async fn a_runner_is_offered_only_jobs_whose_image_it_holds() {
1390
    let h = hub().await;
1391
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1392
    create(&h.app, "andy", "images").await;
1393
    let url = format!("{}/andy/images", h.base);
1394
    let work = tempfile::tempdir().unwrap();
1395
    let c = client(&url, work.path());
1396
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1397
    write(work.path(), "test.sh", "echo ok\n");
1398
    c.commit("Add a pipeline", &[]).unwrap();
1399
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1400
    assert_eq!(runs_of(&h.app, "andy", "images").await.len(), 1);
1401
    let claim_with = |images: Vec<String>| {
1402
        let body = serde_json::json!({ "runner": "test-1", "runtimes": ["microvm"], "images": images }).to_string();
1403
        let app = h.app.clone();
1404
        async move {
1405
            let (st, body) = call(&app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(body)).await;
1406
            (st, body)
1407
        }
1408
    };
1409
    let (st, _) = claim_with(vec!["ab".repeat(32)]).await;
1410
    assert_eq!(st, StatusCode::NO_CONTENT, "no job for a runner without the image");
1411
    let jobs = db::flow::jobs(&h.app.db, runs_of(&h.app, "andy", "images").await[0].id).await.unwrap();
1412
    let rootfs: serde_json::Value = serde_json::from_str(&jobs[0].sandbox).unwrap();
1413
    let rootfs = rootfs["rootfs"].as_str().unwrap().to_string();
1414
    let (st, body) = claim_with(vec!["ab".repeat(32), rootfs]).await;
1415
    assert_eq!(st, StatusCode::OK, "{body}");
1416
}
1417
1418
/// oxygenhub#71: a runner that lists the jobs it holds has the others it
1419
/// was given ended at once (it restarted, or never received them), not at
1420
/// the time limit; a held job is left alone.
1421
#[tokio::test(flavor = "multi_thread")]
1422
async fn a_job_its_runner_no_longer_holds_is_ended_at_its_next_claim() {
1423
    let h = hub().await;
1424
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1425
    create(&h.app, "andy", "held").await;
1426
    let url = format!("{}/andy/held", h.base);
1427
    let work = tempfile::tempdir().unwrap();
1428
    let c = client(&url, work.path());
1429
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
1430
    write(work.path(), "test.sh", "echo ok\n");
1431
    c.commit("Add a pipeline", &[]).unwrap();
1432
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1433
    assert_eq!(runs_of(&h.app, "andy", "held").await.len(), 1);
1434
    let id = claim(&h.app).await.expect("a job to claim")["job_id"].as_i64().unwrap();
1435
    let claim_holding = |holding: Vec<i64>| {
1436
        let body = serde_json::json!({ "runner": "test-1", "runtimes": ["microvm"], "holding": holding }).to_string();
1437
        let app = h.app.clone();
1438
        async move { call(&app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(body)).await.0 }
1439
    };
1440
    claim_holding(vec![id]).await;
1441
    assert_eq!(db::flow::job(&h.app.db, id).await.unwrap().unwrap().status, "running", "a held job stays");
1442
    claim_holding(vec![]).await;
1443
    let j = db::flow::job(&h.app.db, id).await.unwrap().unwrap();
1444
    assert_eq!(j.status, "error");
1445
    assert!(j.error.starts_with("lost:") && j.error.contains("no longer holds"), "{}", j.error);
1446
    let run = &runs_of(&h.app, "andy", "held").await[0];
1447
    assert!(db::flow::jobs(&h.app.db, run.id).await.unwrap().iter().all(|j| j.status != "running"), "the run settles");
1448
}
1449
1450
/// oxygen#59: a job with a `scope` runs on a push only when the push's
1451
/// changes touch a path it names (a release job, when Cargo.toml's version
1452
/// moves); a bookmark's first run and manual runs have every job.
1453
#[tokio::test(flavor = "multi_thread")]
1454
async fn a_scoped_job_runs_only_when_a_push_touches_its_paths() {
1455
    let h = hub().await;
1456
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1457
    create(&h.app, "andy", "scoped").await;
1458
    let url = format!("{}/andy/scoped", h.base);
1459
    let work = tempfile::tempdir().unwrap();
1460
    let c = client(&url, work.path());
1461
    let extra = "job \"dist\" {\n    sandbox \"alpine\"\n    scope \"Cargo.toml\" \"packaging/**\"\n    exec \"true\"\n}\n";
1462
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1463
    write(work.path(), "test.sh", "echo ok\n");
1464
    write(work.path(), "Cargo.toml", "version = \"0.1.0\"\n");
1465
    c.commit("Start", &[]).unwrap();
1466
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1467
    let names = |app: Shared, n: usize| async move {
1468
        let mut runs = Vec::new();
1469
        for _ in 0..100 {
1470
            runs = runs_of(&app, "andy", "scoped").await;
1471
            if runs.len() >= n {
1472
                break;
1473
            }
1474
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1475
        }
1476
        assert_eq!(runs.len(), n, "runs");
1477
        let mut j: Vec<String> = db::flow::jobs(&app.db, runs[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1478
        j.sort();
1479
        // Passed, so the next push is scoped against it, not superseding it.
1480
        sqlx::query("UPDATE flow_runs SET status = 'passed' WHERE id = ?").bind(runs[0].id).execute(&app.db).await.unwrap();
1481
        j
1482
    };
1483
    assert_eq!(names(h.app.clone(), 1).await, ["build", "dist", "lint", "test"], "the first run has every job");
1484
    write(work.path(), "test.sh", "echo still ok\n");
1485
    c.commit("Edit the test", &[]).unwrap();
1486
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1487
    assert_eq!(names(h.app.clone(), 2).await, ["build", "lint", "test"], "dist is out of scope");
1488
    write(work.path(), "Cargo.toml", "version = \"0.1.1\"\n");
1489
    c.commit("Release 0.1.1", &[]).unwrap();
1490
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1491
    assert_eq!(names(h.app.clone(), 3).await, ["build", "dist", "lint", "test"], "a version bump runs dist");
1492
}
1493
1494
/// oxygenflow#32: a run still going is cancelled from the API, the web or
1495
/// by a newer push to its bookmark; its runner is refused from then on,
1496
/// and the next push is scoped past the cancelled run.
1497
#[tokio::test(flavor = "multi_thread")]
1498
async fn runs_are_cancelled_by_hand_or_by_a_newer_push() {
1499
    let h = hub().await;
1500
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1501
    create(&h.app, "andy", "stop").await;
1502
    let url = format!("{}/andy/stop", h.base);
1503
    let work = tempfile::tempdir().unwrap();
1504
    let c = client(&url, work.path());
1505
    let extra = "job \"dist\" {\n    sandbox \"alpine\"\n    scope \"Cargo.toml\"\n    exec \"true\"\n}\n";
1506
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1507
    write(work.path(), "test.sh", "echo ok\n");
1508
    write(work.path(), "Cargo.toml", "version = \"0.1.0\"\n");
1509
    c.commit("Start", &[]).unwrap();
1510
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1511
    let wait_runs = |app: Shared, n: usize| async move {
1512
        for _ in 0..100 {
1513
            let runs = runs_of(&app, "andy", "stop").await;
1514
            if runs.len() >= n {
1515
                return runs;
1516
            }
1517
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1518
        }
1519
        panic!("no run {n}");
1520
    };
1521
    let first = wait_runs(h.app.clone(), 1).await;
1522
    sqlx::query("UPDATE flow_runs SET status = 'passed' WHERE id = ?").bind(first[0].id).execute(&h.app.db).await.unwrap();
1523
    sqlx::query("UPDATE flow_jobs SET status = 'passed' WHERE run_id = ?").bind(first[0].id).execute(&h.app.db).await.unwrap();
1524
1525
    // Run 2 (a version bump) has a job running when run 3 is pushed.
1526
    write(work.path(), "Cargo.toml", "version = \"0.1.1\"\n");
1527
    c.commit("Release 0.1.1", &[]).unwrap();
1528
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1529
    wait_runs(h.app.clone(), 2).await;
1530
    let job = claim(&h.app).await.expect("a job of run 2");
1531
    let id = job["job_id"].as_i64().unwrap();
1532
    write(work.path(), "test.sh", "echo still ok\n");
1533
    c.commit("Edit the test", &[]).unwrap();
1534
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1535
    let runs = wait_runs(h.app.clone(), 3).await;
1536
    let third = &runs[0];
1537
    let mut second = runs[1].clone();
1538
    for _ in 0..100 {
1539
        second = db::flow::run_by_id(&h.app.db, runs[1].id).await.unwrap().unwrap();
1540
        if !second.live() {
1541
            break;
1542
        }
1543
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1544
    }
1545
    assert_eq!(second.status, "cancelled", "a newer push supersedes a run still going");
1546
    let jobs = db::flow::jobs(&h.app.db, second.id).await.unwrap();
1547
    assert!(jobs.iter().all(|j| j.status == "cancelled" && j.error == "superseded by run #3"), "{jobs:?}");
1548
    let mut names: Vec<String> = db::flow::jobs(&h.app.db, third.id).await.unwrap().into_iter().map(|j| j.name).collect();
1549
    names.sort();
1550
    assert_eq!(names, ["build", "dist", "lint", "test"], "run 3 also checks what run 2 would have: the version bump");
1551
    let mut checks = vec![];
1552
    for _ in 0..100 {
1553
        checks = db::hooks::checks_for_state(&h.app.db, second.repo_id, &second.state).await.unwrap();
1554
        if checks.iter().all(|c| c.status == "cancelled") {
1555
            break;
1556
        }
1557
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1558
    }
1559
    assert!(checks.iter().all(|c| c.status == "cancelled"), "{checks:?}");
1560
    // The runner of the cancelled job is refused, so it stops the job.
1561
    let (st, _) =
1562
        call(&h.app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(r#"{"records":[]}"#.into())).await;
1563
    assert_eq!(st, StatusCode::CONFLICT);
1564
1565
    // By hand: the API, then a run already ended is refused.
1566
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/stop/flow/runs/3/cancel", Some("site"), None).await;
1567
    assert_eq!(st, StatusCode::OK, "{body}");
1568
    let third = db::flow::run_by_id(&h.app.db, third.id).await.unwrap().unwrap();
1569
    assert_eq!(third.status, "cancelled");
1570
    assert!(db::flow::jobs(&h.app.db, third.id).await.unwrap().iter().all(|j| j.error == "cancelled by andy"));
1571
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/stop/flow/runs/3/cancel", Some("site"), None).await;
1572
    assert!(st == StatusCode::CONFLICT && body.contains("already cancelled"), "{st} {body}");
1573
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/stop/flow/runs/3/cancel", None, None).await;
1574
    assert_ne!(st, StatusCode::OK, "anonymous callers cannot cancel");
1575
    let (_, page) = call(&h.app, "GET", "/andy/stop/flow/3", None, None).await;
1576
    assert!(page.contains("⊘") && !page.contains("CANCEL</button>"), "a cancelled run shows so, with no button");
1577
}
1578
1579
/// oxygenflow#23 and oxygenhub#89: a job runs under its pipeline's
1580
/// timeout, capped at the site's maximum, else the site's default; and the
1581
/// hub gives a job up only past its own limit.
1582
#[tokio::test(flavor = "multi_thread")]
1583
async fn a_job_runs_under_its_own_time_limit_within_the_sites() {
1584
    let h = hub().await;
1585
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1586
    db::accounts::set_setting(&h.app.db, oxygenhub::flow::SETTING_DEFAULT, "30").await.unwrap();
1587
    db::accounts::set_setting(&h.app.db, oxygenhub::flow::SETTING_MAX, "120").await.unwrap();
1588
    create(&h.app, "andy", "limits").await;
1589
    let url = format!("{}/andy/limits", h.base);
1590
    let work = tempfile::tempdir().unwrap();
1591
    let c = client(&url, work.path());
1592
    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";
1593
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1594
    write(work.path(), "test.sh", "echo ok\n");
1595
    c.commit("Add a pipeline", &[]).unwrap();
1596
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1597
    assert_eq!(runs_of(&h.app, "andy", "limits").await.len(), 1);
1598
    let mut limits = std::collections::HashMap::new();
1599
    let mut ids = std::collections::HashMap::new();
1600
    while let Some(j) = claim(&h.app).await {
1601
        let name = j["job"]["name"].as_str().unwrap().to_string();
1602
        limits.insert(name.clone(), j["timeout_s"].as_u64().unwrap());
1603
        ids.insert(name, j["job_id"].as_i64().unwrap());
1604
    }
1605
    assert_eq!(limits["slow"], 5400, "its own");
1606
    assert_eq!(limits["huge"], 7200, "cut to the site's maximum");
1607
    assert_eq!(limits["build"], 1800, "the site's default");
1608
    // 40 minutes in: past the default and its grace, within slow's limit.
1609
    let started = db::now_ms() - 40 * 60 * 1000;
1610
    sqlx::query("UPDATE flow_jobs SET started_ms = ?").bind(started).execute(&h.app.db).await.unwrap();
1611
    oxygenhub::flow::reap_lost_jobs(&h.app).await.unwrap();
1612
    let status = |id: i64| {
1613
        let app = h.app.clone();
1614
        async move { db::flow::job(&app.db, id).await.unwrap().unwrap().status }
1615
    };
1616
    assert_eq!(status(ids["build"]).await, "error", "past its 30 minutes");
1617
    assert_eq!(status(ids["slow"]).await, "running", "within its 90");
1618
    assert_eq!(status(ids["huge"]).await, "running", "within its 120");
1619
}
1620
1621
/// oxygenflow#24: a job's `on` decides which events start it: a pushed
1622
/// tag runs only the jobs that name it; a push to a bookmark the pipeline
1623
/// does not name starts no run; a rerun repeats its run's event.
1624
#[tokio::test(flavor = "multi_thread")]
1625
async fn on_decides_which_events_start_a_job() {
1626
    let h = hub().await;
1627
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1628
    create(&h.app, "andy", "events").await;
1629
    let url = format!("{}/andy/events", h.base);
1630
    let work = tempfile::tempdir().unwrap();
1631
    let c = client(&url, work.path());
1632
    let text = format!(
1633
        "on {{\n    push \"main\"\n    manual\n}}\n{}job \"dist\" {{\n    sandbox \"alpine\"\n    on {{\n        tag \"v*\"\n    }}\n    exec \"true\"\n}}\n",
1634
        pipeline("")
1635
    );
1636
    // `on` must come after schema-version; pipeline() starts with it.
1637
    let text = text.replacen(
1638
        "on {\n    push \"main\"\n    manual\n}\nschema-version 1\n",
1639
        "schema-version 1\non {\n    push \"main\"\n    manual\n}\n",
1640
        1,
1641
    );
1642
    write(work.path(), ".flow/pipeline.kdl", &text);
1643
    write(work.path(), "test.sh", "echo ok\n");
1644
    c.commit("Start", &[]).unwrap();
1645
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1646
    let jobs_of_latest = |app: Shared, n: usize| async move {
1647
        let mut runs = Vec::new();
1648
        for _ in 0..100 {
1649
            runs = runs_of(&app, "andy", "events").await;
1650
            if runs.len() >= n {
1651
                break;
1652
            }
1653
            tokio::time::sleep(std::time::Duration::from_millis(50)).await;
1654
        }
1655
        assert_eq!(runs.len(), n, "runs");
1656
        let mut j: Vec<String> = db::flow::jobs(&app.db, runs[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1657
        j.sort();
1658
        (runs[0].clone(), j)
1659
    };
1660
    let (_, j) = jobs_of_latest(h.app.clone(), 1).await;
1661
    assert_eq!(j, ["build", "lint", "test"], "a push to main: no dist");
1662
    // A tag: only dist.
1663
    let heads = c.bookmark_heads().unwrap();
1664
    c.tag_create("v1.0.0", &heads, "first").unwrap();
1665
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1666
    let (run, j) = jobs_of_latest(h.app.clone(), 2).await;
1667
    assert_eq!(j, ["dist"], "a tag runs only what names it");
1668
    assert_eq!(run.trigger, "tag:v1.0.0");
1669
    // A rerun repeats the tag's event.
1670
    let row = db::repos::get(&h.app.db, "andy", "events").await.unwrap().unwrap();
1671
    db::flow::finish(
1672
        &h.app.db,
1673
        db::flow::jobs(&h.app.db, run.id).await.unwrap()[0].id,
1674
        db::flow::Outcome { status: "passed", exit_code: Some(0), error: "", receipt: "", receipt_hash: "" },
1675
    )
1676
    .await
1677
    .unwrap();
1678
    let run = db::flow::run_by_id(&h.app.db, run.id).await.unwrap().unwrap();
1679
    oxygenhub::flow::rerun(&h.app, &row, &run, "andy").await.unwrap();
1680
    let (_, j) = jobs_of_latest(h.app.clone(), 3).await;
1681
    assert_eq!(j, ["dist"], "the rerun is the tag's run again");
1682
    // A bookmark the pipeline does not name starts nothing.
1683
    c.bookmark_create("develop", None).unwrap();
1684
    assert!(c.push_bookmark("origin", "develop", false).unwrap().iter().all(|r| r.ok));
1685
    tokio::time::sleep(std::time::Duration::from_millis(300)).await;
1686
    assert_eq!(runs_of(&h.app, "andy", "events").await.len(), 3, "no run for develop");
1687
}
1688
1689
/// oxygenflow#24: a job with a `schedule` line runs on the default
1690
/// bookmark when the line comes due, and only then; other jobs stay out.
1691
#[tokio::test(flavor = "multi_thread")]
1692
async fn scheduled_jobs_run_when_due() {
1693
    let h = hub().await;
1694
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
1695
    create(&h.app, "andy", "nightly").await;
1696
    let url = format!("{}/andy/nightly", h.base);
1697
    let work = tempfile::tempdir().unwrap();
1698
    let c = client(&url, work.path());
1699
    // An odd minute, so the hub's own ticker cannot fire it during the test.
1700
    let extra = "job \"nightly\" {\n    sandbox \"alpine\"\n    on {\n        schedule \"17 4 29 2 *\"\n    }\n    exec \"true\"\n}\n";
1701
    write(work.path(), ".flow/pipeline.kdl", &pipeline(extra));
1702
    write(work.path(), "test.sh", "echo ok\n");
1703
    c.commit("Start", &[]).unwrap();
1704
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
1705
    assert_eq!(runs_of(&h.app, "andy", "nightly").await.len(), 1);
1706
    let first = runs_of(&h.app, "andy", "nightly").await;
1707
    let names: Vec<String> = db::flow::jobs(&h.app.db, first[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1708
    assert!(!names.contains(&"nightly".to_string()), "a push does not run a scheduled job");
1709
    use flow_core::pipeline::When;
1710
    let not_yet = When { minute: 16, hour: 4, day: 29, month: 2, weekday: 4 };
1711
    assert_eq!(oxygenhub::flow::run_due(&h.app, not_yet).await, 0);
1712
    let due = When { minute: 17, ..not_yet };
1713
    assert_eq!(oxygenhub::flow::run_due(&h.app, due).await, 1);
1714
    let runs = runs_of(&h.app, "andy", "nightly").await;
1715
    assert_eq!(runs.len(), 2);
1716
    assert_eq!(runs[0].trigger, "schedule");
1717
    let names: Vec<String> = db::flow::jobs(&h.app.db, runs[0].id).await.unwrap().into_iter().map(|j| j.name).collect();
1718
    assert_eq!(names, ["nightly"]);
1719
    assert_eq!(runs[0].bookmark, "main", "on the default bookmark");
1720
}