OXYGENHUB
# 2bfe5ef66b0c oxygenhub / crates / hub / tests / flow.rs
36.2 KiB · Rust · last changed Flow runs, jobs and logs in the API; checks by heads 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
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
48
    let port = listener.local_addr().unwrap().port();
49
    config.server.base_url = format!("http://127.0.0.1:{port}");
50
    let app = oxygenhub::build(config).await.unwrap();
51
    let router = oxygenhub::router(app.clone());
52
    tokio::spawn(async move { axum::serve(listener, router).await.unwrap() });
53
    Hub { app, base: format!("http://127.0.0.1:{port}"), _dir: dir }
54
}
55
56
async fn call(app: &Shared, method: &str, path: &str, bearer: Option<&str>, json: Option<String>) -> (StatusCode, String) {
57
    let mut req = Request::builder().method(method).uri(path);
58
    if let Some(b) = bearer {
59
        req = req.header(header::AUTHORIZATION, format!("Bearer {b}"));
60
    }
61
    let body = match json {
62
        Some(j) => {
63
            req = req.header(header::CONTENT_TYPE, "application/json");
64
            Body::from(j)
65
        }
66
        None => Body::empty(),
67
    };
68
    let res = oxygenhub::router(app.clone()).oneshot(req.body(body).unwrap()).await.unwrap();
69
    let status = res.status();
70
    let bytes = res.into_body().collect().await.unwrap().to_bytes();
71
    (status, String::from_utf8_lossy(&bytes).into_owned())
72
}
73
74
/// A GET's status, `Location` and `Content-Type`.
75
async fn head(app: &Shared, path: &str) -> (StatusCode, String, String) {
76
    let res = oxygenhub::router(app.clone()).oneshot(Request::get(path).body(Body::empty()).unwrap()).await.unwrap();
77
    let h = |k: header::HeaderName| res.headers().get(k).and_then(|v| v.to_str().ok()).unwrap_or("").to_string();
78
    (res.status(), h(header::LOCATION), h(header::CONTENT_TYPE))
79
}
80
81
async fn claim(app: &Shared) -> Option<serde_json::Value> {
82
    let (st, body) =
83
        call(app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(r#"{"runner":"test-1","runtimes":["microvm"]}"#.into())).await;
84
    match st {
85
        StatusCode::NO_CONTENT => None,
86
        StatusCode::OK => Some(serde_json::from_str(&body).unwrap()),
87
        other => panic!("claim: {other} {body}"),
88
    }
89
}
90
91
fn receipt(job: &str, pipeline_hash: &str, exit: u32) -> serde_json::Value {
92
    serde_json::json!({
93
        "job_name": job, "pipeline_hash": pipeline_hash, "scope_tree_hash": "11".repeat(32),
94
        "inputs": [], "environment": "22".repeat(32), "outputs": [], "exit_code": exit, "duration_ms": 640
95
    })
96
}
97
98
async fn finish(app: &Shared, id: i64, body: serde_json::Value) -> StatusCode {
99
    call(app, "POST", &format!("/api/v1/flow/jobs/{id}/finish"), Some("runner-secret"), Some(body.to_string())).await.0
100
}
101
102
async fn create(app: &Shared, owner: &str, name: &str) {
103
    app.repos.create(&RepoName::parse(&format!("{owner}/{name}")).unwrap(), None).unwrap();
104
    db::repos::create(&app.db, owner, name, "", hub_api::Visibility::Public).await.unwrap();
105
}
106
107
fn client(url: &str, work: &Path) -> Repo {
108
    let mut c = Repo::init(work).unwrap();
109
    c.config.set("remote.origin.url", url).unwrap();
110
    c.config.set("remote.origin.token", "site").unwrap();
111
    c.save_config().unwrap();
112
    c
113
}
114
115
fn pipeline(extra: &str) -> String {
116
    format!(
117
        "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}"
118
    )
119
}
120
121
async fn runs_of(app: &Shared, owner: &str, name: &str) -> Vec<db::flow::Run> {
122
    let row = db::repos::get(&app.db, owner, name).await.unwrap().unwrap();
123
    for _ in 0..100 {
124
        let r = db::flow::runs(&app.db, row.id, 10, None).await.unwrap();
125
        if !r.is_empty() {
126
            return r;
127
        }
128
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
129
    }
130
    vec![]
131
}
132
133
/// The checks on a state once there are `n` of them (they follow the run).
134
async fn checks_when(app: &Shared, repo_id: i64, state: &str, n: usize) -> Vec<db::hooks::Check> {
135
    for _ in 0..100 {
136
        let c = db::hooks::checks_for_state(&app.db, repo_id, state).await.unwrap();
137
        if c.len() >= n {
138
            return c;
139
        }
140
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
141
    }
142
    db::hooks::checks_for_state(&app.db, repo_id, state).await.unwrap()
143
}
144
145
#[tokio::test(flavor = "multi_thread")]
146
async fn a_push_runs_the_pipeline_through_a_runner() {
147
    let h = hub().await;
148
    create(&h.app, "andy", "demo").await;
149
    create(&h.app, "andy", "secret").await;
150
    create(&h.app, "other", "plain").await;
151
    let url = format!("{}/andy/demo", h.base);
152
    let work = tempfile::tempdir().unwrap();
153
    let mut c = client(&url, work.path());
154
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
155
    write(work.path(), "test.sh", "echo ok\n");
156
    c.snapshot("test").unwrap();
157
    c.commit("Add a pipeline", &[]).unwrap();
158
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
159
160
    // The push started a run with three queued jobs, and checks for them.
161
    let runs = runs_of(&h.app, "andy", "demo").await;
162
    assert_eq!(runs.len(), 1);
163
    let run = &runs[0];
164
    assert_eq!((run.bookmark.as_str(), run.status.as_str(), run.actor.as_str()), ("main", "queued", "site token"));
165
    assert_eq!(run.pipeline_hash.len(), 64);
166
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
167
    assert_eq!(jobs.iter().map(|j| (j.name.as_str(), j.depth)).collect::<Vec<_>>(), [("build", 0), ("lint", 0), ("test", 1)]);
168
    // The checks are reported just after the run is recorded.
169
    let checks = checks_when(&h.app, run.repo_id, &run.state, 3).await;
170
    assert_eq!(
171
        checks.iter().map(|c| (c.name.as_str(), c.status.as_str())).collect::<Vec<_>>(),
172
        [("flow/build", "queued"), ("flow/lint", "queued"), ("flow/test", "queued")]
173
    );
174
175
    // Runners need a runner token.
176
    assert_eq!(
177
        call(&h.app, "POST", "/api/v1/flow/claim", Some("site"), Some(r#"{"runner":"x","runtimes":["microvm"]}"#.into())).await.0,
178
        StatusCode::UNAUTHORIZED
179
    );
180
    assert_eq!(
181
        call(&h.app, "POST", "/api/v1/flow/claim", None, Some(r#"{"runner":"x","runtimes":["microvm"]}"#.into())).await.0,
182
        StatusCode::UNAUTHORIZED
183
    );
184
    // A runner without the tier gets nothing.
185
    let (st, _) =
186
        call(&h.app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(r#"{"runner":"x","runtimes":["wasm"]}"#.into())).await;
187
    assert_eq!(st, StatusCode::NO_CONTENT);
188
189
    // Claims come in dependency order; `test` waits for `build`.
190
    let a = claim(&h.app).await.unwrap();
191
    let b = claim(&h.app).await.unwrap();
192
    assert_eq!((a["job"]["name"].as_str(), b["job"]["name"].as_str()), (Some("build"), Some("lint")));
193
    assert!(claim(&h.app).await.is_none(), "test waits for build");
194
    assert_eq!(a["repo"], "andy/demo");
195
    assert_eq!(a["clone_url"], url.as_str());
196
    assert_eq!(a["sandbox"]["rootfs"], ROOTFS);
197
    assert_eq!(a["job"]["exec"], serde_json::json!(["make"]));
198
    assert_eq!(a["timeout_s"], 3600);
199
    // The job is told what it builds (FLOW_STATE, FLOW_BOOKMARK, FLOW_RUN).
200
    assert_eq!(
201
        (a["state"].as_str(), a["bookmark"].as_str(), a["run_number"].as_i64()),
202
        (Some(run.state.as_str()), Some("main"), Some(run.number))
203
    );
204
    let heads: Vec<String> = a["heads"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_string()).collect();
205
    assert_eq!(heads.join("+"), run.heads);
206
    let checks = db::hooks::checks_for_state(&h.app.db, run.repo_id, &run.state).await.unwrap();
207
    assert_eq!(checks.iter().find(|c| c.name == "flow/build").unwrap().status, "running");
208
209
    // The job token reads this repository over the wire, and nothing else.
210
    let token = a["token"].as_str().unwrap().to_string();
211
    assert!(token.starts_with("flowjob_"));
212
    let opts = RemoteOptions { token: Some(token.clone()), ca: None, repo_id: None };
213
    open_remote(&url, &opts).unwrap().refs().unwrap();
214
    assert!(open_remote(&format!("{}/andy/secret", h.base), &opts).unwrap().refs().is_err(), "another repository");
215
    let bad = RemoteOptions { token: Some("flowjob_00".into()), ca: None, repo_id: None };
216
    assert!(open_remote(&url, &bad).unwrap().refs().is_err(), "an unknown job token");
217
    // … and cannot push.
218
    c.config.set("remote.origin.token", &token).unwrap();
219
    c.save_config().unwrap();
220
    write(work.path(), "more.txt", "x\n");
221
    c.snapshot("test").unwrap();
222
    c.commit("More", &[]).unwrap();
223
    let pushed = c.push("origin", false);
224
    assert!(pushed.is_err() || pushed.unwrap().iter().all(|r| !r.ok), "a job token cannot push");
225
    c.config.set("remote.origin.token", "site").unwrap();
226
    c.save_config().unwrap();
227
228
    // Logs, then results with receipts.
229
    let a_id = a["job_id"].as_i64().unwrap();
230
    let b_id = b["job_id"].as_i64().unwrap();
231
    let log = serde_json::json!({ "records": [
232
        { "t": 5, "stream": "flow", "text": "booting" },
233
        { "t": 120, "stream": "out", "text": "cc -o demo demo.c" },
234
        { "t": 130, "stream": "weird", "text": "x".repeat(20_000) },
235
    ]});
236
    assert_eq!(
237
        call(&h.app, "POST", &format!("/api/v1/flow/jobs/{a_id}/log"), Some("runner-secret"), Some(log.to_string())).await.0,
238
        StatusCode::NO_CONTENT
239
    );
240
    let lines = db::flow::log(&h.app.db, a_id, 0, 100).await.unwrap();
241
    assert_eq!(lines.len(), 3);
242
    assert_eq!((lines[2].stream.as_str(), lines[2].text.len()), ("console", 16 * 1024), "streams are known ones, text is capped");
243
    let ph = a["pipeline_hash"].as_str().unwrap();
244
    assert_eq!(
245
        finish(&h.app, a_id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": receipt("lint", ph, 0) })).await,
246
        StatusCode::BAD_REQUEST,
247
        "a receipt for another job"
248
    );
249
    assert_eq!(
250
        finish(&h.app, a_id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": receipt("build", ph, 0) })).await,
251
        StatusCode::NO_CONTENT
252
    );
253
    assert_eq!(finish(&h.app, a_id, serde_json::json!({ "exit_code": 0, "duration_ms": 700 })).await, StatusCode::CONFLICT, "only once");
254
    assert!(open_remote(&url, &opts).unwrap().refs().is_err(), "the token ends with its job");
255
    assert_eq!(
256
        finish(&h.app, b_id, serde_json::json!({ "exit_code": 0, "duration_ms": 300, "receipt": receipt("lint", ph, 0) })).await,
257
        StatusCode::NO_CONTENT
258
    );
259
    let t = claim(&h.app).await.unwrap();
260
    assert_eq!(t["job"]["name"], "test");
261
    let t_id = t["job_id"].as_i64().unwrap();
262
    assert_eq!(
263
        finish(&h.app, t_id, serde_json::json!({ "exit_code": 3, "duration_ms": 500, "receipt": receipt("test", ph, 3) })).await,
264
        StatusCode::NO_CONTENT
265
    );
266
267
    let run = db::flow::run_by_id(&h.app.db, run.id).await.unwrap().unwrap();
268
    assert_eq!(run.status, "failed");
269
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
270
    let build = jobs.iter().find(|j| j.name == "build").unwrap();
271
    assert_eq!((build.status.as_str(), build.exit_code, build.receipt_hash.len()), ("passed", Some(0), 64));
272
    assert_eq!(jobs.iter().find(|j| j.name == "test").unwrap().status, "failed");
273
    let checks = db::hooks::checks_for_state(&h.app.db, run.repo_id, &run.state).await.unwrap();
274
    assert_eq!(
275
        checks.iter().map(|c| (c.name.as_str(), c.status.as_str())).collect::<Vec<_>>(),
276
        [("flow/build", "passed"), ("flow/lint", "passed"), ("flow/test", "failed")]
277
    );
278
    assert!(checks[2].summary.contains("exit 3") && checks[2].url.ends_with(&format!("/andy/demo/flow/{}", run.number)));
279
280
    // Pages: the list, the run with its graph and logs, and the live view.
281
    let (st, list) = call(&h.app, "GET", "/andy/demo/flow", None, None).await;
282
    assert_eq!(st, StatusCode::OK);
283
    assert!(list.contains(&format!("/andy/demo/flow/{}", run.number)) && list.contains("st-failed"), "{list}");
284
    let (st, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", run.number), None, None).await;
285
    assert_eq!(st, StatusCode::OK);
286
    assert!(page.contains("<svg class=\"flow-graph\""), "graph");
287
    assert_eq!(page.matches("data-job-node=").count(), 3);
288
    assert_eq!(page.matches("<path class=\"edge").count(), 1, "one dependency edge");
289
    assert!(page.contains("cc -o demo demo.c"), "log shown");
290
    assert!(!page.contains("data-flow-live"), "a finished run does not poll");
291
    let (st, live) = call(&h.app, "GET", &format!("/andy/demo/flow/{}/live?after={a_id}:1", run.number), None, None).await;
292
    assert_eq!(st, StatusCode::OK);
293
    let live: serde_json::Value = serde_json::from_str(&live).unwrap();
294
    assert_eq!(live["status"], "failed");
295
    let build_live = live["jobs"].as_array().unwrap().iter().find(|j| j["name"] == "build").unwrap().clone();
296
    assert_eq!(build_live["lines"].as_array().unwrap().len(), 2, "lines after seq 1");
297
    assert_eq!(call(&h.app, "GET", "/andy/demo/flow/999", None, None).await.0, StatusCode::NOT_FOUND);
298
299
    // A failed dependency skips what follows; an unrun job is an error.
300
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
301
    write(work.path(), "test.sh", "echo changed\n");
302
    c.snapshot("test").unwrap();
303
    c.commit("Change the test", &[]).unwrap();
304
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
305
    let mut second = None;
306
    for _ in 0..100 {
307
        let r = runs_of(&h.app, "andy", "demo").await;
308
        if r.len() == 2 {
309
            second = Some(r[0].clone());
310
            break;
311
        }
312
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
313
    }
314
    let second = second.expect("a second run");
315
    let x = claim(&h.app).await.unwrap();
316
    let y = claim(&h.app).await.unwrap();
317
    let (build_id, lint_id) = if x["job"]["name"] == "build" {
318
        (x["job_id"].as_i64().unwrap(), y["job_id"].as_i64().unwrap())
319
    } else {
320
        (y["job_id"].as_i64().unwrap(), x["job_id"].as_i64().unwrap())
321
    };
322
    assert_eq!(
323
        finish(&h.app, build_id, serde_json::json!({ "exit_code": null, "duration_ms": 10, "error": "rootfs is not on this runner" }))
324
            .await,
325
        StatusCode::NO_CONTENT
326
    );
327
    assert_eq!(finish(&h.app, lint_id, serde_json::json!({ "exit_code": 0, "duration_ms": 10 })).await, StatusCode::NO_CONTENT);
328
    assert!(claim(&h.app).await.is_none(), "test was skipped");
329
    let jobs = db::flow::jobs(&h.app.db, second.id).await.unwrap();
330
    assert_eq!(
331
        jobs.iter().map(|j| (j.name.as_str(), j.status.as_str())).collect::<Vec<_>>(),
332
        [("build", "error"), ("lint", "passed"), ("test", "skipped")]
333
    );
334
    assert_eq!(db::flow::run_by_id(&h.app.db, second.id).await.unwrap().unwrap().status, "failed");
335
336
    // An invalid pipeline is a run in error with the line.
337
    write(work.path(), ".flow/pipeline.kdl", &pipeline("job \"broken\" {\n    sandbox \"missing\"\n    exec \"x\"\n}\n"));
338
    c.snapshot("test").unwrap();
339
    c.commit("Break the pipeline", &[]).unwrap();
340
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
341
    let mut third = None;
342
    for _ in 0..100 {
343
        let r = runs_of(&h.app, "andy", "demo").await;
344
        if r.len() == 3 {
345
            third = Some(r[0].clone());
346
            break;
347
        }
348
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
349
    }
350
    let third = third.expect("a third run");
351
    assert_eq!(third.status, "error");
352
    assert!(third.error.contains("line 18") && third.error.contains("\"missing\""), "{}", third.error);
353
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", third.number), None, None).await;
354
    assert!(page.contains("The pipeline is not valid"));
355
356
    // State stamps (hub spec §13.2) and images in READMEs.
357
    write(work.path(), "README.md", "# Demo\n\n[![flow](.flow/stamp)](.flow/run)\n\n![logo](img/logo.png)\n");
358
    std::fs::create_dir_all(work.path().join("img")).unwrap();
359
    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")
360
        .unwrap();
361
    c.snapshot("test").unwrap();
362
    c.commit("A README with a stamp", &[]).unwrap();
363
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
364
    let mut fourth = None;
365
    for _ in 0..100 {
366
        let r = runs_of(&h.app, "andy", "demo").await;
367
        if r.len() == 4 {
368
            fourth = Some(r[0].clone());
369
            break;
370
        }
371
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
372
    }
373
    let fourth = fourth.expect("a fourth run");
374
    let (_, overview) = call(&h.app, "GET", "/andy/demo", None, None).await;
375
    assert!(overview.contains("src=\"/andy/demo/raw/main/.flow/stamp\""), "{overview}");
376
    assert!(overview.contains("href=\"/andy/demo/file/main/.flow/run\""));
377
    assert!(overview.contains("src=\"/andy/demo/raw/main/img/logo.png\""), "images use the raw route");
378
    let (st, _, ct) = head(&h.app, "/andy/demo/raw/main/img/logo.png").await;
379
    assert_eq!((st, ct.as_str()), (StatusCode::OK, "image/png"));
380
    let (st, loc, _) = head(&h.app, "/andy/demo/raw/main/.flow/stamp").await;
381
    assert!(st.is_redirection() && loc == "/andy/demo/flow/stamp/main", "{st} {loc}");
382
    let (st, loc, _) = head(&h.app, "/andy/demo/flow/stamp/main").await;
383
    assert!(st.is_redirection() && loc == format!("/andy/demo/flow/stamp/{}", fourth.heads), "a bookmark's stamp names its state: {loc}");
384
    let (st, _, ct) = head(&h.app, &loc).await;
385
    assert_eq!((st, ct.as_str()), (StatusCode::OK, "image/svg+xml; charset=utf-8"));
386
    let (_, svg) = call(&h.app, "GET", &loc, None, None).await;
387
    assert!(svg.starts_with("<svg") && svg.contains("error ·") && svg.contains(&fourth.heads[..12]), "{svg}");
388
    let (_, svg1) = call(&h.app, "GET", &format!("/andy/demo/flow/stamp/{}", run.heads), None, None).await;
389
    assert!(svg1.contains("failed ·") && svg1.contains(&format!("run #{} failed", run.id)), "an older state keeps its own result: {svg1}");
390
    assert!(svg1.contains(&build.receipt_hash), "receipt hashes in the metadata");
391
    assert_eq!(svg1.matches("text-anchor=\"middle\"").count(), 3, "one glyph per job");
392
    let (st, loc, _) = head(&h.app, "/andy/demo/file/main/.flow/run").await;
393
    assert!(st.is_redirection() && loc == "/andy/demo/flow/at/main", "{loc}");
394
    let (st, loc, _) = head(&h.app, "/andy/demo/flow/at/main").await;
395
    assert!(st.is_redirection() && loc == format!("/andy/demo/flow/{}", fourth.id), "{loc}");
396
397
    // A repository outside [flow] repos starts nothing.
398
    let work2 = tempfile::tempdir().unwrap();
399
    let c2 = client(&format!("{}/other/plain", h.base), work2.path());
400
    write(work2.path(), ".flow/pipeline.kdl", &pipeline(""));
401
    c2.snapshot("test").unwrap();
402
    c2.commit("Pipeline", &[]).unwrap();
403
    assert!(c2.push("origin", false).unwrap().iter().all(|r| r.ok));
404
    tokio::time::sleep(std::time::Duration::from_millis(500)).await;
405
    let row = db::repos::get(&h.app.db, "other", "plain").await.unwrap().unwrap();
406
    assert!(db::flow::runs(&h.app.db, row.id, 10, None).await.unwrap().is_empty());
407
    let (_, page) = call(&h.app, "GET", "/other/plain/flow", None, None).await;
408
    assert!(page.contains("not enabled for this repository"));
409
    let (_, loc, _) = head(&h.app, "/other/plain/flow/stamp/main").await;
410
    let (_, svg) = call(&h.app, "GET", &loc, None, None).await;
411
    assert!(svg.contains("no run ·"), "{svg}");
412
    let (_, loc, _) = head(&h.app, "/other/plain/flow/at/main").await;
413
    assert_eq!(loc, "/other/plain/flow");
414
}
415
416
#[tokio::test(flavor = "multi_thread")]
417
async fn claims_carry_pinned_subrepos_and_the_job_token_reads_only_those() {
418
    let h = hub().await;
419
    for n in ["base", "lib", "vault", "other", "app"] {
420
        create(&h.app, "andy", n).await;
421
    }
422
    let push = |name: &str, file: &str| {
423
        let work = tempfile::tempdir().unwrap();
424
        let c = client(&format!("{}/andy/{name}", h.base), work.path());
425
        write(work.path(), file, "x\n");
426
        c.snapshot("t").unwrap();
427
        c.commit("first", &[]).unwrap();
428
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
429
        let heads = c.bookmark_heads().unwrap();
430
        (work, heads)
431
    };
432
    let (_b, base_heads) = push("base", "base.rs");
433
    // lib pins base in turn: a subrepo of a subrepo.
434
    let lib_work = tempfile::tempdir().unwrap();
435
    let lib = client(&format!("{}/andy/lib", h.base), lib_work.path());
436
    lib.submodule_add(&format!("{}/andy/base", h.base), "deps/base", Some("main")).unwrap();
437
    write(lib_work.path(), "lib.rs", "x\n");
438
    lib.snapshot("t").unwrap();
439
    lib.commit("lib on base", &[]).unwrap();
440
    assert!(lib.push("origin", false).unwrap().iter().all(|r| r.ok));
441
    let lib_heads = lib.bookmark_heads().unwrap();
442
    let (_v, _) = push("vault", "secret.rs");
443
    let (_o, _) = push("other", "o.rs");
444
445
    // The app pins lib and vault as subrepos and pushes as the site token.
446
    let work = tempfile::tempdir().unwrap();
447
    let app = client(&format!("{}/andy/app", h.base), work.path());
448
    app.submodule_add(&format!("{}/andy/lib", h.base), "deps/lib", Some("main")).unwrap();
449
    // Vault is private: adding it takes the environment's token, as a clone does.
450
    sqlx::query("UPDATE repositories SET visibility = 'private' WHERE name = 'vault'").execute(&h.app.db).await.unwrap();
451
    assert!(app.submodule_add(&format!("{}/andy/vault", h.base), "deps/vault2", Some("main")).is_err(), "not without a token");
452
    std::env::set_var("OXY_TOKEN", "site");
453
    app.submodule_add(&format!("{}/andy/vault", h.base), "deps/vault", Some("main")).unwrap();
454
    std::env::remove_var("OXY_TOKEN");
455
    // The pusher below is the site token, which has no account: it cannot read vault.
456
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
457
    write(work.path(), "Makefile", "all:\n");
458
    app.snapshot("t").unwrap();
459
    app.commit("app with deps", &[]).unwrap();
460
    assert!(app.push("origin", false).unwrap().iter().all(|r| r.ok));
461
    assert!(!runs_of(&h.app, "andy", "app").await.is_empty());
462
463
    let job = claim(&h.app).await.unwrap();
464
    let subs = job["subrepos"].as_array().cloned().unwrap_or_default();
465
    assert_eq!(subs.len(), 2, "lib and what lib pins; vault is private and the pusher has no account: {subs:?}");
466
    assert_eq!(subs[1]["path"], "deps/lib/deps/base", "nested under its parent, after it");
467
    assert_eq!(subs[1]["heads"], serde_json::json!(base_heads.iter().map(|h| h.to_hex()).collect::<Vec<_>>()));
468
    let _ = std::fs::remove_dir_all(work.path().join("deps/vault2"));
469
    assert_eq!(subs[0]["path"], "deps/lib");
470
    assert_eq!(subs[0]["repo"], "andy/lib");
471
    assert_eq!(subs[0]["heads"], serde_json::json!(lib_heads.iter().map(|h| h.to_hex()).collect::<Vec<_>>()));
472
    assert!(subs[0]["clone_url"].as_str().unwrap().ends_with("/andy/lib"));
473
474
    // The job token reads its repository and the pinned lib, nothing else.
475
    let token = job["token"].as_str().unwrap().to_string();
476
    let read = |name: &str| {
477
        let opts = RemoteOptions { token: Some(token.clone()), ..Default::default() };
478
        open_remote(&format!("{}/andy/{name}", h.base), &opts).and_then(|r| r.refs()).is_ok()
479
    };
480
    assert!(read("app") && read("lib") && read("base"));
481
    assert!(!read("vault"), "not pinned for this pusher");
482
    assert!(!read("other"), "public, but not the job's to read");
483
}
484
485
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
486
async fn concurrent_log_appends_never_fail_on_a_locked_database() {
487
    let h = hub().await;
488
    create(&h.app, "andy", "demo").await;
489
    let work = tempfile::tempdir().unwrap();
490
    let c = client(&format!("{}/andy/demo", h.base), work.path());
491
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
492
    write(work.path(), "Makefile", "all:\n");
493
    c.snapshot("t").unwrap();
494
    c.commit("pipeline", &[]).unwrap();
495
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
496
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
497
    let job = db::flow::jobs(&h.app.db, run.id).await.unwrap().remove(0);
498
    // Many writers at once, each reading the count and then inserting: a
499
    // deferred transaction would fail with "database is locked".
500
    let mut tasks = Vec::new();
501
    for w in 0..16 {
502
        let pool = h.app.db.clone();
503
        tasks.push(tokio::spawn(async move {
504
            let records: Vec<flow_core::api::Record> =
505
                (0..20).map(|i| flow_core::api::Record { t: i, stream: "out".into(), text: format!("writer {w} line {i}") }).collect();
506
            db::flow::append_log(&pool, job.id, &records, 100_000).await
507
        }));
508
    }
509
    for t in tasks {
510
        assert_eq!(t.await.unwrap().unwrap(), 20, "every append succeeds");
511
    }
512
    let lines = db::flow::log(&h.app.db, job.id, 0, 1_000).await.unwrap();
513
    assert_eq!(lines.len(), 320);
514
    let seqs: std::collections::BTreeSet<i64> = lines.iter().map(|l| l.seq).collect();
515
    assert_eq!(seqs.len(), 320, "sequence numbers are unique");
516
}
517
518
/// A repository's own Flow setting overrides hub.toml either way.
519
#[tokio::test(flavor = "multi_thread")]
520
async fn a_repository_setting_turns_flow_on_or_off() {
521
    let h = hub().await;
522
    create(&h.app, "other", "plain").await;
523
    create(&h.app, "andy", "quiet").await;
524
    // A run elsewhere first, so hub-wide ids and per-repository numbers differ.
525
    create(&h.app, "andy", "first").await;
526
    {
527
        let work = tempfile::tempdir().unwrap();
528
        let c = client(&format!("{}/andy/first", h.base), work.path());
529
        write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
530
        write(work.path(), "test.sh", "echo ok\n");
531
        c.commit("Add a pipeline", &[]).unwrap();
532
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
533
        assert_eq!(runs_of(&h.app, "andy", "first").await.len(), 1);
534
    }
535
    let row = db::repos::get(&h.app.db, "other", "plain").await.unwrap().unwrap();
536
    db::repos::set_flow(&h.app.db, row.id, "on").await.unwrap();
537
    let quiet = db::repos::get(&h.app.db, "andy", "quiet").await.unwrap().unwrap();
538
    db::repos::set_flow(&h.app.db, quiet.id, "off").await.unwrap();
539
    for (owner, name) in [("other", "plain"), ("andy", "quiet")] {
540
        let work = tempfile::tempdir().unwrap();
541
        let c = client(&format!("{}/{owner}/{name}", h.base), work.path());
542
        write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
543
        write(work.path(), "test.sh", "echo ok\n");
544
        c.commit("Add a pipeline", &[]).unwrap();
545
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
546
    }
547
    let plain = runs_of(&h.app, "other", "plain").await;
548
    assert_eq!(plain.len(), 1, "turned on");
549
    // Runs are numbered per repository: this is plain's first, whatever
550
    // other repositories ran before.
551
    assert_eq!(plain[0].number, 1);
552
    let checks = checks_when(&h.app, row.id, &plain[0].state, 3).await;
553
    assert!(checks.iter().all(|c| c.url.ends_with("/other/plain/flow/1")), "{checks:?}");
554
    let (st, page) = call(&h.app, "GET", "/other/plain/flow/1", None, None).await;
555
    assert!(st == StatusCode::OK && page.contains("Run #1"), "{st}");
556
    assert!(runs_of(&h.app, "andy", "quiet").await.is_empty(), "turned off despite andy/*");
557
}
558
559
/// "Run pipeline" and "Re-run" (hub spec §13.2): runs that move no
560
/// bookmark, through the API and the pages.
561
#[tokio::test(flavor = "multi_thread")]
562
async fn runs_start_without_a_push_and_finished_runs_re_run() {
563
    let h = hub().await;
564
    // The site token acts as the first site administrator.
565
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
566
    create(&h.app, "andy", "demo").await;
567
    let url = format!("{}/andy/demo", h.base);
568
    let work = tempfile::tempdir().unwrap();
569
    let c = client(&url, work.path());
570
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
571
    write(work.path(), "test.sh", "echo ok\n");
572
    c.commit("Add a pipeline", &[]).unwrap();
573
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
574
    let first = runs_of(&h.app, "andy", "demo").await;
575
    assert_eq!((first.len(), first[0].trigger.as_str()), (1, "push"));
576
577
    // Run pipeline on the default bookmark: a new run of the same state.
578
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some("{}".into())).await;
579
    assert_eq!(st, StatusCode::CREATED, "{body}");
580
    let v: serde_json::Value = serde_json::from_str(&body).unwrap();
581
    assert_eq!(v["number"], 2);
582
    assert!(v["url"].as_str().unwrap().ends_with("/andy/demo/flow/2"));
583
    let second = db::flow::run(&h.app.db, first[0].repo_id, 2).await.unwrap().unwrap();
584
    assert_eq!((second.trigger.as_str(), second.actor.as_str(), second.state.as_str()), ("manual", "andy", first[0].state.as_str()));
585
    assert_eq!(db::flow::jobs(&h.app.db, second.id).await.unwrap().len(), 3);
586
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/2", None, None).await;
587
    assert!(page.contains("started by andy"), "the run page says what started it");
588
589
    // A live run is not re-run; unknown bookmarks and runs are refused.
590
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/1/rerun", Some("site"), None).await;
591
    assert!(st == StatusCode::CONFLICT && body.contains("still queued"), "{st} {body}");
592
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some(r#"{"bookmark":"nope"}"#.into())).await;
593
    assert_eq!(st, StatusCode::CONFLICT);
594
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/99/rerun", Some("site"), None).await;
595
    assert_eq!(st, StatusCode::NOT_FOUND);
596
    // Anonymous callers cannot start runs.
597
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", None, Some("{}".into())).await;
598
    assert_ne!(st, StatusCode::CREATED);
599
600
    // A finished run re-runs as a new run of the same state.
601
    let row = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
602
    for r in [&first[0], &second] {
603
        for j in db::flow::jobs(&h.app.db, r.id).await.unwrap() {
604
            sqlx::query("UPDATE flow_jobs SET status = 'passed' WHERE id = ?").bind(j.id).execute(&h.app.db).await.unwrap();
605
        }
606
        sqlx::query("UPDATE flow_runs SET status = 'passed', finished_ms = 1 WHERE id = ?").bind(r.id).execute(&h.app.db).await.unwrap();
607
    }
608
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/1/rerun", Some("site"), None).await;
609
    assert_eq!(st, StatusCode::CREATED, "{body}");
610
    let third = db::flow::run(&h.app.db, row.id, 3).await.unwrap().unwrap();
611
    assert_eq!((third.trigger.as_str(), third.status.as_str(), third.state.as_str()), ("rerun:1", "queued", first[0].state.as_str()));
612
    let checks = db::hooks::checks_for_state(&h.app.db, row.id, &third.state).await.unwrap();
613
    assert!(
614
        checks.iter().all(|c| c.status == "queued" && c.url.ends_with("/flow/3")),
615
        "the re-run's checks replace the old ones: {checks:?}"
616
    );
617
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/3", None, None).await;
618
    assert!(page.contains("re-run of #1 by andy"));
619
    assert!(!page.contains("RE-RUN"), "anonymous viewers get no button");
620
621
    // With Flow off, nothing starts.
622
    db::repos::set_flow(&h.app.db, row.id, "off").await.unwrap();
623
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some("{}".into())).await;
624
    assert!(st == StatusCode::CONFLICT && body.contains("not enabled"), "{body}");
625
}
626
627
/// The Flow API (hub spec §13.2): runs, a run with its jobs, a job's log,
628
/// checks by the heads a client has, and JSON for unknown API routes.
629
#[tokio::test(flavor = "multi_thread")]
630
async fn runs_jobs_and_logs_are_in_the_api() {
631
    let h = hub().await;
632
    create(&h.app, "andy", "demo").await;
633
    let url = format!("{}/andy/demo", h.base);
634
    let work = tempfile::tempdir().unwrap();
635
    let c = client(&url, work.path());
636
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
637
    write(work.path(), "test.sh", "echo ok\n");
638
    let head = c.commit("Add a pipeline", &[]).unwrap();
639
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
640
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
641
642
    // A job runs and logs.
643
    let a = claim(&h.app).await.unwrap();
644
    let id = a["job_id"].as_i64().unwrap();
645
    let recs =
646
        serde_json::json!({ "records": [{ "t": 1, "stream": "stdout", "text": "one" }, { "t": 3, "stream": "stderr", "text": "three" }] });
647
    let (st, _) = call(&h.app, "POST", &format!("/api/v1/flow/jobs/{id}/log"), Some("runner-secret"), Some(recs.to_string())).await;
648
    assert!(st.is_success(), "{st}");
649
650
    let (st, body) = call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs", None, None).await;
651
    assert_eq!(st, StatusCode::OK, "{body}");
652
    let runs: Vec<hub_api::FlowRun> = serde_json::from_str(&body).unwrap();
653
    assert_eq!(runs.len(), 1);
654
    assert_eq!((runs[0].number, runs[0].state.as_str(), runs[0].trigger.as_str()), (1, run.state.as_str(), "push"));
655
    assert!(runs[0].url.ends_with("/andy/demo/flow/1") && runs[0].jobs.is_empty());
656
657
    let (_, body) = call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs/1", None, None).await;
658
    let one: hub_api::FlowRun = serde_json::from_str(&body).unwrap();
659
    let names: Vec<(&str, &str)> = one.jobs.iter().map(|j| (j.name.as_str(), j.status.as_str())).collect();
660
    assert_eq!(names.len(), 3);
661
    let running = one.jobs.iter().find(|j| j.status == "running").unwrap();
662
    assert_eq!(running.name, a["job"]["name"].as_str().unwrap());
663
    assert!(one.jobs.iter().any(|j| j.name == "test" && j.depends_on == ["build"]));
664
665
    let job = running.name.clone();
666
    let (st, body) = call(&h.app, "GET", &format!("/api/v1/repos/andy/demo/flow/runs/1/jobs/{job}/log"), None, None).await;
667
    assert_eq!(st, StatusCode::OK, "{body}");
668
    let lines: Vec<hub_api::FlowLogLine> = serde_json::from_str(&body).unwrap();
669
    assert!(lines.iter().any(|l| l.text == "three"), "{body}");
670
    let last = lines.last().unwrap().seq;
671
    let (_, body) = call(&h.app, "GET", &format!("/api/v1/repos/andy/demo/flow/runs/1/jobs/{job}/log?after={last}"), None, None).await;
672
    assert_eq!(body, "[]", "nothing after the last line");
673
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs/9", None, None).await.0, StatusCode::NOT_FOUND);
674
    assert_eq!(call(&h.app, "GET", "/api/v1/repos/andy/demo/flow/runs/1/jobs/nope/log", None, None).await.0, StatusCode::NOT_FOUND);
675
676
    // Checks by the state hash, by the head `oxy log` shows, and by bookmark.
677
    let by = |key: String| {
678
        let app = h.app.clone();
679
        async move {
680
            let (st, body) = call(&app, "GET", &format!("/api/v1/repos/andy/demo/checks/{key}"), None, None).await;
681
            assert_eq!(st, StatusCode::OK, "{key}: {body}");
682
            serde_json::from_str::<Vec<hub_api::Check>>(&body).unwrap().len()
683
        }
684
    };
685
    checks_when(&h.app, run.repo_id, &run.state, 3).await;
686
    assert_eq!(by(run.state.clone()).await, 3);
687
    assert_eq!(by(head.to_hex()).await, 3, "a single head names its state");
688
    assert_eq!(by("main".into()).await, 3);
689
    let (st, _) = call(&h.app, "GET", "/api/v1/repos/andy/demo/checks/no-such-bookmark", None, None).await;
690
    assert_eq!(st, StatusCode::NOT_FOUND);
691
692
    // An unknown API route answers with a problem document.
693
    let (st, body) = call(&h.app, "GET", "/api/v1/users/andy/repos", None, None).await;
694
    assert_eq!(st, StatusCode::NOT_FOUND);
695
    let v: serde_json::Value = serde_json::from_str(&body).unwrap();
696
    assert_eq!(v["status"], 404, "{body}");
697
}