File: meta_test.go

package info (click to toggle)
golang-github-dsnet-compress 0.0.2~git20230904.39efe44%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,724 kB
  • sloc: sh: 108; makefile: 5
file content (294 lines) | stat: -rw-r--r-- 8,278 bytes parent folder | download
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
// Copyright 2015, Joe Tsai. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE.md file.

package meta

import (
	"bytes"
	"compress/flate"
	"io"
	"io/ioutil"
	"math/rand"
	"testing"

	"github.com/dsnet/compress/internal/testutil"
)

var (
	testBinary  = testutil.MustLoadFile("../../../testdata/binary.bin")
	testDigits  = testutil.MustLoadFile("../../../testdata/digits.txt")
	testHuffman = testutil.MustLoadFile("../../../testdata/huffman.txt")
	testRandom  = testutil.MustLoadFile("../../../testdata/random.bin")
	testRepeats = testutil.MustLoadFile("../../../testdata/repeats.bin")
	testTwain   = testutil.MustLoadFile("../../../testdata/twain.txt")
	testZeros   = testutil.MustLoadFile("../../../testdata/zeros.bin")
)

func testBackwardCompatibility(t *testing.T, b []byte) {
	// Works only on Go 1.5 and above due to a bug in Go's flate implementation.
	// See https://github.com/golang/go/issues/11030.
	//
	// The following const holds a valid compressed string that uses an empty
	// HDistTree to trigger the bug before performing the backwards
	// compatibility test below.
	const emptyDistBlock = "\x05\xc0\x07\x06\x00\x00\x00\x80\x40\x0f\xff\x37\xa0\xca"
	zd := flate.NewReader(bytes.NewReader([]byte(emptyDistBlock)))
	if _, err := ioutil.ReadAll(zd); err != nil {
		t.Fatal("Empty HDistTree bug found in compress/flate, please use Go 1.5 and above")
	}

	// Append final stream block that just contains the string "test\n".
	const rawTestBlock = "\x01\x04\x00\xfb\xfftest"
	zd = flate.NewReader(bytes.NewBuffer([]byte(string(b) + rawTestBlock)))
	got, err := ioutil.ReadAll(zd)
	if err != nil {
		t.Fatalf("unexpected error: ReadAll() = %v", err)
	}
	if want := "test"; string(got) != want {
		t.Fatalf("mismatching output: ReadAll() = %q, want %q", got, want)
	}
}

func TestRoundTrip(t *testing.T) {
	testBackwardCompatibility(t, nil)

	vectors := []struct {
		name  string
		input []byte
	}{
		{"Nil", nil},
		{"Binary", testBinary},
		{"Digits", testDigits},
		{"Huffman", testHuffman},
		{"Random", testRandom},
		{"Repeats", testRepeats},
		{"Twain", testTwain},
		{"Zeros", testZeros},
	}

	for _, v := range vectors {
		v := v
		t.Run(v.name, func(t *testing.T) {
			t.Parallel()

			var wb, rb bytes.Buffer

			mw := NewWriter(&wb)
			cnt, err := io.Copy(mw, bytes.NewReader(v.input))
			if err != nil {
				t.Errorf("unexpected error: Write() = %v", err)
			}
			if cnt != int64(len(v.input)) {
				t.Errorf("write count mismatch: got %d, want %d", cnt, len(v.input))
			}
			if err := mw.Close(); err != nil {
				t.Errorf("unexpected error: Close() = %v", err)
			}

			mr := NewReader(&wb)
			cnt, err = io.Copy(&rb, mr)
			if err != nil {
				t.Errorf("unexpected error: Read() = %v", err)
			}
			if cnt != int64(len(v.input)) {
				t.Errorf("read count mismatch: got %d, want %d", cnt, len(v.input))
			}
			if err := mr.Close(); err != nil {
				t.Errorf("unexpected error: Close() = %v", err)
			}

			output := rb.Bytes()
			if got, want, ok := testutil.BytesCompare(output, v.input); !ok {
				t.Errorf("output data mismatch:\ngot  %s\nwant %s", got, want)
			}
		})
	}
}

func TestFuzz(t *testing.T) {
	rand := rand.New(rand.NewSource(0))

	bb := bytes.NewBuffer(nil)
	type X struct {
		buf   []byte
		cnt   int
		final FinalMode
	}
	wants := []X{}

	// Encode test.
	mw := new(Writer)
	for numBytes := MinRawBytes; numBytes <= MaxRawBytes; numBytes++ {
		numBits := numBytes * 8
		for zeros := 0; zeros <= numBits; zeros++ {
			ones := numBits - zeros
			huffLen, _ := mw.computeHuffLen(zeros, ones)
			if huffLen == 0 && numBytes <= EnsureRawBytes {
				t.Fatalf("could not compute huffLen (zeros: %d, ones: %d)", zeros, ones)
			}
			if huffLen == 0 {
				continue
			}

			var buf []byte
			perm := rand.Perm(numBits)
			for i := 0; i < numBits/8; i++ {
				var b byte
				for j := 0; j < 8; j++ {
					if perm[8*i+j] >= zeros {
						b |= 1 << uint(j)
					}
				}
				buf = append(buf, b)
			}
			for _, l := range []FinalMode{FinalNil, FinalMeta} {
				mw.Reset(bb)
				mw.bufCnt = copy(mw.buf[:], buf)
				mw.buf0s, mw.buf1s = zeros, ones
				if err := mw.encodeBlock(l); err != nil {
					t.Fatalf("unexpected error: encodeBlock() = %v", err)
				}
				cnt := int(mw.OutputOffset)
				wants = append(wants, X{buf, cnt, l})

				// Ensure theoretical limits are upheld.
				if cnt < MinEncBytes {
					t.Fatalf("exceeded minimum theoretical bounds: %d < %d", cnt, MinEncBytes)
				}
				if cnt > MaxEncBytes {
					t.Fatalf("exceeded maximum theoretical bounds: %d < %d", cnt, MaxEncBytes)
				}
			}
		}
	}

	testBackwardCompatibility(t, bb.Bytes())

	// Decode test.
	mr := new(Reader)
	for _, x := range wants {
		mr.Reset(bb)
		if err := mr.decodeBlock(); err != nil {
			t.Fatalf("unexpected error: decodeBlock() = %v", err)
		}

		if got, want, ok := testutil.BytesCompare(mr.buf, x.buf); !ok {
			t.Fatalf("mismatching data:\ngot  %s\nwant %s", got, want)
		}
		if mr.final != x.final {
			t.Fatalf("mismatching final mode: got %d, want %d", mr.final, x.final)
		}
		if cnt := int(mr.InputOffset); cnt != x.cnt {
			t.Fatalf("mismatching count: got %d, want %d", cnt, x.cnt)
		}
	}
}

func TestRandom(t *testing.T) {
	rand := rand.New(rand.NewSource(0))

	obuf := bytes.NewBuffer(nil)
	ibuf := bytes.NewBuffer(nil)
	mw := NewWriter(obuf)

	// Encode writer test.
	buf := make([]byte, 100)
	for i := 0; i < 1000; i++ {
		cnt := rand.Intn(len(buf))
		rand.Read(buf[:cnt])
		ibuf.Write(buf[:cnt])

		wrCnt, err := mw.Write(buf[:cnt])
		if err != nil {
			t.Fatalf("unexpected error: Write() = %v", err)
		}
		if wrCnt != cnt {
			t.Fatalf("mismatching write count: Write() = %d, want %d", wrCnt, cnt)
		}
		if int(mw.InputOffset) != ibuf.Len() {
			t.Fatalf("mismatching input offset: got %d, want %d", int(mw.InputOffset), ibuf.Len())
		}
		if int(mw.OutputOffset) != obuf.Len() {
			t.Fatalf("mismatching output offset: got %d, want %d", int(mw.OutputOffset), obuf.Len())
		}
	}
	mw.FinalMode = FinalMeta
	if err := mw.Close(); err != nil {
		t.Fatalf("unexpected error: Close() = %v", err)
	}

	testBackwardCompatibility(t, obuf.Bytes())

	// Meta encoding should be better than 50% on large inputs.
	eff := 100.0 * float64(len(ibuf.Bytes())) / float64(len(obuf.Bytes()))
	if thres := 50.0; eff < thres {
		t.Errorf("efficiency worse than expected: %0.1f%% < %0.1f%%", eff, thres)
	}

	// Decode reader test.
	mr := NewReader(bytes.NewReader(obuf.Bytes()))
	buf, err := ioutil.ReadAll(mr)
	if err != nil {
		t.Errorf("unexpected error: Read() = %v", err)
	}
	if got, want, ok := testutil.BytesCompare(buf, ibuf.Bytes()); !ok {
		t.Errorf("mismatching output for Read():\ngot  %s\nwant %s", got, want)
	}
	if err := mr.Close(); err != nil {
		t.Errorf("unexpected error: Close() = %v", err)
	}
	if final := mr.FinalMode; final != FinalMeta {
		t.Errorf("mismatching final mode: got %d, want %d", final, FinalMeta)
	}

	// Verify that statistic agree between Reader/Writer.
	if mr.InputOffset != mw.OutputOffset {
		t.Errorf("mismatching input offset: got %d, want %d", mr.InputOffset, mw.InputOffset)
	}
	if mr.OutputOffset != mw.InputOffset {
		t.Errorf("mismatching output offset: got %d, want %d", mr.OutputOffset, mw.OutputOffset)
	}
	if mr.NumBlocks != mw.NumBlocks {
		t.Errorf("mismatching block count: got %d, want %d", mr.NumBlocks, mw.NumBlocks)
	}
}

func TestReverseSearch(t *testing.T) {
	rand := rand.New(rand.NewSource(0))

	// Search random data (not found).
	data := make([]byte, 1<<12) // 4KiB
	rand.Read(data)
	if idx := ReverseSearch(data); idx != -1 {
		t.Errorf("unexpected meta magic: got %d, want %d", idx, -1)
	}

	// Write arbitrary data.
	buf := bytes.NewBuffer(nil)
	mw := NewWriter(buf)
	for i := 0; i < 4096; i++ {
		cnt := rand.Intn(MaxEncBytes)
		rand.Read(data[:cnt])
		mw.Write(data[:cnt])
		mw.encodeBlock(FinalMode(rand.Intn(3)))
	}

	// Reverse search all the blocks.
	var numBlks int64
	data = buf.Bytes()
	for len(data) > 0 {
		pos := ReverseSearch(data)
		if pos == -1 {
			break
		}
		data = data[:pos]
		numBlks++
	}
	if numBlks != mw.NumBlocks {
		t.Errorf("mismatching block count: got %d, want %d", numBlks, mw.NumBlocks)
	}
	if len(data) > 0 {
		t.Errorf("unexpected residual data: got %d bytes", len(data))
	}
}