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
278
279
280
281
282
mod entry;
mod file;

use crate::file::{DirEntry, Metadata, OpenOptions};
use crate::memory_fs::file::{FileHandle, FileMode};
use crate::tree::{Directory, Entry, FilesystemTree};
use crate::util::{already_exists, invalid_path, not_found};
use crate::FileSystem;
use itertools::Itertools;
use parking_lot::Mutex;
use std::collections::{hash_map, HashMap};
use std::ffi::OsStr;
use std::path::Path;
use std::sync::Arc;

/// A file within the memory filesystem.
type File = Arc<Mutex<Vec<u8>>>;

/// A memory-backed filesystem. All files are stored within.
#[derive(Default)]
pub struct MemoryFS {
    inner: FilesystemTree<File>,
}

impl MemoryFS {
    fn with_parent_and_child_name<R, P: AsRef<Path>, F: FnOnce(&mut Directory<File>, &str) -> R>(
        &self,
        path: P,
        f: F,
    ) -> crate::Result<R> {
        let parent_directory = path.as_ref().parent().ok_or_else(invalid_path)?;
        let child_name = path
            .as_ref()
            .file_name()
            .and_then(OsStr::to_str)
            .ok_or_else(invalid_path)?;

        // fetch the parent directory and insert the new directory, if not already existent
        self.inner
            .with_directory(parent_directory, |dir| f(dir, child_name))
    }
}

impl FileSystem for MemoryFS {
    fn create_dir(&self, path: &str) -> crate::Result<()> {
        // fetch the parent directory and insert the new directory, if not already existent
        self.with_parent_and_child_name(path, |dir, directory_name| {
            match dir.entry(directory_name.to_owned()) {
                hash_map::Entry::Vacant(vac) => {
                    vac.insert(Entry::Directory(HashMap::default()));
                    Ok(())
                }
                _ => Err(already_exists()),
            }
        })?
    }

    fn metadata(&self, path: &str) -> crate::Result<Metadata> {
        // fetch the parent directory, because the entry can either be a folder or file
        self.with_parent_and_child_name(path, |dir, file_name| match dir.get(file_name) {
            Some(Entry::Directory(_)) => Ok(Metadata::directory()),
            Some(Entry::UserData(file)) => Ok(Metadata::file(file.lock().len() as u64)),
            None => Err(not_found()),
        })?
    }

    fn open_file_options(
        &self,
        path: &str,
        options: &OpenOptions,
    ) -> crate::Result<Box<dyn crate::File>> {
        // grab the file
        let mut file = self.with_parent_and_child_name(path, |dir, file_name| {
            let file = match dir.entry(file_name.to_owned()) {
                hash_map::Entry::Occupied(entry) => {
                    // of course we can only grab the file if it's a file
                    if let Entry::UserData(file) = entry.get() {
                        file.clone()
                    } else {
                        return Err(not_found());
                    }
                }
                hash_map::Entry::Vacant(vacant) => {
                    if options.create {
                        // create a new empty file and return it
                        let file = File::new(Mutex::default());
                        vacant.insert(Entry::UserData(file.clone()));
                        file
                    } else {
                        return Err(not_found());
                    }
                }
            };

            let mode = FileMode::from_options(options);
            Ok(FileHandle::new(file, mode))
        })??;

        // if we want to truncate the file, clear the contents
        if options.truncate {
            file.clear();
        }

        Ok(Box::new(file))
    }

    fn read_dir(
        &self,
        path: &str,
    ) -> crate::Result<Box<dyn Iterator<Item = crate::Result<DirEntry>>>> {
        self.inner.with_directory(path, |dir| {
            let iter: Box<dyn Iterator<Item = crate::Result<DirEntry>>> = Box::new(
                dir.iter()
                    .map(|(name, entry)| {
                        Ok(DirEntry {
                            path: name.into(),
                            metadata: entry.into(),
                        })
                    })
                    .collect_vec()
                    .into_iter(),
            );
            iter
        })
    }

    fn remove_dir(&self, path: &str) -> crate::Result<()> {
        self.with_parent_and_child_name(path, |parent, dir| match parent.entry(dir.to_owned()) {
            hash_map::Entry::Occupied(occ) if matches!(occ.get(), Entry::Directory(_)) => {
                occ.remove();
                Ok(())
            }
            _ => Err(not_found()),
        })?
    }

    fn remove_file(&self, path: &str) -> crate::Result<()> {
        self.with_parent_and_child_name(path, |parent, dir| match parent.entry(dir.to_owned()) {
            hash_map::Entry::Occupied(occ) if matches!(occ.get(), Entry::UserData(_)) => {
                occ.remove();
                Ok(())
            }
            _ => Err(not_found()),
        })?
    }

    fn create_dir_all(&self, path: &str) -> crate::Result<()> {
        self.inner.create_dir_all(path, |_| ())
    }
}

#[cfg(test)]
mod test {
    use crate::file::{FileType, Metadata};
    use crate::memory_fs::MemoryFS;
    use crate::FileSystem;
    use std::collections::BTreeMap;
    use std::io::Write;

    fn memory_fs() -> MemoryFS {
        let fs = MemoryFS::default();

        write!(fs.create_file("file").unwrap(), "something interesting").unwrap();
        fs.create_dir_all("folder/and/it/goes/deeper").unwrap();
        write!(fs.create_file("folder/and/it/goes/desc").unwrap(), "goes").unwrap();

        fs
    }

    fn read_directory(fs: &MemoryFS, dir: &str) -> BTreeMap<String, Metadata> {
        fs.read_dir(dir)
            .unwrap()
            .map(|entry| {
                let entry = entry.unwrap();
                (entry.path.to_str().unwrap().to_owned(), entry.metadata)
            })
            .collect()
    }

    #[test]
    fn create_file() {
        memory_fs();
    }

    #[test]
    fn metadata() {
        let fs = memory_fs();

        // basic file
        for name in ["file", "/file", "./file", "test/../file"] {
            let md = fs.metadata(name).unwrap();
            assert_eq!(md.file_type, FileType::File);
            assert_eq!(md.len, 21);
        }

        // basic folder
        for name in ["folder", "/folder", "./folder", "test/../folder"] {
            let md = fs.metadata(name).unwrap();
            assert_eq!(md.file_type, FileType::Directory);
            assert_eq!(md.len, 0);
        }

        // nested file
        for name in [
            "folder/and/it/goes/desc",
            "/folder/and/it/goes/desc",
            "./folder/and/it/goes/desc",
            "test/../folder/and/it/goes/desc",
        ] {
            let md = fs.metadata(name).unwrap();
            assert_eq!(md.file_type, FileType::File);
            assert_eq!(md.len, 4);
        }
    }

    #[test]
    fn read_dir() {
        let fs = memory_fs();

        // simple
        for name in ["", "/", "./", "//", "\\"] {
            let files = read_directory(&fs, name);
            itertools::assert_equal(files.keys(), vec!["file", "folder"]);
            itertools::assert_equal(
                files.values(),
                vec![&Metadata::file(21), &Metadata::directory()],
            )
        }

        // nested
        for name in [
            "folder/and/it/goes",
            "/folder/and/it/goes",
            "./folder/and/it/goes/",
            "///folder/and/it/goes///",
            "\\folder\\and\\it\\goes\\",
        ] {
            let files = read_directory(&fs, name);
            itertools::assert_equal(files.keys(), vec!["deeper", "desc"]);
            itertools::assert_equal(
                files.values(),
                vec![&Metadata::directory(), &Metadata::file(4)],
            )
        }

        // traversal
        for name in [
            "folder/and/../..",
            "./folder/and/../..",
            ".//folder/and//../..",
            "\\folder//../folder/and/../..",
        ] {
            let files = read_directory(&fs, name);
            itertools::assert_equal(files.keys(), vec!["file", "folder"]);
            itertools::assert_equal(
                files.values(),
                vec![&Metadata::file(21), &Metadata::directory()],
            )
        }
    }

    #[test]
    fn remove_dir() {
        let fs = memory_fs();

        assert!(fs.exists("folder/and/it/goes").unwrap());
        fs.remove_dir("folder/and/it").unwrap();
        assert!(!fs.exists("folder/and/it/goes").unwrap());
        assert!(!fs.exists("/folder/and/it").unwrap());
        assert!(!fs.exists("/folder/and/it/goes/desc").unwrap());
    }

    #[test]
    fn remove_file() {
        let fs = memory_fs();

        assert!(fs.exists("folder/and/it/goes/desc").unwrap());
        fs.remove_file("folder/and/it/goes/desc").unwrap();
        assert!(fs.exists("folder/and/it/goes/deeper").unwrap());
        assert!(!fs.exists("folder/and/it/goes/desc").unwrap());
    }
}