frostx 0.1.0

frostx monitors project directories for inactivity. Once a configured inactivity threshold elapses (e.g. "90 days since any file was modified"), frostx executes a pipeline of **actions** - e.g., checking git state, creating archives, uploading backups, deleting local copies. Automating the lifecycle of projects, frostx helps users manage disk space and maintain a clean workspace.
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

//! End-to-end tests for `archive.compress` action behavior.

use std::fs;
use tempfile::tempdir;

fn frostx_bin() -> std::path::PathBuf {
    let mut p = std::env::current_exe().unwrap();
    p.pop();
    p.pop();
    p.push("frostx");
    p
}

fn run_cmd(args: &[&str], dir: &std::path::Path) -> std::process::Output {
    std::process::Command::new(frostx_bin())
        .args(args)
        .current_dir(dir)
        .output()
        .expect("failed to run frostx")
}

/// Write a `frostx.toml` that triggers immediately and runs `archive.compress`.
fn write_archive_config(dir: &std::path::Path) {
    let config = r#"id = "a1b2c3d4-0000-0000-0000-000000000020"

[[rule]]
after = "1h"
actions = ["archive.compress"]
"#;
    fs::write(dir.join("frostx.toml"), config).unwrap();
}

/// Find the single `.tar.gz` file produced by `archive.compress` in `parent`.
fn find_archive(parent: &std::path::Path) -> std::path::PathBuf {
    fs::read_dir(parent)
        .unwrap()
        .filter_map(std::result::Result::ok)
        .find(|e| e.file_name().to_string_lossy().ends_with(".tar.gz"))
        .expect("archive must exist in parent directory")
        .path()
}

fn touch_old(path: &std::path::Path) {
    std::process::Command::new("touch")
        .args(["-d", "48 hours ago", path.to_str().unwrap()])
        .output()
        .unwrap();
}

fn make_old_file(dir: &std::path::Path) {
    let path = dir.join("old_file.txt");
    fs::write(&path, "old content").unwrap();
    std::process::Command::new("touch")
        .args(["-d", "48 hours ago", path.to_str().unwrap()])
        .output()
        .unwrap();
}

#[test]
fn archive_replaces_project_dir() {
    // Layout: parent/project/ - archive lands in parent/, project/ is removed.
    let parent = tempdir().unwrap();
    let project = parent.path().join("myproject");
    fs::create_dir(&project).unwrap();
    make_old_file(&project);
    write_archive_config(&project);

    let state_dir = tempdir().unwrap();
    let out = run_cmd(
        &[
            "--yes",
            "--state-dir",
            state_dir.path().to_str().unwrap(),
            "run",
            project.to_str().unwrap(),
        ],
        parent.path(),
    );
    assert!(
        out.status.success(),
        "frostx run failed: {}",
        String::from_utf8_lossy(&out.stderr)
    );

    // Original project directory must be gone.
    assert!(
        !project.exists(),
        "project directory must be replaced by archive"
    );

    // Exactly one archive file must exist in the parent directory.
    let archives: Vec<_> = fs::read_dir(parent.path())
        .unwrap()
        .filter_map(std::result::Result::ok)
        .filter(|e| e.file_name().to_string_lossy().ends_with(".tar.gz"))
        .collect();
    assert_eq!(archives.len(), 1, "expected exactly one archive in parent");
    assert!(
        archives[0].metadata().unwrap().len() > 0,
        "archive must not be empty"
    );
}

#[test]
fn archive_dry_run_keeps_project_dir() {
    let parent = tempdir().unwrap();
    let project = parent.path().join("myproject");
    fs::create_dir(&project).unwrap();
    make_old_file(&project);
    write_archive_config(&project);

    let state_dir = tempdir().unwrap();
    let out = run_cmd(
        &[
            "--dry-run",
            "--yes",
            "--state-dir",
            state_dir.path().to_str().unwrap(),
            "run",
            project.to_str().unwrap(),
        ],
        parent.path(),
    );
    assert!(
        out.status.success(),
        "frostx run --dry-run failed: {}",
        String::from_utf8_lossy(&out.stderr)
    );

    assert!(project.exists(), "project dir must survive a dry run");
    let archives: Vec<_> = fs::read_dir(parent.path())
        .unwrap()
        .filter_map(std::result::Result::ok)
        .filter(|e| e.file_name().to_string_lossy().ends_with(".tar.gz"))
        .collect();
    assert!(
        archives.is_empty(),
        "no archive should be created in dry-run"
    );
}

#[test]
fn archive_state_updated_to_archive_path() {
    let parent = tempdir().unwrap();
    let project = parent.path().join("myproject");
    fs::create_dir(&project).unwrap();
    make_old_file(&project);
    write_archive_config(&project);

    let state_dir = tempdir().unwrap();
    let out = run_cmd(
        &[
            "--yes",
            "--state-dir",
            state_dir.path().to_str().unwrap(),
            "run",
            project.to_str().unwrap(),
        ],
        parent.path(),
    );
    assert!(
        out.status.success(),
        "frostx run failed: {}",
        String::from_utf8_lossy(&out.stderr)
    );

    // Read the state file and verify project_path now points to the archive.
    let state_files: Vec<_> = fs::read_dir(state_dir.path())
        .unwrap()
        .filter_map(std::result::Result::ok)
        .filter(|e| e.file_name().to_string_lossy().ends_with(".toml"))
        .collect();
    assert_eq!(state_files.len(), 1, "expected one state file");
    let state_content = fs::read_to_string(state_files[0].path()).unwrap();
    assert!(
        state_content.contains(".tar.gz"),
        "state project_path must point to archive, got: {state_content}"
    );
    assert!(
        !state_content.contains("myproject\""),
        "state must not retain the original directory path"
    );
}

#[test]
fn check_on_archived_project_succeeds() {
    let parent = tempdir().unwrap();
    let project = parent.path().join("myproject");
    fs::create_dir(&project).unwrap();
    make_old_file(&project);
    write_archive_config(&project);

    let state_dir = tempdir().unwrap();

    // Run once to archive the project.
    let out = run_cmd(
        &[
            "--yes",
            "--state-dir",
            state_dir.path().to_str().unwrap(),
            "run",
            project.to_str().unwrap(),
        ],
        parent.path(),
    );
    assert!(
        out.status.success(),
        "initial run failed: {}",
        String::from_utf8_lossy(&out.stderr)
    );
    assert!(!project.exists(), "project dir must be replaced by archive");

    let archive = find_archive(parent.path());

    // `frostx check` must succeed when given the archive path.
    let out = run_cmd(
        &[
            "--state-dir",
            state_dir.path().to_str().unwrap(),
            "check",
            archive.to_str().unwrap(),
        ],
        parent.path(),
    );
    assert!(
        out.status.success(),
        "check on archive failed: {}",
        String::from_utf8_lossy(&out.stderr)
    );
}

#[test]
fn run_on_archived_project_executes_further_rules() {
    let parent = tempdir().unwrap();
    let project = parent.path().join("myproject");
    fs::create_dir(&project).unwrap();
    make_old_file(&project);

    let marker_path = parent.path().join("rule2_executed");
    let config = format!(
        r#"id = "a1b2c3d4-0000-0000-0000-000000000022"

[config.hook.mark]
command = "touch {marker}"
kind = "check"
run_on_archive = true

[[rule]]
after = "1h"
actions = ["archive.compress"]

[[rule]]
after = "1h"
actions = ["hook.mark"]
"#,
        marker = marker_path.display()
    );
    fs::write(project.join("frostx.toml"), &config).unwrap();

    let state_dir = tempdir().unwrap();

    // Run 1: archive the project (rule 1 fires).
    let out = run_cmd(
        &[
            "--yes",
            "--state-dir",
            state_dir.path().to_str().unwrap(),
            "run",
            project.to_str().unwrap(),
        ],
        parent.path(),
    );
    assert!(
        out.status.success(),
        "run 1 failed: {}",
        String::from_utf8_lossy(&out.stderr)
    );
    assert!(!project.exists(), "project dir must be replaced by archive");

    let archive = find_archive(parent.path());

    // Make the archive appear old so that rule 2's threshold is met.
    touch_old(&archive);

    // Run 2: operate on the archive path; rule 2 must fire.
    let out = run_cmd(
        &[
            "--yes",
            "--state-dir",
            state_dir.path().to_str().unwrap(),
            "run",
            archive.to_str().unwrap(),
        ],
        parent.path(),
    );
    assert!(
        out.status.success(),
        "run 2 on archive failed: {}",
        String::from_utf8_lossy(&out.stderr)
    );

    assert!(
        marker_path.exists(),
        "rule 2 hook must have created the marker file"
    );
}