From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 9AE479B19C for ; Wed, 24 May 2023 15:58:05 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 063D41F65E for ; Wed, 24 May 2023 15:57:35 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Wed, 24 May 2023 15:57:30 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id B08B846E30 for ; Wed, 24 May 2023 15:57:29 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Wed, 24 May 2023 15:56:16 +0200 Message-Id: <20230524135649.934881-10-l.wagner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230524135649.934881-1-l.wagner@proxmox.com> References: <20230524135649.934881-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.171 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH v2 proxmox 09/42] notify: api: add API for channels X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 24 May 2023 13:58:05 -0000 Signed-off-by: Lukas Wagner --- 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, 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 { + 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>, + // 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