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