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

use heapless::{format, String};
use crate::{debugcon_println, MAX_STRING_LENGTH};

/// Writes a JSON object indicating the start of a test group with its name and test count.
pub fn write_test_group(test_group: &str, test_count: usize) {
    let use_kview = cfg!(feature = "kview");
    let test_group_json: String<MAX_STRING_LENGTH> = format!(r#"{{ "test_group": "{}", "test_count": {}, "use_kview": {} }}"#, 
        test_group, test_count, use_kview).unwrap();
    let test_group_json = replace_heapless_string(&test_group_json, "\n", "").unwrap();
    let test_group_json = replace_heapless_string(&test_group_json, "\t", "").unwrap();

    debugcon_println!("{}", test_group_json);
}

/// Writes a JSON object indicating the success of a test case, including its name and cycle count.
pub fn write_test_success(test_name: &str, cycle_count: u64) {
    let test_json: String<MAX_STRING_LENGTH> = format!(r#"
{{
    "test": "{}",
    "result": "pass",
    "cycle_count": {}
}}"#, test_name, cycle_count).unwrap();
    let test_json = replace_heapless_string(&test_json, "\n", "").unwrap();
    let test_json = replace_heapless_string(&test_json, "   ", "").unwrap();

    debugcon_println!("{}", test_json);
}

/// Writes a JSON object indicating the ignore of a test case, including its name and cycle count.
pub fn write_test_ignore(test_name: &str) {
    let test_json: String<MAX_STRING_LENGTH> = format!(r#"
{{
    "test": "{}",
    "result": "ignore",
    "cycle_count": 0
}}"#, test_name).unwrap();
    let test_json = replace_heapless_string(&test_json, "\n", "").unwrap();
    let test_json = replace_heapless_string(&test_json, "   ", "").unwrap();

    debugcon_println!("{}", test_json);
}

/// Writes a JSON object indicating the failure of a test case, including its name, location, and failure message.
pub fn write_test_failure(test_name: &str, location: &str, message: &str) {
    let location = replace_heapless_string(&String::<MAX_STRING_LENGTH>::try_from(location).unwrap(), "\\", "/").unwrap(); // prevents escape issues with heapless String

    let test_json: String<MAX_STRING_LENGTH> = format!(r#"
{{
    "test": "{}",
    "result": "fail",
    "cycle_count": 0,
    "location": "{}",
    "message": "{}"
}}"#, test_name, location, message).unwrap();
    let test_json = replace_heapless_string(&test_json, "\n", "").unwrap();
    let test_json = replace_heapless_string(&test_json, "   ", "").unwrap();

    debugcon_println!("{}", test_json);
}

/// Helper function to replace all occurrences of a substring in a heapless String
fn replace_heapless_string(
    original: &String<MAX_STRING_LENGTH>,
    from: &str,
    to: &str,
) -> Result<String<MAX_STRING_LENGTH>, heapless::string::FromUtf16Error> {
    let mut new_string: String<MAX_STRING_LENGTH> = String::new();
    let mut last_end = 0;

    for (start, _) in original.match_indices(from) {
        new_string.push_str(&original[last_end..start])?;
        new_string.push_str(to)?;
        last_end = start + from.len();
    }
    new_string.push_str(&original[last_end..])?;
    Ok(new_string)
}