apollo-errors 0.7.0

Structured error handling with automatic format conversion
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! Tests for JSON format output (to_json)

mod common;

use apollo_errors::{CodeCase, Error as ErrorTrait, FieldCase, FormatConfig};
use common::{ErrorWithFields, ErrorWithRenamedField, SimpleError};
use insta::assert_json_snapshot;

#[test]
fn test_simple_error_json() {
    let error = SimpleError::Simple;
    let json = error.to_json(FormatConfig::default()).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "error": "errors::simple",
      "message": "Something went wrong"
    }
    "#);
}

#[test]
fn test_another_error_json() {
    let error = SimpleError::Another;
    let json = error.to_json(FormatConfig::default()).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "error": "errors::another",
      "message": "Another error occurred"
    }
    "#);
}

#[test]
fn test_error_with_fields_json() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: "/etc/config.toml".to_string(),
    };
    let json = error.to_json(FormatConfig::default()).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "config_file": "/etc/config.toml",
      "error": "config::invalid_port",
      "message": "Invalid port",
      "port": 8080
    }
    "#);
}

#[test]
fn test_error_with_single_field_json() {
    let error = ErrorWithFields::MissingConfig {
        expected_path: "/app/config.yaml".to_string(),
    };
    let json = error.to_json(FormatConfig::default()).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "error": "config::missing",
      "expected_path": "/app/config.yaml",
      "message": "Missing configuration"
    }
    "#);
}

#[test]
fn test_field_case_kebab_code_case_screaming_snake_json() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: "/etc/config.toml".to_string(),
    };
    let config = FormatConfig {
        field_case: FieldCase::KebabCase,
        code_case: CodeCase::ScreamingSnakeCase,
    };
    let json = error.to_json(config).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "config-file": "/etc/config.toml",
      "error": "CONFIG_INVALID_PORT",
      "message": "Invalid port",
      "port": 8080
    }
    "#);
}

#[test]
fn test_field_case_screaming_snake_code_case_default_json() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: "/etc/config.toml".to_string(),
    };
    let config = FormatConfig {
        code_case: CodeCase::ScreamingSnakeCase,
        ..FormatConfig::default()
    };
    let json = error.to_json(config).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "config_file": "/etc/config.toml",
      "error": "CONFIG_INVALID_PORT",
      "message": "Invalid port",
      "port": 8080
    }
    "#);
}

#[test]
fn test_default_field_case_code_case_screaming_snake_json() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: "/etc/config.toml".to_string(),
    };
    let config = FormatConfig {
        code_case: CodeCase::ScreamingSnakeCase,
        ..FormatConfig::default()
    };
    let json = error.to_json(config).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "config_file": "/etc/config.toml",
      "error": "CONFIG_INVALID_PORT",
      "message": "Invalid port",
      "port": 8080
    }
    "#);
}

#[test]
fn test_renamed_field_pascal_case_screaming_snake_code_json() {
    let error = ErrorWithRenamedField::WithRename {
        my_field: "value".to_string(),
    };
    let config = FormatConfig {
        field_case: FieldCase::PascalCase,
        code_case: CodeCase::ScreamingSnakeCase,
    };
    let json = error.to_json(config).unwrap();
    assert_json_snapshot!(json, @r#"
    {
      "MyRenamedField": "value",
      "error": "TEST_RENAMED_FIELD",
      "message": "Field was renamed"
    }
    "#);
}