rust-errkit 0.1.1

Idiomatic Rust error handling kit
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

use rust_errkit::result::ResultExt;
use rust_errkit::{
    AppError, AppResult,
    kind::{ErrorDomain, ErrorKind, ErrorReason},
};

#[test]
fn test_error_reason_message() {
    let reason = ErrorReason::Timeout;

    assert_eq!(
        reason.message(),
        "The operation took too long to respond. Please try again later."
    );
}

#[test]
fn test_error_kind_creation() {
    let kind = ErrorKind::network(ErrorReason::Timeout);

    match kind.domain {
        ErrorDomain::Network => {}
        _ => panic!("wrong domain"),
    }

    assert_eq!(
        kind.message(),
        "The operation took too long to respond. Please try again later."
    );
}

#[test]
fn test_error_kind_display() {
    let kind = ErrorKind::network(ErrorReason::Timeout);

    let display_output = format!("{}", kind);
    assert!(display_output.contains("[Network]"));
    assert!(display_output.contains("Timeout"));
    assert!(display_output.contains("The operation took too long"));
}

#[test]
fn test_app_error_creation() {
    let err = AppError::from(ErrorKind::db(ErrorReason::ConnectionFailed));

    assert_eq!(
        err.kind.message(),
        "Unable to establish a connection to the server or service."
    );
    assert!(err.context.is_none());
}

#[test]
fn test_app_error_context() {
    let err = AppError::from(ErrorKind::network(ErrorReason::Timeout))
        .with_context("reqwest", Some("timeout at 10s".to_string()));

    let ctx = err.context.as_ref().unwrap();

    assert_eq!(ctx.source, "reqwest");
    assert_eq!(ctx.details.as_ref().unwrap(), "timeout at 10s");

    let display_output = format!("{}", err);
    assert!(display_output.contains("Source: reqwest"));
}

#[test]
fn test_unknown_error() {
    let err = AppError::unknown();

    assert!(
        err.kind
            .message()
            .contains("An unhandled exception occurred")
    );
}

#[test]
fn test_result_ext_ok() {
    let res: AppResult<i32> = Ok(10);

    let out = res.errkit();

    assert!(out.is_ok());
    assert_eq!(out.unwrap(), 10);
}

#[test]
fn test_result_ext_err() {
    let res: AppResult<i32> = Err(AppError::unknown());

    let out = res.errkit();

    assert!(out.is_err());
}

#[test]
fn test_full_error_flow() {
    let err = AppError::from(ErrorKind::auth(ErrorReason::Unauthorized))
        .with_context("auth_service", None);

    assert_eq!(
        err.kind.message(),
        "Authentication is required to access this resource."
    );

    let ctx = err.context.unwrap();
    assert_eq!(ctx.source, "auth_service");
}

#[test]
fn test_error_trait_compatibility() {
    use std::error::Error;

    let err = AppError::from(ErrorKind::core(ErrorReason::ChecksumMismatch));

    assert!(err.source().is_some());
}