portable-network-archive 0.35.0

Portable-Network-Archive cli
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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
use crate::utils::{archive, setup};
use clap::Parser;
use portable_network_archive::cli;
use std::fs;

/// Precondition: Multiple files of varying sizes exist.
/// Action: Run `pna create` with files in a specific order.
/// Expectation: Archive entries appear in the same order as CLI arguments.
#[test]
fn create_preserves_cli_argument_order() {
    setup();
    let dir = "create_preserves_cli_argument_order";
    fs::create_dir_all(dir).unwrap();

    // Create files with different sizes to affect parallel processing time
    // Large file processes slower, small file processes faster
    let large_file = format!("{dir}/large.bin");
    let small_file = format!("{dir}/small.txt");
    let medium_file = format!("{dir}/medium.dat");

    // Create files: large (1MB), small (10 bytes), medium (100KB)
    fs::write(&large_file, vec![0u8; 1024 * 1024]).unwrap();
    fs::write(&small_file, b"small file").unwrap();
    fs::write(&medium_file, vec![1u8; 100 * 1024]).unwrap();

    let archive_path = format!("{dir}/ordered.pna");

    // Create archive with specific order: small, large, medium
    cli::Cli::try_parse_from([
        "pna",
        "--quiet",
        "c",
        "-f",
        &archive_path,
        "--overwrite",
        &small_file,
        &large_file,
        &medium_file,
        "--unstable",
    ])
    .unwrap()
    .execute()
    .unwrap();

    let mut entry_names = Vec::new();
    archive::for_each_entry(&archive_path, |entry| {
        entry_names.push(entry.header().path().to_string());
    })
    .unwrap();

    assert_eq!(entry_names.len(), 3);
    assert!(
        entry_names[0].ends_with("small.txt"),
        "First entry should be small.txt, got: {}",
        entry_names[0]
    );
    assert!(
        entry_names[1].ends_with("large.bin"),
        "Second entry should be large.bin, got: {}",
        entry_names[1]
    );
    assert!(
        entry_names[2].ends_with("medium.dat"),
        "Third entry should be medium.dat, got: {}",
        entry_names[2]
    );
}

/// Precondition: A directory with multiple files exists.
/// Action: Run `pna create` on the directory.
/// Expectation: Entries appear in consistent walkdir traversal order.
#[test]
fn create_preserves_walkdir_order() {
    setup();
    let dir = "create_preserves_walkdir_order";
    fs::create_dir_all(format!("{dir}/input/aaa")).unwrap();
    fs::create_dir_all(format!("{dir}/input/bbb")).unwrap();

    // Create files with different sizes in nested directories
    fs::write(format!("{dir}/input/01_first.txt"), b"first").unwrap();
    fs::write(
        format!("{dir}/input/aaa/02_in_aaa.txt"),
        vec![0u8; 500 * 1024],
    )
    .unwrap();
    fs::write(format!("{dir}/input/bbb/03_in_bbb.txt"), b"in bbb").unwrap();
    fs::write(format!("{dir}/input/04_last.txt"), vec![1u8; 200 * 1024]).unwrap();

    let archive_path = format!("{dir}/walkdir_order.pna");

    cli::Cli::try_parse_from([
        "pna",
        "--quiet",
        "c",
        "-f",
        &archive_path,
        "--overwrite",
        &format!("{dir}/input"),
        "--unstable",
    ])
    .unwrap()
    .execute()
    .unwrap();

    // Verify entries follow walkdir depth-first order
    let mut entry_names = Vec::new();
    archive::for_each_entry(&archive_path, |entry| {
        entry_names.push(entry.header().path().to_string());
    })
    .unwrap();

    // walkdir traverses depth-first, so directory entries come before their contents
    // Exact order depends on walkdir implementation, but should be consistent
    assert!(
        entry_names.len() >= 4,
        "Should have at least 4 file entries"
    );

    // Verify that the order is consistent (not randomized by parallel processing)
    // Run the same command again and verify same order
    let archive_path2 = format!("{dir}/walkdir_order2.pna");
    cli::Cli::try_parse_from([
        "pna",
        "--quiet",
        "c",
        "-f",
        &archive_path2,
        "--overwrite",
        &format!("{dir}/input"),
        "--unstable",
    ])
    .unwrap()
    .execute()
    .unwrap();

    let mut entry_names2 = Vec::new();
    archive::for_each_entry(&archive_path2, |entry| {
        entry_names2.push(entry.header().path().to_string());
    })
    .unwrap();

    assert_eq!(
        entry_names, entry_names2,
        "Entry order should be deterministic across runs"
    );
}

/// Precondition: Multiple directories with files exist.
/// Action: Run `pna create` with multiple directory arguments.
/// Expectation: Entries from first argument appear before second argument.
#[test]
fn create_preserves_multiple_directory_order() {
    setup();
    let dir = "create_preserves_multiple_directory_order";
    fs::create_dir_all(format!("{dir}/dir_a")).unwrap();
    fs::create_dir_all(format!("{dir}/dir_b")).unwrap();

    // dir_a has a large file (slow), dir_b has small files (fast)
    fs::write(format!("{dir}/dir_a/large.bin"), vec![0u8; 1024 * 1024]).unwrap();
    fs::write(format!("{dir}/dir_b/small1.txt"), b"small1").unwrap();
    fs::write(format!("{dir}/dir_b/small2.txt"), b"small2").unwrap();

    let archive_path = format!("{dir}/multi_dir.pna");

    // Create archive: dir_a first, then dir_b
    cli::Cli::try_parse_from([
        "pna",
        "--quiet",
        "c",
        "-f",
        &archive_path,
        "--overwrite",
        &format!("{dir}/dir_a"),
        &format!("{dir}/dir_b"),
        "--unstable",
    ])
    .unwrap()
    .execute()
    .unwrap();

    let mut entry_names = Vec::new();
    archive::for_each_entry(&archive_path, |entry| {
        entry_names.push(entry.header().path().to_string());
    })
    .unwrap();

    // Find indices of dir_a and dir_b entries
    let dir_a_indices: Vec<usize> = entry_names
        .iter()
        .enumerate()
        .filter(|(_, name)| name.contains("dir_a"))
        .map(|(i, _)| i)
        .collect();
    let dir_b_indices: Vec<usize> = entry_names
        .iter()
        .enumerate()
        .filter(|(_, name)| name.contains("dir_b"))
        .map(|(i, _)| i)
        .collect();

    assert!(!dir_a_indices.is_empty(), "Should have dir_a entries");
    assert!(!dir_b_indices.is_empty(), "Should have dir_b entries");

    // All dir_a entries should come before all dir_b entries
    let max_dir_a = *dir_a_indices.iter().max().unwrap();
    let min_dir_b = *dir_b_indices.iter().min().unwrap();
    assert!(
        max_dir_a < min_dir_b,
        "All dir_a entries (max index {}) should come before dir_b entries (min index {})",
        max_dir_a,
        min_dir_b
    );
}

/// Precondition: Multiple files of varying sizes exist.
/// Action: Run `pna create --solid` with files in a specific order.
/// Expectation: Archive entries appear in the same order as CLI arguments.
#[test]
fn create_solid_preserves_cli_argument_order() {
    setup();
    let dir = "create_solid_preserves_cli_argument_order";
    fs::create_dir_all(dir).unwrap();

    let large_file = format!("{dir}/large.bin");
    let small_file = format!("{dir}/small.txt");
    let medium_file = format!("{dir}/medium.dat");

    fs::write(&large_file, vec![0u8; 1024 * 1024]).unwrap();
    fs::write(&small_file, b"small file").unwrap();
    fs::write(&medium_file, vec![1u8; 100 * 1024]).unwrap();

    let archive_path = format!("{dir}/ordered.pna");

    cli::Cli::try_parse_from([
        "pna",
        "--quiet",
        "c",
        "-f",
        &archive_path,
        "--overwrite",
        "--solid",
        &small_file,
        &large_file,
        &medium_file,
        "--unstable",
    ])
    .unwrap()
    .execute()
    .unwrap();

    let mut entry_names = Vec::new();
    archive::for_each_entry(&archive_path, |entry| {
        entry_names.push(entry.header().path().to_string());
    })
    .unwrap();

    assert_eq!(entry_names.len(), 3);
    assert!(
        entry_names[0].ends_with("small.txt"),
        "First entry should be small.txt, got: {}",
        entry_names[0]
    );
    assert!(
        entry_names[1].ends_with("large.bin"),
        "Second entry should be large.bin, got: {}",
        entry_names[1]
    );
    assert!(
        entry_names[2].ends_with("medium.dat"),
        "Third entry should be medium.dat, got: {}",
        entry_names[2]
    );
}

/// Precondition: Multiple directories with files exist.
/// Action: Run `pna create --solid` with multiple directory arguments.
/// Expectation: Entries from first argument appear before second argument.
#[test]
fn create_solid_preserves_multiple_directory_order() {
    setup();
    let dir = "create_solid_preserves_multiple_directory_order";
    fs::create_dir_all(format!("{dir}/dir_a")).unwrap();
    fs::create_dir_all(format!("{dir}/dir_b")).unwrap();

    fs::write(format!("{dir}/dir_a/large.bin"), vec![0u8; 1024 * 1024]).unwrap();
    fs::write(format!("{dir}/dir_b/small1.txt"), b"small1").unwrap();
    fs::write(format!("{dir}/dir_b/small2.txt"), b"small2").unwrap();

    let archive_path = format!("{dir}/multi_dir_solid.pna");

    cli::Cli::try_parse_from([
        "pna",
        "--quiet",
        "c",
        "-f",
        &archive_path,
        "--overwrite",
        "--solid",
        &format!("{dir}/dir_a"),
        &format!("{dir}/dir_b"),
        "--unstable",
    ])
    .unwrap()
    .execute()
    .unwrap();

    let mut entry_names = Vec::new();
    archive::for_each_entry(&archive_path, |entry| {
        entry_names.push(entry.header().path().to_string());
    })
    .unwrap();

    let dir_a_indices: Vec<usize> = entry_names
        .iter()
        .enumerate()
        .filter(|(_, name)| name.contains("dir_a"))
        .map(|(i, _)| i)
        .collect();
    let dir_b_indices: Vec<usize> = entry_names
        .iter()
        .enumerate()
        .filter(|(_, name)| name.contains("dir_b"))
        .map(|(i, _)| i)
        .collect();

    assert!(!dir_a_indices.is_empty(), "Should have dir_a entries");
    assert!(!dir_b_indices.is_empty(), "Should have dir_b entries");

    let max_dir_a = *dir_a_indices.iter().max().unwrap();
    let min_dir_b = *dir_b_indices.iter().min().unwrap();
    assert!(
        max_dir_a < min_dir_b,
        "All dir_a entries (max index {}) should come before dir_b entries (min index {})",
        max_dir_a,
        min_dir_b
    );
}

/// Precondition: Multiple large files exist.
/// Action: Run `pna create --split` with files in a specific order.
/// Expectation: Concatenated archive has entries in argument order.
#[test]
fn create_split_preserves_entry_order() {
    setup();
    let dir = "create_split_preserves_entry_order";
    fs::create_dir_all(dir).unwrap();

    let large_file = format!("{dir}/large.bin");
    let small_file = format!("{dir}/small.txt");
    let medium_file = format!("{dir}/medium.dat");

    fs::write(&large_file, vec![0u8; 512 * 1024]).unwrap();
    fs::write(&small_file, b"small file").unwrap();
    fs::write(&medium_file, vec![1u8; 256 * 1024]).unwrap();

    let archive_path = format!("{dir}/split.pna");

    cli::Cli::try_parse_from([
        "pna",
        "--quiet",
        "c",
        "-f",
        &archive_path,
        "--overwrite",
        "--split",
        "400KB",
        &small_file,
        &large_file,
        &medium_file,
        "--unstable",
    ])
    .unwrap()
    .execute()
    .unwrap();

    // Concatenate split archives
    let concat_path = format!("{dir}/concat.pna");
    cli::Cli::try_parse_from([
        "pna",
        "--quiet",
        "concat",
        "-f",
        &concat_path,
        "-f",
        &archive_path,
        "--overwrite",
    ])
    .unwrap()
    .execute()
    .unwrap();

    let mut entry_names = Vec::new();
    archive::for_each_entry(&concat_path, |entry| {
        entry_names.push(entry.header().path().to_string());
    })
    .unwrap();

    assert_eq!(entry_names.len(), 3);
    assert!(
        entry_names[0].ends_with("small.txt"),
        "First entry should be small.txt, got: {}",
        entry_names[0]
    );
    assert!(
        entry_names[1].ends_with("large.bin"),
        "Second entry should be large.bin, got: {}",
        entry_names[1]
    );
    assert!(
        entry_names[2].ends_with("medium.dat"),
        "Third entry should be medium.dat, got: {}",
        entry_names[2]
    );
}