qubit-fs 0.1.0

Pluggable filesystem abstraction for Rust
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

use std::sync::{
    Arc,
    Mutex,
};

use qubit_fs::{
    AtomicityRequirement,
    CreateDirOptions,
    FileSystem,
    FsPath,
    ManagedTempDir,
    PersistOptions,
    TempDir,
    TempResource,
};

use crate::common::{
    MockFs,
    MockState,
};

#[test]
fn test_managed_temp_dir_cleanup_removes_directory() {
    let fs: Arc<dyn FileSystem> = Arc::new(MockFs::default());
    let path = FsPath::parse("/manual-dir.tmp").expect("path should parse");
    fs.create_dir(&path, &CreateDirOptions::default())
        .expect("dir should be created");

    Box::new(ManagedTempDir::new(fs.clone(), path.clone()))
        .cleanup()
        .expect("cleanup should succeed");

    assert!(!fs.exists(&path).expect("dir should be gone"));
}

#[test]
fn test_managed_temp_dir_keep_returns_path_without_cleanup() {
    let fs: Arc<dyn FileSystem> = Arc::new(MockFs::default());
    let path = FsPath::parse("/manual-dir.tmp").expect("path should parse");
    fs.create_dir(&path, &CreateDirOptions::default())
        .expect("dir should be created");

    let kept = Box::new(ManagedTempDir::new(fs, path.clone()))
        .keep()
        .expect("keep should succeed");

    assert_eq!(path, kept);
}

#[test]
fn test_managed_temp_dir_persist_renames_when_supported() {
    let fs: Arc<dyn FileSystem> = Arc::new(MockFs::default());
    let path = FsPath::parse("/rename-dir.tmp").expect("path should parse");
    fs.create_dir(&path, &CreateDirOptions::default())
        .expect("dir should be created");

    Box::new(ManagedTempDir::new(fs.clone(), path))
        .persist(
            &FsPath::parse("/renamed-dir").expect("path should parse"),
            &PersistOptions::default(),
        )
        .expect("persist should rename");

    assert!(
        fs.exists(&FsPath::parse("/renamed-dir").expect("path should parse"))
            .expect("target should exist"),
    );
}

#[test]
fn test_managed_temp_dir_persist_copy_deletes_when_rename_unsupported_and_allowed() {
    let state = Arc::new(Mutex::new(MockState::default()));
    let fs: Arc<dyn FileSystem> = Arc::new(MockFs::with_state(state.clone()));
    state.lock().expect("state lock should succeed").fail_rename_unsupported = true;
    let path = FsPath::parse("/copy-dir.tmp").expect("path should parse");
    fs.create_dir(&path, &CreateDirOptions::default())
        .expect("dir should be created");

    Box::new(ManagedTempDir::new(fs, path))
        .persist(
            &FsPath::parse("/copy-dir").expect("path should parse"),
            &PersistOptions {
                allow_copy_delete: true,
                atomic: AtomicityRequirement::BestEffort,
                ..PersistOptions::default()
            },
        )
        .expect("persist should copy-delete");
}

#[test]
fn test_managed_temp_dir_drop_runs_best_effort_cleanup() {
    let fs: Arc<dyn FileSystem> = Arc::new(MockFs::default());
    let path = FsPath::parse("/drop-dir.tmp").expect("path should parse");
    fs.create_dir(&path, &CreateDirOptions::default())
        .expect("dir should be created");

    drop(ManagedTempDir::new(fs.clone(), path.clone()));

    assert!(!fs.exists(&path).expect("drop cleanup should run"));
}

#[test]
fn test_managed_temp_dir_cleanup_and_persist_return_errors() {
    let state = Arc::new(Mutex::new(MockState::default()));
    let fs: Arc<dyn FileSystem> = Arc::new(MockFs::with_state(state.clone()));
    let cleanup_path = FsPath::parse("/cleanup-dir-error.tmp").expect("path should parse");
    fs.create_dir(&cleanup_path, &CreateDirOptions::default())
        .expect("dir should be created");
    state.lock().expect("state lock should succeed").fail_delete = true;
    assert!(
        Box::new(ManagedTempDir::new(fs.clone(), cleanup_path))
            .cleanup()
            .is_err(),
    );
    state.lock().expect("state lock should succeed").fail_delete = false;

    state.lock().expect("state lock should succeed").fail_rename_unsupported = true;
    let unsupported_path = FsPath::parse("/unsupported-dir.tmp").expect("path should parse");
    fs.create_dir(&unsupported_path, &CreateDirOptions::default())
        .expect("dir should be created");
    assert!(
        Box::new(ManagedTempDir::new(fs.clone(), unsupported_path))
            .persist(
                &FsPath::parse("/unsupported-dir").expect("path should parse"),
                &PersistOptions::default(),
            )
            .is_err(),
    );
}