| // Copyright 2011 The Go Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style |
| // license that can be found in the LICENSE file. |
| |
| // Tests that involve both reading and writing. |
| |
| package zip |
| |
| import ( |
| "bytes" |
| "errors" |
| "fmt" |
| "hash" |
| "io" |
| "io/ioutil" |
| "sort" |
| "strings" |
| "testing" |
| "time" |
| ) |
| |
| func TestModTime(t *testing.T) { |
| var testTime = time.Date(2009, time.November, 10, 23, 45, 58, 0, time.UTC) |
| fh := new(FileHeader) |
| fh.SetModTime(testTime) |
| outTime := fh.ModTime() |
| if !outTime.Equal(testTime) { |
| t.Errorf("times don't match: got %s, want %s", outTime, testTime) |
| } |
| } |
| |
| func testHeaderRoundTrip(fh *FileHeader, wantUncompressedSize uint32, wantUncompressedSize64 uint64, t *testing.T) { |
| fi := fh.FileInfo() |
| fh2, err := FileInfoHeader(fi) |
| if err != nil { |
| t.Fatal(err) |
| } |
| if got, want := fh2.Name, fh.Name; got != want { |
| t.Errorf("Name: got %s, want %s\n", got, want) |
| } |
| if got, want := fh2.UncompressedSize, wantUncompressedSize; got != want { |
| t.Errorf("UncompressedSize: got %d, want %d\n", got, want) |
| } |
| if got, want := fh2.UncompressedSize64, wantUncompressedSize64; got != want { |
| t.Errorf("UncompressedSize64: got %d, want %d\n", got, want) |
| } |
| if got, want := fh2.ModifiedTime, fh.ModifiedTime; got != want { |
| t.Errorf("ModifiedTime: got %d, want %d\n", got, want) |
| } |
| if got, want := fh2.ModifiedDate, fh.ModifiedDate; got != want { |
| t.Errorf("ModifiedDate: got %d, want %d\n", got, want) |
| } |
| |
| if sysfh, ok := fi.Sys().(*FileHeader); !ok && sysfh != fh { |
| t.Errorf("Sys didn't return original *FileHeader") |
| } |
| } |
| |
| func TestFileHeaderRoundTrip(t *testing.T) { |
| fh := &FileHeader{ |
| Name: "foo.txt", |
| UncompressedSize: 987654321, |
| ModifiedTime: 1234, |
| ModifiedDate: 5678, |
| } |
| testHeaderRoundTrip(fh, fh.UncompressedSize, uint64(fh.UncompressedSize), t) |
| } |
| |
| func TestFileHeaderRoundTrip64(t *testing.T) { |
| fh := &FileHeader{ |
| Name: "foo.txt", |
| UncompressedSize64: 9876543210, |
| ModifiedTime: 1234, |
| ModifiedDate: 5678, |
| } |
| testHeaderRoundTrip(fh, uint32max, fh.UncompressedSize64, t) |
| } |
| |
| func TestFileHeaderRoundTripModified(t *testing.T) { |
| fh := &FileHeader{ |
| Name: "foo.txt", |
| UncompressedSize: 987654321, |
| Modified: time.Now().Local(), |
| ModifiedTime: 1234, |
| ModifiedDate: 5678, |
| } |
| fi := fh.FileInfo() |
| fh2, err := FileInfoHeader(fi) |
| if err != nil { |
| t.Fatal(err) |
| } |
| if got, want := fh2.Modified, fh.Modified.UTC(); got != want { |
| t.Errorf("Modified: got %s, want %s\n", got, want) |
| } |
| if got, want := fi.ModTime(), fh.Modified.UTC(); got != want { |
| t.Errorf("Modified: got %s, want %s\n", got, want) |
| } |
| } |
| |
| func TestFileHeaderRoundTripWithoutModified(t *testing.T) { |
| fh := &FileHeader{ |
| Name: "foo.txt", |
| UncompressedSize: 987654321, |
| ModifiedTime: 1234, |
| ModifiedDate: 5678, |
| } |
| fi := fh.FileInfo() |
| fh2, err := FileInfoHeader(fi) |
| if err != nil { |
| t.Fatal(err) |
| } |
| if got, want := fh2.ModTime(), fh.ModTime(); got != want { |
| t.Errorf("Modified: got %s, want %s\n", got, want) |
| } |
| if got, want := fi.ModTime(), fh.ModTime(); got != want { |
| t.Errorf("Modified: got %s, want %s\n", got, want) |
| } |
| } |
| |
| type repeatedByte struct { |
| off int64 |
| b byte |
| n int64 |
| } |
| |
| // rleBuffer is a run-length-encoded byte buffer. |
| // It's an io.Writer (like a bytes.Buffer) and also an io.ReaderAt, |
| // allowing random-access reads. |
| type rleBuffer struct { |
| buf []repeatedByte |
| } |
| |
| func (r *rleBuffer) Size() int64 { |
| if len(r.buf) == 0 { |
| return 0 |
| } |
| last := &r.buf[len(r.buf)-1] |
| return last.off + last.n |
| } |
| |
| func (r *rleBuffer) Write(p []byte) (n int, err error) { |
| var rp *repeatedByte |
| if len(r.buf) > 0 { |
| rp = &r.buf[len(r.buf)-1] |
| // Fast path, if p is entirely the same byte repeated. |
| if lastByte := rp.b; len(p) > 0 && p[0] == lastByte { |
| if bytes.Count(p, []byte{lastByte}) == len(p) { |
| rp.n += int64(len(p)) |
| return len(p), nil |
| } |
| } |
| } |
| |
| for _, b := range p { |
| if rp == nil || rp.b != b { |
| r.buf = append(r.buf, repeatedByte{r.Size(), b, 1}) |
| rp = &r.buf[len(r.buf)-1] |
| } else { |
| rp.n++ |
| } |
| } |
| return len(p), nil |
| } |
| |
| func min(x, y int64) int64 { |
| if x < y { |
| return x |
| } |
| return y |
| } |
| |
| func memset(a []byte, b byte) { |
| if len(a) == 0 { |
| return |
| } |
| // Double, until we reach power of 2 >= len(a), same as bytes.Repeat, |
| // but without allocation. |
| a[0] = b |
| for i, l := 1, len(a); i < l; i *= 2 { |
| copy(a[i:], a[:i]) |
| } |
| } |
| |
| func (r *rleBuffer) ReadAt(p []byte, off int64) (n int, err error) { |
| if len(p) == 0 { |
| return |
| } |
| skipParts := sort.Search(len(r.buf), func(i int) bool { |
| part := &r.buf[i] |
| return part.off+part.n > off |
| }) |
| parts := r.buf[skipParts:] |
| if len(parts) > 0 { |
| skipBytes := off - parts[0].off |
| for _, part := range parts { |
| repeat := int(min(part.n-skipBytes, int64(len(p)-n))) |
| memset(p[n:n+repeat], part.b) |
| n += repeat |
| if n == len(p) { |
| return |
| } |
| skipBytes = 0 |
| } |
| } |
| if n != len(p) { |
| err = io.ErrUnexpectedEOF |
| } |
| return |
| } |
| |
| // Just testing the rleBuffer used in the Zip64 test above. Not used by the zip code. |
| func TestRLEBuffer(t *testing.T) { |
| b := new(rleBuffer) |
| var all []byte |
| writes := []string{"abcdeee", "eeeeeee", "eeeefghaaiii"} |
| for _, w := range writes { |
| b.Write([]byte(w)) |
| all = append(all, w...) |
| } |
| if len(b.buf) != 10 { |
| t.Fatalf("len(b.buf) = %d; want 10", len(b.buf)) |
| } |
| |
| for i := 0; i < len(all); i++ { |
| for j := 0; j < len(all)-i; j++ { |
| buf := make([]byte, j) |
| n, err := b.ReadAt(buf, int64(i)) |
| if err != nil || n != len(buf) { |
| t.Errorf("ReadAt(%d, %d) = %d, %v; want %d, nil", i, j, n, err, len(buf)) |
| } |
| if !bytes.Equal(buf, all[i:i+j]) { |
| t.Errorf("ReadAt(%d, %d) = %q; want %q", i, j, buf, all[i:i+j]) |
| } |
| } |
| } |
| } |
| |
| // fakeHash32 is a dummy Hash32 that always returns 0. |
| type fakeHash32 struct { |
| hash.Hash32 |
| } |
| |
| func (fakeHash32) Write(p []byte) (int, error) { return len(p), nil } |
| func (fakeHash32) Sum32() uint32 { return 0 } |
| |
| // suffixSaver is an io.Writer & io.ReaderAt that remembers the last 0 |
| // to 'keep' bytes of data written to it. Call Suffix to get the |
| // suffix bytes. |
| type suffixSaver struct { |
| keep int |
| buf []byte |
| start int |
| size int64 |
| } |
| |
| func (ss *suffixSaver) Size() int64 { return ss.size } |
| |
| var errDiscardedBytes = errors.New("ReadAt of discarded bytes") |
| |
| func (ss *suffixSaver) ReadAt(p []byte, off int64) (n int, err error) { |
| back := ss.size - off |
| if back > int64(ss.keep) { |
| return 0, errDiscardedBytes |
| } |
| suf := ss.Suffix() |
| n = copy(p, suf[len(suf)-int(back):]) |
| if n != len(p) { |
| err = io.EOF |
| } |
| return |
| } |
| |
| func (ss *suffixSaver) Suffix() []byte { |
| if len(ss.buf) < ss.keep { |
| return ss.buf |
| } |
| buf := make([]byte, ss.keep) |
| n := copy(buf, ss.buf[ss.start:]) |
| copy(buf[n:], ss.buf[:]) |
| return buf |
| } |
| |
| func (ss *suffixSaver) Write(p []byte) (n int, err error) { |
| n = len(p) |
| ss.size += int64(len(p)) |
| if len(ss.buf) < ss.keep { |
| space := ss.keep - len(ss.buf) |
| add := len(p) |
| if add > space { |
| add = space |
| } |
| ss.buf = append(ss.buf, p[:add]...) |
| p = p[add:] |
| } |
| for len(p) > 0 { |
| n := copy(ss.buf[ss.start:], p) |
| p = p[n:] |
| ss.start += n |
| if ss.start == ss.keep { |
| ss.start = 0 |
| } |
| } |
| return |
| } |
| |
| // generatesZip64 reports whether f wrote a zip64 file. |
| // f is also responsible for closing w. |
| func generatesZip64(t *testing.T, f func(w *Writer)) bool { |
| ss := &suffixSaver{keep: 10 << 20} |
| w := NewWriter(ss) |
| f(w) |
| return suffixIsZip64(t, ss) |
| } |
| |
| type sizedReaderAt interface { |
| io.ReaderAt |
| Size() int64 |
| } |
| |
| func suffixIsZip64(t *testing.T, zip sizedReaderAt) bool { |
| d := make([]byte, 1024) |
| if _, err := zip.ReadAt(d, zip.Size()-int64(len(d))); err != nil { |
| t.Fatalf("ReadAt: %v", err) |
| } |
| |
| sigOff := findSignatureInBlock(d) |
| if sigOff == -1 { |
| t.Errorf("failed to find signature in block") |
| return false |
| } |
| |
| dirOff, err := findDirectory64End(zip, zip.Size()-int64(len(d))+int64(sigOff)) |
| if err != nil { |
| t.Fatalf("findDirectory64End: %v", err) |
| } |
| if dirOff == -1 { |
| return false |
| } |
| |
| d = make([]byte, directory64EndLen) |
| if _, err := zip.ReadAt(d, dirOff); err != nil { |
| t.Fatalf("ReadAt(off=%d): %v", dirOff, err) |
| } |
| |
| b := readBuf(d) |
| if sig := b.uint32(); sig != directory64EndSignature { |
| return false |
| } |
| |
| size := b.uint64() |
| if size != directory64EndLen-12 { |
| t.Errorf("expected length of %d, got %d", directory64EndLen-12, size) |
| } |
| return true |
| } |
| |
| func testZip64(t testing.TB, size int64) *rleBuffer { |
| const chunkSize = 1024 |
| chunks := int(size / chunkSize) |
| // write size bytes plus "END\n" to a zip file |
| buf := new(rleBuffer) |
| w := NewWriter(buf) |
| f, err := w.CreateHeader(&FileHeader{ |
| Name: "huge.txt", |
| Method: Store, |
| }) |
| if err != nil { |
| t.Fatal(err) |
| } |
| f.(*fileWriter).crc32 = fakeHash32{} |
| chunk := make([]byte, chunkSize) |
| for i := range chunk { |
| chunk[i] = '.' |
| } |
| for i := 0; i < chunks; i++ { |
| _, err := f.Write(chunk) |
| if err != nil { |
| t.Fatal("write chunk:", err) |
| } |
| } |
| if frag := int(size % chunkSize); frag > 0 { |
| _, err := f.Write(chunk[:frag]) |
| if err != nil { |
| t.Fatal("write chunk:", err) |
| } |
| } |
| end := []byte("END\n") |
| _, err = f.Write(end) |
| if err != nil { |
| t.Fatal("write end:", err) |
| } |
| if err := w.Close(); err != nil { |
| t.Fatal(err) |
| } |
| |
| // read back zip file and check that we get to the end of it |
| r, err := NewReader(buf, int64(buf.Size())) |
| if err != nil { |
| t.Fatal("reader:", err) |
| } |
| f0 := r.File[0] |
| rc, err := f0.Open() |
| if err != nil { |
| t.Fatal("opening:", err) |
| } |
| rc.(*checksumReader).hash = fakeHash32{} |
| for i := 0; i < chunks; i++ { |
| _, err := io.ReadFull(rc, chunk) |
| if err != nil { |
| t.Fatal("read:", err) |
| } |
| } |
| if frag := int(size % chunkSize); frag > 0 { |
| _, err := io.ReadFull(rc, chunk[:frag]) |
| if err != nil { |
| t.Fatal("read:", err) |
| } |
| } |
| gotEnd, err := ioutil.ReadAll(rc) |
| if err != nil { |
| t.Fatal("read end:", err) |
| } |
| if !bytes.Equal(gotEnd, end) { |
| t.Errorf("End of zip64 archive %q, want %q", gotEnd, end) |
| } |
| err = rc.Close() |
| if err != nil { |
| t.Fatal("closing:", err) |
| } |
| if size+int64(len("END\n")) >= 1<<32-1 { |
| if got, want := f0.UncompressedSize, uint32(uint32max); got != want { |
| t.Errorf("UncompressedSize %#x, want %#x", got, want) |
| } |
| } |
| |
| if got, want := f0.UncompressedSize64, uint64(size)+uint64(len(end)); got != want { |
| t.Errorf("UncompressedSize64 %#x, want %#x", got, want) |
| } |
| |
| return buf |
| } |
| |
| // Issue 9857 |
| func testZip64DirectoryRecordLength(buf *rleBuffer, t *testing.T) { |
| if !suffixIsZip64(t, buf) { |
| t.Fatal("not a zip64") |
| } |
| } |
| |
| func testValidHeader(h *FileHeader, t *testing.T) { |
| var buf bytes.Buffer |
| z := NewWriter(&buf) |
| |
| f, err := z.CreateHeader(h) |
| if err != nil { |
| t.Fatalf("error creating header: %v", err) |
| } |
| if _, err := f.Write([]byte("hi")); err != nil { |
| t.Fatalf("error writing content: %v", err) |
| } |
| if err := z.Close(); err != nil { |
| t.Fatalf("error closing zip writer: %v", err) |
| } |
| |
| b := buf.Bytes() |
| zf, err := NewReader(bytes.NewReader(b), int64(len(b))) |
| if err != nil { |
| t.Fatalf("got %v, expected nil", err) |
| } |
| zh := zf.File[0].FileHeader |
| if zh.Name != h.Name || zh.Method != h.Method || zh.UncompressedSize64 != uint64(len("hi")) { |
| t.Fatalf("got %q/%d/%d expected %q/%d/%d", zh.Name, zh.Method, zh.UncompressedSize64, h.Name, h.Method, len("hi")) |
| } |
| } |
| |
| // Issue 4302. |
| func TestHeaderInvalidTagAndSize(t *testing.T) { |
| const timeFormat = "20060102T150405.000.txt" |
| |
| ts := time.Now() |
| filename := ts.Format(timeFormat) |
| |
| h := FileHeader{ |
| Name: filename, |
| Method: Deflate, |
| Extra: []byte(ts.Format(time.RFC3339Nano)), // missing tag and len, but Extra is best-effort parsing |
| } |
| h.SetModTime(ts) |
| |
| testValidHeader(&h, t) |
| } |
| |
| func TestHeaderTooShort(t *testing.T) { |
| h := FileHeader{ |
| Name: "foo.txt", |
| Method: Deflate, |
| Extra: []byte{zip64ExtraID}, // missing size and second half of tag, but Extra is best-effort parsing |
| } |
| testValidHeader(&h, t) |
| } |
| |
| func TestHeaderTooLongErr(t *testing.T) { |
| var headerTests = []struct { |
| name string |
| extra []byte |
| wanterr error |
| }{ |
| { |
| name: strings.Repeat("x", 1<<16), |
| extra: []byte{}, |
| wanterr: errLongName, |
| }, |
| { |
| name: "long_extra", |
| extra: bytes.Repeat([]byte{0xff}, 1<<16), |
| wanterr: errLongExtra, |
| }, |
| } |
| |
| // write a zip file |
| buf := new(bytes.Buffer) |
| w := NewWriter(buf) |
| |
| for _, test := range headerTests { |
| h := &FileHeader{ |
| Name: test.name, |
| Extra: test.extra, |
| } |
| _, err := w.CreateHeader(h) |
| if err != test.wanterr { |
| t.Errorf("error=%v, want %v", err, test.wanterr) |
| } |
| } |
| |
| if err := w.Close(); err != nil { |
| t.Fatal(err) |
| } |
| } |
| |
| func TestHeaderIgnoredSize(t *testing.T) { |
| h := FileHeader{ |
| Name: "foo.txt", |
| Method: Deflate, |
| Extra: []byte{zip64ExtraID & 0xFF, zip64ExtraID >> 8, 24, 0, 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8}, // bad size but shouldn't be consulted |
| } |
| testValidHeader(&h, t) |
| } |
| |
| // Issue 4393. It is valid to have an extra data header |
| // which contains no body. |
| func TestZeroLengthHeader(t *testing.T) { |
| h := FileHeader{ |
| Name: "extadata.txt", |
| Method: Deflate, |
| Extra: []byte{ |
| 85, 84, 5, 0, 3, 154, 144, 195, 77, // tag 21589 size 5 |
| 85, 120, 0, 0, // tag 30805 size 0 |
| }, |
| } |
| testValidHeader(&h, t) |
| } |
| |
| // Just benchmarking how fast the Zip64 test above is. Not related to |
| // our zip performance, since the test above disabled CRC32 and flate. |
| func BenchmarkZip64Test(b *testing.B) { |
| for i := 0; i < b.N; i++ { |
| testZip64(b, 1<<26) |
| } |
| } |
| |
| func BenchmarkZip64TestSizes(b *testing.B) { |
| for _, size := range []int64{1 << 12, 1 << 20, 1 << 26} { |
| b.Run(fmt.Sprint(size), func(b *testing.B) { |
| b.RunParallel(func(pb *testing.PB) { |
| for pb.Next() { |
| testZip64(b, size) |
| } |
| }) |
| }) |
| } |
| } |
| |
| func TestSuffixSaver(t *testing.T) { |
| const keep = 10 |
| ss := &suffixSaver{keep: keep} |
| ss.Write([]byte("abc")) |
| if got := string(ss.Suffix()); got != "abc" { |
| t.Errorf("got = %q; want abc", got) |
| } |
| ss.Write([]byte("defghijklmno")) |
| if got := string(ss.Suffix()); got != "fghijklmno" { |
| t.Errorf("got = %q; want fghijklmno", got) |
| } |
| if got, want := ss.Size(), int64(len("abc")+len("defghijklmno")); got != want { |
| t.Errorf("Size = %d; want %d", got, want) |
| } |
| buf := make([]byte, ss.Size()) |
| for off := int64(0); off < ss.Size(); off++ { |
| for size := 1; size <= int(ss.Size()-off); size++ { |
| readBuf := buf[:size] |
| n, err := ss.ReadAt(readBuf, off) |
| if off < ss.Size()-keep { |
| if err != errDiscardedBytes { |
| t.Errorf("off %d, size %d = %v, %v (%q); want errDiscardedBytes", off, size, n, err, readBuf[:n]) |
| } |
| continue |
| } |
| want := "abcdefghijklmno"[off : off+int64(size)] |
| got := string(readBuf[:n]) |
| if err != nil || got != want { |
| t.Errorf("off %d, size %d = %v, %v (%q); want %q", off, size, n, err, got, want) |
| } |
| } |
| } |
| |
| } |
| |
| type zeros struct{} |
| |
| func (zeros) Read(p []byte) (int, error) { |
| for i := range p { |
| p[i] = 0 |
| } |
| return len(p), nil |
| } |
