vom/binary_util_test.go

// Copyright 2015 The Vanadium 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 vom

import (
	"bytes"
	"fmt"
	"io"
	"math"
	"reflect"
	"strings"
	"testing"
)

func hex2Bin(t *testing.T, hex string) []byte {
	binStr, err := binFromHexPat(hex)
	if err != nil {
		t.Fatalf("error converting %q to binary: %v", hex, err)
	}
	return []byte(binStr)
}

func TestBinaryEncodeDecode(t *testing.T) {
	tests := []struct {
		v   interface{}
		hex string
	}{
		{false, "00"},
		{true, "01"},

		{byte(0x80), "80"},
		{byte(0xbf), "bf"},
		{byte(0xc0), "c0"},
		{byte(0xdf), "df"},
		{byte(0xe0), "e0"},
		{byte(0xef), "ef"},

		{uint64(0), "00"},
		{uint64(1), "01"},
		{uint64(2), "02"},
		{uint64(127), "7f"},
		{uint64(128), "ff80"},
		{uint64(255), "ffff"},
		{uint64(256), "fe0100"},
		{uint64(257), "fe0101"},
		{uint64(0xffff), "feffff"},
		{uint64(0xffffff), "fdffffff"},
		{uint64(0xffffffff), "fcffffffff"},
		{uint64(0xffffffffff), "fbffffffffff"},
		{uint64(0xffffffffffff), "faffffffffffff"},
		{uint64(0xffffffffffffff), "f9ffffffffffffff"},
		{uint64(0xffffffffffffffff), "f8ffffffffffffffff"},

		{int64(0), "00"},
		{int64(1), "02"},
		{int64(2), "04"},
		{int64(63), "7e"},
		{int64(64), "ff80"},
		{int64(65), "ff82"},
		{int64(127), "fffe"},
		{int64(128), "fe0100"},
		{int64(129), "fe0102"},
		{int64(math.MaxInt16), "fefffe"},
		{int64(math.MaxInt32), "fcfffffffe"},
		{int64(math.MaxInt64), "f8fffffffffffffffe"},

		{int64(-1), "01"},
		{int64(-2), "03"},
		{int64(-64), "7f"},
		{int64(-65), "ff81"},
		{int64(-66), "ff83"},
		{int64(-128), "ffff"},
		{int64(-129), "fe0101"},
		{int64(-130), "fe0103"},
		{int64(math.MinInt16), "feffff"},
		{int64(math.MinInt32), "fcffffffff"},
		{int64(math.MinInt64), "f8ffffffffffffffff"},

		{float64(0), "00"},
		{float64(1), "fef03f"},
		{float64(17), "fe3140"},
		{float64(18), "fe3240"},

		{"", "00"},
		{"abc", "03616263"},
		{"defghi", "06646566676869"},
	}
	for _, test := range tests {
		// Test encode
		var byteBuf bytes.Buffer
		sb := newSwitchedEncbuf(&byteBuf, 0x81)
		msgID := int64(0x12)
		sb.StartMessage(false, false, false, msgID)
		switch val := test.v.(type) {
		case byte:
			binaryEncodeControl(sb, val)
		case bool:
			binaryEncodeBool(sb, val)
		case uint64:
			binaryEncodeUint(sb, val)
		case int64:
			binaryEncodeInt(sb, val)
		case float64:
			binaryEncodeFloat(sb, val)
		case string:
			binaryEncodeString(sb, val)
		}
		if err := sb.chunked.finishChunk(true); err != nil {
			t.Fatalf("Error finishing chunk\n")
		}
		expectedHex := fmt.Sprintf("%x", msgID*2) + test.hex // message id is prepended to hex
		if got, want := fmt.Sprintf("%x", byteBuf.Bytes()), expectedHex; got != want {
			t.Errorf("binary encode %T(%v): GOT 0x%v WANT 0x%v", test.v, test.v, got, want)
		}
		// Test decode
		var bin string
		if _, err := fmt.Sscanf(test.hex, "%x", &bin); err != nil {
			t.Errorf("couldn't scan 0x%v as hex: %v", test.hex, err)
			continue
		}

		mr := newBinaryUtilTestMessageReader(strings.NewReader(bin))
		mr2 := newBinaryUtilTestMessageReader(strings.NewReader(bin))
		mr3 := newBinaryUtilTestMessageReader(strings.NewReader(bin))
		decbuf := newDecbuf(strings.NewReader(bin))
		decbuf2 := newDecbuf(strings.NewReader(bin))
		var v, v2 interface{}
		var err, err2, err3 error
		var vmr, vmr2 interface{}
		var errmr, errmr2, errmr3 error
		switch test.v.(type) {
		case byte:
			_, v, err = decbufBinaryDecodeUintWithControl(decbuf)
			decbuf2.Skip(1)
			vmr, err = binaryPeekControl(mr)
			mr.Skip(1)
			_, vmr2, errmr2 = binaryDecodeUintWithControl(mr2)
			errmr3 = binaryIgnoreUint(mr3)
		case bool:
			decbuf.Skip(1)
			decbuf2.Skip(1)
			vmr, errmr = binaryDecodeBool(mr)
			errmr2 = binaryIgnoreUint(mr2)
		case uint64:
			v, err = decbufBinaryDecodeUint(decbuf)
			v2, _, err2 = decbufBinaryDecodeUintWithControl(decbuf2)
			vmr, errmr = binaryDecodeUint(mr)
			vmr2, _, errmr2 = binaryDecodeUintWithControl(mr2)
			errmr3 = binaryIgnoreUint(mr3)
		case int64:
			v, err = decbufBinaryDecodeInt(decbuf)
			v2, err2 = decbufBinaryDecodeInt(decbuf2)
			vmr, errmr = binaryDecodeInt(mr)
			errmr2 = binaryIgnoreUint(mr2)
		case float64:
			decbufBinaryDecodeUint(decbuf)  // skip
			decbufBinaryDecodeUint(decbuf2) // skip
			vmr, errmr = binaryDecodeFloat(mr)
			errmr2 = binaryIgnoreUint(mr2)
		case string:
			l, _ := decbufBinaryDecodeUint(decbuf)
			decbuf.Skip(int(l))
			l, _ = decbufBinaryDecodeUint(decbuf2)
			decbuf2.Skip(int(l))
			vmr, errmr = binaryDecodeString(mr)
			errmr2 = binaryIgnoreString(mr2)
		}
		if v2 != nil && v != v2 {
			t.Errorf("binary decode %T(0x%v) differently: %v %v", test.v, test.hex, v, v2)
			continue
		}
		if vmr2 != nil && vmr != vmr2 {
			t.Errorf("message reader binary decode %T(0x%v) differently: %v %v", test.v, test.hex, v, v2)
			continue
		}
		if err != nil || err2 != nil || err3 != nil {
			t.Errorf("binary decode %T(0x%v): %v %v %v", test.v, test.hex, err, err2, err3)
			continue
		}
		if errmr != nil || errmr2 != nil || errmr3 != nil {
			t.Errorf("message reader binary decode %T(0x%v): %v %v %v", test.v, test.hex, errmr, errmr2, errmr3)
			continue
		}
		if b, err := decbuf.ReadByte(); err != io.EOF {
			t.Errorf("binary decode %T(0x%v) leftover byte r=%x", test.v, test.hex, b)
			continue
		}
		if b, err := decbuf2.ReadByte(); err != io.EOF {
			t.Errorf("binary decode %T(0x%v) leftover byte r2=%x", test.v, test.hex, b)
			continue
		}
		if v != nil {
			if !reflect.DeepEqual(v, test.v) {
				t.Errorf("binary decode %T(0x%v): GOT %v WANT %v", test.v, test.hex, v, test.v)
			}
		}
		if vmr != nil {
			if !reflect.DeepEqual(vmr, test.v) {
				t.Errorf("binary decode %T(0x%v): GOT %v WANT %v", test.v, test.hex, vmr, test.v)
			}
		}
	}
}

func newBinaryUtilTestMessageReader(r io.Reader) *messageReader {
	buf := newDecbuf(r)
	buf.SetLimit(1000)
	return newMessageReader(buf)
}