OXYGENHUB
# db72849cd22e oxygenhub / crates / hub / tests / api.rs
14.1 KiB · Rust · last changed Clippy: check reports as a struct; no needless borrow; unused test imports (lint gate correction) 1 month ago source blame history raw
1
//! Milestone 0.5 end to end: the JSON API with scoped tokens, webhooks
2
//! delivered to a local receiver with signatures and retries, checks on a
3
//! projected state that gate landing, and the proposal event stream.
4
5
use axum::body::Body;
6
use axum::http::{header, Request, StatusCode};
7
use axum::routing::post;
8
use axum::Router;
9
use http_body_util::BodyExt;
10
use oxy_core::repo::Repo;
11
use oxygenhub::config::Config;
12
use oxygenhub::Shared;
13
use std::path::Path;
14
use std::sync::{Arc, Mutex};
15
use tower::ServiceExt;
16
17
fn hermetic() {
18
    static ONCE: std::sync::Once = std::sync::Once::new();
19
    static DIR: std::sync::OnceLock<tempfile::TempDir> = std::sync::OnceLock::new();
20
    ONCE.call_once(|| {
21
        let d = tempfile::tempdir().unwrap();
22
        std::env::set_var("OXY_HOME", d.path());
23
        DIR.set(d).ok();
24
    });
25
}
26
27
fn write(root: &Path, rel: &str, content: &[u8]) {
28
    let p = root.join(rel);
29
    std::fs::create_dir_all(p.parent().unwrap()).unwrap();
30
    std::fs::write(p, content).unwrap();
31
}
32
33
struct Hub {
34
    app: Shared,
35
    base: String,
36
    _dir: tempfile::TempDir,
37
}
38
39
async fn hub() -> Hub {
40
    hermetic();
41
    let dir = tempfile::tempdir().unwrap();
42
    let mut config = Config::load(dir.path()).unwrap();
43
    config.auth.push_tokens = vec!["site".into()];
44
    config.registration.mode = "open".into();
45
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
46
    let port = listener.local_addr().unwrap().port();
47
    config.server.base_url = format!("http://127.0.0.1:{port}");
48
    let app = oxygenhub::build(config).await.unwrap();
49
    let router = oxygenhub::router(app.clone());
50
    tokio::spawn(async move { axum::serve(listener, router).await.unwrap() });
51
    Hub { app, base: format!("http://127.0.0.1:{port}"), _dir: dir }
52
}
53
54
struct Res {
55
    status: StatusCode,
56
    body: String,
57
    cookie: Option<String>,
58
}
59
60
async fn call(
61
    app: &Shared,
62
    method: &str,
63
    path: &str,
64
    bearer: Option<&str>,
65
    cookie: Option<&str>,
66
    json: Option<&str>,
67
    form: Option<&str>,
68
) -> Res {
69
    let mut req = Request::builder().method(method).uri(path);
70
    if let Some(b) = bearer {
71
        req = req.header(header::AUTHORIZATION, format!("Bearer {b}"));
72
    }
73
    if let Some(c) = cookie {
74
        req = req.header(header::COOKIE, format!("oxyhub={c}"));
75
    }
76
    let body = if let Some(j) = json {
77
        req = req.header(header::CONTENT_TYPE, "application/json");
78
        Body::from(j.to_string())
79
    } else if let Some(f) = form {
80
        req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
81
        Body::from(f.to_string())
82
    } else {
83
        Body::empty()
84
    };
85
    let res = oxygenhub::router(app.clone()).oneshot(req.body(body).unwrap()).await.unwrap();
86
    let status = res.status();
87
    let cookie = res
88
        .headers()
89
        .get(header::SET_COOKIE)
90
        .and_then(|v| v.to_str().ok())
91
        .and_then(|v| v.split(';').next())
92
        .and_then(|kv| kv.split_once('='))
93
        .map(|(_, v)| v.to_string());
94
    let bytes = res.into_body().collect().await.unwrap().to_bytes();
95
    Res { status, body: String::from_utf8_lossy(&bytes).into_owned(), cookie }
96
}
97
98
async fn api(app: &Shared, method: &str, path: &str, bearer: Option<&str>, json: Option<&str>) -> (StatusCode, serde_json::Value) {
99
    let r = call(app, method, path, bearer, None, json, None).await;
100
    let v = serde_json::from_str(&r.body).unwrap_or(serde_json::Value::String(r.body.clone()));
101
    (r.status, v)
102
}
103
104
fn csrf_of(page: &str) -> String {
105
    let i = page.find("name=\"_csrf\" value=\"").expect("csrf field") + "name=\"_csrf\" value=\"".len();
106
    page[i..].split('"').next().unwrap().to_string()
107
}
108
109
/// A webhook receiver that records what it gets and fails the first time.
110
struct Receiver {
111
    url: String,
112
    seen: Arc<Mutex<Vec<(String, String, String)>>>,
113
    fail_first: Arc<Mutex<bool>>,
114
}
115
116
async fn receiver() -> Receiver {
117
    let seen: Arc<Mutex<Vec<(String, String, String)>>> = Arc::new(Mutex::new(vec![]));
118
    let fail_first = Arc::new(Mutex::new(true));
119
    let (s2, f2) = (seen.clone(), fail_first.clone());
120
    let router = Router::new().route(
121
        "/hook",
122
        post(move |headers: header::HeaderMap, body: String| {
123
            let (s2, f2) = (s2.clone(), f2.clone());
124
            async move {
125
                let event = headers.get("x-oxyhub-event").and_then(|v| v.to_str().ok()).unwrap_or("").to_string();
126
                let sig = headers.get("x-oxyhub-signature").and_then(|v| v.to_str().ok()).unwrap_or("").to_string();
127
                let mut f = f2.lock().unwrap();
128
                if *f {
129
                    *f = false;
130
                    return (StatusCode::INTERNAL_SERVER_ERROR, "flaky");
131
                }
132
                s2.lock().unwrap().push((event, sig, body));
133
                (StatusCode::OK, "ok")
134
            }
135
        }),
136
    );
137
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
138
    let port = listener.local_addr().unwrap().port();
139
    tokio::spawn(async move { axum::serve(listener, router).await.unwrap() });
140
    Receiver { url: format!("http://127.0.0.1:{port}/hook"), seen, fail_first }
141
}
142
143
#[tokio::test(flavor = "multi_thread")]
144
async fn api_webhooks_and_checks() {
145
    let h = hub().await;
146
    let app = &h.app;
147
    // Accounts and tokens through the pages.
148
    let r =
149
        call(app, "POST", "/register", None, None, None, Some("username=andy&email=a%40example.com&password=correct-horse-battery")).await;
150
    let andy = r.cookie.unwrap();
151
    let r =
152
        call(app, "POST", "/register", None, None, None, Some("username=bob&email=b%40example.com&password=correct-horse-battery")).await;
153
    let bob = r.cookie.unwrap();
154
    let mint = |cookie: String, scopes: &'static str| {
155
        let app = app.clone();
156
        async move {
157
            let page = call(&app, "GET", "/settings/tokens", None, Some(&cookie), None, None).await;
158
            let csrf = csrf_of(&page.body);
159
            let r = call(&app, "POST", "/settings/tokens", None, Some(&cookie), None, Some(&format!("_csrf={csrf}&name=t&{scopes}"))).await;
160
            r.body.split("oxyhub_").nth(1).map(|s| format!("oxyhub_{}", s.split('<').next().unwrap().trim())).unwrap()
161
        }
162
    };
163
    let andy_admin = mint(andy.clone(), "scopes=repo%3Aadmin").await;
164
    let andy_ro = mint(andy.clone(), "scopes=repo%3Aread").await;
165
    let bob_rw = mint(bob.clone(), "scopes=repo%3Aread&scopes=repo%3Awrite").await;
166
167
    // Create a repository through the API; the read-only token cannot.
168
    let (st, _) = api(app, "POST", "/api/v1/repos", Some(&andy_ro), Some(r#"{"owner":"andy","name":"x"}"#)).await;
169
    assert_eq!(st, StatusCode::FORBIDDEN);
170
    let (st, v) = api(
171
        app,
172
        "POST",
173
        "/api/v1/repos",
174
        Some(&andy_admin),
175
        Some(r#"{"owner":"andy","name":"demo","description":"d","visibility":"public"}"#),
176
    )
177
    .await;
178
    assert_eq!(st, StatusCode::CREATED, "{v}");
179
    assert_eq!(v["clone_url"], format!("{}/andy/demo", h.base));
180
    let (st, _) = api(app, "POST", "/api/v1/repos", Some(&andy_admin), Some(r#"{"owner":"andy","name":"demo"}"#)).await;
181
    assert_eq!(st, StatusCode::CONFLICT);
182
    let (st, _) = api(app, "GET", "/api/v1/user", Some(&andy_ro), None).await;
183
    assert_eq!(st, StatusCode::FORBIDDEN, "user:read is a scope of its own");
184
    let (st, v) = api(app, "GET", "/api/v1/users/andy", None, None).await;
185
    assert_eq!(st, StatusCode::OK);
186
    assert_eq!(v["username"], "andy");
187
188
    // A webhook on the repository; push, then see the delivery with a valid signature after a retry.
189
    let rx = receiver().await;
190
    let (st, v) = api(
191
        app,
192
        "POST",
193
        "/api/v1/repos/andy/demo/hooks",
194
        Some(&andy_admin),
195
        Some(&format!(r#"{{"url":"{}","secret":"s3","events":"push,proposal,check"}}"#, rx.url)),
196
    )
197
    .await;
198
    assert_eq!(st, StatusCode::CREATED, "{v}");
199
    let work = tempfile::tempdir().unwrap();
200
    let mut client = Repo::init(work.path()).unwrap();
201
    client.config.set("remote.origin.url", &format!("{}/andy/demo", h.base)).unwrap();
202
    client.config.set("remote.origin.token", "site").unwrap();
203
    client.save_config().unwrap();
204
    write(work.path(), "a.txt", b"a\n");
205
    client.snapshot("t").unwrap();
206
    let base = client.commit("base", &[]).unwrap();
207
    assert!(client.push("origin", false).unwrap().iter().all(|r| r.ok));
208
    // The worker retries with backoff; drive it directly for the retry.
209
    tokio::time::sleep(std::time::Duration::from_millis(400)).await;
210
    assert!(rx.seen.lock().unwrap().is_empty(), "the first attempt failed");
211
    sqlx::query("UPDATE deliveries SET next_ms = 0").execute(&app.db).await.unwrap();
212
    oxygenhub::hooks::deliver_due(app).await;
213
    let seen = rx.seen.lock().unwrap().clone();
214
    assert_eq!(seen.len(), 1, "{seen:?}");
215
    assert_eq!(seen[0].0, "push");
216
    assert_eq!(seen[0].1, oxygenhub::hooks::signature("s3", seen[0].2.as_bytes()));
217
    let payload: serde_json::Value = serde_json::from_str(&seen[0].2).unwrap();
218
    assert_eq!(payload["repository"]["name"], "demo");
219
    assert_eq!(payload["data"]["updates"][0]["reference"], "main");
220
    let (_, v) = api(app, "GET", "/api/v1/repos/andy/demo/hooks", Some(&andy_admin), None).await;
221
    assert_eq!(v.as_array().unwrap().len(), 1);
222
223
    // History, tree, file, blame, bookmarks, trust, pushes through the API.
224
    let (st, v) = api(app, "GET", "/api/v1/repos/andy/demo/history/main", None, None).await;
225
    assert_eq!(st, StatusCode::OK);
226
    assert_eq!(v["changes"][0]["hash"], base.to_hex());
227
    let (_, v) = api(app, "GET", "/api/v1/repos/andy/demo/tree/main", None, None).await;
228
    assert_eq!(v[0]["name"], "a.txt");
229
    let r = call(app, "GET", "/api/v1/repos/andy/demo/file/main/a.txt", None, None, None, None).await;
230
    assert_eq!(r.body, "a\n");
231
    let (_, v) = api(app, "GET", "/api/v1/repos/andy/demo/blame/main/a.txt", None, None).await;
232
    assert_eq!(v[0]["change"], base.to_hex());
233
    let (_, v) = api(app, "GET", &format!("/api/v1/repos/andy/demo/changes/{}", base.to_hex()), None, None).await;
234
    assert_eq!(v["files"][0]["path"], "a.txt");
235
    let (_, v) = api(app, "GET", "/api/v1/repos/andy/demo/trust", None, None).await;
236
    assert!(v["policy"].is_null());
237
    let (_, v) = api(app, "GET", "/api/v1/repos/andy/demo/pushes", None, None).await;
238
    assert_eq!(v[0]["reference"], "main");
239
240
    // Issues through the API: Bob opens one, comments, and closes it.
241
    let (st, v) = api(app, "POST", "/api/v1/repos/andy/demo/issues", Some(&bob_rw), Some(r#"{"title":"Bug","body":"it broke"}"#)).await;
242
    assert_eq!(st, StatusCode::CREATED, "{v}");
243
    assert_eq!(v["number"], 1);
244
    let (st, _) = api(app, "POST", "/api/v1/repos/andy/demo/issues/1/comments", Some(&bob_rw), Some(r#"{"body":"more"}"#)).await;
245
    assert_eq!(st, StatusCode::CREATED);
246
    let (st, v) = api(app, "POST", "/api/v1/repos/andy/demo/issues/1", Some(&bob_rw), Some(r#"{"state":"closed"}"#)).await;
247
    assert_eq!(st, StatusCode::OK, "{v}");
248
    assert_eq!(v["state"], "closed");
249
    let (_, v) = api(app, "GET", "/api/v1/repos/andy/demo/issues?state=all", None, None).await;
250
    assert_eq!(v[0]["comments"], 1);
251
    let (_, v) = api(app, "GET", "/api/v1/search?q=broke", None, None).await;
252
    assert_eq!(v[0]["number"], 1);
253
254
    // A proposal through the API, then a required check gates its landing.
255
    client.bookmark_create("feat", Some(&[base])).unwrap();
256
    client.bookmark_switch("feat", false).unwrap();
257
    write(work.path(), "b.txt", b"b\n");
258
    client.snapshot("t").unwrap();
259
    let feat = client.commit("feat", &[]).unwrap();
260
    assert!(client.push_bookmark("origin", "feat", false).unwrap().iter().all(|r| r.ok));
261
    let (st, v) =
262
        api(app, "POST", "/api/v1/repos/andy/demo/proposals", Some(&bob_rw), Some(r#"{"title":"Feat","target":"main","source":"feat"}"#))
263
            .await;
264
    assert_eq!(st, StatusCode::CREATED, "{v}");
265
    assert_eq!(v["number"], 2);
266
    let state = v["projected_state"].as_str().unwrap().to_string();
267
    assert_eq!(v["landable"], true);
268
    // Require the "build" check.
269
    let settings = call(app, "GET", "/andy/demo/settings", None, Some(&andy), None, None).await;
270
    let csrf = csrf_of(&settings.body);
271
    assert_eq!(
272
        call(app, "POST", "/andy/demo/settings/checks", None, Some(&andy), None, Some(&format!("_csrf={csrf}&required_checks=build")))
273
            .await
274
            .status,
275
        StatusCode::OK
276
    );
277
    let (_, v) = api(app, "GET", "/api/v1/repos/andy/demo/proposals/2", None, None).await;
278
    assert_eq!(v["landable"], false);
279
    assert!(v["blockers"][0].as_str().unwrap().contains("build"), "{v}");
280
    // A checker reports on the projected state: first running, then passed; the page streams it.
281
    let (st, v) = api(
282
        app,
283
        "POST",
284
        "/api/v1/repos/andy/demo/checks",
285
        Some(&andy_ro),
286
        Some(&format!(r#"{{"state":"{state}","name":"build","status":"running"}}"#)),
287
    )
288
    .await;
289
    assert_eq!(st, StatusCode::FORBIDDEN, "{v}");
290
    let mut events = app.events.proposals.subscribe();
291
    let (st, v) = api(
292
        app,
293
        "POST",
294
        "/api/v1/repos/andy/demo/checks",
295
        Some(&bob_rw),
296
        Some(&format!(r#"{{"state":"{state}","name":"build","status":"passed","summary":"42 tests","url":"https://ci.example/1"}}"#)),
297
    )
298
    .await;
299
    assert_eq!(st, StatusCode::CREATED, "{v}");
300
    let (_, ev) = events.recv().await.unwrap();
301
    assert_eq!(ev.kind, "check");
302
    assert_eq!(ev.check.unwrap().name, "build");
303
    let (_, v) = api(app, "GET", "/api/v1/repos/andy/demo/proposals/2/checks", None, None).await;
304
    assert_eq!(v[0]["status"], "passed");
305
    let (_, v) = api(app, "GET", "/api/v1/repos/andy/demo/proposals/2", None, None).await;
306
    assert_eq!(v["landable"], true, "{v}");
307
    let page = call(app, "GET", "/andy/demo/proposal/2", None, Some(&andy), None, None).await;
308
    assert!(page.body.contains("42 tests"), "{}", page.body);
309
    // The check and the proposal reached the webhook too.
310
    sqlx::query("UPDATE deliveries SET next_ms = 0").execute(&app.db).await.unwrap();
311
    oxygenhub::hooks::deliver_due(app).await;
312
    let kinds: Vec<String> = rx.seen.lock().unwrap().iter().map(|s| s.0.clone()).collect();
313
    assert!(kinds.contains(&"proposal.opened".to_string()) && kinds.contains(&"check".to_string()), "{kinds:?}");
314
    let _ = feat;
315
    let _ = rx.fail_first;
316
}