OXYGENHUB
# df940d75cd3d oxygenhub / crates / hub / tests / browse.rs
16.1 KiB · Rust · last changed Repository overview: the heads strip lines up with the main column, clone moves behind a button beside search, Contributors and Languages boxes, and a public, internal or private badge by the name 1 month ago source blame history raw
1
//! End to end: a hub in a temporary data directory, a real `oxy` client
2
//! pushing over the wire protocol, and every milestone 0.1 page fetched.
3
4
use axum::body::Body;
5
use axum::http::{Request, StatusCode};
6
use http_body_util::BodyExt;
7
use oxy_core::repo::Repo;
8
use oxygenhub::config::Config;
9
use oxygenhub::repos::RepoName;
10
use oxygenhub::{db, Shared};
11
use std::path::Path;
12
use tower::ServiceExt;
13
14
/// Point `$OXY_HOME` at a throwaway directory so the client's identity and
15
/// configuration never touch the developer's.
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(push_tokens: Vec<String>) -> Hub {
39
    hermetic();
40
    let dir = tempfile::tempdir().unwrap();
41
    let mut config = Config::load(dir.path()).unwrap();
42
    config.auth.push_tokens = push_tokens;
43
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
44
    let port = listener.local_addr().unwrap().port();
45
    config.server.base_url = format!("http://127.0.0.1:{port}");
46
    let app = oxygenhub::build(config).await.unwrap();
47
    let router = oxygenhub::router(app.clone());
48
    tokio::spawn(async move { axum::serve(listener, router).await.unwrap() });
49
    Hub { app, base: format!("http://127.0.0.1:{port}"), _dir: dir }
50
}
51
52
async fn get(app: &Shared, path: &str) -> (StatusCode, String) {
53
    let res = oxygenhub::router(app.clone()).oneshot(Request::get(path).body(Body::empty()).unwrap()).await.unwrap();
54
    let status = res.status();
55
    let bytes = res.into_body().collect().await.unwrap().to_bytes();
56
    (status, String::from_utf8_lossy(&bytes).into_owned())
57
}
58
59
async fn page(app: &Shared, path: &str) -> String {
60
    let (status, body) = get(app, path).await;
61
    assert_eq!(status, StatusCode::OK, "{path}: {}", body.lines().find(|l| l.contains("lead")).unwrap_or(""));
62
    body
63
}
64
65
/// Push a small history from a client: two changes on main, a second
66
/// bookmark, a tag.
67
fn populate(url: &str, work: &Path) -> (Repo, String, String) {
68
    // The hosted repository is unbound until the first push, so it cannot
69
    // be cloned yet: start locally and push, as moving an existing
70
    // repository to the hub does.
71
    assert!(Repo::clone(url, &work.join("early")).err().unwrap().to_string().contains("unbound"));
72
    let mut client = Repo::init(work).unwrap();
73
    // A signing identity, so changes and the tag travel signed.
74
    client.create_identity("Test Author", "[email protected]", oxy_core::repo::IdentityScope::User).unwrap();
75
    client.config.set("remote.origin.url", url).unwrap();
76
    client.config.set("remote.origin.token", "site-token").unwrap();
77
    client.config.set("core.sign", "change").unwrap();
78
    client.save_config().unwrap();
79
    write(work, "README.md", b"# Demo\n\nSee [docs](docs/guide.md).\n");
80
    write(work, "src/main.rs", b"fn main() {\n    println!(\"hi\");\n}\n");
81
    write(work, "docs/guide.md", b"# Guide\n");
82
    client.snapshot("test").unwrap();
83
    let c1 = client.commit("Initial import", &[]).unwrap();
84
    write(work, "src/main.rs", b"fn main() {\n    println!(\"hello\");\n}\n\nfn two() {}\n");
85
    client.snapshot("test").unwrap();
86
    let c2 = client.commit("Greet properly\n\nAlso adds two().", &[]).unwrap();
87
    client.tag_create("v0.1", &[c2], "First tag").unwrap();
88
    client.bookmark_create("feature", Some(&[c1])).unwrap();
89
    let results = client.push("origin", false).unwrap();
90
    assert!(results.iter().all(|r| r.ok), "{results:?}");
91
    let results = client.push_bookmark("origin", "feature", false).unwrap();
92
    assert!(results.iter().all(|r| r.ok), "{results:?}");
93
    // Bound now: a clone shares the id.
94
    let clone = Repo::clone(url, &work.join("clone")).unwrap();
95
    assert_eq!(clone.id().unwrap(), client.id().unwrap());
96
    (client, c1.to_hex(), c2.to_hex())
97
}
98
99
#[tokio::test(flavor = "multi_thread")]
100
async fn create_push_and_browse() {
101
    let h = hub(vec!["site-token".into()]).await;
102
    let name = RepoName::parse("andy/demo").unwrap();
103
    h.app.repos.create(&name, None).unwrap();
104
    db::repos::create(&h.app.db, "andy", "demo", "A demo", hub_api::Visibility::Public).await.unwrap();
105
    let work = tempfile::tempdir().unwrap();
106
    let (_client, c1, c2) = populate(&format!("{}/andy/demo", h.base), work.path());
107
108
    // Help, filled in for this hub (hub spec §6.3).
109
    let help = page(&h.app, "/help").await;
110
    assert!(help.contains(&format!("oxy remote add hub {}/OWNER/REPOSITORY", h.base)), "commands carry this hub's address");
111
    assert!(help.contains(&format!("oxy clone {}/OWNER/REPOSITORY", h.base)));
112
    assert!(help.contains(&format!("curl -fsSL {}/.well-known/oxyhub-key -o hub.identity", h.base)), "the delegation recipe");
113
    assert!(!help.contains("oxyhub-ca.pem"), "no certificate step for a hub without a self-signed certificate");
114
    for id in ["start", "identity", "push", "clone", "proposals", "delegate", "flow", "keys", "glossary"] {
115
        assert!(help.contains(&format!("id=\"{id}\"")) && help.contains(&format!("href=\"#{id}\"")), "section {id}");
116
    }
117
    assert!(help.contains("<strong>bookmark</strong>") && help.contains("<strong>proposal</strong>"), "glossary");
118
    assert!(home_has_help(&page(&h.app, "/explore").await), "linked from every page");
119
120
    // Front page and owner page list it.
121
    let home = page(&h.app, "/").await;
122
    assert!(home.contains("/andy/demo"), "{home}");
123
    assert!(page(&h.app, "/andy").await.contains("demo"));
124
    assert_eq!(get(&h.app, "/nobody").await.0, StatusCode::NOT_FOUND);
125
126
    // Overview: tree, README rendered with rebased links, clone URL, counts.
127
    let o = page(&h.app, "/andy/demo").await;
128
    assert!(o.contains("src"), "tree entries");
129
    assert!(o.contains("href=\"/andy/demo/file/main/docs/guide.md\""), "README link rebased: {o}");
130
    assert!(o.contains(&format!("oxy clone {}/andy/demo", h.base)));
131
    assert!(o.contains("2 changes"));
132
    // Overview: clone popover, contributors, languages, visibility badge.
133
    assert!(o.contains("class=\"clone-pop\"") && o.contains("value=\"oxy clone "), "clone behind a button");
134
    assert!(o.contains("<h3>Contributors") && o.contains("<h3>Languages</h3>") && o.contains("<strong>Rust</strong>"), "{o}");
135
    assert!(o.contains("class=\"vis vis-public\""));
136
    // Landmarks, skip link, current tab (hub spec §6.13).
137
    assert!(o.contains("<a class=\"skip\" href=\"#main\">") && o.contains("<main id=\"main\""));
138
    assert!(o.contains("aria-label=\"Site\"") && o.contains("aria-label=\"Repository\"") && o.contains("aria-label=\"Account\""));
139
    assert!(o.contains("class=\"on\" aria-current=\"page\">Code</a>"), "the current tab is announced");
140
    assert!(o.contains("v0.1"));
141
    assert!(o.contains("feature"));
142
143
    // Tree at a bookmark, a tag and a change; file with highlighting; raw; blame.
144
    let t = page(&h.app, "/andy/demo/tree/main/src").await;
145
    assert!(t.contains("main.rs"));
146
    assert!(page(&h.app, "/andy/demo/tree/v0.1").await.contains("README.md"));
147
    assert!(page(&h.app, &format!("/andy/demo/tree/{}", &c1[..10])).await.contains("README.md"));
148
    assert_eq!(get(&h.app, "/andy/demo/tree/main/nope").await.0, StatusCode::NOT_FOUND);
149
    let f = page(&h.app, "/andy/demo/file/main/src/main.rs").await;
150
    assert!(f.contains("sy-storage sy-type sy-function"), "highlighted: {f}");
151
    assert!(f.contains("id=\"L5\""));
152
    assert!(f.contains("Rust"));
153
    let (status, raw) = get(&h.app, "/andy/demo/file/main/src/main.rs?plain=1").await;
154
    assert_eq!(status, StatusCode::OK);
155
    assert_eq!(raw, "fn main() {\n    println!(\"hello\");\n}\n\nfn two() {}\n");
156
    let b = page(&h.app, "/andy/demo/file/main/src/main.rs?blame=1").await;
157
    assert!(b.contains(&c1[..8]) && b.contains(&c2[..8]), "both changes blamed: {b}");
158
    // Sidebar, permalink, blame shading and "blame before this change" (hub spec §6.6).
159
    assert!(f.contains("class=\"file-side\""), "sidebar");
160
    assert!(f.contains("href=\"/andy/demo/tree/main/docs\""), "sibling directory listed");
161
    let here = f.split("class=\"here\" aria-current=\"page\">").nth(1).unwrap_or("");
162
    assert!(here.trim_start().starts_with("<a href=\"/andy/demo/file/main/src/main.rs\""), "the file marked");
163
    assert!(f.contains(&format!("data-permalink=\"/andy/demo/file/{c2}/src/main.rs\"")), "permalink at the head");
164
    assert!(b.contains(&format!("data-permalink=\"/andy/demo/file/{c2}/src/main.rs?blame=1\"")));
165
    assert!(b.contains("blame age-0") && b.contains("blame age-9"), "oldest and newest shaded");
166
    assert!(b.contains(&format!("href=\"/andy/demo/file/{c1}/src/main.rs?blame=1#L")), "the state before c2 is c1");
167
    assert_eq!(b.matches("class=\"before\"").count(), b.matches("blame age-9").count(), "c1 has no dependencies, so no link");
168
    let before = page(&h.app, &format!("/andy/demo/file/{c1}/src/main.rs?blame=1")).await;
169
    assert!(before.contains(&c1[..8]) && !before.contains(&c2[..8]), "blamed in c1's state");
170
    // States: heads joined with +, in any order; not a change otherwise.
171
    let (lo, hi) = if c1 < c2 { (&c1, &c2) } else { (&c2, &c1) };
172
    assert!(page(&h.app, &format!("/andy/demo/tree/{hi}+{lo}/src"))
173
        .await
174
        .contains(&format!("data-permalink=\"/andy/demo/tree/{lo}+{hi}/src\"")));
175
    assert_ne!(get(&h.app, &format!("/andy/demo/tree/{c1}+{}", &c2[..12])).await.0, StatusCode::OK, "state heads are full hashes");
176
    let md = page(&h.app, "/andy/demo/file/main/README.md").await;
177
    assert!(md.contains("<h1>Demo</h1>"), "markdown rendered");
178
    // Last-change JSON for tree rows.
179
    let (status, json) = get(&h.app, "/andy/demo/last/main?paths=README.md,src").await;
180
    assert_eq!(status, StatusCode::OK);
181
    assert!(json.contains("Initial import") && json.contains("Greet properly"), "{json}");
182
183
    // History with graph rows, filtered by path; change page with diff; compare.
184
    let hist = page(&h.app, "/andy/demo/changes/main").await;
185
    assert!(hist.contains("Greet properly") && hist.contains("Initial import"));
186
    assert!(hist.contains("<circle"), "graph drawn");
187
    assert!(hist.contains("lbl-tag") && hist.contains("v0.1"), "tag label on its head");
188
    let by_path = page(&h.app, "/andy/demo/changes/main?path=README.md").await;
189
    assert!(by_path.contains("Initial import") && !by_path.contains("Greet properly"));
190
    let c = page(&h.app, &format!("/andy/demo/change/{c2}")).await;
191
    assert!(c.contains("Also adds two()"), "body shown");
192
    assert!(c.contains("+fn two() {}") || c.contains("fn two() {}"), "diff shown: {c}");
193
    assert!(c.contains("class=\"add\"") && c.contains("class=\"del\""));
194
    assert!(c.contains(&c1[..12]), "dependency listed");
195
    assert!(page(&h.app, &format!("/andy/demo/change/{}", &c2[..8])).await.contains("Greet properly"));
196
    let cmp = page(&h.app, "/andy/demo/compare/feature...main").await;
197
    assert!(cmp.contains("1 change") && cmp.contains("Greet properly"));
198
    assert_eq!(get(&h.app, "/andy/demo/compare/feature").await.0, StatusCode::BAD_REQUEST);
199
    // Pickers, swap and the /compare form (hub spec §6.3).
200
    assert!(
201
        cmp.contains("<datalist id=\"compare-refs\">")
202
            && cmp.contains("<option value=\"feature\">bookmark</option>")
203
            && cmp.contains("<option value=\"v0.1\">tag</option>")
204
    );
205
    assert!(cmp.contains("href=\"/andy/demo/compare/main...feature\""), "swap");
206
    assert!(!cmp.contains("Propose this"), "anonymous viewers cannot propose");
207
    let redirect = |path: &'static str| {
208
        let app = h.app.clone();
209
        async move {
210
            let res = oxygenhub::router(app).oneshot(Request::get(path).body(Body::empty()).unwrap()).await.unwrap();
211
            (res.status(), res.headers().get("location").and_then(|v| v.to_str().ok()).unwrap_or("").to_string())
212
        }
213
    };
214
    let (st, loc) = redirect("/andy/demo/compare").await;
215
    assert!(st.is_redirection() && loc == "/andy/demo/compare/main...feature", "the newest other bookmark against the default: {loc}");
216
    let (_, loc) = redirect("/andy/demo/compare?base=v0.1&head=+feature+").await;
217
    assert_eq!(loc, "/andy/demo/compare/v0.1...feature");
218
219
    // Bookmarks, tags, conflicts (none), trust (no policy), pushes.
220
    let bm = page(&h.app, "/andy/demo/bookmarks").await;
221
    assert!(bm.contains("feature") && bm.contains("default"));
222
    let tags = page(&h.app, "/andy/demo/tags").await;
223
    assert!(tags.contains("v0.1") && tags.contains("First tag"));
224
    assert!(page(&h.app, "/andy/demo/conflicts").await.contains("No bookmark carries a conflict"));
225
    let trust = page(&h.app, "/andy/demo/trust").await;
226
    assert!(trust.contains("No trust policy") && trust.contains(&h.app.hub_key.key.to_hex()));
227
    assert!(trust.contains("2 signed"), "signed changes verified on the host: {trust}");
228
    assert!(c.contains("signed by Test Author"), "change page shows the signer");
229
    let pushes = page(&h.app, "/andy/demo/pushes").await;
230
    assert!(pushes.contains("accepted") && pushes.contains("main"), "{pushes}");
231
    assert!(pushes.contains("<td>2</td>") && pushes.contains("<code title="), "two changes imported and the state shown: {pushes}");
232
233
    // API and small endpoints.
234
    let (_, repos) = get(&h.app, "/api/v1/repos").await;
235
    assert!(repos.contains("\"name\":\"demo\""));
236
    let (_, bms) = get(&h.app, "/api/v1/repos/andy/demo/bookmarks").await;
237
    assert!(bms.contains("\"default\":true"));
238
    let (status, key) = get(&h.app, "/.well-known/oxyhub-key").await;
239
    assert_eq!(status, StatusCode::OK);
240
    assert!(!key.is_empty());
241
    assert!(get(&h.app, "/health").await.1.contains("\"ok\":true"));
242
    assert_eq!(get(&h.app, "/style.css").await.0, StatusCode::OK);
243
    assert_eq!(get(&h.app, "/static/fonts/Barlow-400.woff2").await.0, StatusCode::OK);
244
    assert_eq!(get(&h.app, "/andy/demo/oxy/v1/nothing").await.0, StatusCode::NOT_FOUND);
245
}
246
247
#[tokio::test(flavor = "multi_thread")]
248
async fn private_repositories_and_push_tokens() {
249
    let h = hub(vec!["s3cret".into()]).await;
250
    for (name, vis) in [("pub", hub_api::Visibility::Public), ("priv", hub_api::Visibility::Private)] {
251
        // `priv` is created bound so it can be cloned while still empty.
252
        let id = if name == "priv" { Some([7u8; 16]) } else { None };
253
        h.app.repos.create(&RepoName::parse(&format!("andy/{name}")).unwrap(), id).unwrap();
254
        db::repos::create(&h.app.db, "andy", name, "", vis).await.unwrap();
255
    }
256
    // The private one is invisible on pages and to anonymous clients.
257
    assert_eq!(get(&h.app, "/andy/priv").await.0, StatusCode::NOT_FOUND);
258
    assert!(!page(&h.app, "/").await.contains("priv"));
259
    assert!(Repo::clone(&format!("{}/andy/priv", h.base), &tempfile::tempdir().unwrap().path().join("x")).is_err());
260
    // Anonymous push to the public one is refused; with the token it lands.
261
    let work = tempfile::tempdir().unwrap();
262
    let mut client = Repo::init(work.path()).unwrap();
263
    client.config.set("remote.origin.url", &format!("{}/andy/pub", h.base)).unwrap();
264
    write(work.path(), "a.txt", b"a\n");
265
    client.snapshot("test").unwrap();
266
    client.commit("a", &[]).unwrap();
267
    assert!(client.push("origin", false).is_err());
268
    client.config.set("remote.origin.token", "s3cret").unwrap();
269
    assert!(client.push("origin", false).unwrap().iter().all(|r| r.ok));
270
    // With the token, the private repository can be cloned too.
271
    let priv_dir = tempfile::tempdir().unwrap();
272
    std::env::set_var("OXY_TOKEN", "s3cret");
273
    let ok = Repo::clone(&format!("{}/andy/priv", h.base), &priv_dir.path().join("p")).is_ok();
274
    std::env::remove_var("OXY_TOKEN");
275
    assert!(ok, "a token reads a private repository until accounts exist");
276
    // The pushes log shows the accepted update; the front page shows activity.
277
    tokio::time::sleep(std::time::Duration::from_millis(100)).await;
278
    assert!(page(&h.app, "/andy/pub/pushes").await.contains("accepted"));
279
    assert!(page(&h.app, "/andy/pub").await.contains("1 change"));
280
}
281
282
fn home_has_help(page: &str) -> bool {
283
    page.contains("<a href=\"/help\">Help</a>")
284
}