-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #39 from VolumeGraphics/add-json-diff
- Loading branch information
Showing
12 changed files
with
455 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| use crate::report::{DiffDetail, Difference}; | ||
| use crate::Error; | ||
| use itertools::Itertools; | ||
| use regex::Regex; | ||
| use schemars_derive::JsonSchema; | ||
| use serde::{Deserialize, Serialize}; | ||
| use std::path::Path; | ||
| use tracing::error; | ||
|
|
||
| #[derive(Debug, Deserialize, Serialize, JsonSchema, Clone)] | ||
| /// configuration for the json compare module | ||
| pub struct JsonConfig { | ||
| #[serde(default)] | ||
| ignore_keys: Vec<String>, | ||
| } | ||
| impl JsonConfig { | ||
| pub(crate) fn get_ignore_list(&self) -> Result<Vec<Regex>, regex::Error> { | ||
| self.ignore_keys.iter().map(|v| Regex::new(v)).collect() | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn compare_files<P: AsRef<Path>>( | ||
| nominal: P, | ||
| actual: P, | ||
| config: &JsonConfig, | ||
| ) -> Result<Difference, Error> { | ||
| let mut diff = Difference::new_for_file(&nominal, &actual); | ||
| let compared_file_name = nominal.as_ref().to_string_lossy().into_owned(); | ||
|
|
||
| let nominal = vg_errortools::fat_io_wrap_std(&nominal, &std::fs::read_to_string)?; | ||
| let actual = vg_errortools::fat_io_wrap_std(&actual, &std::fs::read_to_string)?; | ||
| let ignores = config.get_ignore_list()?; | ||
|
|
||
| let json_diff = json_diff::process::compare_jsons(&nominal, &actual); | ||
| let json_diff = match json_diff { | ||
| Ok(diff) => diff, | ||
| Err(e) => { | ||
| let error_message = | ||
| format!("JSON deserialization failed for {compared_file_name} (error: {e})"); | ||
| error!("{}", error_message); | ||
| diff.push_detail(DiffDetail::Error(error_message)); | ||
| diff.error(); | ||
| return Ok(diff); | ||
| } | ||
| }; | ||
| let filtered_diff: Vec<_> = json_diff | ||
| .all_diffs() | ||
| .into_iter() | ||
| .filter(|(_d, v)| !ignores.iter().any(|excl| excl.is_match(v.get_key()))) | ||
| .collect(); | ||
|
|
||
| if !filtered_diff.is_empty() { | ||
| for (d_type, key) in filtered_diff.iter() { | ||
| error!("{d_type}: {key}"); | ||
| } | ||
| let left = filtered_diff | ||
| .iter() | ||
| .filter_map(|(k, v)| { | ||
| if matches!(k, json_diff::enums::DiffType::LeftExtra) { | ||
| Some(v.to_string()) | ||
| } else { | ||
| None | ||
| } | ||
| }) | ||
| .join("\n"); | ||
| let right = filtered_diff | ||
| .iter() | ||
| .filter_map(|(k, v)| { | ||
| if matches!(k, json_diff::enums::DiffType::RightExtra) { | ||
| Some(v.to_string()) | ||
| } else { | ||
| None | ||
| } | ||
| }) | ||
| .join("\n"); | ||
| let differences = filtered_diff | ||
| .iter() | ||
| .filter_map(|(k, v)| { | ||
| if matches!(k, json_diff::enums::DiffType::Mismatch) { | ||
| Some(v.to_string()) | ||
| } else { | ||
| None | ||
| } | ||
| }) | ||
| .join("\n"); | ||
| let root_mismatch = filtered_diff | ||
| .iter() | ||
| .find(|(k, _v)| matches!(k, json_diff::enums::DiffType::RootMismatch)) | ||
| .map(|(_, v)| v.to_string()); | ||
|
|
||
| diff.push_detail(DiffDetail::Json { | ||
| differences, | ||
| left, | ||
| right, | ||
| root_mismatch, | ||
| }); | ||
|
|
||
| diff.error(); | ||
| } | ||
|
|
||
| Ok(diff) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod test { | ||
| use super::*; | ||
|
|
||
| fn trim_split(list: &str) -> Vec<&str> { | ||
| list.split("\n").map(|e| e.trim()).collect() | ||
| } | ||
|
|
||
| #[test] | ||
| fn no_filter() { | ||
| let cfg = JsonConfig { | ||
| ignore_keys: vec![], | ||
| }; | ||
| let result = compare_files( | ||
| "tests/integ/data/json/expected/guy.json", | ||
| "tests/integ/data/json/actual/guy.json", | ||
| &cfg, | ||
| ) | ||
| .unwrap(); | ||
| if let DiffDetail::Json { | ||
| differences, | ||
| left, | ||
| right, | ||
| root_mismatch, | ||
| } = result.detail.first().unwrap() | ||
| { | ||
| let differences = trim_split(differences); | ||
| assert!(differences.contains(&"car -> [ \"RX7\" :: \"Panda Trueno\" ]")); | ||
| assert!(differences.contains(&"age -> [ 21 :: 18 ]")); | ||
| assert!(differences.contains(&"name -> [ \"Keisuke\" :: \"Takumi\" ]")); | ||
| assert_eq!(differences.len(), 3); | ||
|
|
||
| assert_eq!(left.as_str(), " brothers"); | ||
| assert!(right.is_empty()); | ||
| assert!(root_mismatch.is_none()); | ||
| } else { | ||
| panic!("wrong diffdetail"); | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn filter_works() { | ||
| let cfg = JsonConfig { | ||
| ignore_keys: vec!["name".to_string(), "brother(s?)".to_string()], | ||
| }; | ||
| let result = compare_files( | ||
| "tests/integ/data/json/expected/guy.json", | ||
| "tests/integ/data/json/actual/guy.json", | ||
| &cfg, | ||
| ) | ||
| .unwrap(); | ||
| if let DiffDetail::Json { | ||
| differences, | ||
| left, | ||
| right, | ||
| root_mismatch, | ||
| } = result.detail.first().unwrap() | ||
| { | ||
| let differences = trim_split(differences); | ||
| assert!(differences.contains(&"car -> [ \"RX7\" :: \"Panda Trueno\" ]")); | ||
| assert!(differences.contains(&"age -> [ 21 :: 18 ]")); | ||
| assert_eq!(differences.len(), 2); | ||
| assert!(right.is_empty()); | ||
| assert!(left.is_empty()); | ||
| assert!(root_mismatch.is_none()); | ||
| } else { | ||
| panic!("wrong diffdetail"); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.