canic-cli 0.83.22

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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Module: backup::reference::entry
//!
//! Responsibility: classify persisted backup layouts into list entries.
//! Does not own: backup root scanning or reference lookup.
//! Boundary: manifest, dry-run plan, and execution-backed list row fields.

use super::timestamp::{execution_journal_created_at, run_id_created_at};
use crate::backup::{
    BackupExecutionLayoutStatus, BackupListEntry, BackupListStatus, labels::execution_layout_status,
};
use canic_backup::persistence::BackupLayout;
use std::path::PathBuf;

pub(super) fn backup_list_entry(dir: PathBuf) -> Option<BackupListEntry> {
    let layout = BackupLayout::new(dir.clone());
    if layout.manifest_path().is_file() {
        return Some(manifest_backup_list_entry(dir, &layout));
    }
    if layout.backup_plan_path().is_file() {
        return Some(planned_backup_list_entry(dir, &layout));
    }

    None
}

fn manifest_backup_list_entry(dir: PathBuf, layout: &BackupLayout) -> BackupListEntry {
    let Ok(manifest) = layout.read_manifest() else {
        return BackupListEntry {
            dir,
            backup_id: "-".to_string(),
            created_at: "-".to_string(),
            members: 0,
            status: BackupListStatus::InvalidManifest,
        };
    };
    let status = if layout.backup_plan_path().is_file() {
        execution_backed_layout_status(layout)
    } else {
        BackupListStatus::Ok
    };

    BackupListEntry {
        dir,
        backup_id: manifest.backup_id,
        created_at: manifest.created_at,
        members: manifest.deployment.members.len(),
        status,
    }
}

fn planned_backup_list_entry(dir: PathBuf, layout: &BackupLayout) -> BackupListEntry {
    let Ok(plan) = layout.read_backup_plan() else {
        return BackupListEntry {
            dir,
            backup_id: "-".to_string(),
            created_at: "-".to_string(),
            members: 0,
            status: BackupListStatus::InvalidPlan,
        };
    };
    let status = execution_backed_layout_status(layout);
    let created_at = layout
        .read_execution_journal()
        .ok()
        .and_then(|journal| execution_journal_created_at(&journal))
        .or_else(|| run_id_created_at(&plan.run_id))
        .unwrap_or_else(|| "-".to_string());

    BackupListEntry {
        dir,
        backup_id: plan.plan_id,
        created_at,
        members: plan.targets.len(),
        status,
    }
}

fn execution_backed_layout_status(layout: &BackupLayout) -> BackupListStatus {
    if layout.read_backup_plan().is_err() {
        return BackupListStatus::InvalidPlan;
    }
    if layout.execution_journal_path().is_file() && layout.verify_execution_integrity().is_err() {
        return BackupListStatus::InvalidPlanJournal;
    }
    if !layout.execution_journal_path().is_file() && layout.manifest_path().is_file() {
        return BackupListStatus::InvalidPlanJournal;
    }
    if let Ok(journal) = layout.read_execution_journal() {
        list_status_from_layout_status(execution_layout_status(
            &journal,
            layout.manifest_path().is_file(),
        ))
    } else {
        BackupListStatus::DryRun
    }
}

const fn list_status_from_layout_status(status: BackupExecutionLayoutStatus) -> BackupListStatus {
    match status {
        BackupExecutionLayoutStatus::Complete => BackupListStatus::Complete,
        BackupExecutionLayoutStatus::DryRun => BackupListStatus::DryRun,
        BackupExecutionLayoutStatus::Failed => BackupListStatus::Failed,
        BackupExecutionLayoutStatus::Running => BackupListStatus::Running,
    }
}