gmssl-errors 0.1.0

Custom error library support for the gmssl crate.
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

use cfg_if::cfg_if;
use gmssl::error::Error;

gmssl_errors::gmssl_errors! {
    library Test("test library") {
        functions {
            FOO("function foo");
            BAR("function bar");
        }

        reasons {
            NO_MILK("out of milk");
            NO_BACON("out of bacon");
        }
    }
}

#[test]
fn basic() {
    gmssl_errors::put_error!(Test::FOO, Test::NO_MILK);

    let error = Error::get().unwrap();
    assert_eq!(error.library().unwrap(), "test library");
    assert_eq!(error.function().unwrap(), "function foo");
    assert_eq!(error.reason().unwrap(), "out of milk");
    // Replace Windows `\` separators with `/`
    assert_eq!(
        error.file().replace('\\', "/"),
        "gmssl-errors/tests/test.rs"
    );
    assert_eq!(error.line(), line!() - 11);
    cfg_if! {
        if #[cfg(ossl300)] {
            // https://github.com/openssl/openssl/issues/12530
            assert!(error.data().is_none() || error.data() == Some(""));
        } else {
            assert_eq!(error.data(), None);
        }
    }
}

#[test]
fn static_data() {
    gmssl_errors::put_error!(Test::BAR, Test::NO_BACON, "foobar {{}}");

    let error = Error::get().unwrap();
    assert_eq!(error.library().unwrap(), "test library");
    assert_eq!(error.function().unwrap(), "function bar");
    assert_eq!(error.reason().unwrap(), "out of bacon");
    // Replace Windows `\` separators with `/`
    assert_eq!(
        error.file().replace('\\', "/"),
        "gmssl-errors/tests/test.rs"
    );
    assert_eq!(error.line(), line!() - 11);
    assert_eq!(error.data(), Some("foobar {}"));
}

#[test]
fn dynamic_data() {
    gmssl_errors::put_error!(Test::BAR, Test::NO_MILK, "hello {}", "world");

    let error = Error::get().unwrap();
    assert_eq!(error.library().unwrap(), "test library");
    assert_eq!(error.function().unwrap(), "function bar");
    assert_eq!(error.reason().unwrap(), "out of milk");
    // Replace Windows `\` separators with `/`
    assert_eq!(
        error.file().replace('\\', "/"),
        "gmssl-errors/tests/test.rs"
    );
    assert_eq!(error.line(), line!() - 11);
    assert_eq!(error.data(), Some("hello world"));
}

#[test]
fn deferred_error_render() {
    gmssl_errors::put_error!(Test::BAR, Test::NO_MILK);

    let error = Error::get().unwrap();

    for _ in 0..100 {
        gmssl_errors::put_error!(Test::FOO, Test::NO_BACON);
    }

    assert_eq!(error.function().unwrap(), "function bar");
    // Replace Windows `\` separators with `/`
    assert_eq!(
        error.file().replace('\\', "/"),
        "gmssl-errors/tests/test.rs"
    );

    // clear out the stack for other tests on the same thread
    while Error::get().is_some() {}
}