particle-os/particle-os-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: Clean up error display for validate command

Browse source
This commit is contained in:
Gerald Pinder 2024-11-01 15:50:39 -04:00
parent 9a3ad0ae17
commit 2fa3c88069
3 changed files with 64 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

31
Cargo.lock generated
View file

@ -357,7 +357,7 @@ dependencies = [
"rusty-hook",
"serde",
"serde_json",
"serde_yaml 0.9.34+deprecated",
"serde_yml",
"shadow-rs",
"tempdir",
"tokio",
@ -416,7 +416,7 @@ dependencies = [
"oci-distribution",
"serde",
"serde_json",
"serde_yaml 0.9.34+deprecated",
"serde_yml",
]
[[package]]
@ -451,7 +451,7 @@ dependencies = [
"rstest",
"serde",
"serde_json",
"serde_yaml 0.9.34+deprecated",
"serde_yml",
"syntect",
"which",
]
@ -2290,6 +2290,16 @@ dependencies = [
"libc",
]
[[package]]
name = "libyml"
version = "0.0.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3302702afa434ffa30847a83305f0a69d6abd74293b6554c18ec85c7ef30c980"
dependencies = [
"anyhow",
"version_check",
]
[[package]]
name = "linked-hash-map"
version = "0.5.6"
@ -4119,6 +4129,21 @@ dependencies = [
"unsafe-libyaml",
]
[[package]]
name = "serde_yml"
version = "0.0.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "59e2dd588bf1597a252c3b920e0143eb99b0f76e4e082f4c92ce34fbc9e71ddd"
dependencies = [
"indexmap 2.6.0",
"itoa",
"libyml",
"memchr",
"ryu",
"serde",
"version_check",
]
[[package]]
name = "sha1"
version = "0.10.6"

2
Cargo.toml
View file

@ -24,7 +24,7 @@ miette = "7"
rstest = "0.18"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
serde_yaml = "0.9"
serde_yaml = { version = "0.0.12", package = "serde_yml" }
tempdir = "0.3"
tokio = { version = "1", features = ["rt", "rt-multi-thread"] }
users = "0.11"

63
src/commands/validate.rs
View file

@ -75,18 +75,20 @@ impl BlueBuildCommand for ValidateCommand {
full.push_str(&format!("{err:?}"));
full
});
let main_err = format!("Recipe {recipe_path_display} failed to validate");
if self.all_errors {
bail!("Recipe {recipe_path_display} failed to validate:\n{errors}");
} else {
bail!(
help = format!(
"Use `{}` to view more information",
format!("bluebuild validate --all-errors {}", self.recipe.display()).bold(),
),
"Recipe {recipe_path_display} failed to validate:\n{errors}",
);
return Err(miette!("{errors}").context(main_err));
}
return Err(miette!(
help = format!(
"Use `{}` to view more information",
format!("bluebuild validate --all-errors {}", self.recipe.display()).bold(),
),
"{errors}",
)
.context(main_err));
}
info!("Recipe {recipe_path_display} is valid");
@ -323,7 +325,7 @@ fn process_basic_output(out: BasicOutput<'_>, instance: &Value, path: &Path) ->
match out {
BasicOutput::Valid(_) => vec![],
BasicOutput::Invalid(errors) => {
let mut collection: IndexMap<String, Vec<String>> = IndexMap::new();
let mut collection: IndexMap<String, Vec<Report>> = IndexMap::new();
let errors = {
let mut e = errors.into_iter().collect::<Vec<_>>();
e.sort_by(|e1, e2| {
@ -338,21 +340,17 @@ fn process_basic_output(out: BasicOutput<'_>, instance: &Value, path: &Path) ->
let schema_path = err.keyword_location();
let instance_path = err.instance_location().to_string();
let build_err = || {
format!(
"{:?}",
miette!(
"schema_path:'{}'",
schema_path.to_string().italic().dimmed(),
)
.context(err.error_description().to_string().bold().bright_red())
miette!(
"schema_path: '{}'",
schema_path.to_string().italic().dimmed(),
)
.context(err.error_description().to_string().bold().bright_red())
};
collection
.entry(instance_path)
.and_modify(|errs| {
errs.push(build_err());
// errs.sort_by(|(path1, _), (path2, _)| path1.cmp(path2));
})
.or_insert_with(|| vec![build_err()]);
}
@ -363,15 +361,21 @@ fn process_basic_output(out: BasicOutput<'_>, instance: &Value, path: &Path) ->
let instance = instance.pointer(&key).unwrap();
miette!(
"In file {} at '{}':\n\n{}\n{}",
path.display().to_string().bold().italic(),
key.bold().bright_yellow(),
"{}\n{}",
serde_yaml::to_string(instance)
.into_diagnostic()
.and_then(|file| syntax_highlighting::highlight(&file, "yml", None))
.unwrap_or_else(|_| instance.to_string()),
value.into_iter().collect::<String>()
value.into_iter().fold(String::new(), |mut acc, err| {
acc.push_str(&format!("{err:?}"));
acc
})
)
.context(format!(
"In file {} at '{}'",
path.display().to_string().bold().italic(),
key.bold().bright_yellow(),
))
})
.collect()
}
@ -386,7 +390,14 @@ fn process_err<'a, 'b>(path: &'b Path) -> impl Fn(ValidationError<'a>) -> Report
schema_path: _,
}| {
miette!(
"- Invalid value {} file '{}':\n{}",
"{}",
&serde_yaml::to_string(&*instance)
.into_diagnostic()
.and_then(|file| syntax_highlighting::highlight(&file, "yml", None))
.unwrap_or_else(|_| instance.to_string())
)
.context(format!(
"Invalid value {} file '{}'",
if instance_path.as_str().is_empty() {
string!("in root of")
} else {
@ -396,10 +407,6 @@ fn process_err<'a, 'b>(path: &'b Path) -> impl Fn(ValidationError<'a>) -> Report
)
},
path.display().to_string().italic().bold(),
&serde_yaml::to_string(&*instance)
.into_diagnostic()
.and_then(|file| syntax_highlighting::highlight(&file, "yml", None))
.unwrap_or_else(|_| instance.to_string())
)
))
}
}