1// Copyright 2011 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
5package fnv
6
7import (
8	"bytes"
9	"encoding"
10	"encoding/binary"
11	"hash"
12	"io"
13	"testing"
14)
15
16type golden struct {
17	out       []byte
18	in        string
19	halfState string // marshaled hash state after first half of in written, used by TestGoldenMarshal
20}
21
22var golden32 = []golden{
23	{[]byte{0x81, 0x1c, 0x9d, 0xc5}, "", "fnv\x01\x81\x1c\x9d\xc5"},
24	{[]byte{0x05, 0x0c, 0x5d, 0x7e}, "a", "fnv\x01\x81\x1c\x9d\xc5"},
25	{[]byte{0x70, 0x77, 0x2d, 0x38}, "ab", "fnv\x01\x05\f]~"},
26	{[]byte{0x43, 0x9c, 0x2f, 0x4b}, "abc", "fnv\x01\x05\f]~"},
27}
28
29var golden32a = []golden{
30	{[]byte{0x81, 0x1c, 0x9d, 0xc5}, "", "fnv\x02\x81\x1c\x9d\xc5"},
31	{[]byte{0xe4, 0x0c, 0x29, 0x2c}, "a", "fnv\x02\x81\x1c\x9d\xc5"},
32	{[]byte{0x4d, 0x25, 0x05, 0xca}, "ab", "fnv\x02\xe4\f),"},
33	{[]byte{0x1a, 0x47, 0xe9, 0x0b}, "abc", "fnv\x02\xe4\f),"},
34}
35
36var golden64 = []golden{
37	{[]byte{0xcb, 0xf2, 0x9c, 0xe4, 0x84, 0x22, 0x23, 0x25}, "", "fnv\x03\xcb\xf2\x9c\xe4\x84\"#%"},
38	{[]byte{0xaf, 0x63, 0xbd, 0x4c, 0x86, 0x01, 0xb7, 0xbe}, "a", "fnv\x03\xcb\xf2\x9c\xe4\x84\"#%"},
39	{[]byte{0x08, 0x32, 0x67, 0x07, 0xb4, 0xeb, 0x37, 0xb8}, "ab", "fnv\x03\xafc\xbdL\x86\x01\xb7\xbe"},
40	{[]byte{0xd8, 0xdc, 0xca, 0x18, 0x6b, 0xaf, 0xad, 0xcb}, "abc", "fnv\x03\xafc\xbdL\x86\x01\xb7\xbe"},
41}
42
43var golden64a = []golden{
44	{[]byte{0xcb, 0xf2, 0x9c, 0xe4, 0x84, 0x22, 0x23, 0x25}, "", "fnv\x04\xcb\xf2\x9c\xe4\x84\"#%"},
45	{[]byte{0xaf, 0x63, 0xdc, 0x4c, 0x86, 0x01, 0xec, 0x8c}, "a", "fnv\x04\xcb\xf2\x9c\xe4\x84\"#%"},
46	{[]byte{0x08, 0x9c, 0x44, 0x07, 0xb5, 0x45, 0x98, 0x6a}, "ab", "fnv\x04\xafc\xdcL\x86\x01\xec\x8c"},
47	{[]byte{0xe7, 0x1f, 0xa2, 0x19, 0x05, 0x41, 0x57, 0x4b}, "abc", "fnv\x04\xafc\xdcL\x86\x01\xec\x8c"},
48}
49
50var golden128 = []golden{
51	{[]byte{0x6c, 0x62, 0x27, 0x2e, 0x07, 0xbb, 0x01, 0x42, 0x62, 0xb8, 0x21, 0x75, 0x62, 0x95, 0xc5, 0x8d}, "", "fnv\x05lb'.\a\xbb\x01Bb\xb8!ub\x95ō"},
52	{[]byte{0xd2, 0x28, 0xcb, 0x69, 0x10, 0x1a, 0x8c, 0xaf, 0x78, 0x91, 0x2b, 0x70, 0x4e, 0x4a, 0x14, 0x1e}, "a", "fnv\x05lb'.\a\xbb\x01Bb\xb8!ub\x95ō"},
53	{[]byte{0x8, 0x80, 0x94, 0x5a, 0xee, 0xab, 0x1b, 0xe9, 0x5a, 0xa0, 0x73, 0x30, 0x55, 0x26, 0xc0, 0x88}, "ab", "fnv\x05\xd2(\xcbi\x10\x1a\x8c\xafx\x91+pNJ\x14\x1e"},
54	{[]byte{0xa6, 0x8b, 0xb2, 0xa4, 0x34, 0x8b, 0x58, 0x22, 0x83, 0x6d, 0xbc, 0x78, 0xc6, 0xae, 0xe7, 0x3b}, "abc", "fnv\x05\xd2(\xcbi\x10\x1a\x8c\xafx\x91+pNJ\x14\x1e"},
55}
56
57var golden128a = []golden{
58	{[]byte{0x6c, 0x62, 0x27, 0x2e, 0x07, 0xbb, 0x01, 0x42, 0x62, 0xb8, 0x21, 0x75, 0x62, 0x95, 0xc5, 0x8d}, "", "fnv\x06lb'.\a\xbb\x01Bb\xb8!ub\x95ō"},
59	{[]byte{0xd2, 0x28, 0xcb, 0x69, 0x6f, 0x1a, 0x8c, 0xaf, 0x78, 0x91, 0x2b, 0x70, 0x4e, 0x4a, 0x89, 0x64}, "a", "fnv\x06lb'.\a\xbb\x01Bb\xb8!ub\x95ō"},
60	{[]byte{0x08, 0x80, 0x95, 0x44, 0xbb, 0xab, 0x1b, 0xe9, 0x5a, 0xa0, 0x73, 0x30, 0x55, 0xb6, 0x9a, 0x62}, "ab", "fnv\x06\xd2(\xcbio\x1a\x8c\xafx\x91+pNJ\x89d"},
61	{[]byte{0xa6, 0x8d, 0x62, 0x2c, 0xec, 0x8b, 0x58, 0x22, 0x83, 0x6d, 0xbc, 0x79, 0x77, 0xaf, 0x7f, 0x3b}, "abc", "fnv\x06\xd2(\xcbio\x1a\x8c\xafx\x91+pNJ\x89d"},
62}
63
64func TestGolden32(t *testing.T) {
65	testGolden(t, New32(), golden32)
66}
67
68func TestGolden32a(t *testing.T) {
69	testGolden(t, New32a(), golden32a)
70}
71
72func TestGolden64(t *testing.T) {
73	testGolden(t, New64(), golden64)
74}
75
76func TestGolden64a(t *testing.T) {
77	testGolden(t, New64a(), golden64a)
78}
79
80func TestGolden128(t *testing.T) {
81	testGolden(t, New128(), golden128)
82}
83
84func TestGolden128a(t *testing.T) {
85	testGolden(t, New128a(), golden128a)
86}
87
88func testGolden(t *testing.T, hash hash.Hash, gold []golden) {
89	for _, g := range gold {
90		hash.Reset()
91		done, error := hash.Write([]byte(g.in))
92		if error != nil {
93			t.Fatalf("write error: %s", error)
94		}
95		if done != len(g.in) {
96			t.Fatalf("wrote only %d out of %d bytes", done, len(g.in))
97		}
98		if actual := hash.Sum(nil); !bytes.Equal(g.out, actual) {
99			t.Errorf("hash(%q) = 0x%x want 0x%x", g.in, actual, g.out)
100		}
101	}
102}
103
104func TestGoldenMarshal(t *testing.T) {
105	tests := []struct {
106		name    string
107		newHash func() hash.Hash
108		gold    []golden
109	}{
110		{"32", func() hash.Hash { return New32() }, golden32},
111		{"32a", func() hash.Hash { return New32a() }, golden32a},
112		{"64", func() hash.Hash { return New64() }, golden64},
113		{"64a", func() hash.Hash { return New64a() }, golden64a},
114		{"128", func() hash.Hash { return New128() }, golden128},
115		{"128a", func() hash.Hash { return New128a() }, golden128a},
116	}
117	for _, tt := range tests {
118		t.Run(tt.name, func(t *testing.T) {
119			for _, g := range tt.gold {
120				h := tt.newHash()
121				h2 := tt.newHash()
122
123				io.WriteString(h, g.in[:len(g.in)/2])
124
125				state, err := h.(encoding.BinaryMarshaler).MarshalBinary()
126				if err != nil {
127					t.Errorf("could not marshal: %v", err)
128					continue
129				}
130
131				if string(state) != g.halfState {
132					t.Errorf("checksum(%q) state = %q, want %q", g.in, state, g.halfState)
133					continue
134				}
135
136				if err := h2.(encoding.BinaryUnmarshaler).UnmarshalBinary(state); err != nil {
137					t.Errorf("could not unmarshal: %v", err)
138					continue
139				}
140
141				io.WriteString(h, g.in[len(g.in)/2:])
142				io.WriteString(h2, g.in[len(g.in)/2:])
143
144				if actual, actual2 := h.Sum(nil), h2.Sum(nil); !bytes.Equal(actual, actual2) {
145					t.Errorf("hash(%q) = 0x%x != marshaled 0x%x", g.in, actual, actual2)
146				}
147			}
148		})
149	}
150}
151
152func TestIntegrity32(t *testing.T) {
153	testIntegrity(t, New32())
154}
155
156func TestIntegrity32a(t *testing.T) {
157	testIntegrity(t, New32a())
158}
159
160func TestIntegrity64(t *testing.T) {
161	testIntegrity(t, New64())
162}
163
164func TestIntegrity64a(t *testing.T) {
165	testIntegrity(t, New64a())
166}
167func TestIntegrity128(t *testing.T) {
168	testIntegrity(t, New128())
169}
170
171func TestIntegrity128a(t *testing.T) {
172	testIntegrity(t, New128a())
173}
174
175func testIntegrity(t *testing.T, h hash.Hash) {
176	data := []byte{'1', '2', 3, 4, 5}
177	h.Write(data)
178	sum := h.Sum(nil)
179
180	if size := h.Size(); size != len(sum) {
181		t.Fatalf("Size()=%d but len(Sum())=%d", size, len(sum))
182	}
183
184	if a := h.Sum(nil); !bytes.Equal(sum, a) {
185		t.Fatalf("first Sum()=0x%x, second Sum()=0x%x", sum, a)
186	}
187
188	h.Reset()
189	h.Write(data)
190	if a := h.Sum(nil); !bytes.Equal(sum, a) {
191		t.Fatalf("Sum()=0x%x, but after Reset() Sum()=0x%x", sum, a)
192	}
193
194	h.Reset()
195	h.Write(data[:2])
196	h.Write(data[2:])
197	if a := h.Sum(nil); !bytes.Equal(sum, a) {
198		t.Fatalf("Sum()=0x%x, but with partial writes, Sum()=0x%x", sum, a)
199	}
200
201	switch h.Size() {
202	case 4:
203		sum32 := h.(hash.Hash32).Sum32()
204		if sum32 != binary.BigEndian.Uint32(sum) {
205			t.Fatalf("Sum()=0x%x, but Sum32()=0x%x", sum, sum32)
206		}
207	case 8:
208		sum64 := h.(hash.Hash64).Sum64()
209		if sum64 != binary.BigEndian.Uint64(sum) {
210			t.Fatalf("Sum()=0x%x, but Sum64()=0x%x", sum, sum64)
211		}
212	case 16:
213		// There's no Sum128 function, so we don't need to test anything here.
214	}
215}
216
217func BenchmarkFnv32KB(b *testing.B) {
218	benchmarkKB(b, New32())
219}
220
221func BenchmarkFnv32aKB(b *testing.B) {
222	benchmarkKB(b, New32a())
223}
224
225func BenchmarkFnv64KB(b *testing.B) {
226	benchmarkKB(b, New64())
227}
228
229func BenchmarkFnv64aKB(b *testing.B) {
230	benchmarkKB(b, New64a())
231}
232
233func BenchmarkFnv128KB(b *testing.B) {
234	benchmarkKB(b, New128())
235}
236
237func BenchmarkFnv128aKB(b *testing.B) {
238	benchmarkKB(b, New128a())
239}
240
241func benchmarkKB(b *testing.B, h hash.Hash) {
242	b.SetBytes(1024)
243	data := make([]byte, 1024)
244	for i := range data {
245		data[i] = byte(i)
246	}
247	in := make([]byte, 0, h.Size())
248
249	b.ResetTimer()
250	for i := 0; i < b.N; i++ {
251		h.Reset()
252		h.Write(data)
253		h.Sum(in)
254	}
255}
256