blob: 1eb169cdee5bc6829d89f4d32a7d8b03dbe3693c [file] [log] [blame]
// Copyright 2009 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.
package hex
import (
"bytes"
"fmt"
"io"
"strings"
"testing"
)
type encDecTest struct {
enc string
dec []byte
}
var encDecTests = []encDecTest{
{"", []byte{}},
{"0001020304050607", []byte{0, 1, 2, 3, 4, 5, 6, 7}},
{"08090a0b0c0d0e0f", []byte{8, 9, 10, 11, 12, 13, 14, 15}},
{"f0f1f2f3f4f5f6f7", []byte{0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7}},
{"f8f9fafbfcfdfeff", []byte{0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff}},
{"67", []byte{'g'}},
{"e3a1", []byte{0xe3, 0xa1}},
}
func TestEncode(t *testing.T) {
for i, test := range encDecTests {
dst := make([]byte, EncodedLen(len(test.dec)))
n := Encode(dst, test.dec)
if n != len(dst) {
t.Errorf("#%d: bad return value: got: %d want: %d", i, n, len(dst))
}
if string(dst) != test.enc {
t.Errorf("#%d: got: %#v want: %#v", i, dst, test.enc)
}
}
}
func TestDecode(t *testing.T) {
// Case for decoding uppercase hex characters, since
// Encode always uses lowercase.
decTests := append(encDecTests, encDecTest{"F8F9FAFBFCFDFEFF", []byte{0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff}})
for i, test := range decTests {
dst := make([]byte, DecodedLen(len(test.enc)))
n, err := Decode(dst, []byte(test.enc))
if err != nil {
t.Errorf("#%d: bad return value: got:%d want:%d", i, n, len(dst))
} else if !bytes.Equal(dst, test.dec) {
t.Errorf("#%d: got: %#v want: %#v", i, dst, test.dec)
}
}
}
func TestDecode_tooFewDstBytes(t *testing.T) {
dst := make([]byte, 1)
src := []byte{'0', '1', '2', '3'}
_, err := Decode(dst, src)
if err == nil {
t.Errorf("expected Decode to return an error, but it returned none")
}
}
func TestEncodeToString(t *testing.T) {
for i, test := range encDecTests {
s := EncodeToString(test.dec)
if s != test.enc {
t.Errorf("#%d got:%s want:%s", i, s, test.enc)
}
}
}
func TestDecodeString(t *testing.T) {
for i, test := range encDecTests {
dst, err := DecodeString(test.enc)
if err != nil {
t.Errorf("#%d: unexpected err value: %s", i, err)
continue
}
if !bytes.Equal(dst, test.dec) {
t.Errorf("#%d: got: %#v want: #%v", i, dst, test.dec)
}
}
}
var errTests = []struct {
in string
out string
err error
}{
{"", "", nil},
{"0", "", ErrLength},
{"zd4aa", "", InvalidByteError('z')},
{"d4aaz", "\xd4\xaa", InvalidByteError('z')},
{"30313", "01", ErrLength},
{"0g", "", InvalidByteError('g')},
{"00gg", "\x00", InvalidByteError('g')},
{"0\x01", "", InvalidByteError('\x01')},
{"ffeed", "\xff\xee", ErrLength},
}
func TestDecodeErr(t *testing.T) {
for _, tt := range errTests {
out := make([]byte, len(tt.in)+10)
n, err := Decode(out, []byte(tt.in))
if string(out[:n]) != tt.out || err != tt.err {
t.Errorf("Decode(%q) = %q, %v, want %q, %v", tt.in, string(out[:n]), err, tt.out, tt.err)
}
}
}
func TestDecodeStringErr(t *testing.T) {
for _, tt := range errTests {
out, err := DecodeString(tt.in)
if string(out) != tt.out || err != tt.err {
t.Errorf("DecodeString(%q) = %q, %v, want %q, %v", tt.in, out, err, tt.out, tt.err)
}
}
}
func TestEncoderDecoder(t *testing.T) {
for _, multiplier := range []int{1, 128, 192} {
for _, test := range encDecTests {
input := bytes.Repeat(test.dec, multiplier)
output := strings.Repeat(test.enc, multiplier)
var buf bytes.Buffer
enc := NewEncoder(&buf)
r := struct{ io.Reader }{bytes.NewReader(input)} // io.Reader only; not io.WriterTo
if n, err := io.CopyBuffer(enc, r, make([]byte, 7)); n != int64(len(input)) || err != nil {
t.Errorf("encoder.Write(%q*%d) = (%d, %v), want (%d, nil)", test.dec, multiplier, n, err, len(input))
continue
}
if encDst := buf.String(); encDst != output {
t.Errorf("buf(%q*%d) = %v, want %v", test.dec, multiplier, encDst, output)
continue
}
dec := NewDecoder(&buf)
var decBuf bytes.Buffer
w := struct{ io.Writer }{&decBuf} // io.Writer only; not io.ReaderFrom
if _, err := io.CopyBuffer(w, dec, make([]byte, 7)); err != nil || decBuf.Len() != len(input) {
t.Errorf("decoder.Read(%q*%d) = (%d, %v), want (%d, nil)", test.enc, multiplier, decBuf.Len(), err, len(input))
}
if !bytes.Equal(decBuf.Bytes(), input) {
t.Errorf("decBuf(%q*%d) = %v, want %v", test.dec, multiplier, decBuf.Bytes(), input)
continue
}
}
}
}
func TestDecoderErr(t *testing.T) {
for _, tt := range errTests {
dec := NewDecoder(strings.NewReader(tt.in))
out, err := io.ReadAll(dec)
wantErr := tt.err
// Decoder is reading from stream, so it reports io.ErrUnexpectedEOF instead of ErrLength.
if wantErr == ErrLength {
wantErr = io.ErrUnexpectedEOF
}
if string(out) != tt.out || err != wantErr {
t.Errorf("NewDecoder(%q) = %q, %v, want %q, %v", tt.in, out, err, tt.out, wantErr)
}
}
}
func TestDumper(t *testing.T) {
var in [40]byte
for i := range in {
in[i] = byte(i + 30)
}
for stride := 1; stride < len(in); stride++ {
var out bytes.Buffer
dumper := Dumper(&out)
done := 0
for done < len(in) {
todo := done + stride
if todo > len(in) {
todo = len(in)
}
dumper.Write(in[done:todo])
done = todo
}
dumper.Close()
if !bytes.Equal(out.Bytes(), expectedHexDump) {
t.Errorf("stride: %d failed. got:\n%s\nwant:\n%s", stride, out.Bytes(), expectedHexDump)
}
}
}
func TestDumper_doubleclose(t *testing.T) {
var out strings.Builder
dumper := Dumper(&out)
dumper.Write([]byte(`gopher`))
dumper.Close()
dumper.Close()
dumper.Write([]byte(`gopher`))
dumper.Close()
expected := "00000000 67 6f 70 68 65 72 |gopher|\n"
if out.String() != expected {
t.Fatalf("got:\n%#v\nwant:\n%#v", out.String(), expected)
}
}
func TestDumper_earlyclose(t *testing.T) {
var out strings.Builder
dumper := Dumper(&out)
dumper.Close()
dumper.Write([]byte(`gopher`))
expected := ""
if out.String() != expected {
t.Fatalf("got:\n%#v\nwant:\n%#v", out.String(), expected)
}
}
func TestDump(t *testing.T) {
var in [40]byte
for i := range in {
in[i] = byte(i + 30)
}
out := []byte(Dump(in[:]))
if !bytes.Equal(out, expectedHexDump) {
t.Errorf("got:\n%s\nwant:\n%s", out, expectedHexDump)
}
}
var expectedHexDump = []byte(`00000000 1e 1f 20 21 22 23 24 25 26 27 28 29 2a 2b 2c 2d |.. !"#$%&'()*+,-|
00000010 2e 2f 30 31 32 33 34 35 36 37 38 39 3a 3b 3c 3d |./0123456789:;<=|
00000020 3e 3f 40 41 42 43 44 45 |>?@ABCDE|
`)
var sink []byte
func BenchmarkEncode(b *testing.B) {
for _, size := range []int{256, 1024, 4096, 16384} {
src := bytes.Repeat([]byte{2, 3, 5, 7, 9, 11, 13, 17}, size/8)
sink = make([]byte, 2*size)
b.Run(fmt.Sprintf("%v", size), func(b *testing.B) {
b.SetBytes(int64(size))
for i := 0; i < b.N; i++ {
Encode(sink, src)
}
})
}
}
func BenchmarkDecode(b *testing.B) {
for _, size := range []int{256, 1024, 4096, 16384} {
src := bytes.Repeat([]byte{'2', 'b', '7', '4', '4', 'f', 'a', 'a'}, size/8)
sink = make([]byte, size/2)
b.Run(fmt.Sprintf("%v", size), func(b *testing.B) {
b.SetBytes(int64(size))
for i := 0; i < b.N; i++ {
Decode(sink, src)
}
})
}
}
func BenchmarkDump(b *testing.B) {
for _, size := range []int{256, 1024, 4096, 16384} {
src := bytes.Repeat([]byte{2, 3, 5, 7, 9, 11, 13, 17}, size/8)
b.Run(fmt.Sprintf("%v", size), func(b *testing.B) {
b.SetBytes(int64(size))
for i := 0; i < b.N; i++ {
Dump(src)
}
})
}
}