OXYGENHUB
# 1edac4b68c6d oxygenhub / crates / hub / tests / flow.rs
31.4 KiB · Rust · last changed Run pipeline and Re-run: runs that move no bookmark 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
#[tokio::test(flavor = "multi_thread")]
134
async fn a_push_runs_the_pipeline_through_a_runner() {
135
    let h = hub().await;
136
    create(&h.app, "andy", "demo").await;
137
    create(&h.app, "andy", "secret").await;
138
    create(&h.app, "other", "plain").await;
139
    let url = format!("{}/andy/demo", h.base);
140
    let work = tempfile::tempdir().unwrap();
141
    let mut c = client(&url, work.path());
142
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
143
    write(work.path(), "test.sh", "echo ok\n");
144
    c.snapshot("test").unwrap();
145
    c.commit("Add a pipeline", &[]).unwrap();
146
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
147
148
    // The push started a run with three queued jobs, and checks for them.
149
    let runs = runs_of(&h.app, "andy", "demo").await;
150
    assert_eq!(runs.len(), 1);
151
    let run = &runs[0];
152
    assert_eq!((run.bookmark.as_str(), run.status.as_str(), run.actor.as_str()), ("main", "queued", "site token"));
153
    assert_eq!(run.pipeline_hash.len(), 64);
154
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
155
    assert_eq!(jobs.iter().map(|j| (j.name.as_str(), j.depth)).collect::<Vec<_>>(), [("build", 0), ("lint", 0), ("test", 1)]);
156
    let checks = db::hooks::checks_for_state(&h.app.db, run.repo_id, &run.state).await.unwrap();
157
    assert_eq!(
158
        checks.iter().map(|c| (c.name.as_str(), c.status.as_str())).collect::<Vec<_>>(),
159
        [("flow/build", "queued"), ("flow/lint", "queued"), ("flow/test", "queued")]
160
    );
161
162
    // Runners need a runner token.
163
    assert_eq!(
164
        call(&h.app, "POST", "/api/v1/flow/claim", Some("site"), Some(r#"{"runner":"x","runtimes":["microvm"]}"#.into())).await.0,
165
        StatusCode::UNAUTHORIZED
166
    );
167
    assert_eq!(
168
        call(&h.app, "POST", "/api/v1/flow/claim", None, Some(r#"{"runner":"x","runtimes":["microvm"]}"#.into())).await.0,
169
        StatusCode::UNAUTHORIZED
170
    );
171
    // A runner without the tier gets nothing.
172
    let (st, _) =
173
        call(&h.app, "POST", "/api/v1/flow/claim", Some("runner-secret"), Some(r#"{"runner":"x","runtimes":["wasm"]}"#.into())).await;
174
    assert_eq!(st, StatusCode::NO_CONTENT);
175
176
    // Claims come in dependency order; `test` waits for `build`.
177
    let a = claim(&h.app).await.unwrap();
178
    let b = claim(&h.app).await.unwrap();
179
    assert_eq!((a["job"]["name"].as_str(), b["job"]["name"].as_str()), (Some("build"), Some("lint")));
180
    assert!(claim(&h.app).await.is_none(), "test waits for build");
181
    assert_eq!(a["repo"], "andy/demo");
182
    assert_eq!(a["clone_url"], url.as_str());
183
    assert_eq!(a["sandbox"]["rootfs"], ROOTFS);
184
    assert_eq!(a["job"]["exec"], serde_json::json!(["make"]));
185
    assert_eq!(a["timeout_s"], 3600);
186
    let heads: Vec<String> = a["heads"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_string()).collect();
187
    assert_eq!(heads.join("+"), run.heads);
188
    let checks = db::hooks::checks_for_state(&h.app.db, run.repo_id, &run.state).await.unwrap();
189
    assert_eq!(checks.iter().find(|c| c.name == "flow/build").unwrap().status, "running");
190
191
    // The job token reads this repository over the wire, and nothing else.
192
    let token = a["token"].as_str().unwrap().to_string();
193
    assert!(token.starts_with("flowjob_"));
194
    let opts = RemoteOptions { token: Some(token.clone()), ca: None, repo_id: None };
195
    open_remote(&url, &opts).unwrap().refs().unwrap();
196
    assert!(open_remote(&format!("{}/andy/secret", h.base), &opts).unwrap().refs().is_err(), "another repository");
197
    let bad = RemoteOptions { token: Some("flowjob_00".into()), ca: None, repo_id: None };
198
    assert!(open_remote(&url, &bad).unwrap().refs().is_err(), "an unknown job token");
199
    // … and cannot push.
200
    c.config.set("remote.origin.token", &token).unwrap();
201
    c.save_config().unwrap();
202
    write(work.path(), "more.txt", "x\n");
203
    c.snapshot("test").unwrap();
204
    c.commit("More", &[]).unwrap();
205
    let pushed = c.push("origin", false);
206
    assert!(pushed.is_err() || pushed.unwrap().iter().all(|r| !r.ok), "a job token cannot push");
207
    c.config.set("remote.origin.token", "site").unwrap();
208
    c.save_config().unwrap();
209
210
    // Logs, then results with receipts.
211
    let a_id = a["job_id"].as_i64().unwrap();
212
    let b_id = b["job_id"].as_i64().unwrap();
213
    let log = serde_json::json!({ "records": [
214
        { "t": 5, "stream": "flow", "text": "booting" },
215
        { "t": 120, "stream": "out", "text": "cc -o demo demo.c" },
216
        { "t": 130, "stream": "weird", "text": "x".repeat(20_000) },
217
    ]});
218
    assert_eq!(
219
        call(&h.app, "POST", &format!("/api/v1/flow/jobs/{a_id}/log"), Some("runner-secret"), Some(log.to_string())).await.0,
220
        StatusCode::NO_CONTENT
221
    );
222
    let lines = db::flow::log(&h.app.db, a_id, 0, 100).await.unwrap();
223
    assert_eq!(lines.len(), 3);
224
    assert_eq!((lines[2].stream.as_str(), lines[2].text.len()), ("console", 16 * 1024), "streams are known ones, text is capped");
225
    let ph = a["pipeline_hash"].as_str().unwrap();
226
    assert_eq!(
227
        finish(&h.app, a_id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": receipt("lint", ph, 0) })).await,
228
        StatusCode::BAD_REQUEST,
229
        "a receipt for another job"
230
    );
231
    assert_eq!(
232
        finish(&h.app, a_id, serde_json::json!({ "exit_code": 0, "duration_ms": 700, "receipt": receipt("build", ph, 0) })).await,
233
        StatusCode::NO_CONTENT
234
    );
235
    assert_eq!(finish(&h.app, a_id, serde_json::json!({ "exit_code": 0, "duration_ms": 700 })).await, StatusCode::CONFLICT, "only once");
236
    assert!(open_remote(&url, &opts).unwrap().refs().is_err(), "the token ends with its job");
237
    assert_eq!(
238
        finish(&h.app, b_id, serde_json::json!({ "exit_code": 0, "duration_ms": 300, "receipt": receipt("lint", ph, 0) })).await,
239
        StatusCode::NO_CONTENT
240
    );
241
    let t = claim(&h.app).await.unwrap();
242
    assert_eq!(t["job"]["name"], "test");
243
    let t_id = t["job_id"].as_i64().unwrap();
244
    assert_eq!(
245
        finish(&h.app, t_id, serde_json::json!({ "exit_code": 3, "duration_ms": 500, "receipt": receipt("test", ph, 3) })).await,
246
        StatusCode::NO_CONTENT
247
    );
248
249
    let run = db::flow::run_by_id(&h.app.db, run.id).await.unwrap().unwrap();
250
    assert_eq!(run.status, "failed");
251
    let jobs = db::flow::jobs(&h.app.db, run.id).await.unwrap();
252
    let build = jobs.iter().find(|j| j.name == "build").unwrap();
253
    assert_eq!((build.status.as_str(), build.exit_code, build.receipt_hash.len()), ("passed", Some(0), 64));
254
    assert_eq!(jobs.iter().find(|j| j.name == "test").unwrap().status, "failed");
255
    let checks = db::hooks::checks_for_state(&h.app.db, run.repo_id, &run.state).await.unwrap();
256
    assert_eq!(
257
        checks.iter().map(|c| (c.name.as_str(), c.status.as_str())).collect::<Vec<_>>(),
258
        [("flow/build", "passed"), ("flow/lint", "passed"), ("flow/test", "failed")]
259
    );
260
    assert!(checks[2].summary.contains("exit 3") && checks[2].url.ends_with(&format!("/andy/demo/flow/{}", run.number)));
261
262
    // Pages: the list, the run with its graph and logs, and the live view.
263
    let (st, list) = call(&h.app, "GET", "/andy/demo/flow", None, None).await;
264
    assert_eq!(st, StatusCode::OK);
265
    assert!(list.contains(&format!("/andy/demo/flow/{}", run.number)) && list.contains("st-failed"), "{list}");
266
    let (st, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", run.number), None, None).await;
267
    assert_eq!(st, StatusCode::OK);
268
    assert!(page.contains("<svg class=\"flow-graph\""), "graph");
269
    assert_eq!(page.matches("data-job-node=").count(), 3);
270
    assert_eq!(page.matches("<path class=\"edge").count(), 1, "one dependency edge");
271
    assert!(page.contains("cc -o demo demo.c"), "log shown");
272
    assert!(!page.contains("data-flow-live"), "a finished run does not poll");
273
    let (st, live) = call(&h.app, "GET", &format!("/andy/demo/flow/{}/live?after={a_id}:1", run.number), None, None).await;
274
    assert_eq!(st, StatusCode::OK);
275
    let live: serde_json::Value = serde_json::from_str(&live).unwrap();
276
    assert_eq!(live["status"], "failed");
277
    let build_live = live["jobs"].as_array().unwrap().iter().find(|j| j["name"] == "build").unwrap().clone();
278
    assert_eq!(build_live["lines"].as_array().unwrap().len(), 2, "lines after seq 1");
279
    assert_eq!(call(&h.app, "GET", "/andy/demo/flow/999", None, None).await.0, StatusCode::NOT_FOUND);
280
281
    // A failed dependency skips what follows; an unrun job is an error.
282
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
283
    write(work.path(), "test.sh", "echo changed\n");
284
    c.snapshot("test").unwrap();
285
    c.commit("Change the test", &[]).unwrap();
286
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
287
    let mut second = None;
288
    for _ in 0..100 {
289
        let r = runs_of(&h.app, "andy", "demo").await;
290
        if r.len() == 2 {
291
            second = Some(r[0].clone());
292
            break;
293
        }
294
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
295
    }
296
    let second = second.expect("a second run");
297
    let x = claim(&h.app).await.unwrap();
298
    let y = claim(&h.app).await.unwrap();
299
    let (build_id, lint_id) = if x["job"]["name"] == "build" {
300
        (x["job_id"].as_i64().unwrap(), y["job_id"].as_i64().unwrap())
301
    } else {
302
        (y["job_id"].as_i64().unwrap(), x["job_id"].as_i64().unwrap())
303
    };
304
    assert_eq!(
305
        finish(&h.app, build_id, serde_json::json!({ "exit_code": null, "duration_ms": 10, "error": "rootfs is not on this runner" }))
306
            .await,
307
        StatusCode::NO_CONTENT
308
    );
309
    assert_eq!(finish(&h.app, lint_id, serde_json::json!({ "exit_code": 0, "duration_ms": 10 })).await, StatusCode::NO_CONTENT);
310
    assert!(claim(&h.app).await.is_none(), "test was skipped");
311
    let jobs = db::flow::jobs(&h.app.db, second.id).await.unwrap();
312
    assert_eq!(
313
        jobs.iter().map(|j| (j.name.as_str(), j.status.as_str())).collect::<Vec<_>>(),
314
        [("build", "error"), ("lint", "passed"), ("test", "skipped")]
315
    );
316
    assert_eq!(db::flow::run_by_id(&h.app.db, second.id).await.unwrap().unwrap().status, "failed");
317
318
    // An invalid pipeline is a run in error with the line.
319
    write(work.path(), ".flow/pipeline.kdl", &pipeline("job \"broken\" {\n    sandbox \"missing\"\n    exec \"x\"\n}\n"));
320
    c.snapshot("test").unwrap();
321
    c.commit("Break the pipeline", &[]).unwrap();
322
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
323
    let mut third = None;
324
    for _ in 0..100 {
325
        let r = runs_of(&h.app, "andy", "demo").await;
326
        if r.len() == 3 {
327
            third = Some(r[0].clone());
328
            break;
329
        }
330
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
331
    }
332
    let third = third.expect("a third run");
333
    assert_eq!(third.status, "error");
334
    assert!(third.error.contains("line 18") && third.error.contains("\"missing\""), "{}", third.error);
335
    let (_, page) = call(&h.app, "GET", &format!("/andy/demo/flow/{}", third.number), None, None).await;
336
    assert!(page.contains("The pipeline is not valid"));
337
338
    // State stamps (hub spec §13.2) and images in READMEs.
339
    write(work.path(), "README.md", "# Demo\n\n[![flow](.flow/stamp)](.flow/run)\n\n![logo](img/logo.png)\n");
340
    std::fs::create_dir_all(work.path().join("img")).unwrap();
341
    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")
342
        .unwrap();
343
    c.snapshot("test").unwrap();
344
    c.commit("A README with a stamp", &[]).unwrap();
345
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
346
    let mut fourth = None;
347
    for _ in 0..100 {
348
        let r = runs_of(&h.app, "andy", "demo").await;
349
        if r.len() == 4 {
350
            fourth = Some(r[0].clone());
351
            break;
352
        }
353
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
354
    }
355
    let fourth = fourth.expect("a fourth run");
356
    let (_, overview) = call(&h.app, "GET", "/andy/demo", None, None).await;
357
    assert!(overview.contains("src=\"/andy/demo/raw/main/.flow/stamp\""), "{overview}");
358
    assert!(overview.contains("href=\"/andy/demo/file/main/.flow/run\""));
359
    assert!(overview.contains("src=\"/andy/demo/raw/main/img/logo.png\""), "images use the raw route");
360
    let (st, _, ct) = head(&h.app, "/andy/demo/raw/main/img/logo.png").await;
361
    assert_eq!((st, ct.as_str()), (StatusCode::OK, "image/png"));
362
    let (st, loc, _) = head(&h.app, "/andy/demo/raw/main/.flow/stamp").await;
363
    assert!(st.is_redirection() && loc == "/andy/demo/flow/stamp/main", "{st} {loc}");
364
    let (st, loc, _) = head(&h.app, "/andy/demo/flow/stamp/main").await;
365
    assert!(st.is_redirection() && loc == format!("/andy/demo/flow/stamp/{}", fourth.heads), "a bookmark's stamp names its state: {loc}");
366
    let (st, _, ct) = head(&h.app, &loc).await;
367
    assert_eq!((st, ct.as_str()), (StatusCode::OK, "image/svg+xml; charset=utf-8"));
368
    let (_, svg) = call(&h.app, "GET", &loc, None, None).await;
369
    assert!(svg.starts_with("<svg") && svg.contains("error ·") && svg.contains(&fourth.heads[..12]), "{svg}");
370
    let (_, svg1) = call(&h.app, "GET", &format!("/andy/demo/flow/stamp/{}", run.heads), None, None).await;
371
    assert!(svg1.contains("failed ·") && svg1.contains(&format!("run #{} failed", run.id)), "an older state keeps its own result: {svg1}");
372
    assert!(svg1.contains(&build.receipt_hash), "receipt hashes in the metadata");
373
    assert_eq!(svg1.matches("text-anchor=\"middle\"").count(), 3, "one glyph per job");
374
    let (st, loc, _) = head(&h.app, "/andy/demo/file/main/.flow/run").await;
375
    assert!(st.is_redirection() && loc == "/andy/demo/flow/at/main", "{loc}");
376
    let (st, loc, _) = head(&h.app, "/andy/demo/flow/at/main").await;
377
    assert!(st.is_redirection() && loc == format!("/andy/demo/flow/{}", fourth.id), "{loc}");
378
379
    // A repository outside [flow] repos starts nothing.
380
    let work2 = tempfile::tempdir().unwrap();
381
    let c2 = client(&format!("{}/other/plain", h.base), work2.path());
382
    write(work2.path(), ".flow/pipeline.kdl", &pipeline(""));
383
    c2.snapshot("test").unwrap();
384
    c2.commit("Pipeline", &[]).unwrap();
385
    assert!(c2.push("origin", false).unwrap().iter().all(|r| r.ok));
386
    tokio::time::sleep(std::time::Duration::from_millis(500)).await;
387
    let row = db::repos::get(&h.app.db, "other", "plain").await.unwrap().unwrap();
388
    assert!(db::flow::runs(&h.app.db, row.id, 10, None).await.unwrap().is_empty());
389
    let (_, page) = call(&h.app, "GET", "/other/plain/flow", None, None).await;
390
    assert!(page.contains("not enabled for this repository"));
391
    let (_, loc, _) = head(&h.app, "/other/plain/flow/stamp/main").await;
392
    let (_, svg) = call(&h.app, "GET", &loc, None, None).await;
393
    assert!(svg.contains("no run ·"), "{svg}");
394
    let (_, loc, _) = head(&h.app, "/other/plain/flow/at/main").await;
395
    assert_eq!(loc, "/other/plain/flow");
396
}
397
398
#[tokio::test(flavor = "multi_thread")]
399
async fn claims_carry_pinned_subrepos_and_the_job_token_reads_only_those() {
400
    let h = hub().await;
401
    for n in ["base", "lib", "vault", "other", "app"] {
402
        create(&h.app, "andy", n).await;
403
    }
404
    let push = |name: &str, file: &str| {
405
        let work = tempfile::tempdir().unwrap();
406
        let c = client(&format!("{}/andy/{name}", h.base), work.path());
407
        write(work.path(), file, "x\n");
408
        c.snapshot("t").unwrap();
409
        c.commit("first", &[]).unwrap();
410
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
411
        let heads = c.bookmark_heads().unwrap();
412
        (work, heads)
413
    };
414
    let (_b, base_heads) = push("base", "base.rs");
415
    // lib pins base in turn: a subrepo of a subrepo.
416
    let lib_work = tempfile::tempdir().unwrap();
417
    let lib = client(&format!("{}/andy/lib", h.base), lib_work.path());
418
    lib.submodule_add(&format!("{}/andy/base", h.base), "deps/base", Some("main")).unwrap();
419
    write(lib_work.path(), "lib.rs", "x\n");
420
    lib.snapshot("t").unwrap();
421
    lib.commit("lib on base", &[]).unwrap();
422
    assert!(lib.push("origin", false).unwrap().iter().all(|r| r.ok));
423
    let lib_heads = lib.bookmark_heads().unwrap();
424
    let (_v, _) = push("vault", "secret.rs");
425
    let (_o, _) = push("other", "o.rs");
426
427
    // The app pins lib and vault as subrepos and pushes as the site token.
428
    let work = tempfile::tempdir().unwrap();
429
    let app = client(&format!("{}/andy/app", h.base), work.path());
430
    app.submodule_add(&format!("{}/andy/lib", h.base), "deps/lib", Some("main")).unwrap();
431
    // Vault is private: adding it takes the environment's token, as a clone does.
432
    sqlx::query("UPDATE repositories SET visibility = 'private' WHERE name = 'vault'").execute(&h.app.db).await.unwrap();
433
    assert!(app.submodule_add(&format!("{}/andy/vault", h.base), "deps/vault2", Some("main")).is_err(), "not without a token");
434
    std::env::set_var("OXY_TOKEN", "site");
435
    app.submodule_add(&format!("{}/andy/vault", h.base), "deps/vault", Some("main")).unwrap();
436
    std::env::remove_var("OXY_TOKEN");
437
    // The pusher below is the site token, which has no account: it cannot read vault.
438
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
439
    write(work.path(), "Makefile", "all:\n");
440
    app.snapshot("t").unwrap();
441
    app.commit("app with deps", &[]).unwrap();
442
    assert!(app.push("origin", false).unwrap().iter().all(|r| r.ok));
443
    assert!(!runs_of(&h.app, "andy", "app").await.is_empty());
444
445
    let job = claim(&h.app).await.unwrap();
446
    let subs = job["subrepos"].as_array().cloned().unwrap_or_default();
447
    assert_eq!(subs.len(), 2, "lib and what lib pins; vault is private and the pusher has no account: {subs:?}");
448
    assert_eq!(subs[1]["path"], "deps/lib/deps/base", "nested under its parent, after it");
449
    assert_eq!(subs[1]["heads"], serde_json::json!(base_heads.iter().map(|h| h.to_hex()).collect::<Vec<_>>()));
450
    let _ = std::fs::remove_dir_all(work.path().join("deps/vault2"));
451
    assert_eq!(subs[0]["path"], "deps/lib");
452
    assert_eq!(subs[0]["repo"], "andy/lib");
453
    assert_eq!(subs[0]["heads"], serde_json::json!(lib_heads.iter().map(|h| h.to_hex()).collect::<Vec<_>>()));
454
    assert!(subs[0]["clone_url"].as_str().unwrap().ends_with("/andy/lib"));
455
456
    // The job token reads its repository and the pinned lib, nothing else.
457
    let token = job["token"].as_str().unwrap().to_string();
458
    let read = |name: &str| {
459
        let opts = RemoteOptions { token: Some(token.clone()), ..Default::default() };
460
        open_remote(&format!("{}/andy/{name}", h.base), &opts).and_then(|r| r.refs()).is_ok()
461
    };
462
    assert!(read("app") && read("lib") && read("base"));
463
    assert!(!read("vault"), "not pinned for this pusher");
464
    assert!(!read("other"), "public, but not the job's to read");
465
}
466
467
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
468
async fn concurrent_log_appends_never_fail_on_a_locked_database() {
469
    let h = hub().await;
470
    create(&h.app, "andy", "demo").await;
471
    let work = tempfile::tempdir().unwrap();
472
    let c = client(&format!("{}/andy/demo", h.base), work.path());
473
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
474
    write(work.path(), "Makefile", "all:\n");
475
    c.snapshot("t").unwrap();
476
    c.commit("pipeline", &[]).unwrap();
477
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
478
    let run = runs_of(&h.app, "andy", "demo").await.remove(0);
479
    let job = db::flow::jobs(&h.app.db, run.id).await.unwrap().remove(0);
480
    // Many writers at once, each reading the count and then inserting: a
481
    // deferred transaction would fail with "database is locked".
482
    let mut tasks = Vec::new();
483
    for w in 0..16 {
484
        let pool = h.app.db.clone();
485
        tasks.push(tokio::spawn(async move {
486
            let records: Vec<flow_core::api::Record> =
487
                (0..20).map(|i| flow_core::api::Record { t: i, stream: "out".into(), text: format!("writer {w} line {i}") }).collect();
488
            db::flow::append_log(&pool, job.id, &records, 100_000).await
489
        }));
490
    }
491
    for t in tasks {
492
        assert_eq!(t.await.unwrap().unwrap(), 20, "every append succeeds");
493
    }
494
    let lines = db::flow::log(&h.app.db, job.id, 0, 1_000).await.unwrap();
495
    assert_eq!(lines.len(), 320);
496
    let seqs: std::collections::BTreeSet<i64> = lines.iter().map(|l| l.seq).collect();
497
    assert_eq!(seqs.len(), 320, "sequence numbers are unique");
498
}
499
500
/// A repository's own Flow setting overrides hub.toml either way.
501
#[tokio::test(flavor = "multi_thread")]
502
async fn a_repository_setting_turns_flow_on_or_off() {
503
    let h = hub().await;
504
    create(&h.app, "other", "plain").await;
505
    create(&h.app, "andy", "quiet").await;
506
    // A run elsewhere first, so hub-wide ids and per-repository numbers differ.
507
    create(&h.app, "andy", "first").await;
508
    {
509
        let work = tempfile::tempdir().unwrap();
510
        let c = client(&format!("{}/andy/first", h.base), work.path());
511
        write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
512
        write(work.path(), "test.sh", "echo ok\n");
513
        c.commit("Add a pipeline", &[]).unwrap();
514
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
515
        assert_eq!(runs_of(&h.app, "andy", "first").await.len(), 1);
516
    }
517
    let row = db::repos::get(&h.app.db, "other", "plain").await.unwrap().unwrap();
518
    db::repos::set_flow(&h.app.db, row.id, "on").await.unwrap();
519
    let quiet = db::repos::get(&h.app.db, "andy", "quiet").await.unwrap().unwrap();
520
    db::repos::set_flow(&h.app.db, quiet.id, "off").await.unwrap();
521
    for (owner, name) in [("other", "plain"), ("andy", "quiet")] {
522
        let work = tempfile::tempdir().unwrap();
523
        let c = client(&format!("{}/{owner}/{name}", h.base), work.path());
524
        write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
525
        write(work.path(), "test.sh", "echo ok\n");
526
        c.commit("Add a pipeline", &[]).unwrap();
527
        assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
528
    }
529
    let plain = runs_of(&h.app, "other", "plain").await;
530
    assert_eq!(plain.len(), 1, "turned on");
531
    // Runs are numbered per repository: this is plain's first, whatever
532
    // other repositories ran before.
533
    assert_eq!(plain[0].number, 1);
534
    let checks = db::hooks::checks_for_state(&h.app.db, row.id, &plain[0].state).await.unwrap();
535
    assert!(checks.iter().all(|c| c.url.ends_with("/other/plain/flow/1")), "{checks:?}");
536
    let (st, page) = call(&h.app, "GET", "/other/plain/flow/1", None, None).await;
537
    assert!(st == StatusCode::OK && page.contains("Run #1"), "{st}");
538
    assert!(runs_of(&h.app, "andy", "quiet").await.is_empty(), "turned off despite andy/*");
539
}
540
541
/// "Run pipeline" and "Re-run" (hub spec §13.2): runs that move no
542
/// bookmark, through the API and the pages.
543
#[tokio::test(flavor = "multi_thread")]
544
async fn runs_start_without_a_push_and_finished_runs_re_run() {
545
    let h = hub().await;
546
    // The site token acts as the first site administrator.
547
    db::accounts::create_account(&h.app.db, "andy", "[email protected]", "x", "salt", true).await.unwrap();
548
    create(&h.app, "andy", "demo").await;
549
    let url = format!("{}/andy/demo", h.base);
550
    let work = tempfile::tempdir().unwrap();
551
    let c = client(&url, work.path());
552
    write(work.path(), ".flow/pipeline.kdl", &pipeline(""));
553
    write(work.path(), "test.sh", "echo ok\n");
554
    c.commit("Add a pipeline", &[]).unwrap();
555
    assert!(c.push("origin", false).unwrap().iter().all(|r| r.ok));
556
    let first = runs_of(&h.app, "andy", "demo").await;
557
    assert_eq!((first.len(), first[0].trigger.as_str()), (1, "push"));
558
559
    // Run pipeline on the default bookmark: a new run of the same state.
560
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some("{}".into())).await;
561
    assert_eq!(st, StatusCode::CREATED, "{body}");
562
    let v: serde_json::Value = serde_json::from_str(&body).unwrap();
563
    assert_eq!(v["number"], 2);
564
    assert!(v["url"].as_str().unwrap().ends_with("/andy/demo/flow/2"));
565
    let second = db::flow::run(&h.app.db, first[0].repo_id, 2).await.unwrap().unwrap();
566
    assert_eq!((second.trigger.as_str(), second.actor.as_str(), second.state.as_str()), ("manual", "andy", first[0].state.as_str()));
567
    assert_eq!(db::flow::jobs(&h.app.db, second.id).await.unwrap().len(), 3);
568
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/2", None, None).await;
569
    assert!(page.contains("started by andy"), "the run page says what started it");
570
571
    // A live run is not re-run; unknown bookmarks and runs are refused.
572
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/1/rerun", Some("site"), None).await;
573
    assert!(st == StatusCode::CONFLICT && body.contains("still queued"), "{st} {body}");
574
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some(r#"{"bookmark":"nope"}"#.into())).await;
575
    assert_eq!(st, StatusCode::CONFLICT);
576
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/99/rerun", Some("site"), None).await;
577
    assert_eq!(st, StatusCode::NOT_FOUND);
578
    // Anonymous callers cannot start runs.
579
    let (st, _) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", None, Some("{}".into())).await;
580
    assert_ne!(st, StatusCode::CREATED);
581
582
    // A finished run re-runs as a new run of the same state.
583
    let row = db::repos::get(&h.app.db, "andy", "demo").await.unwrap().unwrap();
584
    for r in [&first[0], &second] {
585
        for j in db::flow::jobs(&h.app.db, r.id).await.unwrap() {
586
            sqlx::query("UPDATE flow_jobs SET status = 'passed' WHERE id = ?").bind(j.id).execute(&h.app.db).await.unwrap();
587
        }
588
        sqlx::query("UPDATE flow_runs SET status = 'passed', finished_ms = 1 WHERE id = ?").bind(r.id).execute(&h.app.db).await.unwrap();
589
    }
590
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs/1/rerun", Some("site"), None).await;
591
    assert_eq!(st, StatusCode::CREATED, "{body}");
592
    let third = db::flow::run(&h.app.db, row.id, 3).await.unwrap().unwrap();
593
    assert_eq!((third.trigger.as_str(), third.status.as_str(), third.state.as_str()), ("rerun:1", "queued", first[0].state.as_str()));
594
    let checks = db::hooks::checks_for_state(&h.app.db, row.id, &third.state).await.unwrap();
595
    assert!(
596
        checks.iter().all(|c| c.status == "queued" && c.url.ends_with("/flow/3")),
597
        "the re-run's checks replace the old ones: {checks:?}"
598
    );
599
    let (_, page) = call(&h.app, "GET", "/andy/demo/flow/3", None, None).await;
600
    assert!(page.contains("re-run of #1 by andy"));
601
    assert!(!page.contains("RE-RUN"), "anonymous viewers get no button");
602
603
    // With Flow off, nothing starts.
604
    db::repos::set_flow(&h.app.db, row.id, "off").await.unwrap();
605
    let (st, body) = call(&h.app, "POST", "/api/v1/repos/andy/demo/flow/runs", Some("site"), Some("{}".into())).await;
606
    assert!(st == StatusCode::CONFLICT && body.contains("not enabled"), "{body}");
607
}