forge_backup 1.2.0

A program to backup all the user home folders to an S3 bucket.
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use std::{fmt, path::PathBuf};

pub type AppResult<T> = Result<T, AppError>;

#[derive(Debug)]
pub enum AppError {
    Backup(BackupError),
    Config(ConfigError),
    Mail(MailerError),
}

#[derive(Debug)]
pub enum ConfigError {
    FileNotFoundError(PathBuf),
    DeserializationError(String, toml::de::Error),
    ProjectPathNotFoundError,
    EnvVarSubstitutionError(String),
}

#[derive(Debug)]
pub enum MailerError {
    SendError,
    ConfigError(String),
}

#[derive(Debug)]
pub enum BackupError {
    DirectoryReadError(PathBuf),
    MakeDirectoryError(PathBuf),
    MissingTempError(PathBuf),
    MissingHomeError(PathBuf),
    InvalidHomeError(PathBuf),
    CreateArchiveError(CreateArchiveError),
    S3CopyError(S3CopyError),
    S3InvalidFile(PathBuf),
    ZipError(String),
    DeleteTempError(PathBuf),
}

#[derive(Debug)]
pub struct CreateArchiveError {
    pub path: PathBuf,
    pub user: String,
}

#[derive(Debug)]
pub struct S3CopyError {
    pub src: String,
    pub dest: String,
    pub std_err: String,
    pub std_out: String,
}

impl fmt::Display for ConfigError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ConfigError::FileNotFoundError(path) => {
                write!(f, "Configuration file not found. {path:?}")
            }
            ConfigError::DeserializationError(_, err) => {
                write!(f, "Failed to deserialize the configuration file: {err}")
            }
            ConfigError::ProjectPathNotFoundError => {
                write!(f, "Could not determine project directories.")
            }
            ConfigError::EnvVarSubstitutionError(var) => {
                write!(f, "Could not find environment variable: {var}")
            }
        }
    }
}
impl fmt::Display for AppError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            AppError::Config(ce) => ce.fmt(f),
            AppError::Backup(be) => be.fmt(f),
            AppError::Mail(me) => me.fmt(f),
        }
    }
}
impl fmt::Display for MailerError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Unable to send email")
    }
}
impl fmt::Display for BackupError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            BackupError::ZipError(s) => {
                write!(f, "Unable to run zip to compress the archive: {s}")
            }
            BackupError::DirectoryReadError(path) => {
                write!(
                    f,
                    "Unable to read directory during backup: {}",
                    path.display()
                )
            }
            BackupError::MakeDirectoryError(path) => {
                write!(
                    f,
                    "Unable to create directory during backup: {}",
                    path.display()
                )
            }
            BackupError::MissingHomeError(path) => {
                write!(f, "Unable to find home folder: {}", path.display())
            }
            BackupError::MissingTempError(path) => {
                write!(f, "Missing temp directory: {}", path.display())
            }
            BackupError::DeleteTempError(path) => {
                write!(f, "Unable to delete temp file: {}", path.display())
            }
            BackupError::InvalidHomeError(path) => {
                write!(f, "Invalid home directory: {}", path.display())
            }
            BackupError::CreateArchiveError(create_archive_error) => {
                write!(
                    f,
                    "Unable to create archive at: {} for user: {}",
                    create_archive_error.path.display(),
                    create_archive_error.user
                )
            }
            BackupError::S3InvalidFile(file) => {
                write!(f, "Invalid source file: {}", file.display())
            }
            BackupError::S3CopyError(s3_copy_error) => {
                write!(
                    f,
                    "Unable to copy from: {} to {}: {}",
                    s3_copy_error.src, s3_copy_error.dest, s3_copy_error.std_err
                )
            }
        }
    }
}

impl std::error::Error for ConfigError {}

impl From<ConfigError> for AppError {
    fn from(error: ConfigError) -> Self {
        AppError::Config(error)
    }
}

impl From<MailerError> for AppError {
    fn from(error: MailerError) -> Self {
        AppError::Mail(error)
    }
}

impl From<BackupError> for AppError {
    fn from(error: BackupError) -> Self {
        AppError::Backup(error)
    }
}