pf8 0.1.6

A Rust library for encoding and decoding artemis PF8 archive files
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

//! Tests for the PF8 library

use pf8::{
    archive::{create_from_dir, extract},
    *,
};
use std::fs;
use std::path::Path;
use tempfile::TempDir;

#[test]
fn test_create_and_read_simple_archive() {
    let temp_dir = TempDir::new().unwrap();
    let input_dir = temp_dir.path().join("input");
    let archive_path = temp_dir.path().join("test.pfs");
    let output_dir = temp_dir.path().join("output");

    // Create input directory with some test files
    fs::create_dir_all(&input_dir).unwrap();
    fs::write(input_dir.join("file1.txt"), b"Hello, World!").unwrap();
    fs::write(input_dir.join("file2.bin"), b"\x00\x01\x02\x03").unwrap();

    let subdir = input_dir.join("subdir");
    fs::create_dir_all(&subdir).unwrap();
    fs::write(subdir.join("file3.txt"), b"Nested file content").unwrap();

    // Create archive using builder
    let mut builder = Pf8Builder::new();
    builder.add_dir(&input_dir).unwrap();
    builder.write_to_file(&archive_path).unwrap();

    // Verify archive was created
    assert!(archive_path.exists());

    // Read archive and verify contents
    let mut archive = Pf8Archive::open(&archive_path).unwrap();

    assert_eq!(archive.len(), 3);
    assert!(archive.contains("file1.txt"));
    assert!(archive.contains("file2.bin"));
    assert!(archive.contains("subdir/file3.txt"));

    // Test file content reading
    let content1 = archive.read_file("file1.txt").unwrap();
    assert_eq!(content1, b"Hello, World!");

    let content2 = archive.read_file("file2.bin").unwrap();
    assert_eq!(content2, b"\x00\x01\x02\x03");

    let content3 = archive.read_file("subdir/file3.txt").unwrap();
    assert_eq!(content3, b"Nested file content");

    // Test extraction
    archive.extract_all(&output_dir).unwrap();

    assert_eq!(
        fs::read(output_dir.join("file1.txt")).unwrap(),
        b"Hello, World!"
    );
    assert_eq!(
        fs::read(output_dir.join("file2.bin")).unwrap(),
        b"\x00\x01\x02\x03"
    );
    assert_eq!(
        fs::read(output_dir.join("subdir/file3.txt")).unwrap(),
        b"Nested file content"
    );
}

#[test]
fn test_convenience_functions() {
    let temp_dir = TempDir::new().unwrap();
    let input_dir = temp_dir.path().join("input");
    let archive_path = temp_dir.path().join("test.pfs");
    let output_dir = temp_dir.path().join("output");

    // Create input directory
    fs::create_dir_all(&input_dir).unwrap();
    fs::write(input_dir.join("test.txt"), b"Test content").unwrap();

    // Test convenience creation
    create_from_dir(&input_dir, &archive_path).unwrap();
    assert!(archive_path.exists());

    // Test convenience extraction
    extract(&archive_path, &output_dir).unwrap();
    assert_eq!(
        fs::read(output_dir.join("test.txt")).unwrap(),
        b"Test content"
    );
}

#[test]
fn test_builder_add_file_as() {
    let temp_dir = TempDir::new().unwrap();
    let input_file = temp_dir.path().join("input.txt");
    let archive_path = temp_dir.path().join("test.pfs");

    fs::write(&input_file, b"File content").unwrap();

    let mut builder = Pf8Builder::new();
    builder
        .add_file_as(&input_file, "custom/path/file.txt")
        .unwrap();
    builder.write_to_file(&archive_path).unwrap();

    let mut archive = Pf8Archive::open(&archive_path).unwrap();
    assert!(archive.contains("custom/path/file.txt"));

    let content = archive.read_file("custom/path/file.txt").unwrap();
    assert_eq!(content, b"File content");
}

#[test]
fn test_empty_archive() {
    let temp_dir = TempDir::new().unwrap();
    let archive_path = temp_dir.path().join("empty.pfs");

    // Try to create empty archive (should fail)
    let builder = Pf8Builder::new();
    let result = builder.write_to_file(&archive_path);
    assert!(result.is_err());
}

#[test]
fn test_file_not_found_error() {
    let temp_dir = TempDir::new().unwrap();
    let nonexistent = temp_dir.path().join("nonexistent.txt");

    let mut builder = Pf8Builder::new();
    let result = builder.add_file(&nonexistent);
    assert!(result.is_err());
}

#[test]
fn test_reader_low_level_api() {
    let temp_dir = TempDir::new().unwrap();
    let input_dir = temp_dir.path().join("input");
    let archive_path = temp_dir.path().join("test.pfs");

    fs::create_dir_all(&input_dir).unwrap();
    fs::write(input_dir.join("test.txt"), b"Test content").unwrap();

    // Create archive
    create_from_dir(&input_dir, &archive_path).unwrap();

    // Test low-level reader API
    let mut reader = Pf8Reader::open(&archive_path).unwrap();

    assert_eq!(reader.len(), 1);
    assert!(!reader.is_empty());

    let entry = reader.get_entry("test.txt").unwrap();
    assert_eq!(entry.size(), 12);
    assert_eq!(entry.file_name().unwrap(), "test.txt");

    let content = reader.read_file("test.txt").unwrap();
    assert_eq!(content, b"Test content");
}

/// Tests the complete integrity of pack-unpack operations
///
/// This comprehensive test verifies that all files remain identical after being
/// packed into a PF8 archive and then extracted back out. It covers:
///
/// - **Multiple file types**: Text files, binary files, empty files, large files
/// - **Complex directory structures**: Nested directories up to 3 levels deep
/// - **UTF-8 content**: Files containing Unicode characters (Chinese text)
/// - **Special file names**: Files with spaces, dashes, and underscores
/// - **File metadata**: Verifies both content and file size integrity
///
/// The test creates a directory structure with 11 files of various types,
/// packs them into a PF8 archive with selective encryption based on file extensions,
/// extracts everything to a new location, and then performs a recursive comparison
/// to ensure perfect data integrity.
///
/// This is the most comprehensive test for data preservation in the PF8 library.
#[test]
fn test_pack_unpack_integrity() {
    let temp_dir = TempDir::new().unwrap();
    let original_dir = temp_dir.path().join("original");
    let archive_path = temp_dir.path().join("test.pfs");
    let extracted_dir = temp_dir.path().join("extracted");

    // Create a complex directory structure with various file types
    fs::create_dir_all(&original_dir).unwrap();

    // Text files (unencrypted)
    let readme_content = "This is a readme file\nwith multiple lines\nand UTF-8 content: 你好世界";
    fs::write(original_dir.join("readme.txt"), readme_content.as_bytes()).unwrap();
    fs::write(
        original_dir.join("config.ini"),
        b"[section]\nkey=value\nother_key=other_value",
    )
    .unwrap();

    // Binary files (encrypted)
    fs::write(
        original_dir.join("data.bin"),
        [0u8, 1, 2, 3, 255, 254, 253, 128, 127],
    )
    .unwrap();
    fs::write(
        original_dir.join("image.jpg"),
        b"\xFF\xD8\xFF\xE0\x00\x10JFIF\x00\x01",
    )
    .unwrap();

    // Empty file
    fs::write(original_dir.join("empty.txt"), b"").unwrap();

    // Large file with repetitive content
    let large_content = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. ".repeat(1000);
    fs::write(original_dir.join("large.txt"), large_content.as_bytes()).unwrap();

    // Nested directories
    let nested_dir = original_dir.join("nested").join("deep").join("structure");
    fs::create_dir_all(&nested_dir).unwrap();
    fs::write(nested_dir.join("nested_file.txt"), b"Deep nested content").unwrap();
    fs::write(nested_dir.join("binary.dat"), [42u8; 256]).unwrap();

    // Files with special characters in names (if supported by filesystem)
    let special_dir = original_dir.join("special");
    fs::create_dir_all(&special_dir).unwrap();
    fs::write(
        special_dir.join("file with spaces.txt"),
        b"Content with spaces",
    )
    .unwrap();
    fs::write(
        special_dir.join("file-with-dashes.txt"),
        b"Content with dashes",
    )
    .unwrap();
    fs::write(
        special_dir.join("file_with_underscores.txt"),
        b"Content with underscores",
    )
    .unwrap();

    // Create archive
    let mut builder = Pf8Builder::new();
    builder.add_dir(&original_dir).unwrap();
    builder.write_to_file(&archive_path).unwrap();

    // Verify archive was created
    assert!(archive_path.exists());

    // Extract the archive
    let mut archive = Pf8Archive::open(&archive_path).unwrap();
    archive.extract_all(&extracted_dir).unwrap();

    // Function to recursively compare directories
    fn compare_directories(original: &Path, extracted: &Path) -> Result<()> {
        use std::collections::HashSet;

        let original_entries: HashSet<_> = fs::read_dir(original)?
            .map(|entry| entry.unwrap().file_name())
            .collect();

        let extracted_entries: HashSet<_> = fs::read_dir(extracted)?
            .map(|entry| entry.unwrap().file_name())
            .collect();

        // Check that both directories have the same entries
        assert_eq!(original_entries, extracted_entries);

        for entry in fs::read_dir(original)? {
            let entry = entry?;
            let original_path = entry.path();
            let extracted_path = extracted.join(entry.file_name());

            if original_path.is_file() {
                // Compare file contents
                let original_content = fs::read(&original_path)?;
                let extracted_content = fs::read(&extracted_path)?;
                assert_eq!(
                    original_content,
                    extracted_content,
                    "File content mismatch: {:?}",
                    entry.file_name()
                );

                // Compare file metadata
                let original_metadata = fs::metadata(&original_path)?;
                let extracted_metadata = fs::metadata(&extracted_path)?;
                assert_eq!(
                    original_metadata.len(),
                    extracted_metadata.len(),
                    "File size mismatch: {:?}",
                    entry.file_name()
                );
            } else if original_path.is_dir() {
                // Recursively compare subdirectories
                compare_directories(&original_path, &extracted_path)?;
            }
        }

        Ok(())
    }

    // Compare the original and extracted directories
    compare_directories(&original_dir, &extracted_dir).unwrap();

    // Verify archive statistics
    assert_eq!(archive.len(), 11); // Total number of files

    // Verify specific files can be read correctly
    let readme_content = archive.read_file("readme.txt").unwrap();
    let expected_readme = "This is a readme file\nwith multiple lines\nand UTF-8 content: 你好世界";
    assert_eq!(readme_content, expected_readme.as_bytes());

    let binary_content = archive.read_file("data.bin").unwrap();
    assert_eq!(binary_content, [0u8, 1, 2, 3, 255, 254, 253, 128, 127]);

    let empty_content = archive.read_file("empty.txt").unwrap();
    assert_eq!(empty_content, b"");

    let nested_content = archive
        .read_file("nested/deep/structure/nested_file.txt")
        .unwrap();
    assert_eq!(nested_content, b"Deep nested content");
}