canic-cli 0.68.0

Operator CLI for Canic fleet setup, builds, evidence, catalog, backup, and restore workflows
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

//! Module: backup::options::prune
//!
//! Responsibility: parse `canic backup prune` options.
//! Does not own: backup pruning execution.
//! Boundary: prune subcommand selectors, preview mode, and output path.

use super::shared::{DEFAULT_BACKUP_DIR, parse_backup_options};
use crate::{
    backup::{BackupCommandError, prune_usage},
    cli::clap::{flag_arg, path_option, required_path, typed_option, value_arg},
};
use clap::{ArgGroup, Command as ClapCommand};
use std::{ffi::OsString, path::PathBuf};

///
/// BackupPruneOptions
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub(in crate::backup) struct BackupPruneOptions {
    pub(in crate::backup) dir: PathBuf,
    pub(in crate::backup) failed: bool,
    pub(in crate::backup) keep: Option<usize>,
    pub(in crate::backup) dry_run: bool,
    pub(in crate::backup) out: Option<PathBuf>,
}

impl BackupPruneOptions {
    pub(in crate::backup) fn parse<I>(args: I) -> Result<Self, BackupCommandError>
    where
        I: IntoIterator<Item = OsString>,
    {
        let matches = parse_backup_options(backup_prune_command(), prune_usage, args)?;
        Ok(Self {
            dir: required_path(&matches, "dir"),
            failed: matches.get_flag("failed"),
            keep: typed_option(&matches, "keep"),
            dry_run: matches.get_flag("dry-run"),
            out: path_option(&matches, "out"),
        })
    }
}

pub(in crate::backup) fn backup_prune_command() -> ClapCommand {
    ClapCommand::new("prune")
        .bin_name("canic backup prune")
        .about("Remove selected backup directories")
        .disable_help_flag(true)
        .arg(
            value_arg("dir")
                .long("dir")
                .value_name("dir")
                .default_value(DEFAULT_BACKUP_DIR)
                .help("Backup root to scan; defaults to backups"),
        )
        .arg(
            flag_arg("failed")
                .long("failed")
                .help("Select failed backup execution layouts"),
        )
        .arg(
            value_arg("keep")
                .long("keep")
                .value_name("count")
                .value_parser(clap::value_parser!(usize))
                .help("Keep the newest count entries from `canic backup list`"),
        )
        .arg(
            flag_arg("dry-run")
                .long("dry-run")
                .help("Preview selected backup directories without deleting them"),
        )
        .arg(value_arg("out").long("out").value_name("file"))
        .group(
            ArgGroup::new("prune-selector")
                .args(["failed", "keep"])
                .required(true)
                .multiple(true),
        )
}