[pbs-devel] [PATCH proxmox-backup v6 2/2] close #4763: client: add command to forget backup group

[Wolfgang Bumiller]

style nit

On Fri, Apr 26, 2024 at 02:37:16PM GMT, Gabriel Goller wrote:
> Add the command `proxmox-backup-client group forget <group>` so
> that we can forget (delete) whole groups with all the containing
> snapshots.
> To avoid printing full datastore paths (which are in the error messages)
> we filter out the most common one (group not found) and rephrase it.
> 
> Signed-off-by: Gabriel Goller <g.goller at proxmox.com>
> ---
>  proxmox-backup-client/src/group.rs | 88 ++++++++++++++++++++++++++++++
>  proxmox-backup-client/src/main.rs  |  3 +
>  2 files changed, 91 insertions(+)
>  create mode 100644 proxmox-backup-client/src/group.rs
> 
> diff --git a/proxmox-backup-client/src/group.rs b/proxmox-backup-client/src/group.rs
> new file mode 100644
> index 00000000..8a2a4e1e
> --- /dev/null
> +++ b/proxmox-backup-client/src/group.rs
> @@ -0,0 +1,88 @@
> +use anyhow::{bail, Error};
> +use serde_json::Value;
> +
> +use proxmox_router::cli::{CliCommand, CliCommandMap, Confirmation};
> +use proxmox_schema::api;
> +
> +use crate::{
> +    complete_backup_group, complete_namespace, complete_repository, merge_group_into,
> +    REPO_URL_SCHEMA,
> +};
> +use pbs_api_types::{BackupGroup, BackupNamespace};
> +use pbs_client::tools::{connect, extract_repository_from_value};
> +
> +pub fn group_mgmt_cli() -> CliCommandMap {
> +    CliCommandMap::new().insert(
> +        "forget",
> +        CliCommand::new(&API_METHOD_FORGET_GROUP)
> +            .arg_param(&["group"])
> +            .completion_cb("ns", complete_namespace)
> +            .completion_cb("repository", complete_repository)
> +            .completion_cb("group", complete_backup_group),
> +    )
> +}
> +
> +#[api(
> +    input: {
> +        properties: {
> +            group: {
> +                type: String,
> +                description: "Backup group",
> +            },
> +            repository: {
> +                schema: REPO_URL_SCHEMA,
> +                optional: true,
> +            },
> +            ns: {
> +                type: BackupNamespace,
> +                optional: true,
> +            },
> +        }
> +    }
> +)]
> +/// Forget (remove) backup snapshots.
> +async fn forget_group(group: String, param: Value) -> Result<Value, Error> {

We have this a lot, but we should stop doing this.
API methods which don't return anything can juts use `Result<(), Error>`.

> +    let backup_group: BackupGroup = group.parse()?;
> +    let repo = extract_repository_from_value(&param)?;
> +    let client = connect(&repo)?;
> +
> +    let mut api_params = param;
> +    merge_group_into(api_params.as_object_mut().unwrap(), backup_group.clone());
> +
> +    let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
> +    let result = client.get(&path, Some(api_params.clone())).await?;
> +    let snapshots = result["data"].as_array().unwrap().len();
> +
> +    let confirmation = Confirmation::query_with_default(
> +        format!(
> +            "Delete group \"{}\" with {} snapshot(s)?",
> +            backup_group, snapshots
> +        )
> +        .as_str(),
> +        Confirmation::No,
> +    )?;
> +    if confirmation.is_yes() {
> +        let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
> +        if let Err(err) = client.delete(&path, Some(api_params)).await {
> +            // "ENOENT: No such file or directory" is part of the error returned when the group
> +            // has not been found. The full error contains the full datastore path and we would
> +            // like to avoid printing that to the console. Checking if it exists before deleting
> +            // the group doesn't work because we currently do not differentiate between an empty
> +            // and a nonexistent group. This would make it impossible to remove empty groups.
> +            if err
> +                .root_cause()
> +                .to_string()
> +                .contains("ENOENT: No such file or directory")
> +            {
> +                bail!("Unable to find backup group!");
> +            } else {
> +                bail!(err);
> +            }
> +        }
> +        println!("Successfully deleted group!");
> +    } else {
> +        println!("Abort.");
> +    }
> +
> +    Ok(Value::Null)

And use `Ok(())` here.

> +}