bashkit 0.16.0

Awesomely fast virtual sandbox with bash and file system
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

//! Security regression tests for repository workflows.
//!
//! These tests keep high-impact CI credential boundaries explicit. The
//! coreutils drift workflow intentionally executes code from uutils/coreutils,
//! so that work must stay in a read-only job with persisted checkout
//! credentials disabled.

use std::fs;
use std::path::{Path, PathBuf};

fn repo_root() -> PathBuf {
    Path::new(env!("CARGO_MANIFEST_DIR"))
        .ancestors()
        .nth(2)
        .expect("crate must live under repo/crates/bashkit")
        .to_path_buf()
}

fn workflow(name: &str) -> String {
    let path = repo_root().join(".github/workflows").join(name);
    fs::read_to_string(path).expect("read workflow")
}

#[test]
fn c_api_windows_build_initializes_msvc_tools() {
    let wf = workflow("c-api-binaries.yml");

    assert!(
        wf.contains("uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756"),
        "Windows C API builds must initialize the MSVC environment before invoking lib.exe and cl.exe"
    );
}

#[test]
fn c_api_release_recovery_can_use_current_main_workflow() {
    let wf = workflow("c-api-binaries.yml");

    assert!(
        wf.contains(
            r#"if [ "$GITHUB_SHA" != "$TAG_SHA" ] && [ "$GITHUB_SHA" != "$MAIN_SHA" ]; then"#
        ),
        "C API recovery must allow the current main workflow to rebuild an existing release tag"
    );
}

fn section_between<'a>(text: &'a str, start: &str, end: &str) -> &'a str {
    let start_idx = text.find(start).expect("section start");
    let rest = &text[start_idx..];
    let end_idx = rest.find(end).expect("section end");
    &rest[..end_idx]
}

#[test]
fn coreutils_drift_executes_external_code_only_in_read_only_job() {
    let wf = workflow("coreutils-args-drift.yml");
    let regenerate = section_between(&wf, "  regenerate:", "  open-pr:");

    assert!(
        regenerate.contains("permissions:\n      contents: read"),
        "uutils checkout/build/test job must not have repository write permissions"
    );
    assert!(
        !regenerate.contains("contents: write") && !regenerate.contains("pull-requests: write"),
        "external-code job must not request write scopes"
    );
    assert!(
        regenerate.matches("persist-credentials: false").count() >= 2,
        "both bashkit and uutils checkouts must disable persisted credentials"
    );
    assert!(
        regenerate.contains("cargo build --release --bin coreutils"),
        "test must cover the job that executes the external uutils build"
    );
    assert!(
        regenerate.contains("BASHKIT_RUN_COREUTILS_DIFF: '1'"),
        "test must cover the job that executes the external uutils binary"
    );
}

#[test]
fn coreutils_drift_write_job_does_not_execute_uutils_or_third_party_pr_action() {
    let wf = workflow("coreutils-args-drift.yml");
    let open_pr = wf
        .split_once("  open-pr:")
        .map(|(_, section)| section)
        .expect("open-pr job");

    assert!(
        open_pr.contains("permissions:\n      contents: write\n      pull-requests: write"),
        "PR publication job owns the minimal write scopes"
    );
    assert!(
        !open_pr.contains("repository: uutils/coreutils")
            && !open_pr.contains("working-directory: uutils")
            && !open_pr.contains("cargo build")
            && !open_pr.contains("BASHKIT_RUN_COREUTILS_DIFF"),
        "write-scoped job must not checkout, build, or execute uutils"
    );
    assert!(
        !wf.contains("peter-evans/create-pull-request"),
        "write-scoped PR creation must not depend on a third-party action"
    );
    assert!(
        open_pr.contains("gh pr create") || open_pr.contains("gh pr edit"),
        "write-scoped job should publish with GitHub CLI"
    );
}