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
|
package quicvarint
import (
"bytes"
"io"
"math/rand/v2"
"testing"
"github.com/stretchr/testify/require"
)
func TestLimits(t *testing.T) {
require.Equal(t, 0, Min)
require.Equal(t, uint64(1<<62-1), uint64(Max))
}
func TestRead(t *testing.T) {
tests := []struct {
name string
input []byte
expected uint64
}{
{"1 byte", []byte{0b00011001}, 25},
{"2 byte", []byte{0b01111011, 0xbd}, 15293},
{"4 byte", []byte{0b10011101, 0x7f, 0x3e, 0x7d}, 494878333},
{"8 byte", []byte{0b11000010, 0x19, 0x7c, 0x5e, 0xff, 0x14, 0xe8, 0x8c}, 151288809941952652},
{"too long", []byte{0b01000000, 0x25}, 37},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
b := bytes.NewReader(tt.input)
val, err := Read(b)
require.NoError(t, err)
require.Equal(t, tt.expected, val)
require.Zero(t, b.Len())
})
}
}
func TestParse(t *testing.T) {
tests := []struct {
name string
input []byte
expectedValue uint64
expectedLen int
}{
{"1 byte", []byte{0b00011001}, 25, 1},
{"2 byte", []byte{0b01111011, 0xbd}, 15293, 2},
{"4 byte", []byte{0b10011101, 0x7f, 0x3e, 0x7d}, 494878333, 4},
{"8 byte", []byte{0b11000010, 0x19, 0x7c, 0x5e, 0xff, 0x14, 0xe8, 0x8c}, 151288809941952652, 8},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
value, l, err := Parse(tt.input)
require.Equal(t, tt.expectedValue, value)
require.Equal(t, tt.expectedLen, l)
require.Nil(t, err)
})
}
}
func TestParsingFailures(t *testing.T) {
tests := []struct {
name string
input []byte
expectedErr error
}{
{
name: "empty slice",
input: []byte{},
expectedErr: io.EOF,
},
{
name: "2-byte encoding: not enough bytes",
input: []byte{0b01000001},
expectedErr: io.ErrUnexpectedEOF,
},
{
name: "4-byte encoding: not enough bytes",
input: []byte{0b10000000, 0x0, 0x0},
expectedErr: io.ErrUnexpectedEOF,
},
{
name: "8-byte encoding: not enough bytes",
input: []byte{0b11000000, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0},
expectedErr: io.ErrUnexpectedEOF,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
value, l, err := Parse(tt.input)
require.Equal(t, uint64(0), value)
require.Equal(t, 0, l)
require.Equal(t, tt.expectedErr, err)
})
}
}
func TestVarintEncoding(t *testing.T) {
tests := []struct {
name string
value uint64
expected []byte
}{
{"1 byte number", 37, []byte{0x25}},
{"maximum 1 byte number", maxVarInt1, []byte{0b00111111}},
{"minimum 2 byte number", maxVarInt1 + 1, []byte{0x40, maxVarInt1 + 1}},
{"2 byte number", 15293, []byte{0b01000000 ^ 0x3b, 0xbd}},
{"maximum 2 byte number", maxVarInt2, []byte{0b01111111, 0xff}},
{"minimum 4 byte number", maxVarInt2 + 1, []byte{0b10000000, 0, 0x40, 0}},
{"4 byte number", 494878333, []byte{0b10000000 ^ 0x1d, 0x7f, 0x3e, 0x7d}},
{"maximum 4 byte number", maxVarInt4, []byte{0b10111111, 0xff, 0xff, 0xff}},
{"minimum 8 byte number", maxVarInt4 + 1, []byte{0b11000000, 0, 0, 0, 0x40, 0, 0, 0}},
{"8 byte number", 151288809941952652, []byte{0xc2, 0x19, 0x7c, 0x5e, 0xff, 0x14, 0xe8, 0x8c}},
{"maximum 8 byte number", maxVarInt8, []byte{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
require.Equal(t, tt.expected, Append(nil, tt.value))
})
}
t.Run("panics when given a too large number (> 62 bit)", func(t *testing.T) {
require.Panics(t, func() { Append(nil, maxVarInt8+1) })
})
}
func TestAppendWithLen(t *testing.T) {
tests := []struct {
name string
value uint64
length int
expected []byte
}{
{"1-byte number in minimal encoding", 37, 1, []byte{0x25}},
{"1-byte number in 2 bytes", 37, 2, []byte{0b01000000, 0x25}},
{"1-byte number in 4 bytes", 37, 4, []byte{0b10000000, 0, 0, 0x25}},
{"1-byte number in 8 bytes", 37, 8, []byte{0b11000000, 0, 0, 0, 0, 0, 0, 0x25}},
{"2-byte number in 4 bytes", 15293, 4, []byte{0b10000000, 0, 0x3b, 0xbd}},
{"4-byte number in 8 bytes", 494878333, 8, []byte{0b11000000, 0, 0, 0, 0x1d, 0x7f, 0x3e, 0x7d}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
b := AppendWithLen(nil, tt.value, tt.length)
require.Equal(t, tt.expected, b)
if tt.length > 1 {
v, n, err := Parse(b)
require.NoError(t, err)
require.Equal(t, tt.length, n)
require.Equal(t, tt.value, v)
}
})
}
}
func TestAppendWithLenFailures(t *testing.T) {
tests := []struct {
name string
value uint64
length int
}{
{"invalid length", 25, 3},
{"too short for 2 bytes", maxVarInt1 + 1, 1},
{"too short for 4 bytes", maxVarInt2 + 1, 2},
{"too short for 8 bytes", maxVarInt4 + 1, 4},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
require.Panics(t, func() {
AppendWithLen(nil, tt.value, tt.length)
})
})
}
}
func TestLen(t *testing.T) {
tests := []struct {
name string
input uint64
expected int
}{
{"zero", 0, 1},
{"max 1 byte", maxVarInt1, 1},
{"min 2 bytes", maxVarInt1 + 1, 2},
{"max 2 bytes", maxVarInt2, 2},
{"min 4 bytes", maxVarInt2 + 1, 4},
{"max 4 bytes", maxVarInt4, 4},
{"min 8 bytes", maxVarInt4 + 1, 8},
{"max 8 bytes", maxVarInt8, 8},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
require.Equal(t, tt.expected, Len(tt.input))
})
}
t.Run("panics on too large number", func(t *testing.T) {
require.Panics(t, func() { Len(maxVarInt8 + 1) })
})
}
type benchmarkValue struct {
b []byte
v uint64
}
func randomValues(maxValue uint64) []benchmarkValue {
r := rand.New(rand.NewPCG(13, 37))
const num = 1025
bv := make([]benchmarkValue, num)
for i := range num {
v := r.Uint64() % maxValue
bv[i].v = v
bv[i].b = Append([]byte{}, v)
}
return bv
}
// using a reader that is also an io.ByteReader
func BenchmarkReadBytesReader(b *testing.B) {
b.Run("1-byte", func(b *testing.B) { benchmarkRead(b, randomValues(maxVarInt1), false) })
b.Run("2-byte", func(b *testing.B) { benchmarkRead(b, randomValues(maxVarInt2), false) })
b.Run("4-byte", func(b *testing.B) { benchmarkRead(b, randomValues(maxVarInt4), false) })
b.Run("8-byte", func(b *testing.B) { benchmarkRead(b, randomValues(maxVarInt8), false) })
}
// using a reader that is not an io.ByteReader
func BenchmarkReadSimpleReader(b *testing.B) {
b.Run("1-byte", func(b *testing.B) { benchmarkRead(b, randomValues(maxVarInt1), true) })
b.Run("2-byte", func(b *testing.B) { benchmarkRead(b, randomValues(maxVarInt2), true) })
b.Run("4-byte", func(b *testing.B) { benchmarkRead(b, randomValues(maxVarInt4), true) })
b.Run("8-byte", func(b *testing.B) { benchmarkRead(b, randomValues(maxVarInt8), true) })
}
// simpleReader satisfies io.Reader, but not io.ByteReader
// This means that NewReader will need to wrap the reader.
type simpleReader struct {
io.Reader
}
func benchmarkRead(b *testing.B, inputs []benchmarkValue, wrapBytesReader bool) {
r := bytes.NewReader([]byte{})
var vr Reader
if wrapBytesReader {
vr = NewReader(&simpleReader{r})
} else {
vr = NewReader(r)
}
var i int
for b.Loop() {
index := i % len(inputs)
i++
r.Reset(inputs[index].b)
val, err := Read(vr)
if err != nil {
b.Fatal(err)
}
if val != inputs[index].v {
b.Fatalf("expected %d, got %d", inputs[index].v, val)
}
}
}
func BenchmarkParse(b *testing.B) {
b.Run("1-byte", func(b *testing.B) { benchmarkParse(b, randomValues(maxVarInt1)) })
b.Run("2-byte", func(b *testing.B) { benchmarkParse(b, randomValues(maxVarInt2)) })
b.Run("4-byte", func(b *testing.B) { benchmarkParse(b, randomValues(maxVarInt4)) })
b.Run("8-byte", func(b *testing.B) { benchmarkParse(b, randomValues(maxVarInt8)) })
}
func benchmarkParse(b *testing.B, inputs []benchmarkValue) {
var i int
for b.Loop() {
index := i % len(inputs)
i++
val, n, err := Parse(inputs[index].b)
if err != nil {
b.Fatal(err)
}
if n != len(inputs[index].b) {
b.Fatalf("expected to consume %d bytes, consumed %d", len(inputs[i].b), n)
}
if val != inputs[index].v {
b.Fatalf("expected %d, got %d", inputs[index].v, val)
}
}
}
func BenchmarkAppend(b *testing.B) {
b.Run("1-byte", func(b *testing.B) { benchmarkAppend(b, randomValues(maxVarInt1)) })
b.Run("2-byte", func(b *testing.B) { benchmarkAppend(b, randomValues(maxVarInt2)) })
b.Run("4-byte", func(b *testing.B) { benchmarkAppend(b, randomValues(maxVarInt4)) })
b.Run("8-byte", func(b *testing.B) { benchmarkAppend(b, randomValues(maxVarInt8)) })
}
func benchmarkAppend(b *testing.B, inputs []benchmarkValue) {
buf := make([]byte, 8)
var i int
for b.Loop() {
buf = buf[:0]
index := i % len(inputs)
i++
buf = Append(buf, inputs[index].v)
if !bytes.Equal(buf, inputs[index].b) {
b.Fatalf("expected to write %v, wrote %v", inputs[index].b, buf)
}
}
}
func BenchmarkAppendWithLen(b *testing.B) {
b.Run("1-byte", func(b *testing.B) { benchmarkAppendWithLen(b, randomValues(maxVarInt1)) })
b.Run("2-byte", func(b *testing.B) { benchmarkAppendWithLen(b, randomValues(maxVarInt2)) })
b.Run("4-byte", func(b *testing.B) { benchmarkAppendWithLen(b, randomValues(maxVarInt4)) })
b.Run("8-byte", func(b *testing.B) { benchmarkAppendWithLen(b, randomValues(maxVarInt8)) })
}
func benchmarkAppendWithLen(b *testing.B, inputs []benchmarkValue) {
buf := make([]byte, 8)
var i int
for b.Loop() {
buf = buf[:0]
index := i % len(inputs)
i++
buf = AppendWithLen(buf, inputs[index].v, len(inputs[index].b))
if !bytes.Equal(buf, inputs[index].b) {
b.Fatalf("expected to write %v, wrote %v", inputs[index].b, buf)
}
}
}
|
