From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>,
Dominik Csapak <d.csapak@proxmox.com>,
pbs-devel@lists.proxmox.com
Subject: Re: [pbs-devel] [pve-devel] [PATCH proxmox-backup 2/2] client: add 'snapshot notes show/update' command
Date: Mon, 16 Nov 2020 10:37:40 +0100 [thread overview]
Message-ID: <49f2d016-5674-e20d-6dc4-475fdd2b7fb7@proxmox.com> (raw)
In-Reply-To: <20201113093852.28788-3-d.csapak@proxmox.com>
On 13.11.20 10:38, Dominik Csapak wrote:
> to show and update snapshot notes from the cli
>
> Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
> ---
> src/bin/proxmox-backup-client.rs | 1 +
> src/bin/proxmox_backup_client/mod.rs | 2 +
> src/bin/proxmox_backup_client/snapshot.rs | 126 ++++++++++++++++++++++
> 3 files changed, 129 insertions(+)
> create mode 100644 src/bin/proxmox_backup_client/snapshot.rs
>
> diff --git a/src/bin/proxmox-backup-client.rs b/src/bin/proxmox-backup-client.rs
> index 54e11f08..1581fbd2 100644
> --- a/src/bin/proxmox-backup-client.rs
> +++ b/src/bin/proxmox-backup-client.rs
> @@ -2068,6 +2068,7 @@ fn main() {
> .insert("prune", prune_cmd_def)
> .insert("restore", restore_cmd_def)
> .insert("snapshots", snapshots_cmd_def)
> + .insert("snapshot", snapshot_mgtm_cli())
makes the CLI interface slightly weirder, maybe moving `snapshots`
into `snapshot list` could help (with hidden alias for backward compat)?
> .insert("files", files_cmd_def)
> .insert("status", status_cmd_def)
> .insert("key", key::cli())
> diff --git a/src/bin/proxmox_backup_client/mod.rs b/src/bin/proxmox_backup_client/mod.rs
> index 0c4bffb9..a14b0dc1 100644
> --- a/src/bin/proxmox_backup_client/mod.rs
> +++ b/src/bin/proxmox_backup_client/mod.rs
> @@ -8,6 +8,8 @@ mod task;
> pub use task::*;
> mod catalog;
> pub use catalog::*;
> +mod snapshot;
> +pub use snapshot::*;
>
> pub mod key;
>
> diff --git a/src/bin/proxmox_backup_client/snapshot.rs b/src/bin/proxmox_backup_client/snapshot.rs
> new file mode 100644
> index 00000000..ee794275
> --- /dev/null
> +++ b/src/bin/proxmox_backup_client/snapshot.rs
> @@ -0,0 +1,126 @@
> +use anyhow::Error;
> +use serde_json::{json, Value};
> +
> +use proxmox::api::{api, cli::*};
> +use proxmox_backup::tools;
> +
> +use crate::{
> + complete_backup_snapshot, connect, extract_repository_from_value, BackupDir, REPO_URL_SCHEMA,
> +};
> +
> +#[api(
> + input: {
> + properties: {
> + repository: {
> + schema: REPO_URL_SCHEMA,
> + optional: true,
> + },
> + snapshot: {
> + type: String,
> + description: "Snapshot path.",
> + },
> + "output-format": {
> + schema: OUTPUT_FORMAT,
> + optional: true,
> + },
> + }
> + }
> +)]
> +/// Show notes
> +async fn show_notes(param: Value) -> Result<Value, Error> {
> + let repo = extract_repository_from_value(¶m)?;
> + let path = tools::required_string_param(¶m, "snapshot")?;
> +
> + let snapshot: BackupDir = path.parse()?;
> + let client = connect(&repo)?;
> +
> + let path = format!("api2/json/admin/datastore/{}/notes", repo.store());
> +
> + let args = json!({
> + "backup-type": snapshot.group().backup_type(),
> + "backup-id": snapshot.group().backup_id(),
> + "backup-time": snapshot.backup_time(),
> + });
> +
> + let output_format = get_output_format(¶m);
slightly weird to have this here, in between the args value used below, as it's
only used after that.
> +
> + let mut result = client.get(&path, Some(args)).await?;
> +
> + let comment = result["data"].take();
> +
> + if output_format == "text" {
> + if let Some(comment) = comment.as_str() {
> + println!("{}", comment);
> + }
> + } else {
> + format_and_print_result(
> + &json!({
> + "comment": comment,
We could just return the notes directly, without wrapping into an object?
> + }),
> + &output_format,
> + );
> + }
> +
> + Ok(Value::Null)
> +}
> +
> +#[api(
> + input: {
> + properties: {
> + repository: {
> + schema: REPO_URL_SCHEMA,
> + optional: true,
> + },
> + snapshot: {
> + type: String,
> + description: "Snapshot path.",
> + },
> + notes: {
> + type: String,
> + description: "The Notes.",
> + },
> + }
> + }
> +)]
> +/// Update Notes
> +async fn update_notes(param: Value) -> Result<Value, Error> {
> + let repo = extract_repository_from_value(¶m)?;
> + let path = tools::required_string_param(¶m, "snapshot")?;
> + let notes = tools::required_string_param(¶m, "notes")?;
> +
> + let snapshot: BackupDir = path.parse()?;
> + let mut client = connect(&repo)?;
> +
> + let path = format!("api2/json/admin/datastore/{}/notes", repo.store());
> +
> + let args = json!({
> + "backup-type": snapshot.group().backup_type(),
> + "backup-id": snapshot.group().backup_id(),
> + "backup-time": snapshot.backup_time(),
> + "notes": notes,
> + });
> +
> + client.put(&path, Some(args)).await?;
> +
> + Ok(Value::Null)
> +}
> +
> +fn notes_cli() -> CliCommandMap {
> + CliCommandMap::new()
> + .insert(
> + "show",
> + CliCommand::new(&API_METHOD_SHOW_NOTES)
> + .arg_param(&["snapshot"])
> + .completion_cb("snapshot", complete_backup_snapshot),
> + )
> + .insert(
> + "update",
> + CliCommand::new(&API_METHOD_UPDATE_NOTES)
> + .arg_param(&["snapshot", "notes"])
> + .completion_cb("snapshot", complete_backup_snapshot),
> + )
> +}
> +
> +pub fn snapshot_mgtm_cli() -> CliCommandMap {
> + CliCommandMap::new().insert("notes", notes_cli())
> +}
>
next prev parent reply other threads:[~2020-11-16 9:37 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-13 9:38 [pbs-devel] [PATCH proxmox-backup/pve-storage/manager] show/edit backup comments Dominik Csapak
2020-11-13 9:38 ` [pbs-devel] [PATCH proxmox-backup 1/2] client/http_client: add put method Dominik Csapak
2020-11-16 16:01 ` [pbs-devel] applied: " Thomas Lamprecht
2020-11-13 9:38 ` [pbs-devel] [PATCH proxmox-backup 2/2] client: add 'snapshot notes show/update' command Dominik Csapak
2020-11-16 9:37 ` Thomas Lamprecht [this message]
2020-11-16 9:42 ` [pbs-devel] [pve-devel] " Dominik Csapak
2020-11-16 10:14 ` Thomas Lamprecht
2020-11-13 9:38 ` [pbs-devel] [PATCH storage 1/2] api2/storage/content: change to volume_size_info and add return properties Dominik Csapak
2020-11-13 9:38 ` [pbs-devel] [PATCH storage 2/2] Storage/Plugin: add get/update_volume_comment and implement for dir/pbs Dominik Csapak
2020-11-13 9:38 ` [pbs-devel] [PATCH manager 1/1] ui: add ability to show and edit comments for backups Dominik Csapak
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=49f2d016-5674-e20d-6dc4-475fdd2b7fb7@proxmox.com \
--to=t.lamprecht@proxmox.com \
--cc=d.csapak@proxmox.com \
--cc=pbs-devel@lists.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