OXYGENHUB
# b0612e7dce30 oxygenhub / crates / hub / tests / proposals.rs
14.8 KiB · Rust · last changed Proposals from feature/ bookmarks; a landing says who and how 1 month ago source blame history raw
1
//! Milestone 0.3 end to end: a proposal from a bookmark and from a fork,
2
//! an atom-anchored comment, a seal-backed approval, requirements and a
3
//! landing from the hub.
4
5
use axum::body::Body;
6
use axum::http::{header, Request, StatusCode};
7
use http_body_util::BodyExt;
8
use oxy_core::repo::Repo;
9
use oxygenhub::config::Config;
10
use oxygenhub::db;
11
use oxygenhub::repos::RepoName;
12
use oxygenhub::Shared;
13
use std::path::Path;
14
use tower::ServiceExt;
15
16
fn hermetic() {
17
    static ONCE: std::sync::Once = std::sync::Once::new();
18
    static DIR: std::sync::OnceLock<tempfile::TempDir> = std::sync::OnceLock::new();
19
    ONCE.call_once(|| {
20
        let d = tempfile::tempdir().unwrap();
21
        std::env::set_var("OXY_HOME", d.path());
22
        DIR.set(d).ok();
23
    });
24
}
25
26
fn write(root: &Path, rel: &str, content: &[u8]) {
27
    let p = root.join(rel);
28
    std::fs::create_dir_all(p.parent().unwrap()).unwrap();
29
    std::fs::write(p, content).unwrap();
30
}
31
32
struct Hub {
33
    app: Shared,
34
    base: String,
35
    _dir: tempfile::TempDir,
36
}
37
38
async fn hub() -> Hub {
39
    hermetic();
40
    let dir = tempfile::tempdir().unwrap();
41
    let mut config = Config::load(dir.path()).unwrap();
42
    config.auth.push_tokens = vec!["site".into()];
43
    config.registration.mode = "open".into();
44
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
45
    let port = listener.local_addr().unwrap().port();
46
    config.server.base_url = format!("http://127.0.0.1:{port}");
47
    let app = oxygenhub::build(config).await.unwrap();
48
    let router = oxygenhub::router(app.clone());
49
    tokio::spawn(async move { axum::serve(listener, router).await.unwrap() });
50
    Hub { app, base: format!("http://127.0.0.1:{port}"), _dir: dir }
51
}
52
53
struct Res {
54
    status: StatusCode,
55
    body: String,
56
    cookie: Option<String>,
57
}
58
59
async fn send(app: &Shared, method: &str, path: &str, cookie: Option<&str>, form: Option<&str>, bearer: Option<&str>) -> Res {
60
    let mut req = Request::builder().method(method).uri(path);
61
    if let Some(c) = cookie {
62
        req = req.header(header::COOKIE, format!("oxyhub={c}"));
63
    }
64
    if let Some(b) = bearer {
65
        req = req.header(header::AUTHORIZATION, format!("Bearer {b}"));
66
    }
67
    let body = match form {
68
        Some(f) => {
69
            req = req.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
70
            Body::from(f.to_string())
71
        }
72
        None => Body::empty(),
73
    };
74
    let res = oxygenhub::router(app.clone()).oneshot(req.body(body).unwrap()).await.unwrap();
75
    let status = res.status();
76
    let cookie = res
77
        .headers()
78
        .get(header::SET_COOKIE)
79
        .and_then(|v| v.to_str().ok())
80
        .and_then(|v| v.split(';').next())
81
        .and_then(|kv| kv.split_once('='))
82
        .map(|(_, v)| v.to_string());
83
    let bytes = res.into_body().collect().await.unwrap().to_bytes();
84
    Res { status, body: String::from_utf8_lossy(&bytes).into_owned(), cookie }
85
}
86
87
async fn get(app: &Shared, path: &str, cookie: Option<&str>) -> Res {
88
    send(app, "GET", path, cookie, None, None).await
89
}
90
91
async fn post(app: &Shared, path: &str, cookie: Option<&str>, form: &str) -> Res {
92
    send(app, "POST", path, cookie, Some(form), None).await
93
}
94
95
/// POST a proposal action and follow its redirect back to the page, as a
96
/// browser does (actions redirect so a reload never repeats them).
97
async fn act(app: &Shared, path: &str, cookie: Option<&str>, form: &str) -> Res {
98
    let mut req = Request::builder().method("POST").uri(path).header(header::CONTENT_TYPE, "application/x-www-form-urlencoded");
99
    if let Some(c) = cookie {
100
        req = req.header(header::COOKIE, format!("oxyhub={c}"));
101
    }
102
    let res = oxygenhub::router(app.clone()).oneshot(req.body(Body::from(form.to_string())).unwrap()).await.unwrap();
103
    assert_eq!(res.status(), StatusCode::SEE_OTHER, "{path} redirects back");
104
    let to = res.headers().get(header::LOCATION).and_then(|v| v.to_str().ok()).unwrap_or("").to_string();
105
    get(app, &to, cookie).await
106
}
107
108
async fn register(app: &Shared, user: &str) -> String {
109
    let r = post(app, "/register", None, &format!("username={user}&email={user}%40example.com&password=correct-horse-battery")).await;
110
    assert_eq!(r.status, StatusCode::SEE_OTHER, "{}", r.body);
111
    r.cookie.unwrap()
112
}
113
114
fn csrf_of(page: &str) -> String {
115
    let i = page.find("name=\"_csrf\" value=\"").expect("csrf field") + "name=\"_csrf\" value=\"".len();
116
    page[i..].split('"').next().unwrap().to_string()
117
}
118
119
#[tokio::test(flavor = "multi_thread")]
120
async fn propose_review_seal_and_land() {
121
    let h = hub().await;
122
    let app = &h.app;
123
    let andy = register(app, "andy").await;
124
    let bob = register(app, "bob").await;
125
126
    // A repository with main and a feature bookmark, pushed by Andy's client.
127
    let repo = RepoName::parse("andy/demo").unwrap();
128
    app.repos.create(&repo, None).unwrap();
129
    db::repos::create(&app.db, "andy", "demo", "", hub_api::Visibility::Public).await.unwrap();
130
    let work = tempfile::tempdir().unwrap();
131
    let mut client = Repo::init(work.path()).unwrap();
132
    client.create_identity("Andy McCall", "[email protected]", oxy_core::repo::IdentityScope::User).unwrap();
133
    client.config.set("remote.origin.url", &format!("{}/andy/demo", h.base)).unwrap();
134
    client.config.set("remote.origin.token", "site").unwrap();
135
    client.config.set("core.sign", "change").unwrap();
136
    client.save_config().unwrap();
137
    write(work.path(), "a.txt", b"one\ntwo\n");
138
    write(work.path(), ".oxyowners", b"* @andy\n");
139
    client.snapshot("t").unwrap();
140
    let base = client.commit("base", &[]).unwrap();
141
    assert!(client.push("origin", false).unwrap().iter().all(|r| r.ok));
142
    client.bookmark_create("feature", Some(&[base])).unwrap();
143
    client.bookmark_switch("feature", false).unwrap();
144
    write(work.path(), "a.txt", b"one\ntwo\nthree\n");
145
    client.snapshot("t").unwrap();
146
    let feat = client.commit("add three", &[]).unwrap();
147
    assert!(client.push_bookmark("origin", "feature", false).unwrap().iter().all(|r| r.ok));
148
149
    // The compare page offers the proposal to writers only (hub spec §6.3).
150
    let cmp = get(app, "/andy/demo/compare/main...feature", Some(&andy)).await;
151
    assert!(cmp.body.contains("href=\"/andy/demo/proposals/new?source=feature&#38;target=main\">Propose this"), "{}", cmp.body);
152
    assert!(!get(app, "/andy/demo/compare/main...feature", Some(&bob)).await.body.contains("Propose this"));
153
    assert!(
154
        !get(app, "/andy/demo/compare/feature...main", Some(&andy)).await.body.contains("Propose this"),
155
        "nothing to propose the other way"
156
    );
157
158
    // Bob previews and opens a proposal feature → main.
159
    let preview = get(app, "/andy/demo/proposals/new?source=feature&target=main", Some(&bob)).await;
160
    assert_eq!(preview.status, StatusCode::OK);
161
    assert!(preview.body.contains("1 change") && preview.body.contains("add three"), "{}", preview.body);
162
    let csrf = csrf_of(&preview.body);
163
    let r =
164
        post(app, "/andy/demo/proposals/new", Some(&bob), &format!("_csrf={csrf}&title=Add+three&body=Please&target=main&source=feature"))
165
            .await;
166
    assert_eq!(r.status, StatusCode::SEE_OTHER, "{}", r.body);
167
    let page = get(app, "/andy/demo/proposal/1", Some(&bob)).await;
168
    assert_eq!(page.status, StatusCode::OK);
169
    assert!(page.body.contains("Add three") && page.body.contains("1 change"), "{}", page.body);
170
    assert!(page.body.contains("Please"));
171
    assert!(get(app, "/andy/demo/proposals", None).await.body.contains("#1"));
172
    let cmp = get(app, "/andy/demo/compare/main...feature", Some(&andy)).await;
173
    assert!(cmp.body.contains("proposal #1 is open") && !cmp.body.contains("Propose this"), "the open proposal instead");
174
175
    // A comment anchored to line 3 of a.txt lands in the thread on the files tab.
176
    let files = get(app, "/andy/demo/proposal/1?tab=files", Some(&bob)).await;
177
    assert!(files.body.contains("+three") || files.body.contains(">three<"), "diff shown: {}", files.body);
178
    let csrf_b = csrf_of(&files.body);
179
    let r = act(app, "/andy/demo/proposal/1/comment", Some(&bob), &format!("_csrf={csrf_b}&body=nice+line&path=a.txt&line=3")).await;
180
    assert_eq!(r.status, StatusCode::OK, "{}", r.body);
181
    assert!(r.body.contains("class=\"thread\"") && r.body.contains("nice line"), "anchored comment placed: {}", r.body);
182
    let c = db::proposals::comments(&app.db, 1).await.unwrap();
183
    assert_eq!(c[0].anchor_change, feat.to_hex(), "anchored to the atom the feature change introduced");
184
185
    // Requirements: one sealed approval and code owners.
186
    let settings = get(app, "/andy/demo/settings", Some(&andy)).await;
187
    let csrf_a = csrf_of(&settings.body);
188
    assert_eq!(
189
        post(app, "/andy/demo/settings/requirements", Some(&andy), &format!("_csrf={csrf_a}&required_approvals=1&require_owners=1"))
190
            .await
191
            .status,
192
        StatusCode::OK
193
    );
194
    let page = get(app, "/andy/demo/proposal/1", Some(&andy)).await;
195
    assert!(page.body.contains("0 of 1 required sealed approvals"), "{}", page.body);
196
    assert!(page.body.contains("code owners still to approve: andy"), "{}", page.body);
197
198
    // Bob cannot approve his own; Andy approves, which is pending until sealed.
199
    let csrf_b = csrf_of(&get(app, "/andy/demo/proposal/1", Some(&bob)).await.body);
200
    let r = act(app, "/andy/demo/proposal/1/review", Some(&bob), &format!("_csrf={csrf_b}&verdict=approve")).await;
201
    assert!(r.body.contains("cannot approve your own"), "{}", r.body);
202
    let r = act(app, "/andy/demo/proposal/1/review", Some(&andy), &format!("_csrf={csrf_a}&verdict=approve&body=LGTM")).await;
203
    assert!(r.body.contains("seal pending"), "{}", r.body);
204
    assert!(r.body.contains("oxy seal --proposal"));
205
206
    // Andy links his key, seals the proposal's change and pushes the seal: the approval counts.
207
    let key = client.config.author_key.unwrap();
208
    let identity = client.identity(&key).unwrap();
209
    db::accounts::link_identity(
210
        &app.db,
211
        db::accounts::account_by_name(&app.db, "andy").await.unwrap().unwrap().id,
212
        &key.to_hex(),
213
        &identity.name,
214
        &identity.email,
215
        &identity.encode(),
216
    )
217
    .await
218
    .unwrap();
219
    let seal = client.seal(&[feat]).unwrap();
220
    client.push_seals("origin", &[seal]).unwrap();
221
    let page = get(app, "/andy/demo/proposal/1", Some(&andy)).await;
222
    assert!(page.body.contains("approved and sealed"), "{}", page.body);
223
    assert!(page.body.contains("ready to land"), "{}", page.body);
224
    // The API agrees, and names the projected heads for `oxy proposal land`.
225
    let api = send(app, "GET", "/api/v1/repos/andy/demo/proposals/1", None, None, Some("site")).await;
226
    assert_eq!(api.status, StatusCode::OK);
227
    let v: serde_json::Value = serde_json::from_str(&api.body).unwrap();
228
    assert_eq!(v["landable"], true, "{}", api.body);
229
    assert_eq!(v["approvals"][0]["sealed"], true);
230
    assert_eq!(v["projected_heads"][0], feat.to_hex());
231
    assert_eq!(v["changes"][0]["hash"], feat.to_hex());
232
233
    // Land from the hub (no policy): main moves to the projected heads.
234
    let csrf_a = csrf_of(&page.body);
235
    let r = act(app, "/andy/demo/proposal/1/land", Some(&andy), &format!("_csrf={csrf_a}")).await;
236
    assert!(r.body.contains("Landed."), "{}", r.body);
237
    let heads = app.repos.read(&repo, |r, _| Ok(r.bookmarks()?.into_iter().find(|b| b.name == "main").unwrap().heads)).await.unwrap();
238
    assert_eq!(heads, vec![feat]);
239
    assert!(get(app, "/andy/demo/proposals?state=landed", None).await.body.contains("#1"));
240
    assert!(get(app, "/andy/demo/pushes", None).await.body.contains("landed #1 (web)"));
241
    // Landed, it still shows what it landed, by whom and how, and nothing holds it back.
242
    let api = send(app, "GET", "/api/v1/repos/andy/demo/proposals/1", None, None, Some("site")).await;
243
    let v: serde_json::Value = serde_json::from_str(&api.body).unwrap();
244
    assert_eq!(v["state"], "landed", "{}", api.body);
245
    assert_eq!(v["changes"][0]["hash"], feat.to_hex(), "{}", api.body);
246
    assert_eq!(v["blockers"], serde_json::json!([]), "{}", api.body);
247
    assert_eq!(v["landed"]["by"], "andy");
248
    assert_eq!(v["landed"]["via"], "web");
249
    let page = get(app, "/andy/demo/proposal/1", Some(&andy)).await;
250
    assert!(page.body.contains("by <a href=\"/andy\">andy</a>, web"), "{}", page.body);
251
    // Lists by state through the API.
252
    let list = |q: &'static str| async move {
253
        let r = send(app, "GET", &format!("/api/v1/repos/andy/demo/proposals{q}"), None, None, Some("site")).await;
254
        serde_json::from_str::<serde_json::Value>(&r.body).unwrap().as_array().unwrap().len()
255
    };
256
    assert_eq!(list("").await, 0, "open ones only by default");
257
    assert_eq!(list("?state=landed").await, 1);
258
    assert_eq!(list("?state=all").await, 1);
259
260
    // A proposal from a fork: a copy of the repository with the same id.
261
    let fork = RepoName::parse("bob/demo").unwrap();
262
    app.repos.create(&fork, Some(client.id().unwrap())).unwrap();
263
    db::repos::create(&app.db, "bob", "demo", "fork", hub_api::Visibility::Public).await.unwrap();
264
    db::accounts::set_collaborator(
265
        &app.db,
266
        db::repos::get(&app.db, "bob", "demo").await.unwrap().unwrap().id,
267
        Some(db::accounts::account_by_name(&app.db, "bob").await.unwrap().unwrap().id),
268
        None,
269
        "admin",
270
    )
271
    .await
272
    .unwrap();
273
    client.config.set("remote.fork.url", &format!("{}/bob/demo", h.base)).unwrap();
274
    client.config.set("remote.fork.token", "site").unwrap();
275
    client.bookmark_switch("main", false).unwrap();
276
    client.fetch("origin").unwrap();
277
    client.bookmark_set("main", &[feat]).unwrap();
278
    client.bookmark_create("fix", Some(&[feat])).unwrap();
279
    client.bookmark_switch("fix", false).unwrap();
280
    write(work.path(), "b.txt", b"b\n");
281
    client.snapshot("t").unwrap();
282
    let fix = client.commit("add b", &[]).unwrap();
283
    assert!(client.push_bookmark("fork", "fix", false).unwrap().iter().all(|r| r.ok));
284
    let preview = get(app, "/andy/demo/proposals/new?source=bob/demo:fix&target=main", Some(&bob)).await;
285
    assert!(preview.body.contains("add b"), "fork preview: {}", preview.body);
286
    let csrf = csrf_of(&preview.body);
287
    let r =
288
        post(app, "/andy/demo/proposals/new", Some(&bob), &format!("_csrf={csrf}&title=From+fork&target=main&source=bob/demo:fix")).await;
289
    assert_eq!(r.status, StatusCode::SEE_OTHER, "{}", r.body);
290
    let page = get(app, "/andy/demo/proposal/2?tab=changes", Some(&andy)).await;
291
    assert!(page.body.contains("add b"), "{}", page.body);
292
    assert!(
293
        app.repos.read(&repo, move |r, _| Ok(r.store().has(&fix))).await.unwrap(),
294
        "the fork's change was copied into the target's store"
295
    );
296
    // Closing and reopening.
297
    let csrf_b = csrf_of(&get(app, "/andy/demo/proposal/2", Some(&bob)).await.body);
298
    let r = act(app, "/andy/demo/proposal/2/state", Some(&bob), &format!("_csrf={csrf_b}&action=close")).await;
299
    assert!(r.body.contains(">closed<"), "{}", r.body);
300
    let r = act(app, "/andy/demo/proposal/2/state", Some(&bob), &format!("_csrf={csrf_b}&action=reopen")).await;
301
    assert!(r.body.contains(">open<"), "{}", r.body);
302
}