From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH proxmox 05/27] notify: matcher: introduce common trait for match directives
Date: Tue, 7 Nov 2023 11:18:05 +0100 [thread overview]
Message-ID: <20231107101827.340100-6-l.wagner@proxmox.com> (raw)
In-Reply-To: <20231107101827.340100-1-l.wagner@proxmox.com>
This allows us to make the match-checking code a bit shorter.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
proxmox-notify/src/matcher.rs | 92 +++++++++++++++++------------------
1 file changed, 45 insertions(+), 47 deletions(-)
diff --git a/proxmox-notify/src/matcher.rs b/proxmox-notify/src/matcher.rs
index b03d11d..e299fd0 100644
--- a/proxmox-notify/src/matcher.rs
+++ b/proxmox-notify/src/matcher.rs
@@ -142,6 +142,11 @@ pub struct MatcherConfig {
pub comment: Option<String>,
}
+trait MatchDirective {
+ fn matches(&self, notification: &Notification) -> Result<bool, Error>;
+}
+
+/// Check if the notification metadata fields match
#[derive(Clone, Debug)]
pub enum FieldMatcher {
Exact {
@@ -157,9 +162,9 @@ pub enum FieldMatcher {
proxmox_serde::forward_deserialize_to_from_str!(FieldMatcher);
proxmox_serde::forward_serialize_to_display!(FieldMatcher);
-impl FieldMatcher {
- fn matches(&self, notification: &Notification) -> bool {
- match self {
+impl MatchDirective for FieldMatcher {
+ fn matches(&self, notification: &Notification) -> Result<bool, Error> {
+ Ok(match self {
FieldMatcher::Exact {
field,
matched_value,
@@ -186,7 +191,7 @@ impl FieldMatcher {
false
}
}
- }
+ })
}
}
@@ -260,9 +265,22 @@ impl MatcherConfig {
let mode = self.mode.unwrap_or_default();
let mut is_match = mode.neutral_element();
- is_match = mode.apply(is_match, self.check_severity_match(notification));
- is_match = mode.apply(is_match, self.check_field_match(notification)?);
- is_match = mode.apply(is_match, self.check_calendar_match(notification)?);
+
+ if let Some(severity_matchers) = self.match_severity.as_deref() {
+ is_match = mode.apply(
+ is_match,
+ self.check_matches(notification, severity_matchers)?,
+ );
+ }
+ if let Some(field_matchers) = self.match_field.as_deref() {
+ is_match = mode.apply(is_match, self.check_matches(notification, field_matchers)?);
+ }
+ if let Some(calendar_matchers) = self.match_calendar.as_deref() {
+ is_match = mode.apply(
+ is_match,
+ self.check_matches(notification, calendar_matchers)?,
+ );
+ }
let invert_match = self.invert_match.unwrap_or_default();
@@ -273,46 +291,24 @@ impl MatcherConfig {
})
}
- fn check_field_match(&self, notification: &Notification) -> Result<bool, Error> {
- let mode = self.mode.unwrap_or_default();
- let mut is_match = mode.neutral_element();
-
- if let Some(match_field) = self.match_field.as_deref() {
- for field_matcher in match_field {
- // let field_matcher: FieldMatcher = match_stmt.parse()?;
- is_match = mode.apply(is_match, field_matcher.matches(notification));
- }
- }
-
- Ok(is_match)
- }
-
- fn check_severity_match(&self, notification: &Notification) -> bool {
+ /// Check if given `MatchDirectives` match a notification.
+ fn check_matches(
+ &self,
+ notification: &Notification,
+ matchers: &[impl MatchDirective],
+ ) -> Result<bool, Error> {
let mode = self.mode.unwrap_or_default();
let mut is_match = mode.neutral_element();
- if let Some(matchers) = self.match_severity.as_ref() {
- for severity_matcher in matchers {
- is_match = mode.apply(is_match, severity_matcher.matches(notification));
- }
- }
-
- is_match
- }
-
- fn check_calendar_match(&self, notification: &Notification) -> Result<bool, Error> {
- let mode = self.mode.unwrap_or_default();
- let mut is_match = mode.neutral_element();
-
- if let Some(matchers) = self.match_calendar.as_ref() {
- for matcher in matchers {
- is_match = mode.apply(is_match, matcher.matches(notification)?);
- }
+ for field_matcher in matchers {
+ is_match = mode.apply(is_match, field_matcher.matches(notification)?);
}
Ok(is_match)
}
}
+
+/// Match severity of the notification.
#[derive(Clone, Debug)]
pub struct SeverityMatcher {
severities: Vec<Severity>,
@@ -321,9 +317,11 @@ pub struct SeverityMatcher {
proxmox_serde::forward_deserialize_to_from_str!(SeverityMatcher);
proxmox_serde::forward_serialize_to_display!(SeverityMatcher);
-impl SeverityMatcher {
- fn matches(&self, notification: &Notification) -> bool {
- self.severities.contains(¬ification.metadata.severity)
+/// Common trait implemented by all matching directives
+impl MatchDirective for SeverityMatcher {
+ /// Check if this directive matches a given notification
+ fn matches(&self, notification: &Notification) -> Result<bool, Error> {
+ Ok(self.severities.contains(¬ification.metadata.severity))
}
}
@@ -360,7 +358,7 @@ pub struct CalendarMatcher {
proxmox_serde::forward_deserialize_to_from_str!(CalendarMatcher);
proxmox_serde::forward_serialize_to_display!(CalendarMatcher);
-impl CalendarMatcher {
+impl MatchDirective for CalendarMatcher {
fn matches(&self, notification: &Notification) -> Result<bool, Error> {
self.schedule
.time_match(notification.metadata.timestamp, false)
@@ -433,13 +431,13 @@ mod tests {
Notification::new_templated(Severity::Notice, "test", "test", Value::Null, fields);
let matcher: FieldMatcher = "exact:foo=bar".parse().unwrap();
- assert!(matcher.matches(¬ification));
+ assert!(matcher.matches(¬ification).unwrap());
let matcher: FieldMatcher = "regex:foo=b.*".parse().unwrap();
- assert!(matcher.matches(¬ification));
+ assert!(matcher.matches(¬ification).unwrap());
let matcher: FieldMatcher = "regex:notthere=b.*".parse().unwrap();
- assert!(!matcher.matches(¬ification));
+ assert!(!matcher.matches(¬ification).unwrap());
assert!("regex:'3=b.*".parse::<FieldMatcher>().is_err());
assert!("invalid:'bar=b.*".parse::<FieldMatcher>().is_err());
@@ -455,6 +453,6 @@ mod tests {
);
let matcher: SeverityMatcher = "info,notice,warning,error".parse().unwrap();
- assert!(matcher.matches(¬ification));
+ assert!(matcher.matches(¬ification).unwrap());
}
}
--
2.39.2
next prev parent reply other threads:[~2023-11-07 10:19 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-07 10:18 [pve-devel] [PATCH many 00/27] overhaul notification system, use matchers instead of filters Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox 01/27] notify: introduce Error::Generic Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox 02/27] notify: factor out notification content into its own type Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox 03/27] notify: replace filters and groups with matcher-based system Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox 04/27] notify: add calendar matcher Lukas Wagner
2023-11-07 10:18 ` Lukas Wagner [this message]
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox 06/27] notify: let a matcher always match if it has no matching directives Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox-perl-rs 07/27] notify: adapt to new matcher-based notification routing Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-cluster 08/27] notify: adapt to matcher based notification system Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-guest-common 09/27] vzdump: deprecate mailto/mailnotification/notification-{target, policy} Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-ha-manager 10/27] env: switch to matcher-based notification system Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 11/27] api: notification: remove notification groups Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 12/27] api: notification: add new matcher-based notification API Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 13/27] ui: dc: remove unneeded notification events panel Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 14/27] vzdump: adapt to new matcher based notification system Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 15/27] api: apt: adapt to matcher-based notifications Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 16/27] api: replication: adapt to matcher-based notification system Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 17/27] debian: postinst: create notifications.cfg if it does not exist Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 18/27] test: fix vzdump notification test Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 19/27] ui: vzdump: remove left-overs from target/policy based notifications Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH pve-manager 20/27] ui: dc: config: show notification panel again Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox-widget-toolkit 21/27] notification ui: add target selector for matcher Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox-widget-toolkit 22/27] notification ui: remove filter setting for targets Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox-widget-toolkit 23/27] notification ui: remove notification groups Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox-widget-toolkit 24/27] notification ui: rename filter to matcher Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox-widget-toolkit 25/27] notification: matcher: add UI for matcher editing Lukas Wagner
2023-11-13 15:13 ` Dominik Csapak
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox-widget-toolkit 26/27] notification ui: unprotected mailto-root target Lukas Wagner
2023-11-07 10:18 ` [pve-devel] [PATCH proxmox-widget-toolkit 27/27] noficiation: matcher edit: make 'field' an editable combobox Lukas Wagner
2023-11-13 14:34 ` [pve-devel] [PATCH many 00/27] overhaul notification system, use matchers instead of filters Dominik Csapak
2023-11-13 14:54 ` Thomas Lamprecht
2023-11-13 14:58 ` Lukas Wagner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231107101827.340100-6-l.wagner@proxmox.com \
--to=l.wagner@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.