vgi-forge-github 0.12.2

GitHub adapter for VGI git namespaces: per-community GitHub App auth, repo creation and bootstrap, role projection, device-flow account linking and verified webhooks.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
//! The bridge-posted check (§9, "forged check runs"): with
//! `GitHubConfig::bridge_checks`, a namespace without an org required
//! workflow commits no workflow, and its ruleset requires the check from the
//! App itself — which only the bridge can post as.

mod common;

use common::*;
use http::HeaderMap;
use serde_json::json;
use vgi_forge::{
    CheckSourceGuard, Forge, ForgeAccount, ForgeError, Namespace, NamespaceKind, Projection,
    ProtectionGap, RepoSpec, StepAction, StepOutcome, VgiConfig,
};
use vgi_forge_github::{CheckConclusion, CheckTriggerKind, GitHubForge, Secret, webhook};
use wiremock::matchers::path_regex;
use wiremock::matchers::{body_json, body_partial_json, method, path, query_param};
use wiremock::{Mock, MockServer, ResponseTemplate};

const SHA: &str = "0123456789abcdef0123456789abcdef01234567";
const HEAD: &str = "1111111111111111111111111111111111111111";
const BASE: &str = "2222222222222222222222222222222222222222";
const KEYRING: &str =
    "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nweb-flow\n-----END PGP PUBLIC KEY BLOCK-----\n";
/// The App id `forge_with` configures.
const APP_ID: u64 = 1001;

/// A forge configured for bridge checks, whose installations carry them.
fn bridge_forge(server: &MockServer) -> GitHubForge {
    let forge = forge_with(server, |cfg| {
        cfg.with_actions_integration_id(ACTIONS_APP_ID)
            .with_bridge_checks()
    });
    forge.set_bridge_checks_ready(&acme(), true);
    forge.set_bridge_checks_ready(
        &vgi_forge::Resource::parse("github.com/alice").unwrap(),
        true,
    );
    forge
}

fn vgi_config() -> VgiConfig {
    VgiConfig::new(
        "did:webvh:registry.example",
        "did:webvh:vtc.acme.example",
        format!("OpenVTC/verifiable-git-infrastructure/.github/actions/verify-trust@{SHA}"),
        "v0.5.0",
    )
    .with_platform_keyring(KEYRING)
}

fn admin_perms() -> serde_json::Value {
    json!({ "administration": "write", "metadata": "read" })
}

#[tokio::test]
async fn capabilities_say_the_bridge_posts_the_check_outside_a_required_workflow() {
    let server = MockServer::start().await;
    let plain = forge_for(&server);
    let bridge = bridge_forge(&server);
    let org = Namespace::new(acme(), NamespaceKind::Organization)
        .with_owner_id(500)
        .with_installation(INSTALLATION);
    let user = Namespace::new(
        vgi_forge::Resource::parse("github.com/alice").unwrap(),
        NamespaceKind::User,
    )
    .with_owner_id(1)
    .with_installation(USER_INSTALLATION);
    // Configured, but the installation's readiness is not known (or it
    // lacks the permissions or events): the Actions workflow stays.
    let unready = forge_with(&server, |cfg| cfg.with_bridge_checks());
    assert!(!unready.capabilities(&org).bridge_posted_check);
    unready.set_bridge_checks_ready(&acme(), false);
    assert!(!unready.capabilities(&org).bridge_posted_check);
    for ns in [org.clone(), user] {
        assert!(!plain.capabilities(&ns).bridge_posted_check);
        let caps = bridge.capabilities(&ns);
        assert!(caps.bridge_posted_check, "{ns:?}");
        assert!(
            !caps.single_owner_repos_unreviewed,
            "no repository workflow is left to weaken"
        );
    }
    // Where the org has a required workflow, that is what runs.
    bridge.set_required_workflow(&acme(), true);
    let caps = bridge.capabilities(&org);
    assert!(caps.required_workflow && !caps.bridge_posted_check);
}

#[tokio::test]
async fn the_plan_commits_no_workflow_and_removes_an_old_one() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    // Two owners: the owner-review guard would apply without bridge checks.
    let spec = RepoSpec::new(repo("gadgets"))
        .with_owner(ForgeAccount::new(7, "bob"))
        .with_owner(ForgeAccount::new(8, "carol"));
    let plan = forge.bootstrap_plan(&spec, &vgi_config()).unwrap();
    let ids: Vec<_> = plan.iter().map(|s| s.id.as_str()).collect();
    assert_eq!(
        ids,
        [
            "ruleset",
            "cleanup:variable:TRUST_REGISTRY_DID",
            "cleanup:variable:VTC_DID",
            "cleanup:workflow",
        ]
    );
    assert!(
        !plan
            .iter()
            .any(|s| matches!(s.action, StepAction::WriteFile { .. })),
        "nothing in the repository is on the check's path"
    );
    match &plan[0].action {
        StepAction::ProtectDefaultBranch(spec) => {
            assert!(spec.require_status_check && !spec.require_code_owner_review);
        }
        other => panic!("{other:?}"),
    }
}

#[tokio::test]
async fn the_ruleset_pins_the_check_to_the_app_itself() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    mount_token(&server, INSTALLATION, Some("gadgets"), admin_perms(), 1).await;
    Mock::given(method("GET"))
        .and(path("/repos/acme/gadgets"))
        .respond_with(ResponseTemplate::new(200).set_body_json(repo_json(
            9001,
            "acme/gadgets",
            false,
        )))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/repos/acme/gadgets/rulesets"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!([])))
        .mount(&server)
        .await;
    // Never asks for the Actions App: nothing Actions posts may count.
    Mock::given(method("GET"))
        .and(path("/apps/github-actions"))
        .respond_with(ResponseTemplate::new(500))
        .expect(0)
        .mount(&server)
        .await;
    Mock::given(method("POST"))
        .and(path("/repos/acme/gadgets/rulesets"))
        .and(body_partial_json(json!({
            "bypass_actors": [],
            "rules": [
                { "type": "deletion" },
                { "type": "non_fast_forward" },
                { "type": "pull_request" },
                { "type": "required_status_checks", "parameters": {
                    "required_status_checks": [
                        { "context": "Verify commit trust", "integration_id": APP_ID }
                    ]
                } }
            ]
        })))
        .respond_with(ResponseTemplate::new(201).set_body_json(json!({ "id": 5 })))
        .expect(1)
        .mount(&server)
        .await;

    let spec = RepoSpec::new(repo("gadgets")).with_owner(ForgeAccount::new(7, "bob"));
    let plan = forge.bootstrap_plan(&spec, &vgi_config()).unwrap();
    let outcome = forge.run_step(&repo("gadgets"), &plan[0]).await.unwrap();
    assert_eq!(outcome, StepOutcome::Created);
}

/// `good_ruleset` with the check pinned to `integration`.
fn ruleset_pinned_to(integration: u64) -> serde_json::Value {
    let mut rs = good_ruleset(9);
    rs["rules"][3]["parameters"]["required_status_checks"][0]["integration_id"] =
        json!(integration);
    rs
}

async fn mount_inspect(server: &MockServer, ruleset: serde_json::Value) {
    mount_token(server, INSTALLATION, Some("widgets"), admin_perms(), 1).await;
    Mock::given(method("GET"))
        .and(path("/repos/acme/widgets"))
        .respond_with(ResponseTemplate::new(200).set_body_json(repo_json(
            812,
            "acme/widgets",
            false,
        )))
        .mount(server)
        .await;
    for p in ["collaborators", "invitations"] {
        Mock::given(method("GET"))
            .and(path(format!("/repos/acme/widgets/{p}")))
            .respond_with(ResponseTemplate::new(200).set_body_json(json!([])))
            .mount(server)
            .await;
    }
    Mock::given(method("GET"))
        .and(path("/repos/acme/widgets/rulesets"))
        .and(query_param("includes_parents", "false"))
        .respond_with(
            ResponseTemplate::new(200)
                .set_body_json(json!([{ "id": 9, "name": "VGI commit trust" }])),
        )
        .mount(server)
        .await;
    Mock::given(method("GET"))
        .and(path("/repos/acme/widgets/rulesets/9"))
        .respond_with(ResponseTemplate::new(200).set_body_json(ruleset))
        .mount(server)
        .await;
}

fn projection() -> Projection {
    let mut p = Projection::new(repo("widgets"));
    p.forge_id = Some(812);
    p.required_check = Some("Verify commit trust".into());
    p.owners = vec![ForgeAccount::new(7, "bob"), ForgeAccount::new(8, "carol")];
    p
}

#[tokio::test]
async fn inspect_counts_only_a_check_pinned_to_the_app() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    mount_inspect(&server, ruleset_pinned_to(APP_ID)).await;
    let state = forge.inspect(&repo("widgets")).await.unwrap();
    assert_eq!(state.protection.required_checks, ["Verify commit trust"]);
    assert_eq!(
        state.protection.check_source_guard,
        CheckSourceGuard::BridgePosted
    );
    assert!(
        forge.diff(&state, &projection()).is_empty(),
        "two owners need no review guard when the bridge posts the check"
    );

    // The same ruleset pinned to Actions is forgeable: it does not count.
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    mount_inspect(&server, ruleset_pinned_to(ACTIONS_APP_ID)).await;
    let state = forge.inspect(&repo("widgets")).await.unwrap();
    let drift = forge.diff(&state, &projection());
    assert!(
        drift.iter().any(|d| matches!(d,
            vgi_forge::Drift::ProtectionWeakened { gaps }
                if gaps.contains(&ProtectionGap::CheckNotRequired { check: "Verify commit trust".into() }))),
        "{drift:?}"
    );
}

fn signed(event: &str, body: &serde_json::Value) -> (HeaderMap, Vec<u8>) {
    let body = serde_json::to_vec(body).unwrap();
    let mut h = HeaderMap::new();
    h.insert("x-github-event", event.parse().unwrap());
    h.insert("x-github-delivery", "d-1".parse().unwrap());
    h.insert(
        "x-hub-signature-256",
        webhook::sign_body(&Secret::new(WEBHOOK_SECRET), &body)
            .parse()
            .unwrap(),
    );
    (h, body)
}

fn pr_event(action: &str) -> serde_json::Value {
    json!({
        "action": action,
        "repository": { "id": 812, "full_name": "Acme/Widgets" },
        "pull_request": {
            "number": 17,
            "commits": 2,
            "head": { "sha": HEAD, "repo": { "full_name": "mallory/widgets" } },
            "base": { "sha": BASE, "ref": "main" },
        },
    })
}

#[tokio::test]
async fn pull_request_and_merge_group_deliveries_trigger_the_check() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);

    for action in ["opened", "synchronize", "reopened"] {
        let (h, b) = signed("pull_request", &pr_event(action));
        let t = forge.parse_check_trigger(&h, &b).unwrap();
        assert_eq!(t.len(), 1);
        let t = &t[0];
        assert_eq!(t.repo, repo("widgets"), "the base repository, lowercased");
        assert_eq!((t.head_sha.as_str(), t.base_sha.as_str()), (HEAD, BASE));
        assert_eq!(t.base_ref, "main");
        assert_eq!(t.kind, CheckTriggerKind::PullRequest { number: 17 });
    }
    for action in ["closed", "labeled", "edited"] {
        let (h, b) = signed("pull_request", &pr_event(action));
        assert!(
            forge.parse_check_trigger(&h, &b).unwrap().is_empty(),
            "{action}: a title edit changes nothing"
        );
    }
    // An edit that moved the base is a new check against the new base.
    let mut moved = pr_event("edited");
    moved["changes"] = json!({ "base": { "ref": { "from": "develop" }, "sha": { "from": SHA } } });
    let (h, b) = signed("pull_request", &moved);
    let t = forge.parse_check_trigger(&h, &b).unwrap();
    assert_eq!(t[0].base_ref, "main");

    let (h, b) = signed(
        "merge_group",
        &json!({
            "action": "checks_requested",
            "repository": { "id": 812, "full_name": "acme/widgets" },
            "merge_group": { "head_sha": HEAD, "base_sha": BASE,
                "base_ref": "refs/heads/main",
                "head_ref": "refs/heads/gh-readonly-queue/main/pr-17" },
        }),
    );
    let t = forge.parse_check_trigger(&h, &b).unwrap();
    assert_eq!(t[0].kind, CheckTriggerKind::MergeGroup);
    assert_eq!(t[0].base_ref, "main", "refs/heads/ stripped");

    // Other events are someone else's.
    let (h, b) = signed("repository", &json!({ "action": "created" }));
    assert!(forge.parse_check_trigger(&h, &b).unwrap().is_empty());
}

#[tokio::test]
async fn a_rerequest_of_this_apps_check_names_each_pull_request() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    let body = |app: u64| {
        json!({
            "action": "rerequested",
            "repository": { "id": 812, "full_name": "acme/widgets" },
            "check_run": {
                "head_sha": HEAD,
                "app": { "id": app },
                "pull_requests": [
                    { "number": 17, "base": { "ref": "main", "sha": BASE }, "head": { "sha": HEAD } },
                    { "number": 18, "base": { "ref": "develop", "sha": SHA }, "head": { "sha": HEAD } },
                ],
            },
        })
    };
    let (h, b) = signed("check_run", &body(APP_ID));
    let t = forge.parse_check_trigger(&h, &b).unwrap();
    assert_eq!(t.len(), 2);
    assert_eq!(t[0].kind, CheckTriggerKind::Rerequested { number: 17 });
    assert_eq!(t[1].base_ref, "develop");
    // Another App's run is not ours to re-run.
    let (h, b) = signed("check_run", &body(ACTIONS_APP_ID));
    assert!(forge.parse_check_trigger(&h, &b).unwrap().is_empty());

    let suite = json!({
        "action": "rerequested",
        "repository": { "id": 812, "full_name": "acme/widgets" },
        "check_suite": { "head_sha": HEAD, "app": { "id": APP_ID }, "pull_requests": [
            { "number": 17, "base": { "ref": "main", "sha": BASE }, "head": { "sha": HEAD } } ] },
    });
    let (h, b) = signed("check_suite", &suite);
    assert_eq!(forge.parse_check_trigger(&h, &b).unwrap().len(), 1);
}

#[tokio::test]
async fn the_default_branch_and_a_pull_request_are_read_from_github() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    mount_token(
        &server,
        INSTALLATION,
        Some("widgets"),
        json!({ "metadata": "read" }),
        1,
    )
    .await;
    mount_token(
        &server,
        INSTALLATION,
        Some("widgets"),
        json!({ "metadata": "read", "pull_requests": "read" }),
        1,
    )
    .await;
    Mock::given(method("GET"))
        .and(path("/repos/acme/widgets"))
        .respond_with(ResponseTemplate::new(200).set_body_json(repo_json(
            812,
            "acme/widgets",
            false,
        )))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/repos/acme/widgets/pulls/17"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "state": "open", "head": { "sha": HEAD }, "base": { "ref": "main", "sha": BASE },
        })))
        .mount(&server)
        .await;
    assert_eq!(
        forge.default_branch(&repo("widgets")).await.unwrap(),
        "main"
    );
    let pr = forge.pull_request(&repo("widgets"), 17).await.unwrap();
    assert_eq!(
        (pr.head_sha.as_str(), pr.base_ref.as_str(), pr.open),
        (HEAD, "main", true)
    );
}

#[tokio::test]
async fn a_comparison_is_read_across_pages() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    mount_any_token(&server).await;
    let shas: Vec<String> = (0..150).map(|i| format!("{i:040x}")).collect();
    let page = |from: usize, to: usize| {
        json!({
            "total_commits": 150,
            "merge_base_commit": { "sha": BASE },
            "commits": shas[from..to].iter().map(|s| json!({ "sha": s })).collect::<Vec<_>>(),
        })
    };
    for (n, body) in [(1, page(0, 100)), (2, page(100, 150))] {
        Mock::given(method("GET"))
            .and(path(format!("/repos/acme/widgets/compare/{BASE}...{HEAD}")))
            .and(query_param("page", n.to_string()))
            .and(query_param("per_page", "100"))
            .respond_with(ResponseTemplate::new(200).set_body_json(body))
            .expect(1)
            .mount(&server)
            .await;
    }
    let c = forge
        .compare_commits(&repo("widgets"), BASE, HEAD)
        .await
        .unwrap();
    assert_eq!(c.total, 150);
    assert_eq!(c.commits, shas, "all 150, in order — not the first 100");
}

#[tokio::test]
async fn a_bind_records_whether_the_installation_can_carry_the_check() {
    use std::collections::BTreeMap;
    use vgi_forge::BindCallback;
    for (events, ready) in [
        (json!(["pull_request", "merge_group", "repository"]), true),
        (json!(["repository"]), false),
    ] {
        let server = MockServer::start().await;
        let forge = forge_with(&server, |cfg| cfg.with_bridge_checks());
        Mock::given(method("GET"))
            .and(path("/app/installations/77"))
            .respond_with(ResponseTemplate::new(200).set_body_json(json!({
                "id": 77,
                "account": { "id": 600, "login": "newco", "type": "User" },
                "permissions": { "checks": "write", "pull_requests": "read",
                                 "merge_queues": "read", "metadata": "read" },
                "events": events,
            })))
            .mount(&server)
            .await;
        let state = GitHubForge::new_state().unwrap();
        let ns = vgi_forge::Resource::parse("github.com/newco").unwrap();
        let params = BTreeMap::from([
            ("state".to_string(), state.clone()),
            ("installation_id".to_string(), "77".to_string()),
            ("setup_action".to_string(), "install".to_string()),
        ]);
        let binding = forge
            .complete_bind(BindCallback::new(params, state, ns.clone()))
            .await
            .unwrap();
        assert_eq!(forge.bridge_checks_ready(&ns), Some(ready));
        assert_eq!(
            binding
                .missing_permissions
                .contains(&"event:pull_request".to_string()),
            !ready
        );
        forge.register_namespace(binding.namespace.clone()).unwrap();
        assert_eq!(
            forge.capabilities(&binding.namespace).bridge_posted_check,
            ready
        );
        // Not ready keeps the Actions workflow in the plan.
        let spec = RepoSpec::new(vgi_forge::Resource::parse("github.com/newco/x").unwrap());
        let plan = forge.bootstrap_plan(&spec, &vgi_config()).unwrap();
        assert_eq!(
            plan.iter().any(|s| s.id == "workflow"),
            !ready,
            "{:?}",
            plan.iter().map(|s| &s.id).collect::<Vec<_>>()
        );
    }
}

#[tokio::test]
async fn without_a_platform_keyring_only_the_bridge_posted_plan_can_be_made() {
    let server = MockServer::start().await;
    let no_keyring = VgiConfig::new(
        "did:webvh:registry.example",
        "did:webvh:vtc.acme.example",
        format!("OpenVTC/verifiable-git-infrastructure/.github/actions/verify-trust@{SHA}"),
        "v0.5.0",
    );
    let spec = RepoSpec::new(repo("gadgets")).with_owner(ForgeAccount::new(7, "bob"));
    assert!(
        bridge_forge(&server)
            .bootstrap_plan(&spec, &no_keyring)
            .is_ok()
    );
    assert!(
        forge_for(&server)
            .bootstrap_plan(&spec, &no_keyring)
            .is_err()
    );
}

#[tokio::test]
async fn a_delivery_is_verified_before_it_is_read() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    let (mut h, b) = signed("pull_request", &pr_event("opened"));
    let mut tampered = b.clone();
    tampered.extend_from_slice(b" ");
    assert!(matches!(
        forge.parse_check_trigger(&h, &tampered),
        Err(ForgeError::Webhook(_))
    ));
    h.remove("x-hub-signature-256");
    assert!(matches!(
        forge.parse_check_trigger(&h, &b),
        Err(ForgeError::Webhook(_))
    ));
    // A signed body with a head that is not a commit id is refused too: it
    // would go into a git command line.
    let mut evil = pr_event("opened");
    evil["pull_request"]["head"]["sha"] = json!("--upload-pack=touch /tmp/x");
    let (h, b) = signed("pull_request", &evil);
    assert!(forge.parse_check_trigger(&h, &b).is_err());
    // …and a pull request without a base branch.
    let mut no_base = pr_event("opened");
    no_base["pull_request"]["base"]
        .as_object_mut()
        .unwrap()
        .remove("ref");
    let (h, b) = signed("pull_request", &no_base);
    assert!(forge.parse_check_trigger(&h, &b).is_err());
}

#[tokio::test]
async fn check_runs_are_posted_with_a_checks_only_token_for_the_one_repository() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    let checks = json!({ "checks": "write", "metadata": "read" });
    mount_token(&server, INSTALLATION, Some("widgets"), checks, 2).await;
    Mock::given(method("POST"))
        .and(path("/repos/acme/widgets/check-runs"))
        .and(InstallationToken)
        .and(body_partial_json(json!({
            "name": "Verify commit trust", "head_sha": HEAD, "status": "in_progress",
        })))
        .respond_with(ResponseTemplate::new(201).set_body_json(json!({ "id": 77 })))
        .expect(1)
        .mount(&server)
        .await;
    Mock::given(method("PATCH"))
        .and(path("/repos/acme/widgets/check-runs/77"))
        .and(body_json(json!({
            "status": "completed",
            "conclusion": "failure",
            "output": { "title": "1 of 2 commits not trusted", "summary": "details" },
        })))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({ "id": 77 })))
        .expect(1)
        .mount(&server)
        .await;

    let id = forge
        .start_check_run(&repo("widgets"), HEAD, "Verify commit trust", "d-1")
        .await
        .unwrap();
    assert_eq!(id, 77);
    forge
        .finish_check_run(
            &repo("widgets"),
            id,
            CheckConclusion::Failure,
            "1 of 2 commits not trusted",
            "details",
        )
        .await
        .unwrap();
}

#[tokio::test]
async fn commits_are_compared_with_a_read_only_token() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    let read = json!({ "contents": "read", "metadata": "read" });
    mount_token(&server, INSTALLATION, Some("widgets"), read, 2).await;
    Mock::given(method("GET"))
        .and(path(format!("/repos/acme/widgets/compare/{BASE}...{HEAD}")))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "total_commits": 2,
            "merge_base_commit": { "sha": BASE },
            "commits": [ { "sha": SHA }, { "sha": HEAD } ],
        })))
        .expect(1)
        .mount(&server)
        .await;
    let c = forge
        .compare_commits(&repo("widgets"), BASE, HEAD)
        .await
        .unwrap();
    assert_eq!(c.commits, [SHA, HEAD]);
    assert_eq!(c.total, 2);
    let token = forge.contents_read_token(&repo("widgets")).await.unwrap();
    assert_eq!(token.expose(), TOKEN);
    assert_eq!(
        forge.clone_url(&repo("widgets")).unwrap().path(),
        "/acme/widgets.git"
    );
    // A bad id never reaches a URL.
    assert!(
        forge
            .compare_commits(&repo("widgets"), "main", HEAD)
            .await
            .is_err()
    );
}

/// The merge base of two commits, for recomputing a platform merge
/// (SEC-4045 / VGI-01): one comparison, one commit listed at most, read with
/// a read-only token — and a merge base that is not a commit id is refused.
#[tokio::test]
async fn a_merge_base_is_read_from_one_small_comparison() {
    let server = MockServer::start().await;
    let forge = bridge_forge(&server);
    mount_any_token(&server).await;
    Mock::given(method("GET"))
        .and(path(format!("/repos/acme/widgets/compare/{SHA}...{HEAD}")))
        .and(query_param("per_page", "1"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "total_commits": 400,
            "merge_base_commit": { "sha": BASE },
            "commits": [ { "sha": SHA } ],
        })))
        .expect(1)
        .mount(&server)
        .await;
    assert_eq!(
        forge.merge_base(&repo("widgets"), SHA, HEAD).await.unwrap(),
        BASE
    );
    assert!(
        forge
            .merge_base(&repo("widgets"), "main", HEAD)
            .await
            .is_err()
    );

    Mock::given(method("GET"))
        .and(path(format!("/repos/acme/widgets/compare/{BASE}...{HEAD}")))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "merge_base_commit": { "sha": "not-a-sha" },
        })))
        .mount(&server)
        .await;
    assert!(
        forge
            .merge_base(&repo("widgets"), BASE, HEAD)
            .await
            .is_err()
    );
}

async fn mount_any_token(server: &MockServer) {
    Mock::given(method("POST"))
        .and(path_regex(r"^/app/installations/\d+/access_tokens$"))
        .respond_with(ResponseTemplate::new(201).set_body_json(json!({
            "token": TOKEN, "expires_at": "2099-01-01T00:00:00Z",
        })))
        .mount(server)
        .await;
}