Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Support all logger level case variants #4242

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/vmm/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ vm-fdt = "0.2.0"
criterion = { version = "0.5.0", default-features = false }
device_tree = "1.1.0"
proptest = { version = "1.0.0", default-features = false, features = ["std"] }
itertools = "0.12.0"

[features]
tracing = ["log-instrument"]
Expand Down
102 changes: 69 additions & 33 deletions src/vmm/src/logger/logging.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
use std::thread;

use log::{Log, Metadata, Record};
use serde::{Deserialize, Serialize};
use serde::{Deserialize, Deserializer, Serialize};
use utils::time::LocalTime;

use super::metrics::{IncMetric, METRICS};
Expand Down Expand Up @@ -200,25 +200,19 @@
/// the log level filter. It would be a breaking change to no longer support this. In the next
/// breaking release this should be removed (replaced with `log::LevelFilter` and only supporting
/// its default deserialization).
#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize)]
pub enum LevelFilter {
/// [`log::LevelFilter:Off`]
#[serde(alias = "OFF")]
Off,
/// [`log::LevelFilter:Trace`]
#[serde(alias = "TRACE")]
Trace,
/// [`log::LevelFilter:Debug`]
#[serde(alias = "DEBUG")]
Debug,
/// [`log::LevelFilter:Info`]
#[serde(alias = "INFO")]
Info,
/// [`log::LevelFilter:Warn`]
#[serde(alias = "WARN", alias = "WARNING", alias = "Warning")]
Warn,
/// [`log::LevelFilter:Error`]
#[serde(alias = "ERROR")]
Error,
}
impl From<LevelFilter> for log::LevelFilter {
Expand All @@ -233,6 +227,25 @@
}
}
}
impl<'de> Deserialize<'de> for LevelFilter {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
use serde::de::Error;
let key = String::deserialize(deserializer)?;
let level = match key.to_lowercase().as_str() {
"off" => Ok(LevelFilter::Off),
"trace" => Ok(LevelFilter::Trace),
"debug" => Ok(LevelFilter::Debug),
"info" => Ok(LevelFilter::Info),
"warn" | "warning" => Ok(LevelFilter::Warn),
"error" => Ok(LevelFilter::Error),
_ => Err(D::Error::custom("Invalid LevelFilter")),

Check warning on line 244 in src/vmm/src/logger/logging.rs

View check run for this annotation

Codecov / codecov/patch

src/vmm/src/logger/logging.rs#L244

Added line #L244 was not covered by tests
};
level
}
}

/// Error type for [`<LevelFilter as FromStr>::from_str`].
#[derive(Debug, PartialEq, Eq, thiserror::Error)]
Expand All @@ -242,13 +255,13 @@
impl FromStr for LevelFilter {
type Err = LevelFilterFromStrError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"Off" | "OFF" => Ok(Self::Off),
"Trace" | "TRACE" => Ok(Self::Trace),
"Debug" | "DEBUG" => Ok(Self::Debug),
"Info" | "INFO" => Ok(Self::Info),
"Warn" | "WARN" | "Warning" | "WARNING" => Ok(Self::Warn),
"Error" | "ERROR" => Ok(Self::Error),
match s.to_ascii_lowercase().as_str() {
wearyzen marked this conversation as resolved.
Show resolved Hide resolved
"off" => Ok(Self::Off),
"trace" => Ok(Self::Trace),
"debug" => Ok(Self::Debug),
"info" => Ok(Self::Info),
"warn" | "warning" => Ok(Self::Warn),
"error" => Ok(Self::Error),
_ => Err(LevelFilterFromStrError(String::from(s))),
}
}
Expand Down Expand Up @@ -287,29 +300,52 @@
log::LevelFilter::Error
);
}

wearyzen marked this conversation as resolved.
Show resolved Hide resolved
#[test]
fn levelfilter_from_str() {
fn levelfilter_from_str_all_variants() {
use itertools::Itertools;

#[derive(Deserialize)]
struct Foo {
#[allow(dead_code)]
level: LevelFilter,
}

for (level, level_enum) in [
("off", LevelFilter::Off),
("trace", LevelFilter::Trace),
("debug", LevelFilter::Debug),
("info", LevelFilter::Info),
("warn", LevelFilter::Warn),
("warning", LevelFilter::Warn),
("error", LevelFilter::Error),
] {
let multi = level.chars().map(|_| 0..=1).multi_cartesian_product();
for combination in multi {
let variant = level
.chars()
.zip_eq(combination)
.map(|(c, v)| match v {
0 => c.to_ascii_lowercase(),
1 => c.to_ascii_uppercase(),
_ => unreachable!(),
})
.collect::<String>();

let ex = format!("{{ \"level\": \"{}\" }}", variant);
assert_eq!(LevelFilter::from_str(&variant), Ok(level_enum));
assert!(serde_json::from_str::<Foo>(&ex).is_ok(), "{ex}");
}
}
let ex = "{{ \"level\": \"blah\" }}".to_string();
assert!(
serde_json::from_str::<Foo>(&ex).is_err(),
"expected error got {ex:#?}"
);
assert_eq!(
LevelFilter::from_str("bad"),
Err(LevelFilterFromStrError(String::from("bad")))
);

assert_eq!(LevelFilter::from_str("Off"), Ok(LevelFilter::Off));
assert_eq!(LevelFilter::from_str("Trace"), Ok(LevelFilter::Trace));
assert_eq!(LevelFilter::from_str("Debug"), Ok(LevelFilter::Debug));
assert_eq!(LevelFilter::from_str("Info"), Ok(LevelFilter::Info));
assert_eq!(LevelFilter::from_str("Warn"), Ok(LevelFilter::Warn));
assert_eq!(LevelFilter::from_str("Error"), Ok(LevelFilter::Error));

assert_eq!(LevelFilter::from_str("OFF"), Ok(LevelFilter::Off));
assert_eq!(LevelFilter::from_str("TRACE"), Ok(LevelFilter::Trace));
assert_eq!(LevelFilter::from_str("DEBUG"), Ok(LevelFilter::Debug));
assert_eq!(LevelFilter::from_str("INFO"), Ok(LevelFilter::Info));
assert_eq!(LevelFilter::from_str("WARN"), Ok(LevelFilter::Warn));
assert_eq!(LevelFilter::from_str("ERROR"), Ok(LevelFilter::Error));

assert_eq!(LevelFilter::from_str("Warning"), Ok(LevelFilter::Warn));
assert_eq!(LevelFilter::from_str("WARNING"), Ok(LevelFilter::Warn));
}

#[test]
Expand Down
Loading