about summary refs log tree commit diff
path: root/tvix/nix-compat/src/nar/reader/async/test.rs
blob: 7bc1f8942f5099b5d8061a57a09c7525d3c395ee (plain) (blame)
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
use tokio::io::AsyncReadExt;

mod nar {
    pub use crate::nar::reader::r#async as reader;
}

#[tokio::test]
async fn symlink() {
    let mut f = std::io::Cursor::new(include_bytes!("../../tests/symlink.nar"));
    let node = nar::reader::open(&mut f).await.unwrap();

    match node {
        nar::reader::Node::Symlink { target } => {
            assert_eq!(
                &b"/nix/store/somewhereelse"[..],
                &target,
                "target must match"
            );
        }
        _ => panic!("unexpected type"),
    }
}

#[tokio::test]
async fn file() {
    let mut f = std::io::Cursor::new(include_bytes!("../../tests/helloworld.nar"));
    let node = nar::reader::open(&mut f).await.unwrap();

    match node {
        nar::reader::Node::File {
            executable,
            mut reader,
        } => {
            assert!(!executable);
            let mut buf = vec![];
            reader
                .read_to_end(&mut buf)
                .await
                .expect("read must succeed");
            assert_eq!(&b"Hello World!"[..], &buf);
        }
        _ => panic!("unexpected type"),
    }
}

#[tokio::test]
async fn complicated() {
    let mut f = std::io::Cursor::new(include_bytes!("../../tests/complicated.nar"));
    let node = nar::reader::open(&mut f).await.unwrap();

    match node {
        nar::reader::Node::Directory(mut dir_reader) => {
            // first entry is .keep, an empty regular file.
            must_read_file(
                ".keep",
                dir_reader
                    .next()
                    .await
                    .expect("next must succeed")
                    .expect("must be some"),
            )
            .await;

            // second entry is aa, a symlink to /nix/store/somewhereelse
            must_be_symlink(
                "aa",
                "/nix/store/somewhereelse",
                dir_reader
                    .next()
                    .await
                    .expect("next must be some")
                    .expect("must be some"),
            );

            {
                // third entry is a directory called "keep"
                let entry = dir_reader
                    .next()
                    .await
                    .expect("next must be some")
                    .expect("must be some");

                assert_eq!(b"keep", entry.name);

                match entry.node {
                    nar::reader::Node::Directory(mut subdir_reader) => {
                        {
                            // first entry is .keep, an empty regular file.
                            let entry = subdir_reader
                                .next()
                                .await
                                .expect("next must succeed")
                                .expect("must be some");

                            must_read_file(".keep", entry).await;
                        }

                        // we must read the None
                        assert!(
                            subdir_reader
                                .next()
                                .await
                                .expect("next must succeed")
                                .is_none(),
                            "keep directory contains only .keep"
                        );
                    }
                    _ => panic!("unexpected type for keep/.keep"),
                }
            };

            // reading more entries yields None (and we actually must read until this)
            assert!(dir_reader.next().await.expect("must succeed").is_none());
        }
        _ => panic!("unexpected type"),
    }
}

#[tokio::test]
#[should_panic]
#[ignore = "TODO: async poisoning"]
async fn file_read_abandoned() {
    let mut f = std::io::Cursor::new(include_bytes!("../../tests/complicated.nar"));
    let node = nar::reader::open(&mut f).await.unwrap();

    match node {
        nar::reader::Node::Directory(mut dir_reader) => {
            // first entry is .keep, an empty regular file.
            {
                let entry = dir_reader
                    .next()
                    .await
                    .expect("next must succeed")
                    .expect("must be some");

                assert_eq!(b".keep", entry.name);
                // don't bother to finish reading it.
            };

            // this should panic (not return an error), because we are meant to abandon the archive reader now.
            assert!(dir_reader.next().await.expect("must succeed").is_none());
        }
        _ => panic!("unexpected type"),
    }
}

#[tokio::test]
#[should_panic]
#[ignore = "TODO: async poisoning"]
async fn dir_read_abandoned() {
    let mut f = std::io::Cursor::new(include_bytes!("../../tests/complicated.nar"));
    let node = nar::reader::open(&mut f).await.unwrap();

    match node {
        nar::reader::Node::Directory(mut dir_reader) => {
            // first entry is .keep, an empty regular file.
            must_read_file(
                ".keep",
                dir_reader
                    .next()
                    .await
                    .expect("next must succeed")
                    .expect("must be some"),
            )
            .await;

            // second entry is aa, a symlink to /nix/store/somewhereelse
            must_be_symlink(
                "aa",
                "/nix/store/somewhereelse",
                dir_reader
                    .next()
                    .await
                    .expect("next must be some")
                    .expect("must be some"),
            );

            {
                // third entry is a directory called "keep"
                let entry = dir_reader
                    .next()
                    .await
                    .expect("next must be some")
                    .expect("must be some");

                assert_eq!(b"keep", entry.name);

                match entry.node {
                    nar::reader::Node::Directory(_) => {
                        // don't finish using it, which poisons the archive reader
                    }
                    _ => panic!("unexpected type for keep/.keep"),
                }
            };

            // this should panic, because we didn't finish reading the child subdirectory
            assert!(dir_reader.next().await.expect("must succeed").is_none());
        }
        _ => panic!("unexpected type"),
    }
}

#[tokio::test]
#[should_panic]
#[ignore = "TODO: async poisoning"]
async fn dir_read_after_none() {
    let mut f = std::io::Cursor::new(include_bytes!("../../tests/complicated.nar"));
    let node = nar::reader::open(&mut f).await.unwrap();

    match node {
        nar::reader::Node::Directory(mut dir_reader) => {
            // first entry is .keep, an empty regular file.
            must_read_file(
                ".keep",
                dir_reader
                    .next()
                    .await
                    .expect("next must succeed")
                    .expect("must be some"),
            )
            .await;

            // second entry is aa, a symlink to /nix/store/somewhereelse
            must_be_symlink(
                "aa",
                "/nix/store/somewhereelse",
                dir_reader
                    .next()
                    .await
                    .expect("next must be some")
                    .expect("must be some"),
            );

            {
                // third entry is a directory called "keep"
                let entry = dir_reader
                    .next()
                    .await
                    .expect("next must be some")
                    .expect("must be some");

                assert_eq!(b"keep", entry.name);

                match entry.node {
                    nar::reader::Node::Directory(mut subdir_reader) => {
                        // first entry is .keep, an empty regular file.
                        must_read_file(
                            ".keep",
                            subdir_reader
                                .next()
                                .await
                                .expect("next must succeed")
                                .expect("must be some"),
                        )
                        .await;

                        // we must read the None
                        assert!(
                            subdir_reader
                                .next()
                                .await
                                .expect("next must succeed")
                                .is_none(),
                            "keep directory contains only .keep"
                        );
                    }
                    _ => panic!("unexpected type for keep/.keep"),
                }
            };

            // reading more entries yields None (and we actually must read until this)
            assert!(dir_reader.next().await.expect("must succeed").is_none());

            // this should panic, because we already got a none so we're meant to stop.
            dir_reader.next().await.unwrap();
            unreachable!()
        }
        _ => panic!("unexpected type"),
    }
}

async fn must_read_file(name: &'static str, entry: nar::reader::Entry<'_, '_>) {
    assert_eq!(name.as_bytes(), entry.name);

    match entry.node {
        nar::reader::Node::File {
            executable,
            mut reader,
        } => {
            assert!(!executable);
            assert_eq!(reader.read(&mut [0]).await.unwrap(), 0);
        }
        _ => panic!("unexpected type for {}", name),
    }
}

fn must_be_symlink(
    name: &'static str,
    exp_target: &'static str,
    entry: nar::reader::Entry<'_, '_>,
) {
    assert_eq!(name.as_bytes(), entry.name);

    match entry.node {
        nar::reader::Node::Symlink { target } => {
            assert_eq!(exp_target.as_bytes(), &target);
        }
        _ => panic!("unexpected type for {}", name),
    }
}