From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com, pve-devel@lists.proxmox.com
Subject: [PATCH proxmox 12/29] notify: api: support new expression parameter
Date: Thu, 9 Jul 2026 13:56:59 +0200 [thread overview]
Message-ID: <20260709115716.299836-13-l.wagner@proxmox.com> (raw)
In-Reply-To: <20260709115716.299836-1-l.wagner@proxmox.com>
Add support for the new 'expression' parameter to the add_matcher and
updater_matcher API functions. Also add some validation that won't allow
to create a configuration with both old properties and new the
'expression'.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
proxmox-notify/src/api/matcher.rs | 119 ++++++++++++++++++++++++++++++
proxmox-notify/src/matcher/mod.rs | 43 ++++++++++-
2 files changed, 161 insertions(+), 1 deletion(-)
diff --git a/proxmox-notify/src/api/matcher.rs b/proxmox-notify/src/api/matcher.rs
index b2bf15ae..3713dfef 100644
--- a/proxmox-notify/src/api/matcher.rs
+++ b/proxmox-notify/src/api/matcher.rs
@@ -40,6 +40,10 @@ pub fn add_matcher(config: &mut Config, matcher_config: MatcherConfig) -> Result
super::ensure_unique(config, &matcher_config.name)?;
super::ensure_endpoints_exist(config, &matcher_config.target)?;
+ matcher_config
+ .ensure_valid()
+ .map_err(|err| http_err!(BAD_REQUEST, "invalid matcher config: {err}"))?;
+
config
.config
.set_data(&matcher_config.name, MATCHER_TYPENAME, &matcher_config)
@@ -83,6 +87,7 @@ pub fn update_matcher(
DeleteableMatcherProperty::InvertMatch => matcher.invert_match = None,
DeleteableMatcherProperty::Comment => matcher.comment = None,
DeleteableMatcherProperty::Disable => matcher.disable = None,
+ DeleteableMatcherProperty::Expression => matcher.expression = None,
}
}
}
@@ -115,11 +120,19 @@ pub fn update_matcher(
matcher.disable = Some(disable);
}
+ if let Some(expression) = matcher_updater.expression {
+ matcher.expression = Some(expression);
+ }
+
if let Some(target) = matcher_updater.target {
super::ensure_endpoints_exist(config, target.as_slice())?;
matcher.target = target;
}
+ matcher
+ .ensure_valid()
+ .map_err(|err| http_err!(BAD_REQUEST, "invalid matcher config: {err}"))?;
+
config
.config
.set_data(name, MATCHER_TYPENAME, &matcher)
@@ -150,8 +163,12 @@ pub fn delete_matcher(config: &mut Config, name: &str) -> Result<(), HttpError>
#[cfg(all(test, feature = "sendmail"))]
mod tests {
+ use proxmox_match_expression::Expression;
+
use super::*;
+
use crate::matcher::MatchModeOperator;
+ use crate::matcher::expression::NotificationMatcher;
fn empty_config() -> Config {
Config::new("", "").unwrap()
@@ -172,6 +189,11 @@ matcher: matcher2
.unwrap()
}
+ fn valid_expression_string() -> String {
+ let expr = Expression::<NotificationMatcher>::Constant(true);
+ serde_json::to_string(&expr).unwrap()
+ }
+
#[test]
fn test_update_not_existing_returns_error() -> Result<(), HttpError> {
let mut config = empty_config();
@@ -261,4 +283,101 @@ matcher: matcher2
Ok(())
}
+
+ #[test]
+ fn test_update_matcher_mutually_exclusive_with_expression() -> Result<(), HttpError> {
+ let mut config = config_with_two_matchers();
+ let digest = config.digest;
+
+ let proto = MatcherConfigUpdater {
+ expression: Some(valid_expression_string()),
+ ..Default::default()
+ };
+
+ let mut updater = proto.clone();
+ updater.match_field = Some(vec!["exact:foo=bar".parse().unwrap()]);
+
+ assert!(update_matcher(&mut config, "matcher1", updater, None, Some(&digest),).is_err());
+
+ let mut updater = proto.clone();
+ updater.match_calendar = Some(vec!["mon..sun 12-13".parse().unwrap()]);
+
+ assert!(update_matcher(&mut config, "matcher1", updater, None, Some(&digest),).is_err());
+
+ let mut updater = proto.clone();
+ updater.match_severity = Some(vec!["info,warning".parse().unwrap()]);
+
+ assert!(update_matcher(&mut config, "matcher1", updater, None, Some(&digest),).is_err());
+
+ Ok(())
+ }
+
+ #[test]
+ fn test_update_invalid_expression() -> Result<(), HttpError> {
+ let mut config = config_with_two_matchers();
+ let digest = config.digest;
+
+ assert!(
+ update_matcher(
+ &mut config,
+ "matcher1",
+ MatcherConfigUpdater {
+ expression: Some("invalid".into()),
+ ..Default::default()
+ },
+ None,
+ Some(&digest),
+ )
+ .is_err()
+ );
+
+ Ok(())
+ }
+
+ #[test]
+ fn test_add_mutually_exclusive_with_expression() -> Result<(), HttpError> {
+ let mut config = empty_config();
+
+ let proto = MatcherConfig {
+ name: "matcher3".into(),
+ expression: Some(valid_expression_string()),
+ ..Default::default()
+ };
+
+ let mut entity = proto.clone();
+ entity.match_field = vec!["exact:foo=bar".parse().unwrap()];
+
+ assert!(add_matcher(&mut config, entity).is_err());
+
+ let mut entity = proto.clone();
+ entity.match_severity = vec!["info,warning".parse().unwrap()];
+
+ assert!(add_matcher(&mut config, entity).is_err());
+
+ let mut entity = proto.clone();
+ entity.match_calendar = vec!["mon..sun 12-13".parse().unwrap()];
+
+ assert!(add_matcher(&mut config, entity).is_err());
+
+ Ok(())
+ }
+
+ #[test]
+ fn test_add_invalid_expression() -> Result<(), HttpError> {
+ let mut config = empty_config();
+
+ assert!(
+ add_matcher(
+ &mut config,
+ MatcherConfig {
+ name: "matcher2".into(),
+ expression: Some("invalid".into()),
+ ..Default::default()
+ }
+ )
+ .is_err()
+ );
+
+ Ok(())
+ }
}
diff --git a/proxmox-notify/src/matcher/mod.rs b/proxmox-notify/src/matcher/mod.rs
index 429692a4..60725e00 100644
--- a/proxmox-notify/src/matcher/mod.rs
+++ b/proxmox-notify/src/matcher/mod.rs
@@ -76,7 +76,7 @@ pub enum MatchModeOperator {
optional: true,
},
})]
-#[derive(Debug, Serialize, Deserialize, Updater, Default)]
+#[derive(Clone, Debug, Serialize, Deserialize, Updater, Default)]
#[serde(rename_all = "kebab-case")]
/// Config for notification matchers.
pub struct MatcherConfig {
@@ -216,6 +216,45 @@ impl MatcherConfig {
);
}
}
+
+ /// Ensure the validity of this matcher.
+ pub(crate) fn ensure_valid(&self) -> Result<(), Error> {
+ if let Some(expression) = &self.expression {
+ if self.invert_match.is_some() {
+ return Err(Error::Generic(
+ "'expression' and 'invert-match' are mutually exclusive properties".into(),
+ ));
+ }
+ if self.mode.is_some() {
+ return Err(Error::Generic(
+ "'expression' and 'mode' are mutually exclusive properties".into(),
+ ));
+ }
+ if !self.match_field.is_empty() {
+ return Err(Error::Generic(
+ "'expression' and 'match-field' are mutually exclusive properties".into(),
+ ));
+ }
+ if !self.match_severity.is_empty() {
+ return Err(Error::Generic(
+ "'expression' and 'match-severity' are mutually exclusive properties".into(),
+ ));
+ }
+ if !self.match_calendar.is_empty() {
+ return Err(Error::Generic(
+ "'expression' and 'match-calendar' are mutually exclusive properties".into(),
+ ));
+ }
+
+ if let Err(err) = serde_json::from_str::<Expression<NotificationMatcher>>(expression) {
+ return Err(Error::Generic(format!(
+ "'expression' is not valid: {err:#}"
+ )));
+ }
+ }
+
+ Ok(())
+ }
}
#[api]
@@ -237,6 +276,8 @@ pub enum DeleteableMatcherProperty {
MatchSeverity,
/// Delete `mode`
Mode,
+ /// Delete `expression`
+ Expression,
/// Delete `target`
Target,
}
--
2.47.3
next prev parent reply other threads:[~2026-07-09 12:01 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-09 11:56 [PATCH many 00/29] notifications: add nested match expressions Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 01/29] add new proxmox-match-expression crate Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 02/29] notify: promote matcher to dir-style module Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 03/29] notify: fix doc comment Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 04/29] notify: matcher: break out severity matcher into submodule Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 05/29] notify: matcher: break out field " Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 06/29] notify: matcher: break out calendar " Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 07/29] notify: matcher: calendar: add basic unit test Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 08/29] notify: matcher: add InlineSeverityMatcher Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 09/29] notify: matcher: add InlineFieldMatcher Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 10/29] notify: matcher: add InlineCalendarMatcher Lukas Wagner
2026-07-09 11:56 ` [PATCH proxmox 11/29] notify: matcher: add expression support Lukas Wagner
2026-07-09 11:56 ` Lukas Wagner [this message]
2026-07-09 11:57 ` [PATCH proxmox 13/29] notify: api: add `get_matcher_as_expression` Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox 14/29] notify: migrate PBS's and PVE's default matcher to expression syntax Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox 15/29] notify: move legacy matcher keys behind feature flag Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-widget-toolkit 16/29] notification: increase matcher window width Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-widget-toolkit 17/29] notifications: matcher: add support for match expressions Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-widget-toolkit 18/29] notification: matcher: add better calendar editor Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-widget-toolkit 19/29] notifications: matcher: consistently use title case for UI elements Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-backup 20/29] notification: opt into 'legacy-matchers' feature in proxmox-notify Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-backup 21/29] api: notification: add 'migrate-to-expression' parameter to get_matcher Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-backup 22/29] ui: notification: enable new matcher UI Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-perl-rs 23/29] notify: matcher: pass matcher config / updater directly Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-perl-rs 24/29] notify: opt into 'legacy-matchers' feature in proxmox-notify Lukas Wagner
2026-07-09 11:57 ` [PATCH proxmox-perl-rs 25/29] notify: add 'migrate_to_expression' parameter for get_matcher Lukas Wagner
2026-07-09 11:57 ` [PATCH manager 26/29] api: notification: pass config/updater directly to rust bindings Lukas Wagner
2026-07-09 11:57 ` [PATCH manager 27/29] api: notification: get_matcher: add 'migrate-to-expression' parameter Lukas Wagner
2026-07-09 11:57 ` [PATCH manager 28/29] api: notification: add 'expression' to matcher parameter schema Lukas Wagner
2026-07-09 11:57 ` [PATCH manager 29/29] ui: notification: enable new matcher UI 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=20260709115716.299836-13-l.wagner@proxmox.com \
--to=l.wagner@proxmox.com \
--cc=pbs-devel@lists.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.