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

#[cfg(test)]
use crate::hw::qemu;

#[cfg(test)]
pub struct TestCase {
    pub name: &'static str,
    pub ignore: bool,
    pub source: &'static str,
    pub line: u32,
    pub should_panic: bool,
    pub test_fn: &'static dyn Fn(),
}

#[macro_export]
macro_rules! test {
    // The entry point
    ($($(#[$($attr:tt)+])* fn $name:ident() $body:block)*) => {
        $($crate::testing::test!(@meta_chain $([$($attr)+])* => [] {false, false} fn $name() $body);)*
    };
    // any other entrypoints are errors
    ($(other:tt)*) => {
        compile_error!("Invalid test syntax");
    };
    // The final chain, if we don't have any more `meta` attributes, we build the thing
    (@meta_chain
        => [$($builtmeta:tt)*]
        {$should_panic:expr, $ignore:expr}
        fn $name:ident() $body:block
    ) => {
        $crate::testing::test!(@final [$($builtmeta)*] {$should_panic, $ignore}  fn $name() $body);
    };
    // If we have meta `should_panic` or `ignore`, we modify the variable we are using
    (@meta_chain
        [should_panic] $([$($rest:tt)+])* => [$($builtmeta:tt)*]
        {$should_panic:expr, $ignore:expr}
        fn $name:ident() $body:block
    ) => {
        $crate::testing::test!(@meta_chain $([$($rest)+])* =>
        [
            $($builtmeta)*
        ]
        {true, $ignore} fn $name() $body);
    };
    (@meta_chain
        [ignore] $([$($rest:tt)+])* => [$($builtmeta:tt)*]
        {$should_panic:expr, $ignore:expr}
        fn $name:ident() $body:block
    ) => {
        $crate::testing::test!(@meta_chain $([$($rest)+])* =>
        [
            $($builtmeta)*
        ]
        {$should_panic, true} fn $name() $body);
    };
    // Any other attributes are passed as is
    (@meta_chain
        [$($first:tt)+] $([$($rest:tt)+])* => [$($builtmeta:tt)*]
        {$should_panic:expr, $ignore:expr}
        fn $name:ident() $body:block
    ) => {
        $crate::testing::test!(@meta_chain $([$($rest)+])* =>
        [
            #[$($first)+]
            $($builtmeta)*
        ]
        {$should_panic, $ignore} fn $name() $body);
    };
    // final construction
    (@final
        [$($builtmeta:tt)*]
        {$should_panic:expr, $ignore:expr}
        fn $name:ident() $body:block
    ) => {
        #[cfg(test)]
        $($builtmeta)*
        fn $name() $body
        #[cfg(test)]
        #[test_case]
        #[allow(non_upper_case_globals)]
        const $name: $crate::testing::TestCase = $crate::testing::TestCase {
            name: concat!(module_path!(), "::", stringify!($name)),
            ignore: $ignore,
            source: file!(),
            line: line!(),
            should_panic: $should_panic,
            test_fn: &$name,
        };
    };
}

pub use test;

#[cfg(test)]
pub fn test_runner(tests: &[&TestCase]) {
    use alloc::{string::String, vec::Vec};

    use crate::{io::console, panic_handler};

    println!("Running {} tests", tests.len());

    let mut passed = 0;
    let mut failed = 0;
    let mut ignored = 0;

    let mut failed_buffers = Vec::new();

    for test in tests {
        print!("test {} ... ", test.name);
        if test.ignore {
            println!("IGNORED");
            ignored += 1;
            continue;
        }

        assert!(console::start_capture().is_none());

        let r = panic_handler::catch_unwind(|| (test.test_fn)());

        let buffer = console::stop_capture().unwrap();

        if r.is_ok() {
            if test.should_panic {
                failed += 1;
                println!("FAILED (should_panic)");
            } else {
                passed += 1;
                println!("OK");
            }
        } else if test.should_panic {
            passed += 1;
            println!("OK");
        } else {
            failed += 1;
            println!("FAILED");

            failed_buffers.push((test.name, buffer));
        }
    }

    if !failed_buffers.is_empty() {
        println!("\n\nfailures:\n");

        for (name, panic) in failed_buffers {
            println!("--- {name} ---\n{panic}\n");
        }

        println!();
    }

    println!("{} passed; {} failed; {} ignored", passed, failed, ignored);

    if failed > 0 {
        qemu::exit(qemu::ExitStatus::Failure);
    } else {
        qemu::exit(qemu::ExitStatus::Success);
    }
}