rusync2 0.10.0

Maintained fork of rusync: adds --include/--exclude filters and a --sleep-interval watch mode
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

use std::fs;
use std::option::Option;
use std::path::Path;
use std::path::PathBuf;

#[derive(Debug, Clone)]
pub struct Entry {
    description: String,
    path: PathBuf,
    metadata: Option<fs::Metadata>,
    exists: bool,
    is_link: Option<bool>,
}

impl Entry {
    pub fn new(description: &str, entry_path: &Path) -> Entry {
        // A single `symlink_metadata` call is enough for regular files and
        // directories; only symlinks need a second call, to decide whether
        // they exist from the caller's point of view.
        let symlink_metadata = match fs::symlink_metadata(entry_path) {
            Ok(metadata) => metadata,
            Err(_) => {
                return Entry {
                    description: String::from(description),
                    metadata: None,
                    path: entry_path.to_path_buf(),
                    exists: false,
                    is_link: None,
                };
            }
        };
        let is_link = symlink_metadata.file_type().is_symlink();
        if is_link {
            Entry {
                description: String::from(description),
                metadata: Some(symlink_metadata),
                path: entry_path.to_path_buf(),
                // `exists` follows the link: it is false for broken symlinks:
                exists: entry_path.exists(),
                is_link: Some(true),
            }
        } else {
            Entry {
                description: String::from(description),
                metadata: Some(symlink_metadata),
                path: entry_path.to_path_buf(),
                exists: true,
                is_link: Some(false),
            }
        }
    }

    /// Build an entry for a regular file, reusing metadata that the walker
    /// already read, so that no extra syscall is needed.
    pub(crate) fn regular_file(
        description: &str,
        entry_path: &Path,
        metadata: fs::Metadata,
    ) -> Entry {
        Entry {
            description: String::from(description),
            metadata: Some(metadata),
            path: entry_path.to_path_buf(),
            exists: true,
            is_link: Some(false),
        }
    }

    pub fn description(&self) -> &String {
        &self.description
    }

    pub fn path(&self) -> &PathBuf {
        &self.path
    }
    pub fn metadata(&self) -> Option<&fs::Metadata> {
        self.metadata.as_ref()
    }
    pub fn exists(&self) -> bool {
        self.exists
    }

    pub fn is_link(&self) -> Option<bool> {
        self.is_link
    }
}

#[cfg(test)]
mod tests {

    use super::Entry;
    use super::Path;

    #[test]
    fn new_entry_with_non_existing_path() {
        let path = Path::new("/path/to/nosuch.txt");
        let entry = Entry::new("nosuch", path);

        assert!(!entry.exists());
        assert!(entry.metadata.is_none());
    }

    #[test]
    fn new_entry_with_existing_path() {
        let path = Path::new(file!());
        let entry = Entry::new("entry.rs", path);

        assert!(entry.exists());
        assert!(entry.metadata.is_some());
        let is_link = entry.is_link();
        assert!(is_link.is_some());
        assert!(!is_link.unwrap());
    }

    #[cfg(unix)]
    #[test]
    fn new_entry_with_regular_file_keeps_metadata() {
        let tmp_dir = tempfile::TempDir::new().unwrap();
        let path = tmp_dir.path().join("file.txt");
        std::fs::write(&path, "contents").unwrap();
        let entry = Entry::new("file.txt", &path);
        assert!(entry.exists());
        assert_eq!(entry.metadata().unwrap().len(), 8);
        assert_eq!(entry.is_link(), Some(false));
    }

    #[cfg(unix)]
    #[test]
    fn new_entry_with_broken_symlink() {
        let tmp_dir = tempfile::TempDir::new().unwrap();
        let path = tmp_dir.path().join("broken");
        std::os::unix::fs::symlink("no-such-file", &path).unwrap();
        let entry = Entry::new("broken", &path);
        // A broken symlink does not "exist" (following the link fails):
        assert!(!entry.exists());
        // ... but its metadata (that of the link itself) is available:
        assert!(entry.metadata().is_some());
        assert_eq!(entry.is_link(), Some(true));
    }

    #[cfg(unix)]
    #[test]
    fn new_entry_with_symlink_to_directory() {
        let tmp_dir = tempfile::TempDir::new().unwrap();
        let dir = tmp_dir.path().join("dir");
        std::fs::create_dir(&dir).unwrap();
        let path = tmp_dir.path().join("link");
        std::os::unix::fs::symlink(&dir, &path).unwrap();
        let entry = Entry::new("link", &path);
        assert!(entry.exists());
        assert_eq!(entry.is_link(), Some(true));
    }
}