cargo-image-runner 0.5.0

A generic, customizable runner for building and booting kernel/embedded images with Limine, GRUB, QEMU, and more
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

//! Integration tests for standalone library usage (no cargo_metadata required).

use cargo_image_runner::{builder, Config};

/// Test the full standalone workflow: Config::from_toml_str -> builder -> build_image.
#[test]
fn test_standalone_from_toml_str() {
    let dir = tempfile::tempdir().unwrap();

    let exe = dir.path().join("kernel.efi");
    std::fs::write(&exe, b"fake uefi executable").unwrap();

    let config = Config::from_toml_str(
        r#"
        [boot]
        type = "uefi"

        [bootloader]
        kind = "none"

        [image]
        format = "directory"
        "#,
    )
    .unwrap();

    assert_eq!(config.boot.boot_type, cargo_image_runner::BootType::Uefi);
    assert_eq!(
        config.bootloader.kind,
        cargo_image_runner::BootloaderKind::None
    );
    assert_eq!(
        config.image.format,
        cargo_image_runner::ImageFormat::Directory
    );

    let runner = builder()
        .with_config(config)
        .workspace_root(dir.path())
        .executable(&exe)
        .build()
        .unwrap();

    let image_path = runner.build_image().unwrap();
    assert!(image_path.exists());
    assert!(image_path.is_dir());

    let bootx64 = image_path.join("efi/boot/bootx64.efi");
    assert!(bootx64.exists());
    assert_eq!(
        std::fs::read_to_string(&bootx64).unwrap(),
        "fake uefi executable"
    );
}

/// Test Config::from_toml_file for loading from a standalone file.
#[test]
fn test_standalone_from_toml_file() {
    let dir = tempfile::tempdir().unwrap();

    let config_path = dir.path().join("image-runner.toml");
    std::fs::write(
        &config_path,
        r#"
        [boot]
        type = "uefi"

        [bootloader]
        kind = "none"

        [image]
        format = "directory"

        [variables]
        KERNEL_NAME = "test-kernel"
        "#,
    )
    .unwrap();

    let config = Config::from_toml_file(&config_path).unwrap();
    assert_eq!(config.boot.boot_type, cargo_image_runner::BootType::Uefi);
    assert_eq!(config.variables.get("KERNEL_NAME").unwrap(), "test-kernel");
}

/// Test that Config::from_toml_str with defaults works (minimal TOML).
#[test]
fn test_standalone_minimal_config() {
    let config = Config::from_toml_str("").unwrap();
    assert_eq!(config.boot.boot_type, cargo_image_runner::BootType::Uefi);
    assert_eq!(
        config.bootloader.kind,
        cargo_image_runner::BootloaderKind::None
    );
    assert_eq!(
        config.image.format,
        cargo_image_runner::ImageFormat::Directory
    );
}

/// Test error on invalid TOML input.
#[test]
fn test_standalone_invalid_toml() {
    let result = Config::from_toml_str("not valid { toml [[[");
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("TOML"));
}

/// Test error on missing config file.
#[test]
fn test_standalone_missing_file() {
    let result = Config::from_toml_file("/nonexistent/path/config.toml");
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("config file"));
}