/
StreamHandling.cs
542 lines (460 loc) · 14.2 KB
/
StreamHandling.cs
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
using ICSharpCode.SharpZipLib.Core;
using ICSharpCode.SharpZipLib.Tests.TestSupport;
using ICSharpCode.SharpZipLib.Zip;
using NUnit.Framework;
using System;
using System.IO;
namespace ICSharpCode.SharpZipLib.Tests.Zip
{
/// <summary>
/// This contains newer tests for stream handling. Much of this is still in GeneralHandling
/// </summary>
[TestFixture]
public class StreamHandling : ZipBase
{
private void MustFailRead(Stream s, byte[] buffer, int offset, int count)
{
bool exception = false;
try
{
s.Read(buffer, offset, count);
}
catch
{
exception = true;
}
Assert.IsTrue(exception, "Read should fail");
}
[Test]
[Category("Zip")]
public void ParameterHandling()
{
byte[] buffer = new byte[10];
byte[] emptyBuffer = new byte[0];
var ms = new MemoryStream();
var outStream = new ZipOutputStream(ms);
outStream.IsStreamOwner = false;
outStream.PutNextEntry(new ZipEntry("Floyd"));
outStream.Write(buffer, 0, 10);
outStream.Finish();
ms.Seek(0, SeekOrigin.Begin);
var inStream = new ZipInputStream(ms);
ZipEntry e = inStream.GetNextEntry();
MustFailRead(inStream, null, 0, 0);
MustFailRead(inStream, buffer, -1, 1);
MustFailRead(inStream, buffer, 0, 11);
MustFailRead(inStream, buffer, 7, 5);
MustFailRead(inStream, buffer, 0, -1);
MustFailRead(inStream, emptyBuffer, 0, 1);
int bytesRead = inStream.Read(buffer, 10, 0);
Assert.AreEqual(0, bytesRead, "Should be able to read zero bytes");
bytesRead = inStream.Read(emptyBuffer, 0, 0);
Assert.AreEqual(0, bytesRead, "Should be able to read zero bytes");
}
/// <summary>
/// Check that Zip64 descriptor is added to an entry OK.
/// </summary>
[Test]
[Category("Zip")]
public void Zip64Descriptor()
{
MemoryStream msw = new MemoryStreamWithoutSeek();
var outStream = new ZipOutputStream(msw);
outStream.UseZip64 = UseZip64.Off;
outStream.IsStreamOwner = false;
outStream.PutNextEntry(new ZipEntry("StripedMarlin"));
outStream.WriteByte(89);
outStream.Close();
Assert.IsTrue(ZipTesting.TestArchive(msw.ToArray()));
msw = new MemoryStreamWithoutSeek();
outStream = new ZipOutputStream(msw);
outStream.UseZip64 = UseZip64.On;
outStream.IsStreamOwner = false;
outStream.PutNextEntry(new ZipEntry("StripedMarlin"));
outStream.WriteByte(89);
outStream.Close();
Assert.IsTrue(ZipTesting.TestArchive(msw.ToArray()));
}
[Test]
[Category("Zip")]
public void ReadAndWriteZip64NonSeekable()
{
MemoryStream msw = new MemoryStreamWithoutSeek();
using (ZipOutputStream outStream = new ZipOutputStream(msw))
{
outStream.UseZip64 = UseZip64.On;
outStream.IsStreamOwner = false;
outStream.PutNextEntry(new ZipEntry("StripedMarlin"));
outStream.WriteByte(89);
outStream.PutNextEntry(new ZipEntry("StripedMarlin2"));
outStream.WriteByte(89);
outStream.Close();
}
Assert.IsTrue(ZipTesting.TestArchive(msw.ToArray()));
msw.Position = 0;
using (ZipInputStream zis = new ZipInputStream(msw))
{
while (zis.GetNextEntry() != null)
{
int len = 0;
int bufferSize = 1024;
byte[] buffer = new byte[bufferSize];
while ((len = zis.Read(buffer, 0, bufferSize)) > 0)
{
// Reading the data is enough
}
}
}
}
/// <summary>
/// Check that adding an entry with no data and Zip64 works OK
/// </summary>
[Test]
[Category("Zip")]
public void EntryWithNoDataAndZip64()
{
MemoryStream msw = new MemoryStreamWithoutSeek();
var outStream = new ZipOutputStream(msw);
outStream.IsStreamOwner = false;
var ze = new ZipEntry("Striped Marlin");
ze.ForceZip64();
ze.Size = 0;
outStream.PutNextEntry(ze);
outStream.CloseEntry();
outStream.Finish();
outStream.Close();
Assert.IsTrue(ZipTesting.TestArchive(msw.ToArray()));
}
/// <summary>
/// Empty zip entries can be created and read?
/// </summary>
[Test]
[Category("Zip")]
public void EmptyZipEntries()
{
var ms = new MemoryStream();
var outStream = new ZipOutputStream(ms);
for (int i = 0; i < 10; ++i)
{
outStream.PutNextEntry(new ZipEntry(i.ToString()));
}
outStream.Finish();
ms.Seek(0, SeekOrigin.Begin);
var inStream = new ZipInputStream(ms);
int extractCount = 0;
byte[] decompressedData = new byte[100];
while ((inStream.GetNextEntry()) != null)
{
while (true)
{
int numRead = inStream.Read(decompressedData, extractCount, decompressedData.Length);
if (numRead <= 0)
{
break;
}
extractCount += numRead;
}
}
inStream.Close();
Assert.Zero(extractCount, "No data should be read from empty entries");
}
/// <summary>
/// Test that calling Write with 0 bytes behaves.
/// See issue @ https://github.com/icsharpcode/SharpZipLib/issues/123.
/// </summary>
[Test]
[Category("Zip")]
public void TestZeroByteWrite()
{
using (var ms = new MemoryStreamWithoutSeek())
{
using (var outStream = new ZipOutputStream(ms) { IsStreamOwner = false })
{
var ze = new ZipEntry("Striped Marlin");
outStream.PutNextEntry(ze);
var buffer = Array.Empty<byte>();
outStream.Write(buffer, 0, 0);
}
ms.Seek(0, SeekOrigin.Begin);
using (var inStream = new ZipInputStream(ms) { IsStreamOwner = false })
{
int extractCount = 0;
byte[] decompressedData = new byte[100];
while (inStream.GetNextEntry() != null)
{
while (true)
{
int numRead = inStream.Read(decompressedData, extractCount, decompressedData.Length);
if (numRead <= 0)
{
break;
}
extractCount += numRead;
}
}
Assert.Zero(extractCount, "No data should be read from empty entries");
}
}
}
[Test]
[Category("Zip")]
public void WriteZipStreamWithNoCompression([Values(0, 1, 256)] int contentLength)
{
var buffer = new byte[255];
using (var dummyZip = Utils.GetDummyFile(0))
using (var inputFile = Utils.GetDummyFile(contentLength))
{
// Filename is manually cleaned here to prevent this test from failing while ZipEntry doesn't automatically clean it
var inputFileName = ZipEntry.CleanName(inputFile.Filename);
using (var zipFileStream = File.OpenWrite(dummyZip.Filename))
using (var zipOutputStream = new ZipOutputStream(zipFileStream))
using (var inputFileStream = File.OpenRead(inputFile.Filename))
{
zipOutputStream.PutNextEntry(new ZipEntry(inputFileName)
{
CompressionMethod = CompressionMethod.Stored,
});
StreamUtils.Copy(inputFileStream, zipOutputStream, buffer);
}
using (var zf = new ZipFile(dummyZip.Filename))
{
var inputBytes = File.ReadAllBytes(inputFile.Filename);
var entry = zf.GetEntry(inputFileName);
Assert.IsNotNull(entry, "No entry matching source file \"{0}\" found in archive, found \"{1}\"", inputFileName, zf[0].Name);
Assert.DoesNotThrow(() =>
{
using (var entryStream = zf.GetInputStream(entry))
{
var outputBytes = new byte[entryStream.Length];
entryStream.Read(outputBytes, 0, outputBytes.Length);
Assert.AreEqual(inputBytes, outputBytes, "Archive content does not match the source content");
}
}, "Failed to locate entry stream in archive");
Assert.IsTrue(zf.TestArchive(testData: true), "Archive did not pass TestArchive");
}
}
}
[Test]
[Category("Zip")]
public void ZipEntryFileNameAutoClean()
{
using (var dummyZip = Utils.GetDummyFile(0))
using (var inputFile = Utils.GetDummyFile()) {
using (var zipFileStream = File.OpenWrite(dummyZip.Filename))
using (var zipOutputStream = new ZipOutputStream(zipFileStream))
using (var inputFileStream = File.OpenRead(inputFile.Filename))
{
// New ZipEntry created with a full file name path as it's name
zipOutputStream.PutNextEntry(new ZipEntry(inputFile.Filename)
{
CompressionMethod = CompressionMethod.Stored,
});
inputFileStream.CopyTo(zipOutputStream);
}
using (var zf = new ZipFile(dummyZip.Filename))
{
// The ZipEntry name should have been automatically cleaned
Assert.AreEqual(ZipEntry.CleanName(inputFile.Filename), zf[0].Name);
}
}
}
/// <summary>
/// Empty zips can be created and read?
/// </summary>
[Test]
[Category("Zip")]
public void CreateAndReadEmptyZip()
{
var ms = new MemoryStream();
var outStream = new ZipOutputStream(ms);
outStream.Finish();
ms.Seek(0, SeekOrigin.Begin);
var inStream = new ZipInputStream(ms);
while ((inStream.GetNextEntry()) != null)
{
Assert.Fail("No entries should be found in empty zip");
}
}
/// <summary>
/// Base stream is closed when IsOwner is true ( default);
/// </summary>
[Test]
public void BaseClosedWhenOwner()
{
var ms = new TrackedMemoryStream();
Assert.IsFalse(ms.IsClosed, "Underlying stream should NOT be closed");
using (ZipOutputStream stream = new ZipOutputStream(ms))
{
Assert.IsTrue(stream.IsStreamOwner, "Should be stream owner by default");
}
Assert.IsTrue(ms.IsClosed, "Underlying stream should be closed");
}
/// <summary>
/// Check that base stream is not closed when IsOwner is false;
/// </summary>
[Test]
public void BaseNotClosedWhenNotOwner()
{
var ms = new TrackedMemoryStream();
Assert.IsFalse(ms.IsClosed, "Underlying stream should NOT be closed");
using (ZipOutputStream stream = new ZipOutputStream(ms))
{
Assert.IsTrue(stream.IsStreamOwner, "Should be stream owner by default");
stream.IsStreamOwner = false;
}
Assert.IsFalse(ms.IsClosed, "Underlying stream should still NOT be closed");
}
/// <summary>
/// Check that base stream is not closed when IsOwner is false;
/// </summary>
[Test]
public void BaseClosedAfterFailure()
{
var ms = new TrackedMemoryStream(new byte[32]);
Assert.IsFalse(ms.IsClosed, "Underlying stream should NOT be closed initially");
bool blewUp = false;
try
{
using (ZipOutputStream stream = new ZipOutputStream(ms))
{
Assert.IsTrue(stream.IsStreamOwner, "Should be stream owner by default");
try
{
stream.PutNextEntry(new ZipEntry("Tiny"));
stream.Write(new byte[32], 0, 32);
}
finally
{
Assert.IsFalse(ms.IsClosed, "Stream should still not be closed.");
stream.Close();
Assert.Fail("Exception not thrown");
}
}
}
catch
{
blewUp = true;
}
Assert.IsTrue(blewUp, "Should have failed to write to stream");
Assert.IsTrue(ms.IsClosed, "Underlying stream should be closed");
}
[Test]
[Category("Zip")]
[Category("Performance")]
[Explicit("Long Running")]
public void WriteThroughput()
{
PerformanceTesting.TestWrite(0x10000000, bs =>
{
var zos = new ZipOutputStream(bs);
zos.PutNextEntry(new ZipEntry("0"));
return zos;
});
}
[Test]
[Category("Zip")]
[Category("Performance")]
[Explicit("Long Running")]
public void SingleLargeEntry()
{
const string EntryName = "CantSeek";
PerformanceTesting.TestReadWrite(
size: TestDataSize.Large,
input: bs =>
{
var zis = new ZipInputStream(bs);
var entry = zis.GetNextEntry();
Assert.AreEqual(EntryName, entry.Name);
Assert.IsTrue((entry.Flags & (int)GeneralBitFlags.Descriptor) != 0);
return zis;
},
output: bs =>
{
var zos = new ZipOutputStream(bs);
zos.PutNextEntry(new ZipEntry(EntryName));
return zos;
}
);
}
const string BZip2CompressedZip =
"UEsDBC4AAAAMAEyxgU5p3ou9JwAAAAcAAAAFAAAAYS5kYXRCWmg5MUFZJlNZ0buMcAAAAkgACABA" +
"ACAAIQCCCxdyRThQkNG7jHBQSwECMwAuAAAADABMsYFOad6LvScAAAAHAAAABQAAAAAAAAAAAAAA" +
"AAAAAAAAYS5kYXRQSwUGAAAAAAEAAQAzAAAASgAAAAAA";
/// <summary>
/// Should fail to read a zip with BZip2 compression
/// </summary>
[Test]
[Category("Zip")]
public void ShouldReadBZip2EntryButNotDecompress()
{
var fileBytes = System.Convert.FromBase64String(BZip2CompressedZip);
using (var input = new MemoryStream(fileBytes, false))
{
var zis = new ZipInputStream(input);
var entry = zis.GetNextEntry();
Assert.That(entry.Name, Is.EqualTo("a.dat"), "Should be able to get entry name");
Assert.That(entry.CompressionMethod, Is.EqualTo(CompressionMethod.BZip2), "Entry should be BZip2 compressed");
Assert.That(zis.CanDecompressEntry, Is.False, "Should not be able to decompress BZip2 entry");
var buffer = new byte[1];
Assert.Throws<ZipException>(() => zis.Read(buffer, 0, 1), "Trying to read the stream should throw");
}
}
/// <summary>
/// Test for https://github.com/icsharpcode/SharpZipLib/issues/341
/// Should be able to read entries whose names contain invalid filesystem
/// characters
/// </summary>
[Test]
[Category("Zip")]
public void ShouldBeAbleToReadEntriesWithInvalidFileNames()
{
var testFileName = "<A|B?C>.txt";
using (var memoryStream = new MemoryStream())
{
using (var outStream = new ZipOutputStream(memoryStream))
{
outStream.IsStreamOwner = false;
outStream.PutNextEntry(new ZipEntry(testFileName));
}
memoryStream.Seek(0, SeekOrigin.Begin);
using (var inStream = new ZipInputStream(memoryStream))
{
var entry = inStream.GetNextEntry();
Assert.That(entry.Name, Is.EqualTo(testFileName), "output name must match original name");
}
}
}
[Test]
[Category("Zip")]
public void ShouldThrowDescriptiveExceptionOnUncompressedDescriptorEntry()
{
using (var ms = new MemoryStreamWithoutSeek())
{
using (var zos = new ZipOutputStream(ms))
{
zos.IsStreamOwner = false;
var entry = new ZipEntry("testentry");
entry.CompressionMethod = CompressionMethod.Stored;
entry.Flags |= (int)GeneralBitFlags.Descriptor;
zos.PutNextEntry(entry);
zos.Write(new byte[1], 0, 1);
zos.CloseEntry();
}
// Patch the Compression Method, since ZipOutputStream automatically changes it to Deflate when descriptors are used
ms.Seek(8, SeekOrigin.Begin);
ms.WriteByte((byte)CompressionMethod.Stored);
ms.Seek(0, SeekOrigin.Begin);
using (var zis = new ZipInputStream(ms))
{
zis.IsStreamOwner = false;
var buf = new byte[32];
zis.GetNextEntry();
Assert.Throws(typeof(StreamUnsupportedException), () =>
{
zis.Read(buf, 0, buf.Length);
});
}
}
}
}
}