ripsync-core 1.2.0

Core sync engine for ripsync: delta engine, parallel walk, plan/apply, and the safety model.
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

use std::path::Path;

use ripsync_core::Filter;
use ripsync_core::apply::{ApplyOptions, MetadataOptions, apply_plan_controlled};
use ripsync_core::plan::{PlanOptions, build_plan_controlled};
use ripsync_core::report::{Event, NullReporter, Reporter, RunPhase};
use ripsync_core::verify::{VerifyMode, verify};
use ripsync_core::{Error, RunControl};
use tempfile::tempdir;

fn write(path: &Path, contents: &[u8]) {
    if let Some(parent) = path.parent() {
        std::fs::create_dir_all(parent).unwrap();
    }
    std::fs::write(path, contents).unwrap();
}

struct CancelOn {
    control: RunControl,
    phase: Option<RunPhase>,
    file_start: bool,
}

impl Reporter for CancelOn {
    fn event(&self, event: Event) {
        let phase_matches = matches!(event, Event::Phase(phase) if Some(phase) == self.phase);
        if phase_matches || (self.file_start && matches!(event, Event::FileStart { .. })) {
            self.control.cancel();
        }
    }
}

#[test]
fn cancellation_during_planning_is_reported() {
    let temp = tempdir().unwrap();
    let src = temp.path().join("src");
    let dst = temp.path().join("dst");
    write(&src.join("file"), b"content");
    let control = RunControl::default();
    let reporter = CancelOn {
        control: control.clone(),
        phase: Some(RunPhase::Planning),
        file_start: false,
    };
    let excludes = Filter::none();
    let result = build_plan_controlled(
        &src,
        &dst,
        PlanOptions::default(),
        &excludes,
        &control,
        &reporter,
    );
    assert!(matches!(result, Err(Error::Cancelled)));
}

#[test]
fn cancellation_after_an_in_flight_copy_leaves_no_temp_file() {
    let temp = tempdir().unwrap();
    let src = temp.path().join("src");
    let dst = temp.path().join("dst");
    write(&src.join("file"), &[7; 4096]);
    let excludes = Filter::none();
    let plan =
        ripsync_core::plan::build_plan(&src, &dst, PlanOptions::default(), &excludes).unwrap();
    let control = RunControl::default();
    let reporter = CancelOn {
        control: control.clone(),
        phase: None,
        file_start: true,
    };
    let result = apply_plan_controlled(
        &plan,
        &src,
        &dst,
        ApplyOptions {
            threads: 1,
            ..ApplyOptions::default()
        },
        &reporter,
        &control,
    );
    assert!(matches!(result, Err(Error::Cancelled)));
    let names: Vec<_> = std::fs::read_dir(&dst)
        .unwrap()
        .flatten()
        .map(|entry| entry.file_name())
        .collect();
    assert!(
        names
            .iter()
            .all(|name| !name.to_string_lossy().starts_with(".ripsync-tmp-"))
    );
}

#[test]
fn cancellation_before_deletion_keeps_stale_entry() {
    let temp = tempdir().unwrap();
    let src = temp.path().join("src");
    let dst = temp.path().join("dst");
    write(&src.join("keep"), b"same");
    write(&dst.join("keep"), b"same");
    write(&dst.join("stale"), b"stale");
    let excludes = Filter::none();
    let plan = ripsync_core::plan::build_plan(
        &src,
        &dst,
        PlanOptions {
            delete: true,
            ..PlanOptions::default()
        },
        &excludes,
    )
    .unwrap();
    let control = RunControl::default();
    let reporter = CancelOn {
        control: control.clone(),
        phase: Some(RunPhase::Deleting),
        file_start: false,
    };
    let result = apply_plan_controlled(
        &plan,
        &src,
        &dst,
        ApplyOptions {
            delete: true,
            yes: true,
            ..ApplyOptions::default()
        },
        &reporter,
        &control,
    );
    assert!(matches!(result, Err(Error::Cancelled)));
    assert!(dst.join("stale").exists());
}

#[test]
fn verification_reports_content_mismatch_and_can_cancel() {
    let temp = tempdir().unwrap();
    let src = temp.path().join("src");
    let dst = temp.path().join("dst");
    write(&src.join("file"), b"source");
    write(&dst.join("file"), b"destination");
    let excludes = Filter::none();
    let plan =
        ripsync_core::plan::build_plan(&src, &dst, PlanOptions::default(), &excludes).unwrap();
    let summary = verify(
        &plan,
        &src,
        &dst,
        VerifyMode::All,
        MetadataOptions::default(),
        1,
        &RunControl::default(),
        &NullReporter,
    )
    .unwrap();
    assert!(!summary.mismatches.is_empty());

    let control = RunControl::default();
    let reporter = CancelOn {
        control: control.clone(),
        phase: Some(RunPhase::Verifying),
        file_start: false,
    };
    let result = verify(
        &plan,
        &src,
        &dst,
        VerifyMode::All,
        MetadataOptions::default(),
        1,
        &control,
        &reporter,
    );
    assert!(matches!(result, Err(Error::Cancelled)));
}