dotm-rs 2.0.0

Dotfile manager with composable roles, templates, and host-specific overrides
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
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367

use dotm::deployer::{apply_permission_override, deploy_copy, deploy_symlink, DeployResult};
use dotm::scanner::{EntryKind, FileAction};
use std::os::unix::fs::PermissionsExt;
use std::path::PathBuf;
use tempfile::TempDir;

// --- deploy_symlink tests ---

#[test]
fn symlink_base_file_to_source() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    let source_path = source_dir.path().join("app.conf");
    std::fs::write(&source_path, "base config content").unwrap();

    let action = FileAction {
        source: source_path.clone(),
        target_rel_path: PathBuf::from(".config/app.conf"),
        kind: EntryKind::Base,
    };

    let result = deploy_symlink(&action, target_dir.path(), false, false).unwrap();
    assert!(matches!(result, DeployResult::Created));

    // Target should be a symlink pointing directly to the source
    let target = target_dir.path().join(".config/app.conf");
    assert!(target.is_symlink());
    assert_eq!(
        std::fs::read_link(&target).unwrap(),
        std::fs::canonicalize(&source_path).unwrap()
    );

    // Content should match source
    assert_eq!(std::fs::read_to_string(&target).unwrap(), "base config content");
}

#[test]
fn symlink_replaces_existing_symlink() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    let source_path = source_dir.path().join("test.conf");
    std::fs::write(&source_path, "content").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from("test.conf"),
        kind: EntryKind::Base,
    };

    // First deploy — should be Created
    let result = deploy_symlink(&action, target_dir.path(), false, false).unwrap();
    assert!(matches!(result, DeployResult::Created));

    // Second deploy — should be Updated
    let result = deploy_symlink(&action, target_dir.path(), false, false).unwrap();
    assert!(matches!(result, DeployResult::Updated));

    // Target should still be a symlink
    let target = target_dir.path().join("test.conf");
    assert!(target.is_symlink());
}

#[test]
fn symlink_conflicts_with_unmanaged_regular_file() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    // Place an unmanaged regular file at the target path
    std::fs::write(target_dir.path().join("conflict.conf"), "I was here first").unwrap();

    let source_path = source_dir.path().join("conflict.conf");
    std::fs::write(&source_path, "new content").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from("conflict.conf"),
        kind: EntryKind::Base,
    };

    let result = deploy_symlink(&action, target_dir.path(), false, false).unwrap();
    assert!(matches!(result, DeployResult::Conflict(_)));

    // Original file should still exist
    let target = target_dir.path().join("conflict.conf");
    assert!(target.exists());
    assert!(!target.is_symlink());
    assert_eq!(std::fs::read_to_string(&target).unwrap(), "I was here first");
}

#[test]
fn symlink_force_overwrites_regular_file() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    // Place an unmanaged regular file at the target path
    std::fs::write(target_dir.path().join("conflict.conf"), "I was here first").unwrap();

    let source_path = source_dir.path().join("conflict.conf");
    std::fs::write(&source_path, "new content").unwrap();

    let action = FileAction {
        source: source_path.clone(),
        target_rel_path: PathBuf::from("conflict.conf"),
        kind: EntryKind::Base,
    };

    let result = deploy_symlink(&action, target_dir.path(), false, true).unwrap();
    assert!(matches!(result, DeployResult::Updated));

    // Target should now be a symlink to the source
    let target = target_dir.path().join("conflict.conf");
    assert!(target.is_symlink());
    assert_eq!(
        std::fs::read_link(&target).unwrap(),
        std::fs::canonicalize(&source_path).unwrap()
    );
}

#[test]
fn symlink_errors_on_directory_target() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    // Create a directory at the target path
    std::fs::create_dir_all(target_dir.path().join(".config")).unwrap();

    let source_path = source_dir.path().join("app.conf");
    std::fs::write(&source_path, "content").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from(".config"),
        kind: EntryKind::Base,
    };

    let result = deploy_symlink(&action, target_dir.path(), false, false).unwrap();
    match result {
        DeployResult::Conflict(msg) => {
            assert!(msg.contains("directory"), "expected 'directory' in error message, got: {}", msg);
        }
        _ => panic!("expected Conflict result for directory target"),
    }
}

#[test]
fn symlink_dry_run_creates_nothing() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    let source_path = source_dir.path().join("app.conf");
    std::fs::write(&source_path, "some content").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from(".config/app.conf"),
        kind: EntryKind::Base,
    };

    let result = deploy_symlink(&action, target_dir.path(), true, false).unwrap();
    assert!(matches!(result, DeployResult::DryRun));

    assert!(!target_dir.path().join(".config/app.conf").exists(), "dry run should not create target symlink");
}

// --- deploy_copy tests ---

#[test]
fn copy_writes_rendered_template() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    let source_path = source_dir.path().join("app.conf.tera");
    std::fs::write(&source_path, "{{ raw_template }}").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from(".config/app.conf"),
        kind: EntryKind::Template,
    };

    let rendered = "rendered template output";
    let result = deploy_copy(&action, target_dir.path(), false, false, Some(rendered)).unwrap();
    assert!(matches!(result, DeployResult::Created));

    let target = target_dir.path().join(".config/app.conf");
    assert!(target.exists());
    assert!(!target.is_symlink(), "template should be a regular file, not a symlink");
    assert_eq!(std::fs::read_to_string(&target).unwrap(), "rendered template output");
}

#[test]
fn copy_base_file_copies_from_source() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    let source_path = source_dir.path().join("script.sh");
    std::fs::write(&source_path, "#!/bin/sh\necho hello").unwrap();
    std::fs::set_permissions(&source_path, std::fs::Permissions::from_mode(0o755)).unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from("script.sh"),
        kind: EntryKind::Base,
    };

    let result = deploy_copy(&action, target_dir.path(), false, false, None).unwrap();
    assert!(matches!(result, DeployResult::Created));

    let target = target_dir.path().join("script.sh");
    assert!(target.exists());
    assert!(!target.is_symlink(), "deploy_copy should create a regular file, not a symlink");
    assert_eq!(std::fs::read_to_string(&target).unwrap(), "#!/bin/sh\necho hello");

    // Check permissions were preserved
    let mode = std::fs::metadata(&target).unwrap().permissions().mode() & 0o777;
    assert_eq!(mode, 0o755, "copy should preserve source permissions");
}

#[test]
fn copy_errors_on_directory_target() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    // Create a directory at the target path
    std::fs::create_dir_all(target_dir.path().join(".config")).unwrap();

    let source_path = source_dir.path().join("app.conf");
    std::fs::write(&source_path, "content").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from(".config"),
        kind: EntryKind::Base,
    };

    let result = deploy_copy(&action, target_dir.path(), false, false, None).unwrap();
    match result {
        DeployResult::Conflict(msg) => {
            assert!(msg.contains("directory"), "expected 'directory' in error message, got: {}", msg);
        }
        _ => panic!("expected Conflict result for directory target"),
    }
}

#[test]
fn copy_replaces_existing_symlink() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    // Create a symlink at the target path (pointing to something else)
    let dummy_file = source_dir.path().join("dummy");
    std::fs::write(&dummy_file, "dummy content").unwrap();
    let target_path = target_dir.path().join("test.conf");
    std::os::unix::fs::symlink(&dummy_file, &target_path).unwrap();

    let source_path = source_dir.path().join("test.conf");
    std::fs::write(&source_path, "new content").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from("test.conf"),
        kind: EntryKind::Base,
    };

    let result = deploy_copy(&action, target_dir.path(), false, false, None).unwrap();
    assert!(matches!(result, DeployResult::Updated));

    // Target should now be a regular file (not symlink)
    assert!(!target_path.is_symlink());
    assert_eq!(std::fs::read_to_string(&target_path).unwrap(), "new content");
}

#[test]
fn copy_conflicts_with_unmanaged_regular_file() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    // Place an unmanaged regular file at the target path
    std::fs::write(target_dir.path().join("conflict.conf"), "I was here first").unwrap();

    let source_path = source_dir.path().join("conflict.conf");
    std::fs::write(&source_path, "new content").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from("conflict.conf"),
        kind: EntryKind::Base,
    };

    let result = deploy_copy(&action, target_dir.path(), false, false, None).unwrap();
    assert!(matches!(result, DeployResult::Conflict(_)));

    // Original file should still exist
    let target = target_dir.path().join("conflict.conf");
    assert!(target.exists());
    assert_eq!(std::fs::read_to_string(&target).unwrap(), "I was here first");
}

#[test]
fn copy_force_overwrites_regular_file() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    // Place an unmanaged regular file at the target path
    std::fs::write(target_dir.path().join("conflict.conf"), "I was here first").unwrap();

    let source_path = source_dir.path().join("conflict.conf");
    std::fs::write(&source_path, "new content").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from("conflict.conf"),
        kind: EntryKind::Base,
    };

    let result = deploy_copy(&action, target_dir.path(), false, true, None).unwrap();
    assert!(matches!(result, DeployResult::Updated));

    // Target should now contain new content
    let target = target_dir.path().join("conflict.conf");
    assert_eq!(std::fs::read_to_string(&target).unwrap(), "new content");
}

#[test]
fn copy_dry_run_creates_nothing() {
    let target_dir = TempDir::new().unwrap();
    let source_dir = TempDir::new().unwrap();

    let source_path = source_dir.path().join("app.conf");
    std::fs::write(&source_path, "some content").unwrap();

    let action = FileAction {
        source: source_path,
        target_rel_path: PathBuf::from(".config/app.conf"),
        kind: EntryKind::Base,
    };

    let result = deploy_copy(&action, target_dir.path(), true, false, None).unwrap();
    assert!(matches!(result, DeployResult::DryRun));

    assert!(!target_dir.path().join(".config/app.conf").exists(), "dry run should not create target file");
}

// --- apply_permission_override tests ---

#[test]
fn apply_permission_override_sets_mode() {
    let dir = TempDir::new().unwrap();
    let file_path = dir.path().join("test_file");
    std::fs::write(&file_path, "content").unwrap();

    // Start with default permissions, then override to 755
    apply_permission_override(&file_path, "755").unwrap();
    let mode = std::fs::metadata(&file_path).unwrap().permissions().mode() & 0o777;
    assert_eq!(mode, 0o755);

    // Override to 600
    apply_permission_override(&file_path, "600").unwrap();
    let mode = std::fs::metadata(&file_path).unwrap().permissions().mode() & 0o777;
    assert_eq!(mode, 0o600);

    // Invalid octal string should error
    let err = apply_permission_override(&file_path, "xyz");
    assert!(err.is_err());
}