File: archivereader_test.go

package info (click to toggle)
golang-github-u-root-uio 0.0~git20240224.d2acac8-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 276 kB
  • sloc: sh: 25; makefile: 2
file content (259 lines) | stat: -rw-r--r-- 6,888 bytes parent folder | download | duplicates (2)
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
// Copyright 2021 the u-root Authors. All rights reserved
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package uio

import (
	"bytes"
	"io"
	"math/rand"
	"strings"
	"testing"
	"time"

	"github.com/pierrec/lz4/v4"
)

const choices = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

func TestArchiveReaderRegular(t *testing.T) {
	dataStr := strings.Repeat("This is an important data!@#$%^^&&*&**(()())", 1000)

	ar, err := NewArchiveReader(bytes.NewReader([]byte(dataStr)))
	if err != nil {
		t.Fatalf("newArchiveReader(bytes.NewReader(%v)) returned error: %v", []byte(dataStr), err)
	}

	buf := new(strings.Builder)
	if _, err := io.Copy(buf, ar); err != nil {
		t.Errorf("io.Copy(%v, %v) returned error: %v, want nil.", buf, ar, err)
	}
	if buf.String() != dataStr {
		t.Errorf("got %s, want %s", buf.String(), dataStr)
	}
}

func TestArchiveReaderPreReadShort(t *testing.T) {
	dataStr := "short data"
	ar, err := NewArchiveReader(bytes.NewReader([]byte(dataStr)))
	if err != nil {
		t.Errorf("newArchiveReader(bytes.NewReader([]byte(%s))) returned err: %v, want nil", dataStr, err)
	}
	got, err := io.ReadAll(ar)
	if err != nil {
		t.Errorf("got error reading archive reader: %v, want nil", err)
	}
	if string(got) != dataStr {
		t.Errorf("got %s, want %s", string(got), dataStr)
	}
	// Pre-read nothing.
	dataStr = ""
	ar, err = NewArchiveReader(bytes.NewReader([]byte(dataStr)))
	if err != ErrPreReadError {
		t.Errorf("newArchiveReader(bytes.NewReader([]byte(%s))) returned err: %v, want %v", dataStr, err, ErrPreReadError)
	}
	got, err = io.ReadAll(ar)
	if err != nil {
		t.Errorf("got error reading archive reader: %v, want nil", err)
	}
	if string(got) != dataStr {
		t.Errorf("got %s, want %s", string(got), dataStr)
	}
}

// randomString generates random string of fixed length in a fast and simple way.
func randomString(l int) string {
	//nolint
	rand.Seed(time.Now().UnixNano())
	r := make([]byte, l)
	for i := 0; i < l; i++ {
		r[i] = choices[rand.Intn(len(choices))]
	}
	return string(r)
}

func checkArchiveReaderLZ4(t *testing.T, tt archiveReaderLZ4Case) {
	t.Helper()

	srcR := bytes.NewReader([]byte(tt.dataStr))

	srcBuf := new(bytes.Buffer)
	lz4w := tt.setup(srcBuf)

	n, err := io.Copy(lz4w, srcR)
	if err != nil {
		t.Fatalf("io.Copy(%v, %v) returned error: %v, want nil", lz4w, srcR, err)
	}
	if n != int64(len([]byte(tt.dataStr))) {
		t.Fatalf("got %d bytes compressed, want %d", n, len([]byte(tt.dataStr)))
	}
	if err = lz4w.Close(); err != nil {
		t.Fatalf("Failed to close lz4 writer: %v", err)
	}

	// Test ArchiveReader reading it.
	ar, err := NewArchiveReader(bytes.NewReader(srcBuf.Bytes()))
	if err != nil {
		t.Fatalf("newArchiveReader(bytes.NewReader(%v)) returned error: %v", srcBuf.Bytes(), err)
	}
	buf := new(strings.Builder)
	if _, err := io.Copy(buf, ar); err != nil {
		t.Errorf("io.Copy(%v, %v) returned error: %v, want nil.", buf, ar, err)
	}

	r := strings.TrimRight(buf.String(), "\x00")

	if r != tt.dataStr {
		t.Errorf("got %s, want %s", r, tt.dataStr)
	}
}

type archiveReaderLZ4Case struct {
	name    string
	setup   func(w io.Writer) *lz4.Writer
	dataStr string
}

func TestArchiveReaderLZ4(t *testing.T) {
	for _, tt := range []archiveReaderLZ4Case{
		{
			name:    "non-legacy regular",
			setup:   lz4.NewWriter,
			dataStr: randomString(1024),
		},
		{
			name:    "non-legacy larger data",
			setup:   lz4.NewWriter,
			dataStr: randomString(5 * 1024),
		},
		{
			name:    "non-legacy short data", // Likley not realistic for most cases in the real world.
			setup:   lz4.NewWriter,
			dataStr: randomString(100), // Smaller than pre-read size, 1024 bytes.
		},
		{
			name: "legacy regular",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.LegacyOption(true)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(1024),
		},
		{
			name: "legacy larger data",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.LegacyOption(true)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(5 * 1024),
		},
		{
			name: "legacy small data",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.LegacyOption(true)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(100), // Smaller than pre-read size, 1024 bytes..
		},
		{
			name: "legacy small data",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.LegacyOption(true)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(100), // Smaller than pre-read size, 1024 bytes..
		},
		{
			name: "regular larger data with fast compression",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.CompressionLevelOption(lz4.Fast)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(5 * 1024),
		},
		{
			name: "legacy larger data with fast compression",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.LegacyOption(true), lz4.CompressionLevelOption(lz4.Fast)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(5 * 1024),
		},
	} {
		t.Run(tt.name, func(t *testing.T) {
			checkArchiveReaderLZ4(t, tt)
		})
	}
}

func TestArchiveReaderLZ4SlowCompressed(t *testing.T) {
	for _, tt := range []archiveReaderLZ4Case{
		{
			name: "regular larger data with medium compression",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.CompressionLevelOption(lz4.Level5)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(5 * 1024),
		},
		{
			name: "regular larger data with slow compression",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.CompressionLevelOption(lz4.Level9)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(5 * 1024),
		},
		{
			name: "legacy larger data with medium compression",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.LegacyOption(true), lz4.CompressionLevelOption(lz4.Level5)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(5 * 1024),
		},
		{
			name: "legacy larger data with slow compression",
			setup: func(w io.Writer) *lz4.Writer {
				lz4w := lz4.NewWriter(w)
				if err := lz4w.Apply(lz4.LegacyOption(true), lz4.CompressionLevelOption(lz4.Level9)); err != nil {
					t.Fatal(err)
				}
				return lz4w
			},
			dataStr: randomString(5 * 1024),
		},
	} {
		t.Run(tt.name, func(t *testing.T) {
			checkArchiveReaderLZ4(t, tt)
		})
	}
}