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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
use thiserror::Error; #[derive(Debug, PartialEq, Eq)] pub enum PathSegment<'a> { Name(&'a str), Index(usize), } #[derive(Debug, PartialEq, Eq)] pub struct State<'a> { path: Vec<PathSegment<'a>>, } impl<'a> std::fmt::Display for State<'a> { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { for segment in self.path.iter().rev() { match segment { PathSegment::Name(name) => write!(f, ".{}", name)?, PathSegment::Index(index) => write!(f, "[{}]", index)?, }; } Ok(()) } } impl<'a> Default for State<'a> { fn default() -> Self { State { path: vec![] } } } #[derive(Error, Debug, PartialEq, Eq)] pub enum SchemaErrorKind<'a> { #[error("wrong type, expected {expected} got {actual}")] WrongType { expected: &'static str, actual: &'a str, }, #[error("field '{field}' missing")] FieldMissing { field: &'a str }, #[error("field '{field}' is not specified in the schema")] ExtraField { field: &'a str }, #[error("unknown type specified: {unknown_type}")] UnknownType { unknown_type: &'a str }, #[error("multiple errors were encountered: {errors:?}")] Multiple { errors: Vec<SchemaError<'a>> }, #[error("schema '{uri}' references was not found")] UnknownSchema { uri: &'a str }, } #[derive(Debug, PartialEq, Eq)] pub struct SchemaError<'a> { pub kind: SchemaErrorKind<'a>, pub state: State<'a>, } impl<'a> SchemaError<'a> { fn flatten(&self, fmt: &mut std::fmt::Formatter<'_>, root: String) -> std::fmt::Result { match &self.kind { SchemaErrorKind::Multiple { errors } => { for err in errors { err.flatten(fmt, format!("{}{}", root, self.state))?; } } err => writeln!(fmt, "{}{}: {}", root, self.state, err)?, } Ok(()) } } impl<'a> std::fmt::Display for SchemaError<'a> { fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { self.flatten(fmt, "#".to_string()) } } #[cfg(test)] impl<'a> SchemaErrorKind<'a> { pub fn with_path(self, path: Vec<PathSegment<'a>>) -> SchemaError<'a> { SchemaError { kind: self, state: State { path }, } } } pub fn add_path_name<'a>(path: &'a str) -> impl Fn(SchemaError<'a>) -> SchemaError<'a> { move |mut err: SchemaError<'a>| -> SchemaError<'a> { err.state.path.push(PathSegment::Name(path)); err } } pub fn add_path_index<'a>(index: usize) -> impl Fn(SchemaError<'a>) -> SchemaError<'a> { move |mut err: SchemaError<'a>| -> SchemaError<'a> { err.state.path.push(PathSegment::Index(index)); err } } pub fn optional<'a, T>(default: T) -> impl FnOnce(SchemaError<'a>) -> Result<T, SchemaError<'a>> { move |err: SchemaError<'a>| -> Result<T, SchemaError<'a>> { match err.kind { SchemaErrorKind::FieldMissing { .. } => Ok(default), _ => Err(err), } } } impl<'a> Into<SchemaError<'a>> for SchemaErrorKind<'a> { fn into(self) -> SchemaError<'a> { SchemaError { kind: self, state: State::default(), } } } #[cfg(test)] mod tests { use crate::types::*; use crate::utils::load_simple; use crate::{Context, Validate}; use std::convert::TryFrom; #[test] fn test_error_path() { let yaml = load_simple( r#" items: test: type: integer something: type: object items: level2: type: object items: leaf: hello "#, ); let err = SchemaObject::try_from(&yaml).unwrap_err(); debug_assert_eq!( format!("{}", err), "#.items.something.items.level2.items.leaf: field \'type\' missing\n", ); } #[test] fn test_error_path_validation() { let yaml = load_simple( r#" items: test: type: integer something: type: object items: level2: type: array items: type: object items: num: type: integer "#, ); let schema = SchemaObject::try_from(&yaml).unwrap(); let document = load_simple( r#" test: 20 something: level2: - num: abc - num: hash: value - num: - array: hello - num: 10 - num: jkl "#, ); let ctx = Context::default(); let err = schema.validate(&ctx, &document).unwrap_err(); debug_assert_eq!( format!("{}", err), r#"#.something.level2[0].num: wrong type, expected integer got string #.something.level2[1].num: wrong type, expected integer got hash #.something.level2[2].num: wrong type, expected integer got array #.something.level2[4].num: wrong type, expected integer got string "# ); } }