oopsie 0.1.0-rc.20

Ergonomic, structured error handling: context selectors, traced errors, and rich colorized reports
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

//! Message-free `Welp` conversion (F3): `.welp()` / `Welp::from_error`.
//!
//! These exercise the public facade + prelude surface — propagation through
//! `?`, `Display` delegation to the source, the `source()` chain shape, and
//! downcasting through `source()` back to the original error.

#![cfg_attr(
    feature = "unstable-error-generic-member-access",
    feature(error_generic_member_access)
)]

use std::error::Error as _;

use oopsie::prelude::*;

/// `.welp()?` propagates a foreign `io::Error` into a `Result<_, Welp>` with no
/// invented message, reachable purely through the prelude (it rides
/// `WelpResultExt`).
#[test]
fn welp_propagates_foreign_io_error_through_question_mark() {
    fn read() -> Result<String, Welp> {
        let raw = std::fs::read_to_string("/nonexistent/oopsie-welp-test").welp()?;
        Ok(raw)
    }

    let err = read().unwrap_err();
    // No `Welp` message is invented; the display is the io error's own.
    assert!(err.message().is_none());
    assert!(err.source().is_some());
}

/// The wrapper's `Display` equals the source's, and the source stays reachable.
#[test]
fn welp_delegates_display_to_source() {
    let result: Result<(), std::io::Error> = Err(std::io::Error::other("disk full"));
    let err = result.welp().unwrap_err();
    assert_eq!(err.to_string(), "disk full");
    assert_eq!(err.source().expect("source").to_string(), "disk full");
}

/// The chain is exactly one link deep: `Welp` -> original error -> end.
#[test]
fn welp_source_chain_is_one_link() {
    let result: Result<(), std::io::Error> = Err(std::io::Error::other("boom"));
    let err = result.welp().unwrap_err();

    let first = err.source().expect("first source is the io error");
    assert_eq!(first.to_string(), "boom");
    assert!(
        first.source().is_none(),
        "the io error is the chain's root cause"
    );
}

/// `source()` exposes the *original* error, so a caller can downcast straight
/// back to it — the property the delegating `Display`/`source` choice preserves.
#[test]
fn welp_source_downcasts_to_original_error() {
    let result: Result<(), std::io::Error> = Err(std::io::Error::new(
        std::io::ErrorKind::PermissionDenied,
        "nope",
    ));
    let err = result.welp().unwrap_err();

    let io = err
        .source()
        .and_then(|s| s.downcast_ref::<std::io::Error>())
        .expect("source downcasts back to the original io::Error");
    assert_eq!(io.kind(), std::io::ErrorKind::PermissionDenied);
}

/// `Welp::from_error` is the manual equivalent of `.welp()`.
#[test]
fn from_error_matches_welp_behavior() {
    let err = Welp::from_error(std::io::Error::other("manual"));
    assert!(err.message().is_none());
    assert_eq!(err.to_string(), "manual");
    assert_eq!(err.source().expect("source").to_string(), "manual");
}

/// Traces are captured-or-extracted like `welp_context`: a `.welp()` wrapper
/// surfaces a backtrace (the source's origin-most one under the Provider API,
/// else the wrap-site capture).
#[test]
fn welp_surfaces_a_trace() {
    use oopsie::Diagnostic as _;

    oopsie_core::test_utils::force_backtrace();
    let result: Result<(), Welp> = Err(Welp::new("origin"));
    let err = result.welp().unwrap_err();
    assert!(err.oopsie_backtrace().is_some());
}