zippity 0.5.0

Library for asynchronously creating a ZIP file on the fly.
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

use std::collections::HashSet;

use crate::{
    Builder,
    test_util::{build_and_open, test_entry_data::TestEntryData},
};
use assert2::assert;
use indexmap::IndexMap;
use std::io::Read;
use test_strategy::proptest;

#[tokio::test]
async fn empty_archive() {
    let unpacked = build_and_open(Builder::<&[u8]>::new()).await;
    assert!(unpacked.is_empty());
}

#[tokio::test]
async fn empty_entry_name() {
    let mut builder: Builder<&[u8]> = Builder::new();
    builder.add_entry(String::new(), b"".as_ref()).unwrap();

    let mut unpacked = build_and_open(builder).await;
    assert!(unpacked.len() == 1);

    let mut zipfile = unpacked.by_index(0).unwrap();
    let name = std::str::from_utf8(zipfile.name_raw()).unwrap().to_string();
    assert!(name.is_empty());
    let mut file_content = Vec::new();
    zipfile.read_to_end(&mut file_content).unwrap();
    assert!(file_content.is_empty());
}

#[tokio::test]
async fn archive_with_single_file() {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder
        .add_entry("Foo".to_owned(), b"bar!".as_slice())
        .unwrap();

    let mut unpacked = build_and_open(builder).await;
    assert!(unpacked.len() == 1);

    let mut zipfile = unpacked.by_index(0).unwrap();
    let name = std::str::from_utf8(zipfile.name_raw()).unwrap().to_string();
    assert!(name == "Foo");
    let mut file_content = Vec::new();
    zipfile.read_to_end(&mut file_content).unwrap();
    assert!(file_content == b"bar!");
}

#[tokio::test]
async fn archive_with_single_empty_file() {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder.add_entry("0".to_owned(), b"".as_slice()).unwrap();

    let mut unpacked = build_and_open(builder).await;
    assert!(unpacked.len() == 1);

    let mut zipfile = unpacked.by_index(0).unwrap();
    let name = std::str::from_utf8(zipfile.name_raw()).unwrap().to_string();
    assert!(name == "0");
    let mut file_content = Vec::new();
    zipfile.read_to_end(&mut file_content).unwrap();
    assert!(file_content == b"");
}

#[proptest(async = "tokio")]
async fn any_archive(content: TestEntryData) {
    let builder = content.clone().into();
    let mut unpacked = build_and_open(builder).await;
    assert!(unpacked.len() == content.0.len());

    let mut unpacked_content: IndexMap<String, Vec<u8>> = IndexMap::new();
    for i in 0..unpacked.len() {
        dbg!(&i);
        let mut zipfile = unpacked.by_index(i).unwrap();
        let name = std::str::from_utf8(zipfile.name_raw()).unwrap().to_string();
        let mut file_content = Vec::new();
        zipfile.read_to_end(&mut file_content).unwrap();

        unpacked_content.insert(name, file_content);
    }
    assert!(unpacked_content == content.0);
}

#[proptest(async = "tokio")]
async fn entry_ordering(entry_names: HashSet<String>) {
    let entry_names: Vec<_> = entry_names.into_iter().collect(); // Fix the order of the input

    let mut builder = Builder::<&[u8]>::new();

    for name in &entry_names {
        builder.add_entry(name.clone(), b"".as_ref()).unwrap();
    }

    let mut unpacked = build_and_open(builder).await;

    let unpacked_entries: Vec<_> = (0..unpacked.len())
        .map(|i| {
            let zipfile = unpacked.by_index(i).unwrap();
            std::str::from_utf8(zipfile.name_raw()).unwrap().to_string()
        })
        .collect();

    assert!(unpacked_entries == entry_names);
}

#[proptest(async = "tokio")]
async fn file_modification_time(
    #[strategy(1980..=2107)] year: i32,
    #[strategy(1u32..=12u32)] month: u32,
    #[strategy(1u32..=31u32)] day: u32,
    #[strategy(0u32..=23u32)] hour: u32,
    #[strategy(0u32..=59u32)] minute: u32,
    #[strategy(0u32..=59u32)] second: u32,
) {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder
        .add_entry("X".into(), b"".as_ref())
        .unwrap()
        .datetime_fields(year, month, day, hour, minute, second)
        .unwrap();

    let mut unpacked = build_and_open(builder).await;

    assert!(unpacked.len() == 1);

    let unpacked_timestamp = unpacked.by_index(0).unwrap().last_modified();

    assert!(unpacked_timestamp.year() == u16::try_from(year).unwrap());
    assert!(unpacked_timestamp.month() == u8::try_from(month).unwrap());
    assert!(unpacked_timestamp.day() == u8::try_from(day).unwrap());
    assert!(unpacked_timestamp.hour() == u8::try_from(hour).unwrap());
    assert!(unpacked_timestamp.minute() == u8::try_from(minute).unwrap());
    assert!(unpacked_timestamp.second() == u8::try_from(second & !1).unwrap());
}

#[tokio::test]
async fn regular_file_default_permissions() {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder.add_entry("X".into(), b"".as_ref()).unwrap();

    let mut unpacked = build_and_open(builder).await;

    assert!(unpacked.len() == 1);

    let permissions = unpacked.by_index(0).unwrap().unix_mode().unwrap();

    assert!(permissions == 0o100_644);
}

#[tokio::test]
async fn directory_default_permissions() {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder
        .add_entry("X".into(), b"".as_ref())
        .unwrap()
        .directory();

    let mut unpacked = build_and_open(builder).await;

    assert!(unpacked.len() == 1);

    let permissions = unpacked.by_index(0).unwrap().unix_mode().unwrap();

    assert!(permissions == 0o40_755);
}

#[tokio::test]
async fn regular_file_override_permissions() {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder
        .add_entry("X".into(), b"".as_ref())
        .unwrap()
        .unix_permissions(0o123);

    let mut unpacked = build_and_open(builder).await;

    assert!(unpacked.len() == 1);

    let permissions = unpacked.by_index(0).unwrap().unix_mode().unwrap();

    assert!(permissions == 0o100_123);
}

#[tokio::test]
async fn directory_override_permissions() {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder
        .add_entry("X".into(), b"".as_ref())
        .unwrap()
        .directory()
        .unix_permissions(0o123);

    let mut unpacked = build_and_open(builder).await;

    assert!(unpacked.len() == 1);

    let permissions = unpacked.by_index(0).unwrap().unix_mode().unwrap();

    assert!(permissions == 0o40_123);
}

#[tokio::test]
async fn readonly_file_permissions() {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder
        .add_entry("ro_file".into(), b"".as_ref())
        .unwrap()
        .readonly(true);

    let mut unpacked = build_and_open(builder).await;

    assert!(unpacked.len() == 1);

    let permissions = unpacked.by_index(0).unwrap().unix_mode().unwrap();

    assert!(permissions == 0o100_444);
}

#[tokio::test]
async fn readonly_directory_permissions() {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder
        .add_entry("ro_dir".into(), b"".as_ref())
        .unwrap()
        .directory()
        .readonly(true);

    let mut unpacked = build_and_open(builder).await;

    assert!(unpacked.len() == 1);

    let permissions = unpacked.by_index(0).unwrap().unix_mode().unwrap();

    assert!(permissions == 0o40_555);
}

#[tokio::test]
async fn symlink_permissions() {
    let mut builder: Builder<&[u8]> = Builder::new();

    builder
        .add_entry("X".into(), b"".as_ref())
        .unwrap()
        .symlink()
        .unix_permissions(0o123); // Will get overridden

    let mut unpacked = build_and_open(builder).await;

    assert!(unpacked.len() == 1);

    let permissions = unpacked.by_index(0).unwrap().unix_mode().unwrap();

    assert!(permissions == 0o120_777);
}