From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 451CE1FF16B for ; Thu, 31 Oct 2024 13:16:59 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 9E7818DE1; Thu, 31 Oct 2024 13:17:02 +0100 (CET) From: Christian Ebner To: pbs-devel@lists.proxmox.com Date: Thu, 31 Oct 2024 13:15:02 +0100 Message-Id: <20241031121519.434337-13-c.ebner@proxmox.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241031121519.434337-1-c.ebner@proxmox.com> References: <20241031121519.434337-1-c.ebner@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.030 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 Subject: [pbs-devel] [PATCH v6 proxmox-backup 12/29] api/api-types: refactor api endpoint version, add api types X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" Add a dedicated api type for the `version` api endpoint and helper methods for supported feature comparison. This will be used to detect api incompatibility of older hosts, not supporting some features. Use the new api type to refactor the version endpoint and set it as return type. Signed-off-by: Christian Ebner --- changes since version 5: - add `features` vector to store supported feature strings - drop `min_version_check`, introduce `supported_feature` check pbs-api-types/src/lib.rs | 3 + pbs-api-types/src/version.rs | 109 +++++++++++++++++++++++++++++++++++ src/api2/version.rs | 42 ++++++++------ 3 files changed, 137 insertions(+), 17 deletions(-) create mode 100644 pbs-api-types/src/version.rs diff --git a/pbs-api-types/src/lib.rs b/pbs-api-types/src/lib.rs index 460c7da7c..6bae4a52b 100644 --- a/pbs-api-types/src/lib.rs +++ b/pbs-api-types/src/lib.rs @@ -155,6 +155,9 @@ pub use zfs::*; mod metrics; pub use metrics::*; +mod version; +pub use version::*; + const_regex! { // just a rough check - dummy acceptor is used before persisting pub OPENSSL_CIPHERS_REGEX = r"^[0-9A-Za-z_:, +!\-@=.]+$"; diff --git a/pbs-api-types/src/version.rs b/pbs-api-types/src/version.rs new file mode 100644 index 000000000..c7c91a53a --- /dev/null +++ b/pbs-api-types/src/version.rs @@ -0,0 +1,109 @@ +//! Defines the types for the api version info endpoint +use std::convert::TryFrom; + +use anyhow::Context; + +use proxmox_schema::api; + +#[api( + description: "Api version information", + properties: { + "version": { + description: "Version 'major.minor'", + type: String, + }, + "release": { + description: "Version release", + type: String, + }, + "repoid": { + description: "Version repository id", + type: String, + }, + "features": { + description: "List of supported features", + type: Array, + items: { + type: String, + description: "Feature id", + }, + }, + } +)] +#[derive(serde::Deserialize, serde::Serialize)] +pub struct ApiVersionInfo { + pub version: String, + pub release: String, + pub repoid: String, + #[serde(default, skip_serializing_if = "Vec::is_empty")] + pub features: Vec, +} + +pub type ApiVersionMajor = u64; +pub type ApiVersionMinor = u64; +pub type ApiVersionRelease = u64; + +#[allow(dead_code)] +pub struct ApiVersion { + major: ApiVersionMajor, + minor: ApiVersionMinor, + release: ApiVersionRelease, + features: Vec, +} + +impl TryFrom for ApiVersion { + type Error = anyhow::Error; + + fn try_from(value: ApiVersionInfo) -> Result { + let mut parts = value.version.split('.'); + let major: ApiVersionMajor = if let Some(val) = parts.next() { + val.parse() + .with_context(|| "failed to parse major version")? + } else { + ApiVersionMajor::default() + }; + let minor: ApiVersionMinor = if let Some(val) = parts.next() { + val.parse() + .with_context(|| "failed to parse minor version")? + } else { + ApiVersionMinor::default() + }; + + let release: ApiVersionMinor = value + .release + .parse() + .with_context(|| "failed to parse release version")?; + + Ok(Self { + major, + minor, + release, + features: value.features.to_vec(), + }) + } +} + +impl ApiVersion { + pub fn new( + major: ApiVersionMajor, + minor: ApiVersionMinor, + release: ApiVersionRelease, + features: Vec, + ) -> Self { + Self { + major, + minor, + release, + features, + } + } + + pub fn supports_feature(&self, feature: &str) -> bool { + for supported_feature in &self.features { + if *supported_feature == feature { + return true; + } + } + false + } +} diff --git a/src/api2/version.rs b/src/api2/version.rs index 0e91688b5..a6cec5216 100644 --- a/src/api2/version.rs +++ b/src/api2/version.rs @@ -1,27 +1,35 @@ //! Version information use anyhow::Error; -use serde_json::{json, Value}; +use serde_json::Value; -use proxmox_router::{ApiHandler, ApiMethod, Permission, Router, RpcEnvironment}; -use proxmox_schema::ObjectSchema; +use proxmox_router::{ApiMethod, Permission, Router, RpcEnvironment}; +use proxmox_schema::api; -fn get_version( +use pbs_api_types::ApiVersionInfo; + +const FEATURES: &'static [&'static str] = &[]; + +#[api( + returns: { + type: ApiVersionInfo, + }, + access: { + permission: &Permission::Anybody, + } +)] +///Proxmox Backup Server API version. +fn version( _param: Value, _info: &ApiMethod, _rpcenv: &mut dyn RpcEnvironment, -) -> Result { - Ok(json!({ - "version": pbs_buildcfg::PROXMOX_PKG_VERSION, - "release": pbs_buildcfg::PROXMOX_PKG_RELEASE, - "repoid": pbs_buildcfg::PROXMOX_PKG_REPOID - })) +) -> Result { + Ok(ApiVersionInfo { + version: pbs_buildcfg::PROXMOX_PKG_VERSION.to_string(), + release: pbs_buildcfg::PROXMOX_PKG_RELEASE.to_string(), + repoid: pbs_buildcfg::PROXMOX_PKG_REPOID.to_string(), + features: FEATURES.iter().map(|feature| feature.to_string()).collect(), + }) } -pub const ROUTER: Router = Router::new().get( - &ApiMethod::new( - &ApiHandler::Sync(&get_version), - &ObjectSchema::new("Proxmox Backup Server API version.", &[]), - ) - .access(None, &Permission::Anybody), -); +pub const ROUTER: Router = Router::new().get(&API_METHOD_VERSION); -- 2.39.5 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel