binsync 0.0.4

A library for syncing binary files between two locations.
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

use std::{fs, path::Path};

use binsync::{CachingChunkProvider, Syncer};

extern crate binsync;

mod common;

#[test]
/// Tests a basic copy and paste. No file exists at the destination.
fn test_empty_destination() {
    let context = common::TestContext::new();

    context.write_file("in/test.bin", 1048576); // 1MB
    context.write_file("in/test2.bin", 1048576); // 1MB

    let from = context.path("in");
    let to = context.path("out");

    let manifest = binsync::generate_manifest(&from).unwrap();

    let from_path = Path::new(&from);
    let provider = CachingChunkProvider::new(from_path);

    let to_path = Path::new(&to);
    let mut syncer = Syncer::new(to_path, provider, manifest);
    syncer.sync().unwrap();

    assert!(context.compare_hashes("in/test.bin", "out/test.bin"));
    assert!(context.compare_hashes("in/test2.bin", "out/test2.bin"));
}

#[test]
/// Write into a file deep into a folder hierarchy. Catches issues when we
/// assume certain folders exist at the destination.
fn test_empty_destination_complex() {
    let context = common::TestContext::new();

    context.write_file("in/foo/bar/baz/test.bin", 1048576); // 1MB

    binsync::sync(&context.path("in"), &context.path("out")).unwrap();

    assert!(context.compare_hashes("in/foo/bar/baz/test.bin", "out/foo/bar/baz/test.bin"));
}

#[test]
/// Randomize the destination file, along with making it longer. Ensures
/// proper truncation and modification of the destination file.
fn test_rand_destination() {
    let context = common::TestContext::new();

    context.write_file("in/test.bin", 1048576); // 1MB
    context.write_file("out/test.bin", 1048677); // 1MB

    binsync::sync(&context.path("in"), &context.path("out")).unwrap();

    assert!(context.compare_hashes("in/test.bin", "out/test.bin"));
}

#[test]
/// Two exact same files that should incur no copies.
fn test_copy_destination() {
    let context = common::TestContext::new();

    context.write_file("in/test.bin", 1048576); // 1MB
    fs::copy(context.path("in/test.bin"), context.path("out/test.bin")).unwrap();

    let from = context.path("in");
    let to = context.path("out");

    let manifest = binsync::generate_manifest(&from).unwrap();

    let from_path = Path::new(&from);
    let provider = CachingChunkProvider::new(from_path);

    let to_path = Path::new(&to);
    let mut syncer = Syncer::new(to_path, provider, manifest);

    let plan = syncer.plan().unwrap();
    assert_eq!(0, plan.operations.len());

    syncer.sync_from_plan(&plan).unwrap();

    assert!(context.compare_hashes("in/test.bin", "out/test.bin"));
}

#[test]
/// Forces us to copy chunks from the existing destination file and reuse them.
/// This rarely happens in the other tests as chunks do not move throughout the
/// file we are copying from/to.
fn test_copy_destination_padded() {
    let context = common::TestContext::new();

    context.write_file("in/test.bin", 1048576); // 1MB
    fs::copy(context.path("in/test.bin"), context.path("out/test.bin")).unwrap();

    // Change the in file to contain its data embedded inside itself. This is
    // not done optimally but conveniently.
    let mut data = fs::read(context.path("in/test.bin")).unwrap();
    let mut copy = data.clone();
    let mut copy2 = copy.split_off(copy.len() / 2);

    copy2.append(&mut data);
    copy2.append(&mut copy);
    fs::write(context.path("in/test.bin"), copy2).unwrap();

    binsync::sync(&context.path("in"), &context.path("out")).unwrap();

    assert!(context.compare_hashes("in/test.bin", "out/test.bin"));
}