rpgcpf 0.1.1

GCPF archive compression and decompression library
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

#![crate_name = "rpgcpf"]
#![warn(clippy::pedantic, missing_docs)]
#![cfg_attr(test, feature(coverage_attribute))]
#![cfg_attr(test, feature(assert_matches))]

//! rpgcpf is a rust library and command line tool for compressing and decompressing godot compressed packed format (GCPF) files.

//!
//! Based on work by `PandorasFox` <https://gist.github.com/PandorasFox/0b771e0bc64dfeb2e212437ff1a26b93>

pub mod compression_mode;
pub mod compressor;
pub mod decompressor;
pub mod error;
pub mod gcpf;

pub use crate::{error::*, gcpf::*};

#[cfg(test)]
mod test {
    use std::assert_matches::assert_matches;

    #[allow(unused_imports)]
    use pretty_assertions::{assert_eq, assert_ne};

    use rstest::rstest;

    pub use crate::{
        compression_mode::CompressionMode, compressor::Compressor, decompressor::Decompressor,
        error::Error, gcpf::Gcpf,
    };

    #[rstest]
    #[cfg_attr(not(feature = "brotli"), ignore)]
    fn test_brotli_compression() {
        let data = b"here's some test data";

        let expected = [
            0x47, 0x43, 0x50, 0x46, 0x4, 0x0, 0x0, 0x0, 0x0, 0x10, 0x0, 0x0, 0x15, 0x0, 0x0, 0x0,
            0x19, 0x0, 0x0, 0x0, 0xb, 0xa, 0x80, 0x68, 0x65, 0x72, 0x65, 0x27, 0x73, 0x20, 0x73,
            0x6f, 0x6d, 0x65, 0x20, 0x74, 0x65, 0x73, 0x74, 0x20, 0x64, 0x61, 0x74, 0x61, 0x3,
            0x47, 0x43, 0x50, 0x46,
        ];

        let actual = Gcpf::compress(data, CompressionMode::Brotli).unwrap();
        let dec = Gcpf::read(&actual).unwrap().decompress().unwrap();

        assert_eq!(dec, data);
        assert_eq!(actual, expected);
    }

    #[rstest]
    #[cfg_attr(not(feature = "brotli"), ignore)]
    fn test_brotli_decompression() {
        let data = [
            0x47, 0x43, 0x50, 0x46, 0x4, 0x0, 0x0, 0x0, 0x0, 0x10, 0x0, 0x0, 0x15, 0x0, 0x0, 0x0,
            0x19, 0x0, 0x0, 0x0, 0xb, 0xa, 0x80, 0x68, 0x65, 0x72, 0x65, 0x27, 0x73, 0x20, 0x73,
            0x6f, 0x6d, 0x65, 0x20, 0x74, 0x65, 0x73, 0x74, 0x20, 0x64, 0x61, 0x74, 0x61, 0x3,
            0x47, 0x43, 0x50, 0x46,
        ];

        let expected = b"here's some test data";

        let gcpf = Gcpf::read(&data).unwrap();

        let actual = gcpf.decompress().unwrap();

        assert_eq!(actual, expected);
    }

    #[rstest]
    #[cfg_attr(not(feature = "deflate"), ignore)]
    fn test_deflate_compression() {
        let data = b"here's some test data";

        let expected = [
            0x47, 0x43, 0x50, 0x46, 0x01, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x15, 0x00,
            0x00, 0x00, 0x17, 0x00, 0x00, 0x00, 0xcb, 0x48, 0x2d, 0x4a, 0x55, 0x2f, 0x56, 0x28,
            0xce, 0xcf, 0x4d, 0x55, 0x28, 0x49, 0x2d, 0x2e, 0x51, 0x48, 0x49, 0x2c, 0x49, 0x04,
            0x00, 0x47, 0x43, 0x50, 0x46,
        ];

        let actual = Gcpf::compress(data, CompressionMode::Deflate).unwrap();
        let dec = Gcpf::read(&actual).unwrap().decompress().unwrap();

        assert_eq!(dec, data);
        assert_eq!(actual, expected);
    }

    #[rstest]
    #[cfg_attr(not(feature = "deflate"), ignore)]
    fn test_deflate_decompression() {
        let data = [
            0x47, 0x43, 0x50, 0x46, 0x01, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x15, 0x00,
            0x00, 0x00, 0x17, 0x00, 0x00, 0x00, 0xcb, 0x48, 0x2d, 0x4a, 0x55, 0x2f, 0x56, 0x28,
            0xce, 0xcf, 0x4d, 0x55, 0x28, 0x49, 0x2d, 0x2e, 0x51, 0x48, 0x49, 0x2c, 0x49, 0x04,
            0x00, 0x47, 0x43, 0x50, 0x46,
        ];

        let expected = b"here's some test data";

        let gcpf = Gcpf::read(&data).unwrap();

        let actual = gcpf.decompress().unwrap();
        assert_eq!(actual, expected);
    }

    #[rstest]
    #[cfg_attr(not(feature = "fastlz"), ignore)]
    fn test_fastlz_compression() {
        let data = b"here's some test data";

        let expected = [
            0x47, 0x43, 0x50, 0x46, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x15, 0x00,
            0x00, 0x00, 0x16, 0x00, 0x00, 0x00, 0x14, 0x68, 0x65, 0x72, 0x65, 0x27, 0x73, 0x20,
            0x73, 0x6f, 0x6d, 0x65, 0x20, 0x74, 0x65, 0x73, 0x74, 0x20, 0x64, 0x61, 0x74, 0x61,
            0x47, 0x43, 0x50, 0x46,
        ];

        let actual = Gcpf::compress(data, CompressionMode::FastLZ).unwrap();
        let dec = Gcpf::read(&actual).unwrap().decompress().unwrap();

        assert_eq!(dec, data);
        assert_eq!(actual, expected);
    }

    #[rstest]
    #[cfg_attr(not(feature = "fastlz"), ignore)]
    fn test_fastlz_decompression() {
        let data = [
            0x47, 0x43, 0x50, 0x46, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x15, 0x00,
            0x00, 0x00, 0x16, 0x00, 0x00, 0x00, 0x14, 0x68, 0x65, 0x72, 0x65, 0x27, 0x73, 0x20,
            0x73, 0x6f, 0x6d, 0x65, 0x20, 0x74, 0x65, 0x73, 0x74, 0x20, 0x64, 0x61, 0x74, 0x61,
            0x47, 0x43, 0x50, 0x46,
        ];

        let expected = b"here's some test data";

        let gcpf = Gcpf::read(&data).unwrap();

        let actual = gcpf.decompress().unwrap();
        assert_eq!(actual, expected);
    }

    #[rstest]
    #[cfg_attr(not(feature = "gzip"), ignore)]
    fn test_gzip_compression() {
        let data = b"here's some test data";

        let expected = [
            0x47, 0x43, 0x50, 0x46, 0x03, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x15, 0x00,
            0x00, 0x00, 0x29, 0x00, 0x00, 0x00, 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00,
            0x00, 0xff, 0xcb, 0x48, 0x2d, 0x4a, 0x55, 0x2f, 0x56, 0x28, 0xce, 0xcf, 0x4d, 0x55,
            0x28, 0x49, 0x2d, 0x2e, 0x51, 0x48, 0x49, 0x2c, 0x49, 0x04, 0x00, 0xc7, 0x8a, 0xef,
            0x2e, 0x15, 0x00, 0x00, 0x00, 0x47, 0x43, 0x50, 0x46,
        ];

        let actual = Gcpf::compress(data, CompressionMode::Gzip).unwrap();
        let dec = Gcpf::read(&actual).unwrap().decompress().unwrap();

        assert_eq!(dec, data);
        assert_eq!(actual, expected);
    }

    #[rstest]
    #[cfg_attr(not(feature = "gzip"), ignore)]
    fn test_gzip_decompression() {
        let data = [
            0x47, 0x43, 0x50, 0x46, 0x03, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x15, 0x00,
            0x00, 0x00, 0x29, 0x00, 0x00, 0x00, 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00,
            0x00, 0x13, 0xcb, 0x48, 0x2d, 0x4a, 0x55, 0x2f, 0x56, 0x28, 0xce, 0xcf, 0x4d, 0x55,
            0x28, 0x49, 0x2d, 0x2e, 0x51, 0x48, 0x49, 0x2c, 0x49, 0x04, 0x00, 0xc7, 0x8a, 0xef,
            0x2e, 0x15, 0x00, 0x00, 0x00, 0x47, 0x43, 0x50, 0x46,
        ];

        let expected = b"here's some test data";

        let gcpf = Gcpf::read(&data).unwrap();

        let actual = gcpf.decompress().unwrap();
        assert_eq!(actual, expected);
    }

    #[rstest]
    #[cfg_attr(not(feature = "zstd"), ignore)]
    fn test_zstd_compression() {
        let data = b"here's some test data";

        let expected = [
            0x47, 0x43, 0x50, 0x46, 0x02, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x15, 0x00,
            0x00, 0x00, 0x1e, 0x00, 0x00, 0x00, 0x28, 0xb5, 0x2f, 0xfd, 0x00, 0x58, 0xa9, 0x00,
            0x00, 0x68, 0x65, 0x72, 0x65, 0x27, 0x73, 0x20, 0x73, 0x6f, 0x6d, 0x65, 0x20, 0x74,
            0x65, 0x73, 0x74, 0x20, 0x64, 0x61, 0x74, 0x61, 0x47, 0x43, 0x50, 0x46,
        ];

        let actual = Gcpf::compress(data, CompressionMode::Zstd).unwrap();
        let dec = Gcpf::read(&actual).unwrap().decompress().unwrap();

        assert_eq!(dec, data);
        assert_eq!(actual, expected);
    }

    #[rstest]
    #[cfg_attr(not(feature = "zstd"), ignore)]
    fn test_zstd_decompression() {
        let data = [
            0x47, 0x43, 0x50, 0x46, 0x02, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x15, 0x00,
            0x00, 0x00, 0x1e, 0x00, 0x00, 0x00, 0x28, 0xb5, 0x2f, 0xfd, 0x20, 0x15, 0xa9, 0x00,
            0x00, 0x68, 0x65, 0x72, 0x65, 0x27, 0x73, 0x20, 0x73, 0x6f, 0x6d, 0x65, 0x20, 0x74,
            0x65, 0x73, 0x74, 0x20, 0x64, 0x61, 0x74, 0x61, 0x47, 0x43, 0x50, 0x46,
        ];

        let expected = b"here's some test data";

        let gcpf = Gcpf::read(&data).unwrap();

        let actual = gcpf.decompress().unwrap();
        assert_eq!(actual, expected);
    }

    #[rstest]
    fn test_gcpf_truncated_min_length() {
        let bad_data = b"GCPF";

        let result = Gcpf::read(bad_data);

        assert_matches!(result, Err(Error::GcpfTruncated));
    }

    #[rstest]
    fn test_bad_magic() {
        let bad_data = b"this is some very very bad data";

        let result = Gcpf::read(bad_data);

        assert_matches!(result, Err(Error::BadMagic([b't', b'h', b'i', b's'])));
    }

    #[rstest]
    fn test_truncated_blocks() {
        let bad_data = [
            b'G', b'C', b'P', b'F', 0, 0, 0, 0, 1, 0, 0, 0, 2, 0, 0, 0, b'G', b'C', b'P', b'F',
        ];
        let result = Gcpf::read(&bad_data);

        assert_matches!(result, Err(Error::GcpfTruncated));
    }

    #[rstest]
    fn test_no_footer() {
        let bad_data = [
            b'G', b'C', b'P', b'F', 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 0,
        ];
        let result = Gcpf::read(&bad_data);

        assert_matches!(result, Err(Error::GcpfTruncated));
    }

    #[rstest]
    fn test_bad_footer() {
        let bad_data = [
            b'G', b'C', b'P', b'F', 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
        ];
        let result = Gcpf::read(&bad_data);

        assert_matches!(result, Err(Error::BadMagic([0, 0, 0, 0])));
    }

    #[rstest]
    fn test_multiblock_compression_deflate() {
        test_multiblock_compression(CompressionMode::Deflate);
    }

    #[rstest]
    fn test_multiblock_compression_zstd() {
        test_multiblock_compression(CompressionMode::Zstd);
    }

    #[rstest]
    fn test_multiblock_compression_gzip() {
        test_multiblock_compression(CompressionMode::Gzip);
    }

    #[rstest]
    fn test_multiblock_compression_brotli() {
        test_multiblock_compression(CompressionMode::Brotli);
    }

    #[rstest]
    fn test_multiblock_compression_fastlz() {
        test_multiblock_compression(CompressionMode::FastLZ);
    }

    /// Reusable test for checking multiblock compression
    ///
    /// # Panics
    ///
    /// Will `panic!` if:
    ///
    /// - `mode.get_compressor()` returns `Err`
    /// - The [`compression_mode::Compressor`] impl for `mode` doesn't produce a valid compression stream
    /// - The [`compression_mode::Compressor`] impl for `mode` doesn't compress data correctly
    /// - The [`compression_mode::Decompressor`] impl for `mode` doesn't decompress data correctly
    fn test_multiblock_compression(mode: CompressionMode) {
        let expected = b"this is test data";

        let actual =
            Gcpf::compress_settings(expected, mode, 10, mode.get_compressor().unwrap().as_ref())
                .unwrap();

        let dec = Gcpf::read(&actual).unwrap().decompress().unwrap();

        assert_ne!(actual, expected);
        assert_eq!(dec, expected);
    }
}