axbuild 0.4.17

An OS build lib toolkit used by arceos
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

use std::{
    collections::BTreeSet,
    env,
    ffi::{OsStr, OsString},
    fs,
    path::Path,
    sync::{LazyLock, Mutex},
};

use ostool::run::qemu::QemuConfig;
use tempfile::tempdir;

use super::*;

static ENV_LOCK: LazyLock<Mutex<()>> = LazyLock::new(|| Mutex::new(()));

struct TempEnvVar {
    key: &'static str,
    original: Option<OsString>,
}

impl TempEnvVar {
    fn set(key: &'static str, value: impl AsRef<OsStr>) -> Self {
        let original = env::var_os(key);
        unsafe {
            env::set_var(key, value);
        }
        Self { key, original }
    }

    fn unset(key: &'static str) -> Self {
        let original = env::var_os(key);
        unsafe {
            env::remove_var(key);
        }
        Self { key, original }
    }
}

impl Drop for TempEnvVar {
    fn drop(&mut self) {
        match self.original.as_ref() {
            Some(value) => unsafe {
                env::set_var(self.key, value);
            },
            None => unsafe {
                env::remove_var(self.key);
            },
        }
    }
}

fn fake_config() -> CaseAssetConfig {
    CaseAssetConfig {
        grouped_runner: GroupedCaseRunnerConfig {
            runner_name: "suite-run-case-tests".to_string(),
            runner_path: "/usr/bin/suite-run-case-tests".to_string(),
            autorun_profile_script: None,
            begin_marker: "SUITE_GROUPED_TEST_BEGIN".to_string(),
            passed_marker: "SUITE_GROUPED_TEST_PASSED".to_string(),
            failed_marker: "SUITE_GROUPED_TEST_FAILED".to_string(),
            all_passed_marker: "SUITE_GROUPED_TESTS_PASSED".to_string(),
            all_failed_marker: "SUITE_GROUPED_TESTS_FAILED".to_string(),
            success_regex: r"(?m)^SUITE_GROUPED_TESTS_PASSED\s*$".to_string(),
            fail_regex: r"(?m)^SUITE_GROUPED_TEST_FAILED:".to_string(),
        },
        script_env: CaseScriptEnvConfig {
            staging_root: "SUITE_STAGING_ROOT".to_string(),
            case_dir: "SUITE_CASE_DIR".to_string(),
            case_c_dir: "SUITE_CASE_C_DIR".to_string(),
            case_work_dir: "SUITE_CASE_WORK_DIR".to_string(),
            case_build_dir: "SUITE_CASE_BUILD_DIR".to_string(),
            case_overlay_dir: "SUITE_CASE_OVERLAY_DIR".to_string(),
        },
        cache_env_vars: Vec::new(),
        prepare_staging_root: |_| Ok(()),
        prepare_guest_package_env: None,
    }
}

fn fake_case(root: &Path, name: &str) -> TestQemuCase {
    let case_dir = root.join("test-suite/example/default").join(name);
    fs::create_dir_all(&case_dir).unwrap();
    TestQemuCase {
        name: name.to_string(),
        display_name: name.to_string(),
        case_dir: case_dir.clone(),
        qemu_config_path: case_dir.join("qemu-aarch64.toml"),
        test_commands: Vec::new(),
        host_symbolize_success_regex: Vec::new(),
        host_http_server: None,
        subcases: Vec::new(),
        grouped_subcase_filter: None,
    }
}

#[test]
fn resolve_target_dir_uses_workspace_target_directory() {
    let root = tempdir().unwrap();
    let dir = resolve_target_dir(root.path(), "x86_64-unknown-none").unwrap();

    assert_eq!(dir, root.path().join("target/x86_64-unknown-none"));
}

#[tokio::test]
async fn prepare_case_assets_plain_case_uses_shared_rootfs_with_snapshot() {
    let root = tempdir().unwrap();
    let target_dir = root.path().join("target/x86_64-unknown-none");
    let rootfs_dir = root.path().join("tmp/axbuild/rootfs");
    fs::create_dir_all(&target_dir).unwrap();
    fs::create_dir_all(&rootfs_dir).unwrap();
    let shared_img = rootfs_dir.join("rootfs-x86_64-alpine.img");
    fs::write(&shared_img, b"rootfs").unwrap();
    let case = fake_case(root.path(), "smoke");

    let assets = prepare_case_assets(
        root.path(),
        "x86_64",
        "x86_64-unknown-none",
        &case,
        shared_img.clone(),
        fake_config(),
    )
    .await
    .unwrap();

    // Plain case (no pipeline): rootfs_path must point to the shared image
    // directly -- no per-case copy is created.
    assert_eq!(assets.rootfs_path, shared_img);
    assert!(assets.rootfs_copy_to_remove.is_none());
    // -snapshot must always be present so QEMU guest writes never dirty the
    // shared image.
    assert!(assets.extra_qemu_args.contains(&"-snapshot".to_string()));
    // The shared image must be unmodified.
    assert_eq!(fs::read(&shared_img).unwrap(), b"rootfs");
}

#[test]
fn grouped_runner_script_runs_all_commands_and_reports_summary() {
    let root = tempdir().unwrap();
    let overlay = root.path().join("overlay");
    let commands = vec![
        "/usr/bin/alpha".to_string(),
        "/usr/bin/beta --flag".to_string(),
    ];

    let config = fake_config();
    write_grouped_case_runner_script(&overlay, &commands, &config.grouped_runner).unwrap();

    let runner = overlay.join("usr/bin/suite-run-case-tests");
    let content = fs::read_to_string(&runner).unwrap();
    assert!(content.contains("total=2"));
    assert!(content.contains("step=$((step + 1))"));
    assert!(content.contains("'SUITE_GROUPED_TEST_BEGIN'"));
    assert!(content.contains("'SUITE_GROUPED_TEST_PASSED'"));
    assert!(content.contains("'SUITE_GROUPED_TEST_FAILED'"));
    assert!(content.contains("'/usr/bin/alpha'"));
    assert!(content.contains("'/usr/bin/beta --flag'"));
    assert!(content.contains("SUITE_GROUPED_TESTS_PASSED"));
}

#[test]
fn grouped_runner_script_hashes_multiline_command_labels() {
    let root = tempdir().unwrap();
    let overlay = root.path().join("overlay");
    let commands = vec![
        "failed=0\nif [ \"$failed\" -ne 0 ]; then\n    echo \"SUITE_GROUPED_TEST_FAILED: \
         nested\"\nfi"
            .to_string(),
    ];

    let config = fake_config();
    write_grouped_case_runner_script(&overlay, &commands, &config.grouped_runner).unwrap();

    let runner = overlay.join("usr/bin/suite-run-case-tests");
    let content = fs::read_to_string(&runner).unwrap();
    assert!(content.contains("sh -c 'failed=0"));
    assert!(content.contains("'inline-command:"));
    assert!(content.contains("'SUITE_GROUPED_TEST_FAILED'"));
    assert!(!content.contains("command=failed=0"));
    assert!(!content.contains("command=echo"));
}

#[test]
fn grouped_runner_can_install_profile_autorun_without_interactive_guard() {
    let root = tempdir().unwrap();
    let overlay = root.path().join("overlay");
    let commands = vec!["/usr/bin/alpha".to_string()];
    let mut config = fake_config();
    config.grouped_runner.autorun_profile_script = Some("99-suite-run-case-tests.sh".into());

    write_grouped_case_runner_script(&overlay, &commands, &config.grouped_runner).unwrap();

    let profile = overlay.join("etc/profile.d/99-suite-run-case-tests.sh");
    let content = fs::read_to_string(&profile).unwrap();
    assert!(content.contains("AXBUILD_GROUPED_AUTORUN_DONE"));
    assert!(content.contains("/usr/bin/suite-run-case-tests"));
    assert!(!content.contains("case \"$-\" in"));
    assert!(!content.contains("set -u"));
}

#[test]
fn grouped_runner_profile_autorun_skips_shell_init() {
    let mut config = fake_config();
    config.grouped_runner.autorun_profile_script = Some("99-suite-run-case-tests.sh".into());
    let mut qemu = QemuConfig::default();
    let mut case = fake_case(tempdir().unwrap().path(), "grouped");
    case.test_commands = vec!["/usr/bin/alpha".to_string()];

    apply_grouped_qemu_config(&mut qemu, &case, &config.grouped_runner);

    assert!(qemu.shell_init_cmd.is_none());
}

#[test]
fn grouped_runner_shell_init_uses_short_exec_command_without_autorun() {
    let config = fake_config();
    let mut qemu = QemuConfig::default();
    let mut case = fake_case(tempdir().unwrap().path(), "grouped");
    case.test_commands = vec!["/usr/bin/alpha".to_string()];

    apply_grouped_qemu_config(&mut qemu, &case, &config.grouped_runner);

    let command = qemu.shell_init_cmd.as_deref().unwrap();
    assert_eq!(command, "exec /usr/bin/suite-run-case-tests");
    assert!(
        command.len() < 80,
        "Starry canonical TTY input buffer is 80 bytes"
    );
}

#[test]
fn grouped_cache_key_tracks_runner_autorun_config() {
    let root = tempdir().unwrap();
    let shared_img = root.path().join("rootfs.img");
    fs::write(&shared_img, b"rootfs").unwrap();
    let case = fake_case(root.path(), "grouped");
    let mut config = fake_config();

    let without_autorun = case_asset_cache_key(
        "x86_64",
        "x86_64-unknown-none",
        CasePipeline::Grouped,
        &case,
        &shared_img,
        &config,
    )
    .unwrap();

    config.grouped_runner.autorun_profile_script = Some("99-suite-run-case-tests.sh".into());
    let with_autorun = case_asset_cache_key(
        "x86_64",
        "x86_64-unknown-none",
        CasePipeline::Grouped,
        &case,
        &shared_img,
        &config,
    )
    .unwrap();

    assert_ne!(without_autorun, with_autorun);
}

#[test]
fn grouped_cache_key_tracks_subcase_filter() {
    let root = tempdir().unwrap();
    let shared_img = root.path().join("rootfs.img");
    fs::write(&shared_img, b"rootfs").unwrap();
    let case = fake_case(root.path(), "grouped");
    let config = fake_config();

    let full_group = case_asset_cache_key(
        "x86_64",
        "x86_64-unknown-none",
        CasePipeline::Grouped,
        &case,
        &shared_img,
        &config,
    )
    .unwrap();

    let mut filtered_case = case.clone();
    filtered_case.grouped_subcase_filter = Some(BTreeSet::from(["alpha".to_string()]));
    let single_subcase = case_asset_cache_key(
        "x86_64",
        "x86_64-unknown-none",
        CasePipeline::Grouped,
        &filtered_case,
        &shared_img,
        &config,
    )
    .unwrap();

    assert_ne!(full_group, single_subcase);
}

#[test]
fn save_rootfs_cache_image_is_noop_in_ci() {
    let _lock = ENV_LOCK.lock().unwrap();
    let _ci = TempEnvVar::set("CI", "1");
    let _disable = TempEnvVar::unset("AXBUILD_DISABLE_ROOTFS_CACHE");

    let root = tempdir().unwrap();
    let src = root.path().join("src.img");
    let dst = root.path().join("cache/rootfs.img");
    fs::write(&src, vec![0_u8; 1024 * 1024]).unwrap();

    save_rootfs_cache_image(&src, &dst).unwrap();
    assert!(!dst.exists());
}

#[test]
fn save_rootfs_cache_image_writes_when_enabled() {
    let _lock = ENV_LOCK.lock().unwrap();
    let _ci = TempEnvVar::unset("CI");
    let _disable = TempEnvVar::unset("AXBUILD_DISABLE_ROOTFS_CACHE");

    let root = tempdir().unwrap();
    let src = root.path().join("src.img");
    let dst = root.path().join("cache/rootfs.img");
    fs::write(&src, vec![1_u8; 1024 * 1024]).unwrap();

    save_rootfs_cache_image(&src, &dst).unwrap();
    assert!(dst.is_file());
    assert_eq!(fs::read(&dst).unwrap().len(), 1024 * 1024);
}