backpak 0.3.0

A content-addressed backup system with deduplication and compression
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277

use std::{
    fs,
    os::unix::{self, fs::PermissionsExt},
    process::Command,
};

use anyhow::Result;
use tempfile::tempdir;

mod common;

use common::*;

#[test]
fn restore_src() -> Result<()> {
    let backup_dir = tempdir()?;
    let backup_path = backup_dir.path();

    let working_dir = tempdir()?;
    let working_path = working_dir.path();

    cli_run(working_path, backup_path)?
        .args(["init", "filesystem"])
        .assert()
        .success();

    // Let's make a copy of src so we don't fudge the actual code
    assert!(
        Command::new("cp")
            .args(&["-r", "src"])
            .arg(working_path)
            .status()?
            .success()
    );

    // And back it up
    cli_run(working_path, backup_path)?
        .arg("backup")
        .arg(working_path.join("src"))
        .assert()
        .success();

    let restoreit = |args: &[&str]| {
        let restore_run = cli_run(working_path, backup_path)
            .unwrap()
            .args(&["restore", "--delete", "--times", "--permissions", "LAST"])
            .args(args)
            .assert()
            .success();
        let restore_err = stderr(&restore_run).trim();
        eprintln!("{}", restore_err);
        let restore_output: Vec<_> = stdout(&restore_run)
            .trim()
            .lines()
            // Strip Opening... Building a master index... snapshot <hash>...
            .skip(3)
            // I don't care about atime. They change if you sneeze (and based on mount opts).
            .filter(|l| !l.starts_with("A "))
            .map(str::to_owned)
            .collect();
        restore_output
    };

    let prefix_working_path = |s: &str| -> String {
        let (code, path) = s.split_at(2);
        let prefixed = working_path.join(path);
        format!("{}{}", code, prefixed.display())
    };

    let compare = |expected: &[&str], args: &[&str]| {
        let expected = expected
            .iter()
            .map(|p| prefix_working_path(p))
            .collect::<Vec<_>>();
        let got = restoreit(args);
        println!("Expected:\n{:#?}", expected);
        println!("Got:\n{:#?}", got);
        assert_eq!(expected, got);
    };

    // Without any changes, restore should be a no-op
    compare(&[], &[]);

    // Obvious stuff - added, removed, moved, modified, perms...
    fs::remove_file(working_path.join("src/diff.rs"))?;
    fs::File::create(working_path.join("src/aNewFile"))?;
    fs::rename(
        working_path.join("src/backend"),
        working_path.join("src/wackend"),
    )?;
    fs::write(working_path.join("src/lib.rs"), "I want some butts!")?;
    fs::set_permissions(
        working_path.join("src/main.rs"),
        fs::Permissions::from_mode(0o777),
    )?;

    compare(
        &[
            "- src/aNewFile",
            "+ src/backend/",
            "+ src/backend/backblaze.rs",
            "+ src/backend/cache.rs",
            "+ src/backend/filter.rs",
            "+ src/backend/fs.rs",
            "+ src/backend/memory.rs",
            "+ src/backend/semaphored.rs",
            "+ src/diff.rs",
            "C src/lib.rs",
            "P src/main.rs",
            "- src/wackend/",
            "- src/wackend/backblaze.rs",
            "- src/wackend/cache.rs",
            "- src/wackend/filter.rs",
            "- src/wackend/fs.rs",
            "- src/wackend/memory.rs",
            "- src/wackend/semaphored.rs",
            "T src/",
        ],
        &[],
    );

    // Restoring again should do nothing
    compare(&[], &[]);

    // Changed type!
    fs::remove_file(working_path.join("src/ls.rs"))?;
    unix::fs::symlink("/dev/null", working_path.join("src/ls.rs"))?;

    compare(&["- src/ls.rs -> /dev/null", "+ src/ls.rs", "T src/"], &[]);

    // Symlink modified (should be -/+, not M)
    fs::remove_file(working_path.join("src/ls.rs"))?;
    unix::fs::symlink("/dev/null", working_path.join("src/ls.rs"))?;
    cli_run(working_path, backup_path)?
        .arg("backup")
        .arg(working_path.join("src"))
        .assert()
        .success();

    fs::remove_file(working_path.join("src/ls.rs"))?;
    unix::fs::symlink("/dev/urandom", working_path.join("src/ls.rs"))?;

    compare(
        &[
            "- src/ls.rs -> /dev/urandom",
            "+ src/ls.rs -> /dev/null",
            "T src/",
        ],
        &[],
    );

    // Move our directory and retarget the restore with --output
    let moved_to_path = &working_path.join("elsewhere");
    let moved_to = moved_to_path.to_str().unwrap();

    fs::rename(working_path.join("src"), moved_to)?;

    // Everything should compare cleanly,
    // except the symlink whose time got bumped by the restore above.
    compare(&["T elsewhere/ls.rs -> /dev/null"], &["--output", moved_to]);

    // Axe the backend folder and bring it back at the new target.
    fs::remove_dir_all(moved_to_path.join("backend"))?;

    compare(
        &[
            "+ elsewhere/backend/",
            "+ elsewhere/backend/backblaze.rs",
            "+ elsewhere/backend/cache.rs",
            "+ elsewhere/backend/filter.rs",
            "+ elsewhere/backend/fs.rs",
            "+ elsewhere/backend/memory.rs",
            "+ elsewhere/backend/semaphored.rs",
            "T elsewhere/",
        ],
        &["-o", moved_to],
    );

    // We should be clean now
    compare(&[], &["-o", moved_to]);

    Ok(())
}

#[test]
fn restore_multipath() -> Result<()> {
    let backup_dir = tempdir()?;
    let backup_path = backup_dir.path();

    let working_dir = tempdir()?;
    let working_path = working_dir.path();

    cli_run(working_path, backup_path)?
        .args(["init", "filesystem"])
        .assert()
        .success();

    // Back up multiple things! And try files as the top-level objects to boot!
    assert!(
        Command::new("cp")
            .args(&["README.md", "LICENSE.txt"])
            .arg(working_path)
            .status()?
            .success()
    );

    cli_run(working_path, backup_path)?
        .arg("backup")
        .arg(working_path.join("README.md"))
        .arg(working_path.join("LICENSE.txt"))
        .assert()
        .success();

    // Copy-pasting this makes me sad but I'm too lazy to write versions that take
    // the working and backup paths and return some partially-applied Fn.
    // (Haskell is ruining me.)
    let restoreit = |args: &[&str]| {
        let restore_run = cli_run(working_path, backup_path)
            .unwrap()
            .args(&["restore", "--delete", "--times", "--permissions", "LAST"])
            .args(args)
            .assert()
            .success();
        let restore_err = stderr(&restore_run).trim();
        eprintln!("{}", restore_err);
        let restore_output: Vec<_> = stdout(&restore_run)
            .trim()
            .lines()
            // Strip Opening... Building a master index... snapshot <hash>...
            .skip(3)
            // I don't care about atime. They change if you sneeze (and based on mount opts).
            .filter(|l| !l.starts_with("A "))
            .map(str::to_owned)
            .collect();
        restore_output
    };

    let prefix_working_path = |s: &str| -> String {
        let (code, path) = s.split_at(2);
        let prefixed = working_path.join(path);
        format!("{}{}", code, prefixed.display())
    };

    let compare = |expected: &[&str], args: &[&str]| {
        let expected = expected
            .iter()
            .map(|p| prefix_working_path(p))
            .collect::<Vec<_>>();
        let got = restoreit(args);
        println!("Expected:\n{:#?}", expected);
        println!("Got:\n{:#?}", got);
        assert_eq!(expected, got);
    };

    compare(&[], &[]);

    // Multi-path restore works
    fs::write(working_path.join("LICENSE.txt"), "https://xkcd.com/225/")?;
    fs::write(
        working_path.join("README.md"),
        "We spend eternity looking at pleasant moments—like today at the zoo. \
        Isn't this a nice moment?",
    )?;
    compare(&["C LICENSE.txt", "C README.md"], &[]);

    // Multi-path retargeting:
    let out_path = &working_path.join("elsewhere");
    let out = out_path.to_str().unwrap();

    fs::create_dir(out_path)?;
    compare(
        &["+ elsewhere/LICENSE.txt", "+ elsewhere/README.md"],
        &["--output", out],
    );

    Ok(())
}