aerro 0.9.0

Cross-service gRPC error framework for Rust.
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

//! End-to-end test of `#[derive(aerro::Aerro)]` — verifies the derive produces
//! a working `Aerro` impl that round-trips via the wire layer.

#![cfg(feature = "macro")]

use aerro::wire::encode::EncodeOptions;
use aerro::{Aerro, Category, Exposure, IntoStatus, ServiceFailure, StatusIntoResultExt};
use tonic::Code;

#[derive(Debug, aerro::Aerro)]
pub enum CreateUser {
    #[aerro(
        category = Business,
        code = AlreadyExists,
        error = "email already taken: {email}"
    )]
    EmailTaken { email: String },

    #[aerro(
        category = Validation,
        code = InvalidArgument,
        error = "invalid name: {0}"
    )]
    InvalidName(String),

    #[aerro(category = System, code = Internal, error = "create_user.boom")]
    Boom,
}

#[test]
fn type_ids_listed() {
    assert_eq!(
        CreateUser::TYPE_IDS,
        &[
            "create_user.email_taken",
            "create_user.invalid_name",
            "create_user.boom",
        ]
    );
}

#[test]
fn type_id_per_variant() {
    assert_eq!(
        Aerro::type_id(&CreateUser::EmailTaken { email: "x".into() }),
        "create_user.email_taken"
    );
    assert_eq!(
        Aerro::type_id(&CreateUser::InvalidName("nope".into())),
        "create_user.invalid_name"
    );
    assert_eq!(Aerro::type_id(&CreateUser::Boom), "create_user.boom");
}

#[test]
fn category_and_code_dispatch() {
    let e = CreateUser::EmailTaken {
        email: "a@b".into(),
    };
    assert_eq!(e.category(), Category::Business);
    assert_eq!(e.code(), Code::AlreadyExists);
    assert_eq!(e.exposure(), Exposure::Public);

    let s = CreateUser::Boom;
    assert_eq!(s.category(), Category::System);
    assert_eq!(s.code(), Code::Internal);
    assert_eq!(s.exposure(), Exposure::Internal);
}

#[test]
fn display_renders_format_string() {
    assert_eq!(
        CreateUser::EmailTaken {
            email: "a@b".into()
        }
        .to_string(),
        "email already taken: a@b"
    );
    assert_eq!(
        CreateUser::InvalidName("@@@".into()).to_string(),
        "invalid name: @@@"
    );
}

#[test]
fn struct_variant_roundtrips_via_wire() {
    let st = CreateUser::EmailTaken {
        email: "alice@x".into(),
    }
    .into_status(&EncodeOptions::default());
    let sf: ServiceFailure<CreateUser> = st.into_aerro::<CreateUser>().unwrap();
    match sf.into_inner() {
        CreateUser::EmailTaken { email } => assert_eq!(email, "alice@x"),
        _ => panic!("wrong variant"),
    }
}

#[test]
fn tuple_variant_roundtrips_via_wire() {
    let st = CreateUser::InvalidName("bob".into()).into_status(&EncodeOptions::default());
    let sf: ServiceFailure<CreateUser> = st.into_aerro::<CreateUser>().unwrap();
    match sf.into_inner() {
        CreateUser::InvalidName(s) => assert_eq!(s, "bob"),
        _ => panic!("wrong variant"),
    }
}

#[test]
fn unit_variant_roundtrips_via_wire() {
    let st = CreateUser::Boom.into_status(&EncodeOptions::default());
    let sf: ServiceFailure<CreateUser> = st.into_aerro::<CreateUser>().unwrap();
    assert!(matches!(sf.inner(), CreateUser::Boom));
}