borg-hive 0.0.2

Automated backups using Borg Backup
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

// borg-hive - Zero-configuration wrapper for borg
// Copyright (C) 2017  Lorenzo Villani
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 3 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

use std::fs;
use std::path;

use serde_json;

use errors::*;
use paths;

#[derive(Debug, Deserialize, PartialEq, Serialize)]
pub struct Config {
    pub destinations: Vec<Destination>,

    #[serde(default)]
    pub exclude: Vec<String>,
}

#[derive(Debug, Deserialize, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Destination {
    pub repo: String,

    #[serde(default)]
    pub after_backup: Vec<String>,

    #[serde(default)]
    pub before_backup: Vec<String>,
}

impl Config {
    pub fn load_user() -> Result<Self> {
        Self::load(&paths::config_file()?)
    }

    pub fn load(p: &path::Path) -> Result<Self> {
        serde_json::from_reader(fs::File::open(&p)?).chain_err(|| "cannot load configuration file")
    }
}

#[cfg(test)]
mod tests {
    use std::fs;
    use std::io::Write;
    use std::path;

    use tempdir;

    use super::*;

    #[test]
    fn test_missing_config() {
        with_config(|config_path| {
            assert!(Config::load(&config_path).is_err());
        });
    }

    #[test]
    fn test_invalid_config() {
        with_config(|config_path| {
            fs::File::create(&config_path)
                .unwrap()
                .write_all(
                    br#"{ "destinations": [ { "url": "file:///", "beforeBackup": "test" } ] }"#
                )
                .unwrap();

            assert!(Config::load(&config_path).is_err());
        });
    }

    #[test]
    fn test_load_config() {
        with_config(|config_path| {
            fs::File::create(&config_path)
                .unwrap()
                .write_all(br#"{"destinations": []}"#)
                .unwrap();

            let expected = Config {
                destinations: vec![],
                exclude: vec![],
            };

            let obtained = Config::load(&config_path).unwrap();

            assert_eq!(obtained, expected);
        });
    }

    #[test]
    fn test_load_config_destinations() {
        macro_rules! vec_s {
           ($($x:expr), *) => (vec![$($x.to_string()), *]);
        }

        with_config(|config_path| {
            fs::File::create(&config_path)
                .unwrap()
                .write_all(
                    br#"{
                    "destinations": [
                        {
                            "repo": "/"
                        },
                        {
                            "beforeBackup": ["test", "command"],
                            "repo": "/"
                        }
                    ]
                }"#,
                )
                .unwrap();

            let expected = Config {
                destinations: vec![
                    Destination {
                        after_backup: vec![],
                        before_backup: vec![],
                        repo: "/".to_string(),
                    },
                    Destination {
                        after_backup: vec![],
                        before_backup: vec_s!["test", "command"],
                        repo: "/".to_string(),
                    },
                ],
                exclude: vec![],
            };

            let obtained = Config::load(&config_path).unwrap();

            assert_eq!(obtained, expected);
        });
    }

    fn with_config<F: FnOnce(&path::Path) -> ()>(block: F) {
        let tmpdir = tempdir::TempDir::new("borg-hive").unwrap();
        let tmpdir_path = tmpdir.path();
        let test_config = tmpdir_path.join("borg-hive.json");

        block(&test_config);
    }
}