timelord 3.0.2

A Rust library to preserve file timestamps (mtime) between builds, even with fresh git checkouts
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

use camino::Utf8PathBuf;
use log::{debug, info, warn};
use owo_colors::OwoColorize;

#[test]
fn self_test() {
    use std::fs::{self, File};
    use std::io::Write;
    use std::time::SystemTime;

    env_logger::builder()
        .filter_level(log::LevelFilter::Debug)
        .init();

    debug!(
        "{}",
        "===============================================".blue()
    );
    info!("Starting {}", "Timelord Self-Test".green());
    debug!(
        "{}",
        "===============================================".blue()
    );

    // Create temporary directories for source and cache
    let temp_dir = tempfile::tempdir().unwrap();
    let source_dir = temp_dir.path().join("source");
    let cache_dir = temp_dir.path().join("cache");
    fs::create_dir_all(&source_dir).unwrap();
    fs::create_dir_all(source_dir.join("src")).unwrap();
    fs::create_dir_all(source_dir.join("tests")).unwrap();
    info!("Created temporary directories: {}", "".yellow());
    debug!("  Source: {}", source_dir.display().blue());
    debug!("  Cache: {}", cache_dir.display().blue());

    // Create some test files
    let file1_path = source_dir.join("src/main.rs");
    let file2_path = source_dir.join("tests/integration-test.rs");
    let file3_path = source_dir.join("README.md");
    let mut file1 = File::create(&file1_path).unwrap();
    let mut file2 = File::create(&file2_path).unwrap();
    let mut file3 = File::create(&file3_path).unwrap();
    file1.write_all(b"Hello, World!").unwrap();
    file2.write_all(b"Timelord test").unwrap();
    file3.write_all(b"README content").unwrap();
    info!("Created test files: {}", "".yellow());
    debug!("  {}: 'Hello, World!'", file1_path.display().blue());
    debug!("  {}: 'Timelord test'", file2_path.display().blue());
    debug!("  {}: 'README content'", file3_path.display().blue());

    debug!(
        "{}",
        "===============================================".blue()
    );
    info!("Scenario 1: First Run - {}", "Creating Cache".green());
    debug!(
        "{}",
        "===============================================".blue()
    );
    // Run Timelord for the first time
    super::sync(
        Utf8PathBuf::from_path_buf(source_dir.clone()).unwrap(),
        Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap(),
    );

    // Check if the database was created
    let cache_file = cache_dir.join("timelord.db");
    assert!(cache_file.exists(), "Database file was not created");
    info!(
        "Cache file created successfully: {}",
        cache_file.display().green()
    );

    // Run cache-info command
    debug!("Running cache-info command: {}", "".cyan());
    super::cache_info(Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap());

    debug!(
        "{}",
        "===============================================".blue()
    );
    info!("Scenario 2: {}", "Modifying Timestamps".green());
    debug!(
        "{}",
        "===============================================".blue()
    );
    // Change all timestamps
    let new_time = SystemTime::now() - std::time::Duration::from_secs(3600);
    File::open(&file1_path)
        .unwrap()
        .set_modified(new_time)
        .unwrap();
    File::open(&file2_path)
        .unwrap()
        .set_modified(new_time)
        .unwrap();
    info!(
        "Modified timestamps of src/main.rs and tests/integration-test.rs to {}",
        "1 hour ago".yellow()
    );

    // Run Timelord again
    debug!("Running Timelord to restore timestamps: {}", "".cyan());
    super::sync(
        Utf8PathBuf::from_path_buf(source_dir.clone()).unwrap(),
        Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap(),
    );

    // Check if timestamps were restored
    let file1_time = fs::metadata(&file1_path).unwrap().modified().unwrap();
    let file2_time = fs::metadata(&file2_path).unwrap().modified().unwrap();
    assert!(
        file1_time != new_time,
        "src/main.rs timestamp was not restored"
    );
    assert!(
        file2_time != new_time,
        "tests/integration-test.rs timestamp was not restored"
    );
    info!(
        "Timestamps successfully restored for {}",
        "both files".green()
    );

    // Run cache-info command
    debug!("Running cache-info command: {}", "".cyan());
    super::cache_info(Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap());

    debug!(
        "{}",
        "===============================================".blue()
    );
    info!("Scenario 3: {}", "Modifying Content and Timestamps".green());
    debug!(
        "{}",
        "===============================================".blue()
    );
    // Change timestamps again and modify one file
    let another_new_time = SystemTime::now() - std::time::Duration::from_secs(7200);
    File::open(&file1_path)
        .unwrap()
        .set_modified(another_new_time)
        .unwrap();
    let mut file2 = File::create(&file2_path).unwrap();
    file2.write_all(b"Modified content").unwrap();
    file2.set_modified(another_new_time).unwrap();
    info!(
        "Modified timestamps of src/main.rs and tests/integration-test.rs to {}",
        "2 hours ago".yellow()
    );
    info!(
        "Changed content of tests/integration-test.rs to {}",
        "'Modified content'".yellow()
    );

    // Run Timelord one more time
    debug!(
        "Running Timelord to selectively restore timestamps: {}",
        "".cyan()
    );
    super::sync(
        Utf8PathBuf::from_path_buf(source_dir.clone()).unwrap(),
        Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap(),
    );

    // Check if timestamps were restored correctly
    let file1_final_time = fs::metadata(&file1_path).unwrap().modified().unwrap();
    let file2_final_time = fs::metadata(&file2_path).unwrap().modified().unwrap();
    assert!(
        file1_final_time != another_new_time,
        "src/main.rs timestamp was not restored after content remained unchanged"
    );
    assert!(
        file2_final_time == another_new_time,
        "tests/integration-test.rs timestamp was correctly not restored after content change"
    );
    info!(
        "src/main.rs timestamp restored ({})",
        "content unchanged".green()
    );
    info!(
        "tests/integration-test.rs timestamp not restored ({})",
        "content changed".green()
    );

    // Run cache-info command
    debug!("Running cache-info command: {}", "".cyan());
    super::cache_info(Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap());

    debug!(
        "{}",
        "===============================================".blue()
    );
    info!("Scenario 4: {}", "Different Source Directory Base".green());
    debug!(
        "{}",
        "===============================================".blue()
    );
    // Create a new source directory with the same structure
    let new_source_dir = temp_dir.path().join("new_source");
    fs::create_dir_all(new_source_dir.join("src")).unwrap();
    fs::create_dir_all(new_source_dir.join("tests")).unwrap();
    let new_file1_path = new_source_dir.join("src/main.rs");
    let new_file2_path = new_source_dir.join("tests/integration-test.rs");
    let new_file3_path = new_source_dir.join("README.md");
    fs::copy(&file1_path, &new_file1_path).unwrap();
    fs::copy(&file2_path, &new_file2_path).unwrap();
    fs::copy(&file3_path, &new_file3_path).unwrap();

    // Modify timestamps of the new files
    let new_time = SystemTime::now() - std::time::Duration::from_secs(3600);
    File::open(&new_file1_path)
        .unwrap()
        .set_modified(new_time)
        .unwrap();
    File::open(&new_file2_path)
        .unwrap()
        .set_modified(new_time)
        .unwrap();

    info!(
        "Created new source directory with {}",
        "same files".yellow()
    );
    debug!("  New Source: {}", new_source_dir.display().blue());

    // Run Timelord with the new source directory
    debug!("Running Timelord with new source directory: {}", "".cyan());
    super::sync(
        Utf8PathBuf::from_path_buf(new_source_dir.clone()).unwrap(),
        Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap(),
    );

    // Check if timestamps were restored in the new location
    let new_file1_time = fs::metadata(&new_file1_path).unwrap().modified().unwrap();
    let new_file2_time = fs::metadata(&new_file2_path).unwrap().modified().unwrap();
    assert!(
        new_file1_time != new_time,
        "New src/main.rs timestamp was not restored"
    );
    assert!(
        new_file2_time != new_time,
        "New tests/integration-test.rs timestamp was not restored"
    );
    info!(
        "Timestamps successfully restored in {}",
        "new location".green()
    );

    // Run cache-info command
    debug!("Running cache-info command: {}", "".cyan());
    super::cache_info(Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap());

    debug!(
        "{}",
        "===============================================".blue()
    );
    info!("Scenario 5: {}", "Corrupted Cache File".green());
    debug!(
        "{}",
        "===============================================".blue()
    );

    // Corrupt the cache file
    let mut cache_file = File::options()
        .write(true)
        .open(&cache_file)
        .expect("Failed to open cache file");
    cache_file
        .write_all(&[0xBA, 0xDB, 0xAD, 0xFF])
        .expect("Failed to write corrupt data");
    cache_file.flush().expect("Failed to flush cache file");

    warn!("Corrupted cache file with {}", "0xBADBADFF".yellow());

    // Run Timelord with corrupted cache
    debug!("Running Timelord with corrupted cache: {}", "".cyan());
    super::sync(
        Utf8PathBuf::from_path_buf(source_dir.clone()).unwrap(),
        Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap(),
    );

    // Check if a new cache file was created
    assert!(
        cache_file.metadata().unwrap().len() > 0,
        "New cache file was not created or is empty after corruption"
    );
    info!(
        "Timelord handled corrupted cache and {}",
        "created a new one".green()
    );

    // Run cache-info command
    debug!("Running cache-info command: {}", "".cyan());
    super::cache_info(Utf8PathBuf::from_path_buf(cache_dir.clone()).unwrap());

    debug!(
        "{}",
        "===============================================".blue()
    );
    info!("All scenarios completed {}", "successfully!".green());
    debug!(
        "{}",
        "===============================================".blue()
    );
}