mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-10-14 00:59:33 +00:00
e0aac68759
* [NOD-1128] Change message command to uint32 * [NOD-1128] Don't use iota * [NOD-1128] Remove redundant line
271 lines
8.1 KiB
Go
271 lines
8.1 KiB
Go
// Copyright (c) 2013-2016 The btcsuite developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package wire
|
|
|
|
import (
|
|
"bytes"
|
|
"github.com/pkg/errors"
|
|
"io"
|
|
"reflect"
|
|
"testing"
|
|
|
|
"github.com/davecgh/go-spew/spew"
|
|
"github.com/kaspanet/kaspad/util/daghash"
|
|
)
|
|
|
|
// TestGetData tests the MsgGetData API.
|
|
func TestGetData(t *testing.T) {
|
|
pver := ProtocolVersion
|
|
|
|
// Ensure the command is expected value.
|
|
wantCmd := MessageCommand(6)
|
|
msg := NewMsgGetData()
|
|
if cmd := msg.Command(); cmd != wantCmd {
|
|
t.Errorf("NewMsgGetData: wrong command - got %v want %v",
|
|
cmd, wantCmd)
|
|
}
|
|
|
|
// Ensure max payload is expected value for latest protocol version.
|
|
// Num inventory vectors (varInt) + max allowed inventory vectors.
|
|
wantPayload := uint32(4718601)
|
|
maxPayload := msg.MaxPayloadLength(pver)
|
|
if maxPayload != wantPayload {
|
|
t.Errorf("MaxPayloadLength: wrong max payload length for "+
|
|
"protocol version %d - got %v, want %v", pver,
|
|
maxPayload, wantPayload)
|
|
}
|
|
|
|
// Ensure inventory vectors are added properly.
|
|
hash := daghash.Hash{}
|
|
iv := NewInvVect(InvTypeBlock, &hash)
|
|
err := msg.AddInvVect(iv)
|
|
if err != nil {
|
|
t.Errorf("AddInvVect: %v", err)
|
|
}
|
|
if msg.InvList[0] != iv {
|
|
t.Errorf("AddInvVect: wrong invvect added - got %v, want %v",
|
|
spew.Sprint(msg.InvList[0]), spew.Sprint(iv))
|
|
}
|
|
|
|
// Ensure adding more than the max allowed inventory vectors per
|
|
// message returns an error.
|
|
for i := 0; i < MaxInvPerMsg; i++ {
|
|
err = msg.AddInvVect(iv)
|
|
}
|
|
if err == nil {
|
|
t.Errorf("AddInvVect: expected error on too many inventory " +
|
|
"vectors not received")
|
|
}
|
|
|
|
// Ensure creating the message with a size hint larger than the max
|
|
// works as expected.
|
|
msg = NewMsgGetDataSizeHint(MaxInvPerMsg + 1)
|
|
wantCap := MaxInvPerMsg
|
|
if cap(msg.InvList) != wantCap {
|
|
t.Errorf("NewMsgGetDataSizeHint: wrong cap for size hint - "+
|
|
"got %v, want %v", cap(msg.InvList), wantCap)
|
|
}
|
|
}
|
|
|
|
// TestGetDataWire tests the MsgGetData wire encode and decode for various
|
|
// numbers of inventory vectors and protocol versions.
|
|
func TestGetDataWire(t *testing.T) {
|
|
// Block 203707 hash.
|
|
hashStr := "3264bc2ac36a60840790ba1d475d01367e7c723da941069e9dc"
|
|
blockHash, err := daghash.NewHashFromStr(hashStr)
|
|
if err != nil {
|
|
t.Errorf("NewHashFromStr: %v", err)
|
|
}
|
|
|
|
// Transaction 1 of Block 203707 hash.
|
|
hashStr = "d28a3dc7392bf00a9855ee93dd9a81eff82a2c4fe57fbd42cfe71b487accfaf0"
|
|
txHash, err := daghash.NewHashFromStr(hashStr)
|
|
if err != nil {
|
|
t.Errorf("NewHashFromStr: %v", err)
|
|
}
|
|
|
|
iv := NewInvVect(InvTypeBlock, blockHash)
|
|
iv2 := NewInvVect(InvTypeTx, txHash)
|
|
|
|
// Empty MsgGetData message.
|
|
NoInv := NewMsgGetData()
|
|
NoInvEncoded := []byte{
|
|
0x00, // Varint for number of inventory vectors
|
|
}
|
|
|
|
// MsgGetData message with multiple inventory vectors.
|
|
MultiInv := NewMsgGetData()
|
|
MultiInv.AddInvVect(iv)
|
|
MultiInv.AddInvVect(iv2)
|
|
MultiInvEncoded := []byte{
|
|
0x02, // Varint for number of inv vectors
|
|
0x02, 0x00, 0x00, 0x00, // InvTypeBlock
|
|
0xdc, 0xe9, 0x69, 0x10, 0x94, 0xda, 0x23, 0xc7,
|
|
0xe7, 0x67, 0x13, 0xd0, 0x75, 0xd4, 0xa1, 0x0b,
|
|
0x79, 0x40, 0x08, 0xa6, 0x36, 0xac, 0xc2, 0x4b,
|
|
0x26, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // Block 203707 hash
|
|
0x01, 0x00, 0x00, 0x00, // InvTypeTx
|
|
0xf0, 0xfa, 0xcc, 0x7a, 0x48, 0x1b, 0xe7, 0xcf,
|
|
0x42, 0xbd, 0x7f, 0xe5, 0x4f, 0x2c, 0x2a, 0xf8,
|
|
0xef, 0x81, 0x9a, 0xdd, 0x93, 0xee, 0x55, 0x98,
|
|
0x0a, 0xf0, 0x2b, 0x39, 0xc7, 0x3d, 0x8a, 0xd2, // Tx 1 of block 203707 hash
|
|
}
|
|
|
|
tests := []struct {
|
|
in *MsgGetData // Message to encode
|
|
out *MsgGetData // Expected decoded message
|
|
buf []byte // Wire encoding
|
|
pver uint32 // Protocol version for wire encoding
|
|
}{
|
|
// Latest protocol version with no inv vectors.
|
|
{
|
|
NoInv,
|
|
NoInv,
|
|
NoInvEncoded,
|
|
ProtocolVersion,
|
|
},
|
|
|
|
// Latest protocol version with multiple inv vectors.
|
|
{
|
|
MultiInv,
|
|
MultiInv,
|
|
MultiInvEncoded,
|
|
ProtocolVersion,
|
|
},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
// Encode the message to wire format.
|
|
var buf bytes.Buffer
|
|
err := test.in.KaspaEncode(&buf, test.pver)
|
|
if err != nil {
|
|
t.Errorf("KaspaEncode #%d error %v", i, err)
|
|
continue
|
|
}
|
|
if !bytes.Equal(buf.Bytes(), test.buf) {
|
|
t.Errorf("KaspaEncode #%d\n got: %s want: %s", i,
|
|
spew.Sdump(buf.Bytes()), spew.Sdump(test.buf))
|
|
continue
|
|
}
|
|
|
|
// Decode the message from wire format.
|
|
var msg MsgGetData
|
|
rbuf := bytes.NewReader(test.buf)
|
|
err = msg.KaspaDecode(rbuf, test.pver)
|
|
if err != nil {
|
|
t.Errorf("KaspaDecode #%d error %v", i, err)
|
|
continue
|
|
}
|
|
if !reflect.DeepEqual(&msg, test.out) {
|
|
t.Errorf("KaspaDecode #%d\n got: %s want: %s", i,
|
|
spew.Sdump(msg), spew.Sdump(test.out))
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestGetDataWireErrors performs negative tests against wire encode and decode
|
|
// of MsgGetData to confirm error paths work correctly.
|
|
func TestGetDataWireErrors(t *testing.T) {
|
|
pver := ProtocolVersion
|
|
wireErr := &MessageError{}
|
|
|
|
// Block 203707 hash.
|
|
hashStr := "3264bc2ac36a60840790ba1d475d01367e7c723da941069e9dc"
|
|
blockHash, err := daghash.NewHashFromStr(hashStr)
|
|
if err != nil {
|
|
t.Fatalf("NewHashFromStr: %v", err)
|
|
}
|
|
|
|
iv := NewInvVect(InvTypeBlock, blockHash)
|
|
|
|
// Base message used to induce errors.
|
|
baseGetData := NewMsgGetData()
|
|
baseGetData.AddInvVect(iv)
|
|
baseGetDataEncoded := []byte{
|
|
0x02, // Varint for number of inv vectors
|
|
0x02, 0x00, 0x00, 0x00, // InvTypeBlock
|
|
0xdc, 0xe9, 0x69, 0x10, 0x94, 0xda, 0x23, 0xc7,
|
|
0xe7, 0x67, 0x13, 0xd0, 0x75, 0xd4, 0xa1, 0x0b,
|
|
0x79, 0x40, 0x08, 0xa6, 0x36, 0xac, 0xc2, 0x4b,
|
|
0x26, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // Block 203707 hash
|
|
}
|
|
|
|
// Message that forces an error by having more than the max allowed inv
|
|
// vectors.
|
|
maxGetData := NewMsgGetData()
|
|
for i := 0; i < MaxInvPerMsg; i++ {
|
|
maxGetData.AddInvVect(iv)
|
|
}
|
|
maxGetData.InvList = append(maxGetData.InvList, iv)
|
|
|
|
w := &bytes.Buffer{}
|
|
err = WriteVarInt(w, MaxInvPerMsg+1)
|
|
if err != nil {
|
|
t.Fatalf("WriteVarInt: %s", err)
|
|
}
|
|
maxGetDataEncoded := w.Bytes()
|
|
|
|
tests := []struct {
|
|
in *MsgGetData // Value to encode
|
|
buf []byte // Wire encoding
|
|
pver uint32 // Protocol version for wire encoding
|
|
max int // Max size of fixed buffer to induce errors
|
|
writeErr error // Expected write error
|
|
readErr error // Expected read error
|
|
}{
|
|
// Latest protocol version with intentional read/write errors.
|
|
// Force error in inventory vector count
|
|
{baseGetData, baseGetDataEncoded, pver, 0, io.ErrShortWrite, io.EOF},
|
|
// Force error in inventory list.
|
|
{baseGetData, baseGetDataEncoded, pver, 1, io.ErrShortWrite, io.EOF},
|
|
// Force error with greater than max inventory vectors.
|
|
{maxGetData, maxGetDataEncoded, pver, 5, wireErr, wireErr},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
// Encode to wire format.
|
|
w := newFixedWriter(test.max)
|
|
err := test.in.KaspaEncode(w, test.pver)
|
|
|
|
// For errors which are not of type MessageError, check them for
|
|
// equality. If the error is a MessageError, check only if it's
|
|
// the expected type.
|
|
if msgErr := &(MessageError{}); !errors.As(err, &msgErr) {
|
|
if !errors.Is(err, test.writeErr) {
|
|
t.Errorf("KaspaEncode #%d wrong error got: %v, "+
|
|
"want: %v", i, err, test.writeErr)
|
|
continue
|
|
}
|
|
} else if reflect.TypeOf(msgErr) != reflect.TypeOf(test.writeErr) {
|
|
t.Errorf("ReadMessage #%d wrong error type got: %T, "+
|
|
"want: %T", i, msgErr, test.writeErr)
|
|
continue
|
|
}
|
|
|
|
// Decode from wire format.
|
|
var msg MsgGetData
|
|
r := newFixedReader(test.max, test.buf)
|
|
err = msg.KaspaDecode(r, test.pver)
|
|
|
|
// For errors which are not of type MessageError, check them for
|
|
// equality. If the error is a MessageError, check only if it's
|
|
// the expected type.
|
|
if msgErr := &(MessageError{}); !errors.As(err, &msgErr) {
|
|
if !errors.Is(err, test.readErr) {
|
|
t.Errorf("KaspaDecode #%d wrong error got: %v, "+
|
|
"want: %v", i, err, test.readErr)
|
|
continue
|
|
}
|
|
} else if reflect.TypeOf(msgErr) != reflect.TypeOf(test.readErr) {
|
|
t.Errorf("ReadMessage #%d wrong error type got: %T, "+
|
|
"want: %T", i, msgErr, test.readErr)
|
|
continue
|
|
}
|
|
}
|
|
}
|