From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v2 proxmox 09/42] notify: api: add API for channels
Date: Wed, 24 May 2023 15:56:16 +0200 [thread overview]
Message-ID: <20230524135649.934881-10-l.wagner@proxmox.com> (raw)
In-Reply-To: <20230524135649.934881-1-l.wagner@proxmox.com>
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
proxmox-notify/src/api/channel.rs | 253 ++++++++++++++++++++++++++++++
proxmox-notify/src/api/mod.rs | 1 +
2 files changed, 254 insertions(+)
create mode 100644 proxmox-notify/src/api/channel.rs
diff --git a/proxmox-notify/src/api/channel.rs b/proxmox-notify/src/api/channel.rs
new file mode 100644
index 00000000..a763fdfa
--- /dev/null
+++ b/proxmox-notify/src/api/channel.rs
@@ -0,0 +1,253 @@
+use crate::api::ApiError;
+use crate::channel::{
+ ChannelConfig, ChannelConfigUpdater, DeleteableChannelProperty, CHANNEL_TYPENAME,
+};
+use crate::Config;
+
+/// Add new channel
+/// Get all notification channels
+///
+/// The caller is responsible for any needed permission checks.
+/// Returns a list of all channels or an `ApiError` if the config is erroneous.
+pub fn get_channels(config: &Config) -> Result<Vec<ChannelConfig>, ApiError> {
+ config
+ .config
+ .convert_to_typed_array(CHANNEL_TYPENAME)
+ .map_err(|e| ApiError::internal_server_error("Could not fetch channels", Some(e.into())))
+}
+
+/// Get channel with given `name`
+///
+/// The caller is responsible for any needed permission checks.
+/// Returns the endpoint or an `ApiError` if the channel was not found.
+pub fn get_channel(config: &Config, name: &str) -> Result<ChannelConfig, ApiError> {
+ config
+ .config
+ .lookup(CHANNEL_TYPENAME, name)
+ .map_err(|_| ApiError::not_found(format!("channel '{name}' not found"), None))
+}
+
+///
+/// The caller is responsible for any needed permission checks.
+/// The caller also responsible for locking the configuration files.
+/// Returns an `ApiError` if a channel with the same name already exists, or
+/// if the channel could not be saved
+pub fn add_channel(config: &mut Config, channel_config: &ChannelConfig) -> Result<(), ApiError> {
+ if get_channel(config, &channel_config.name).is_ok() {
+ return Err(ApiError::bad_request(
+ format!("channel '{}' already exists", channel_config.name),
+ None,
+ ));
+ }
+
+ if let Some(endpoints) = &channel_config.endpoint {
+ check_if_endpoints_exist(config, endpoints)?;
+ }
+
+ config
+ .config
+ .set_data(&channel_config.name, CHANNEL_TYPENAME, channel_config)
+ .map_err(|e| {
+ ApiError::internal_server_error(
+ format!("could not save channel '{}'", channel_config.name),
+ Some(e.into()),
+ )
+ })?;
+
+ Ok(())
+}
+
+/// Update existing channel
+///
+/// The caller is responsible for any needed permission checks.
+/// The caller also responsible for locking the configuration files.
+/// Returns an `ApiError` if the config could not be saved.
+pub fn update_channel(
+ config: &mut Config,
+ name: &str,
+ // endpoints: Option<Vec<&str>>,
+ // comment: Option<&str>,
+ updater: &ChannelConfigUpdater,
+ delete: Option<&[DeleteableChannelProperty]>,
+ digest: Option<&[u8]>,
+) -> Result<(), ApiError> {
+ super::verify_digest(config, digest)?;
+
+ let mut channel = get_channel(config, name)?;
+
+ if let Some(delete) = delete {
+ for deleteable_property in delete {
+ match deleteable_property {
+ DeleteableChannelProperty::Endpoint => channel.endpoint = None,
+ DeleteableChannelProperty::Comment => channel.comment = None,
+ }
+ }
+ }
+
+ if let Some(endpoints) = &updater.endpoint {
+ check_if_endpoints_exist(config, endpoints)?;
+ channel.endpoint = Some(endpoints.iter().map(Into::into).collect())
+ }
+
+ if let Some(comment) = &updater.comment {
+ channel.comment = Some(comment.into());
+ }
+
+ config
+ .config
+ .set_data(name, CHANNEL_TYPENAME, &channel)
+ .map_err(|e| {
+ ApiError::internal_server_error(
+ format!("could not save channel '{name}'"),
+ Some(e.into()),
+ )
+ })?;
+
+ Ok(())
+}
+
+/// Delete existing channel
+///
+/// The caller is responsible for any needed permission checks.
+/// The caller also responsible for locking the configuration files.
+/// Returns an `ApiError` if the channel does not exist.
+pub fn delete_channel(config: &mut Config, name: &str) -> Result<(), ApiError> {
+ // Check if the channel exists
+ let _ = get_channel(config, name)?;
+
+ config.config.sections.remove(name);
+
+ Ok(())
+}
+
+fn check_if_endpoints_exist(config: &Config, endpoints: &[String]) -> Result<(), ApiError> {
+ for endpoint in endpoints {
+ if !super::endpoint_exists(config, endpoint) {
+ return Err(ApiError::not_found(
+ format!("endoint '{endpoint}' does not exist"),
+ None,
+ ));
+ }
+ }
+
+ Ok(())
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::api::test_helpers::*;
+
+ fn add_default_channel(config: &mut Config) -> Result<(), ApiError> {
+ add_channel(
+ config,
+ &ChannelConfig {
+ name: "channel1".into(),
+ endpoint: None,
+ comment: None,
+ },
+ )?;
+
+ Ok(())
+ }
+
+ #[test]
+ fn test_add_channel_fails_if_endpoint_does_not_exist() {
+ let mut config = empty_config();
+ assert!(add_channel(
+ &mut config,
+ &ChannelConfig {
+ name: "channel1".into(),
+ endpoint: Some(vec!["foo".into()]),
+ comment: None,
+ },
+ )
+ .is_err());
+ }
+
+ #[test]
+ fn test_add_channel() -> Result<(), ApiError> {
+ let mut config = empty_config();
+ assert!(add_default_channel(&mut config).is_ok());
+ Ok(())
+ }
+
+ #[test]
+ fn test_update_channel_fails_if_endpoint_does_not_exist() -> Result<(), ApiError> {
+ let mut config = empty_config();
+ add_default_channel(&mut config)?;
+
+ assert!(update_channel(
+ &mut config,
+ "channel1",
+ &ChannelConfigUpdater {
+ endpoint: Some(vec!["foo".into()]),
+ ..Default::default()
+ },
+ None,
+ None
+ )
+ .is_err());
+ Ok(())
+ }
+
+ #[test]
+ fn test_update_channel_fails_if_digest_invalid() -> Result<(), ApiError> {
+ let mut config = empty_config();
+ add_default_channel(&mut config)?;
+
+ assert!(update_channel(
+ &mut config,
+ "channel1",
+ &Default::default(),
+ None,
+ Some(&[0u8; 32])
+ )
+ .is_err());
+ Ok(())
+ }
+
+ #[test]
+ fn test_update_channel() -> Result<(), ApiError> {
+ let mut config = empty_config();
+ add_default_channel(&mut config)?;
+
+ assert!(update_channel(
+ &mut config,
+ "channel1",
+ &ChannelConfigUpdater {
+ endpoint: None,
+ comment: Some("newcomment".into())
+ },
+ None,
+ None,
+ )
+ .is_ok());
+ let channel = get_channel(&config, "channel1")?;
+ assert_eq!(channel.comment, Some("newcomment".into()));
+
+ assert!(update_channel(
+ &mut config,
+ "channel1",
+ &Default::default(),
+ Some(&[DeleteableChannelProperty::Comment]),
+ None
+ )
+ .is_ok());
+ let channel = get_channel(&config, "channel1")?;
+ assert_eq!(channel.comment, None);
+
+ Ok(())
+ }
+
+ #[test]
+ fn test_channel_delete() -> Result<(), ApiError> {
+ let mut config = empty_config();
+ add_default_channel(&mut config)?;
+
+ assert!(delete_channel(&mut config, "channel1").is_ok());
+ assert!(delete_channel(&mut config, "channel1").is_err());
+
+ Ok(())
+ }
+}
diff --git a/proxmox-notify/src/api/mod.rs b/proxmox-notify/src/api/mod.rs
index 839a75cc..9e5f15b8 100644
--- a/proxmox-notify/src/api/mod.rs
+++ b/proxmox-notify/src/api/mod.rs
@@ -4,6 +4,7 @@ use std::fmt::Display;
use crate::Config;
use serde::Serialize;
+pub mod channel;
pub mod common;
#[derive(Debug, Serialize)]
--
2.30.2
next prev parent reply other threads:[~2023-05-24 13:58 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-24 13:56 [pve-devel] [PATCH v2 cluster/guest-common/manager/ha-manager/proxmox{, -perl-rs} 00/42] fix #4156: introduce new notification module Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 01/42] add `proxmox-human-byte` crate Lukas Wagner
2023-06-26 11:58 ` Wolfgang Bumiller
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 02/42] human-byte: move tests to their own sub-module Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 03/42] add proxmox-notify crate Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 04/42] notify: add debian packaging Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 05/42] notify: preparation for the first endpoint plugin Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 06/42] notify: preparation for the API Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 07/42] notify: api: add API for sending notifications/testing endpoints Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 08/42] notify: add notification channels Lukas Wagner
2023-05-24 13:56 ` Lukas Wagner [this message]
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 10/42] notify: add sendmail plugin Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 11/42] notify: api: add API for sendmail endpoints Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 12/42] notify: add gotify endpoint Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 13/42] notify: api: add API for gotify endpoints Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 14/42] notify: add notification filter mechanism Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 15/42] notify: api: add API for filters Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 16/42] notify: add template rendering Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox 17/42] notify: add example for " Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox-perl-rs 18/42] log: set default log level to 'info', add product specific logging env var Lukas Wagner
2023-06-05 7:27 ` Wolfgang Bumiller
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox-perl-rs 19/42] add PVE::RS::Notify module Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox-perl-rs 20/42] notify: add api for sending notifications/testing endpoints Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox-perl-rs 21/42] notify: add api for notification channels Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox-perl-rs 22/42] notify: add api for sendmail endpoints Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox-perl-rs 23/42] notify: add api for gotify endpoints Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 proxmox-perl-rs 24/42] notify: add api for notification filters Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-cluster 25/42] cluster files: add notifications.cfg Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-guest-common 26/42] vzdump: add config options for new notification backend Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 27/42] test: fix names of .PHONY targets Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 28/42] add PVE::Notify module Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 29/42] vzdump: send notifications via new notification module Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 30/42] test: rename mail_test.pl to vzdump_notification_test.pl Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 31/42] api: apt: send notification via new notification module Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 32/42] api: replication: send notifications " Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 33/42] ui: backup: allow to select notification channel for notifications Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 34/42] ui: backup: adapt backup job details to new notification params Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 35/42] ui: backup: allow to set notification-{channel, mode} for one-off backups Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 36/42] api: prepare api handler module for notification config Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 37/42] api: add api routes for notification channels Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 38/42] api: add api routes for sendmail endpoints Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 39/42] api: add api routes for gotify endpoints Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 40/42] api: add api routes for notification filters Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-manager 41/42] ui: backup: disable notification mode selector for now Lukas Wagner
2023-05-24 13:56 ` [pve-devel] [PATCH v2 pve-ha-manager 42/42] manager: send notifications via new notification module Lukas Wagner
2023-05-26 8:31 ` [pve-devel] [PATCH v2 cluster/guest-common/manager/ha-manager/proxmox{, -perl-rs} 00/42] fix #4156: introduce " 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=20230524135649.934881-10-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