public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH proxmox v2 37/63] notify: remove 'test_target' API
Date: Wed, 18 Nov 2026 10:43:21 +0100	[thread overview]
Message-ID: <20261118094348.273646-38-l.wagner@proxmox.com> (raw)
In-Reply-To: <20261118094348.273646-1-l.wagner@proxmox.com>

Test notifications are now handled via a regular 'send', this is now
possible via the new recipient property of a notification, which allows
us to notify a target directly. This shifts some of the aspects of test
notifications towards the application code, such as the name of the
template, template data and metadata.

Since testing a target should also work when the target is set disabled,
a new generic 'set_entity_disabled' API method is added. This allows us
to temporarily enable the target in the product code, just before
sending the test notification. The modified entity is never persisted.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 proxmox-notify/src/api/mod.rs | 58 +++++++++++++++++++++++++++++++++++
 proxmox-notify/src/lib.rs     |  2 +-
 proxmox-notify/src/send.rs    | 47 ++--------------------------
 3 files changed, 61 insertions(+), 46 deletions(-)

diff --git a/proxmox-notify/src/api/mod.rs b/proxmox-notify/src/api/mod.rs
index fb6ba9ad9..b09c9e536 100644
--- a/proxmox-notify/src/api/mod.rs
+++ b/proxmox-notify/src/api/mod.rs
@@ -5,6 +5,7 @@ use proxmox_http_error::HttpError;
 
 use crate::Config;
 use crate::api_types::{EndpointType, Origin, Target};
+use crate::config::ConfigEntity;
 
 pub mod common;
 pub mod gotify;
@@ -84,6 +85,34 @@ pub fn get_targets(config: &Config) -> Result<Vec<Target>, HttpError> {
     Ok(targets)
 }
 
+/// Set the `disable` property of an entity.
+///
+/// The caller is responsible for any needed permission checks.
+/// The caller also responsible for locking the configuration files.
+///
+/// Returns a `HttpError` if:
+///   - the entity does not exist (`404 Not found`)
+///
+pub fn set_entity_disabled(
+    config: &mut Config,
+    name: &str,
+    disable: bool,
+) -> Result<(), HttpError> {
+    if let Some(entity) = config.config.get_mut(name) {
+        match entity {
+            ConfigEntity::Sendmail(config) => config.disable = Some(disable),
+            ConfigEntity::Gotify(config) => config.disable = Some(disable),
+            ConfigEntity::Matcher(config) => config.disable = Some(disable),
+            ConfigEntity::Smtp(config) => config.disable = Some(disable),
+            ConfigEntity::Webhook(config) => config.disable = Some(disable),
+        }
+    } else {
+        http_bail!(NOT_FOUND, "entity '{name}' not found");
+    }
+
+    Ok(())
+}
+
 fn verify_digest(config: &Config, digest: Option<ConfigDigest>) -> Result<(), HttpError> {
     config
         .digest()
@@ -318,4 +347,33 @@ mod tests {
 
         assert!(ensure_endpoints_exist(&config, &["sendmail", "gotify", "builtin"]).is_ok());
     }
+
+    #[test]
+    fn test_set_target_disabled() -> Result<(), HttpError> {
+        let mut config = prepare_config()?;
+
+        set_entity_disabled(&mut config, "matcher", true)?;
+        assert_eq!(
+            matcher::get_matcher(&config, "matcher")?.disable,
+            Some(true)
+        );
+
+        set_entity_disabled(&mut config, "sendmail", true)?;
+        set_entity_disabled(&mut config, "gotify", true)?;
+        assert_eq!(
+            sendmail::get_endpoint(&config, "sendmail")?.disable,
+            Some(true)
+        );
+        assert_eq!(gotify::get_endpoint(&config, "gotify")?.disable, Some(true));
+
+        set_entity_disabled(&mut config, "sendmail", false)?;
+        assert_eq!(
+            sendmail::get_endpoint(&config, "sendmail")?.disable,
+            Some(false)
+        );
+
+        assert!(set_entity_disabled(&mut config, "nonexistent", true).is_err());
+
+        Ok(())
+    }
 }
diff --git a/proxmox-notify/src/lib.rs b/proxmox-notify/src/lib.rs
index c446b52de..4304e2977 100644
--- a/proxmox-notify/src/lib.rs
+++ b/proxmox-notify/src/lib.rs
@@ -26,7 +26,7 @@ mod renderer;
 #[cfg(feature = "send-impl")]
 mod send;
 #[cfg(feature = "send-impl")]
-pub use send::{send, test_target};
+pub use send::send;
 
 mod error;
 pub use error::Error;
diff --git a/proxmox-notify/src/send.rs b/proxmox-notify/src/send.rs
index f05661367..42cd0bb1a 100644
--- a/proxmox-notify/src/send.rs
+++ b/proxmox-notify/src/send.rs
@@ -1,8 +1,6 @@
 use std::collections::{HashMap, HashSet};
 
 use proxmox_section_config::typed::{convert_to_typed_array, lookup};
-use proxmox_uuid::Uuid;
-use serde_json::json;
 use tracing::{error, info};
 
 use crate::api_types::{MatcherConfig, SendmailConfig};
@@ -12,9 +10,7 @@ use crate::endpoints::gotify::GotifyEndpoint;
 use crate::endpoints::sendmail::SendmailEndpoint;
 use crate::endpoints::smtp::SmtpEndpoint;
 use crate::endpoints::webhook::WebhookEndpoint;
-use crate::{
-    Config, Content, Context, EmailRecipient, Error, Metadata, Notification, Recipient, Severity,
-};
+use crate::{Config, Context, EmailRecipient, Error, Notification, Recipient};
 
 /// Send a notification to a given target.
 ///
@@ -27,17 +23,6 @@ pub fn send(context: &Context, config: &Config, notification: &Notification) ->
     Ok(())
 }
 
-/// Test target (group or single endpoint) identified by its `name`.
-///
-/// The caller is responsible for any needed permission checks.
-/// Returns an `anyhow::Error` if sending via the endpoint failed.
-pub fn test_target(context: &Context, config: &Config, endpoint: &str) -> Result<(), Error> {
-    let bus = Bus::from_config(config)?;
-    bus.test_target(context, endpoint)?;
-
-    Ok(())
-}
-
 /// Notification bus - distributes notifications to all registered endpoints
 // The reason for the split between `Config` and this struct is to make testing with mocked
 // endpoints a bit easier.
@@ -212,35 +197,6 @@ impl Bus {
         }
     }
 
-    /// Send a test notification to a target (endpoint or group).
-    ///
-    /// In contrast to the `send` function, this function will return
-    /// any errors to the caller.
-    pub fn test_target(&self, context: &Context, target: &str) -> Result<(), Error> {
-        let notification = Notification {
-            metadata: Metadata {
-                severity: Severity::Info,
-                // TODO: what fields would make sense for test notifications?
-                additional_fields: Default::default(),
-                timestamp: proxmox_time::epoch_i64(),
-            },
-            content: Content::Template {
-                template_name: "test".to_string(),
-                data: json!({ "target": target }),
-            },
-            id: Uuid::generate(),
-            recipient: Recipient::Target(target.into()),
-        };
-
-        if let Some(endpoint) = self.endpoints.get(target) {
-            endpoint.send(context, &notification)?;
-        } else {
-            return Err(Error::target_does_not_exist(target));
-        }
-
-        Ok(())
-    }
-
     fn check_matches(&self, notification: &Notification) -> HashSet<&str> {
         let mut targets = HashSet::new();
         let mut matching_matchers = Vec::new();
@@ -285,6 +241,7 @@ mod tests {
     use proxmox_match_expression::Expression;
 
     use crate::{
+        Severity,
         api_types::{expression::NotificationMatcher, severity::SeverityMatcher},
         context::{Context, test},
     };
-- 
2.47.3





  parent reply	other threads:[~2026-11-18  9:49 UTC|newest]

Thread overview: 66+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-18  9:42 [PATCH many v2 00/63] notify: maintenance, PDM preparations, queue + worker Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 01/63] notify: disallow `unsafe` code Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 02/63] notify: refactor error type Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 03/63] notify: move `Endpoint` trait to endpoint module as pub(crate) Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 04/63] notify: use ConfigDigest instead of raw byte arrays Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 05/63] notify: remove static context and pass context as parameter Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 06/63] notify: matcher: drop unused field matcher verifiers Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 07/63] notify: introduce 'send-impl', 'api-impl' and 'api-types' features Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 08/63] notify: matcher: make matcher validation methods public Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 09/63] notify: matcher: stub CalendarMatcher::matches on wasm32 Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 10/63] notify: make SendmailEndpoint and SmtpEndpoint private types Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 11/63] notify: move `send`, `test_target` and `Bus` to new `send` module Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 12/63] notify: move Origin type to api_types module Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 13/63] notify: move Target " Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 14/63] notify: move Config to config module Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 15/63] notify: move Notification and sub-types to `notification` module Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 16/63] notify: move schema module to api_types Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 17/63] notify: move check_matches from api_types::matcher to send::Bus Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 18/63] notify: move TemplateSource to context module Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 19/63] notify: config: cleanup helper names and visibility Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 20/63] notify: config: rename section config parser/writer methods Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 21/63] notify: config: pass builtins explicitly when parsing section config Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 22/63] notify: implement PartialEq for all Config types Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 23/63] notify: use typed SectionConfigData Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 24/63] notify: api: api types: rename Deleteable* -> Deletable* Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 25/63] notify: context: parse builtin config only once Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 26/63] notify: context: parse proxy config in trait impl, not at the callsite Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 27/63] notify: gate sub-modules with the appropriate feature flags Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 28/63] notify: fold mail-forwarder feature into send-impl Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 29/63] notify: forwarded mails: don't hardcode severity and metadata fields Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 30/63] notify: don't pass uid when instantiating forwarded mail notifications Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 31/63] notify: derive PartialEq for Notification type Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 32/63] notify: add getters for severity and fields on " Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 33/63] notify: add test suite for " Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 34/63] notify: serialize raw, forwarded mail content as base64 Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 35/63] notify: unify code paths for legacy-sendmail and regular notifications Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 36/63] notify: add backwards-compat note to Notification type Lukas Wagner
2026-11-18  9:43 ` Lukas Wagner [this message]
2026-11-18  9:43 ` [PATCH proxmox v2 38/63] notify: replace notification instantiation with builder pattern Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 39/63] notify: add send receipts Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 40/63] notify: make sure that template name matches SAFE_ID_REGEX Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 41/63] notify: implement notification queue submitter Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 42/63] notify: context: add read_config Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 43/63] notify: queue: add queue consumer Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 44/63] notify: queue: add worker task Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 45/63] notifications: don't ignore verification errors in legacy-sendmail mode Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 46/63] notifications: adapt to proxmox-notify API changes Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 47/63] api: notification: send test notification via proxmox_notify::send Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 48/63] notifications: send all notifications via proxmox-notify's queue Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-perl-rs v2 49/63] pve: notify: adapt to changes in the public API of proxmox-notify Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-perl-rs v2 50/63] pve: notify: add `PVE::RS::Notify::enqueue` method Lukas Wagner
2026-11-18  9:43 ` [PATCH pve-cluster v2 51/63] notify: send notifications via notification queue Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 52/63] vzdump: send legacy-sendmail notifications via simplified API Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 53/63] debian: create notification queue directory via tmpfiles Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 54/63] debian: add 'pve-notify-worker' as dependecy Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 55/63] api: services: add 'pve-notify-worker' as known service Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 56/63] services: request pve-notify-worker.service via Wants Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 57/63] forward mails via notification queue Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 58/63] use return code to signal permanent or temporary failure Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 59/63] limit size of mail read from stdin Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 60/63] cargo: move mail forwarder into a workspace member crate Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 61/63] add crate for code shared between the mail-forwarder and the worker Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 62/63] add pve-notify-worker crate and package Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 63/63] debian: add versioned break for pve-manager and proxmox-backup-server Lukas Wagner
2026-11-18 21:44 ` [PATCH many v2 00/63] notify: maintenance, PDM preparations, queue + worker Thomas Lamprecht
2026-11-19 10:45   ` 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=20261118094348.273646-38-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal