ktest 0.1.6

A custom test framework for Rust-based operating system kernels
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

/// `klib!` function-like macro
#[cfg(not(feature = "limine"))]
#[macro_export]
macro_rules! klib {
    // test group only
    ($test_group:literal) => {
        $crate::klib!($test_group, klib_config = &ktest::KlibConfig::new_default(), boot_config = &bootloader_api::BootloaderConfig::new_default());
    };

    // test group + klib config
    ($test_group:literal, klib_config = &$klib_config:expr) => {
        $crate::klib!($test_group, klib_config = &$klib_config, boot_config = &bootloader_api::BootloaderConfig::new_default());
    };

    // test group + boot config
    ($test_group:literal, boot_config = &$boot_config:expr) => {
        $crate::klib!($test_group, klib_config = &ktest::KlibConfig::new_default(), boot_config = &$boot_config);
    };

    // test group + klib config + boot config
    ($test_group:literal, klib_config = &$klib_config:expr, boot_config = &$boot_config:expr) => {
        #[cfg(test)] // it is important to only include this code in test builds
        const _: () = {
            // note: the triple underscore (___) prefix is to avoid name collisions

            static ___BOOTLOADER_CONFIG: bootloader_api::BootloaderConfig = $boot_config;
            static ___KLIB_CONFIG: ktest::KlibConfig = $klib_config;

            #[panic_handler]
            fn ___panic(info: &core::panic::PanicInfo) -> ! {
                ktest::panic(info)
            }

            fn ___kernel_test_main(boot_info: &'static mut bootloader_api::BootInfo) -> ! {
                ktest::init_harness($test_group);
                ktest::memory::heap::init_allocator_if_enabled(boot_info)
                    .expect("Heap allocator initialization failed");

                if let Some(before_tests) = ___KLIB_CONFIG.before_tests {
                    before_tests(boot_info);
                }

                test_main();

                if let Some(after_tests) = ___KLIB_CONFIG.after_tests {
                    after_tests();
                }

                loop {
                    // It may seem preferable to use the x86_64 `hlt` instruction here, but
                    // that would require any crates using this macro to depend on `x86_64`,
                    // which is not desirable. Using inline assembly avoids that dependency.
                    //
                    // note: this is the exact same instruction as `x86_64::instructions::hlt()`
                    unsafe { core::arch::asm!("hlt", options(nomem, nostack, preserves_flags)); }
                }
            }

            bootloader_api::entry_point!(___kernel_test_main, config = &___BOOTLOADER_CONFIG);
        };
    };
}

/// `klib!` function-like macro
#[cfg(feature = "limine")]
#[macro_export]
macro_rules! klib {
    // test group only
    ($test_group:literal) => {
        $crate::klib!($test_group, klib_config = &ktest::KlibConfig::new_default());
    };

    // test group + klib config
    ($test_group:literal, klib_config = &$klib_config:expr) => {
        #[cfg(test)] // it is important to only include this code in test builds
        const _: () = {
            // note: the triple underscore (___) prefix is to avoid name collisions

            #[used]
            #[unsafe(link_section = ".requests_start_marker")]
            static ___START_MARKER: limine::request::RequestsStartMarker = limine::request::RequestsStartMarker::new();

            #[used]
            #[unsafe(link_section = ".requests_end_marker")]
            static ___END_MARKER: limine::request::RequestsEndMarker = limine::request::RequestsEndMarker::new();

            static ___KLIB_CONFIG: ktest::KlibConfig = $klib_config;

            #[panic_handler]
            fn ___panic(info: &core::panic::PanicInfo) -> ! {
                ktest::panic(info)
            }

            #[unsafe(no_mangle)]
            pub extern "C" fn _start() -> ! {
                ktest::init_harness($test_group);

                if let Some(before_tests) = ___KLIB_CONFIG.before_tests {
                    before_tests();
                }

                test_main();

                if let Some(after_tests) = ___KLIB_CONFIG.after_tests {
                    after_tests();
                }

                loop {
                    // It may seem preferable to use the x86_64 `hlt` instruction here, but
                    // that would require any crates using this macro to depend on `x86_64`,
                    // which is not desirable. Using inline assembly avoids that dependency.
                    //
                    // note: this is the exact same instruction as `x86_64::instructions::hlt()`
                    unsafe { core::arch::asm!("hlt", options(nomem, nostack, preserves_flags)); }
                }
            }
        };
    };
}

pub struct KlibConfig {
    #[cfg(not(feature = "limine"))]
    pub before_tests: Option<fn(&'static bootloader_api::BootInfo)>,
    #[cfg(feature = "limine")]
    pub before_tests: Option<fn()>,
    pub after_tests: Option<fn()>
}

impl KlibConfig {
    pub const fn new_default() -> Self {
        KlibConfig {
            before_tests: None,
            after_tests: None
        }
    }
}

pub struct KlibConfigBuilder {
    #[cfg(not(feature = "limine"))]
    pub before_tests: Option<fn(&'static bootloader_api::BootInfo)>,
    #[cfg(feature = "limine")]
    pub before_tests: Option<fn()>,
    pub after_tests: Option<fn()>
}

impl KlibConfigBuilder {
    pub const fn new_default() -> Self {
        KlibConfigBuilder {
            before_tests: None,
            after_tests: None
        }
    }

    #[cfg(not(feature = "limine"))]
    pub const fn new(before_tests: Option<fn(&'static bootloader_api::BootInfo)>, after_tests: Option<fn()>) -> Self {
        KlibConfigBuilder {
            before_tests,
            after_tests
        }
    }

    #[cfg(feature = "limine")]
    pub const fn new(before_tests: Option<fn()>, after_tests: Option<fn()>) -> Self {
        KlibConfigBuilder {
            before_tests,
            after_tests
        }
    }

    pub const fn build(self) -> KlibConfig {
        KlibConfig {
            before_tests: self.before_tests,
            after_tests: self.after_tests
        }
    }

    #[cfg(not(feature = "limine"))]
    pub const fn before_tests(mut self, before_tests: fn(&'static bootloader_api::BootInfo)) -> Self {
        self.before_tests = Some(before_tests);
        self
    }

    #[cfg(feature = "limine")]
    pub const fn before_tests(mut self, before_tests: fn()) -> Self {
        self.before_tests = Some(before_tests);
        self
    }

    pub const fn after_tests(mut self, after_tests: fn()) -> Self {
        self.after_tests = Some(after_tests);
        self
    }
}