Add negative tests for MsgAddr.

This commit adds tests for the error paths when encoded and decoding
MsgAddr.

msgaddr_test.go

@@ -8,6 +8,7 @@ import (
 	"bytes"
 	"github.com/conformal/btcwire"
 	"github.com/davecgh/go-spew/spew"
+	"io"
 	"net"
 	"reflect"
 	"testing"
@@ -203,3 +204,117 @@ func TestAddrWire(t *testing.T) {
 		}
 	}
 }
+
+// TestAddrWireErrors performs negative tests against wire encode and decode
+// of MsgAddr to confirm error paths work correctly.
+func TestAddrWireErrors(t *testing.T) {
+	pver := btcwire.ProtocolVersion
+	pverMA := btcwire.MultipleAddressVersion
+	btcwireErr := &btcwire.MessageError{}
+
+	// A couple of NetAddresses to use for testing.
+	na := &btcwire.NetAddress{
+		Timestamp: time.Unix(0x495fab29, 0), // 2009-01-03 12:15:05 -0600 CST
+		Services:  btcwire.SFNodeNetwork,
+		IP:        net.ParseIP("127.0.0.1"),
+		Port:      8333,
+	}
+	na2 := &btcwire.NetAddress{
+		Timestamp: time.Unix(0x495fab29, 0), // 2009-01-03 12:15:05 -0600 CST
+		Services:  btcwire.SFNodeNetwork,
+		IP:        net.ParseIP("192.168.0.1"),
+		Port:      8334,
+	}
+
+	// Address message with multiple addresses.
+	baseAddr := btcwire.NewMsgAddr()
+	baseAddr.AddAddresses(na, na2)
+	baseAddrEncoded := []byte{
+		0x02,                   // Varint for number of addresses
+		0x29, 0xab, 0x5f, 0x49, // Timestamp
+		0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // SFNodeNetwork
+		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+		0x00, 0x00, 0xff, 0xff, 0x7f, 0x00, 0x00, 0x01, // IP 127.0.0.1
+		0x20, 0x8d, // Port 8333 in big-endian
+		0x29, 0xab, 0x5f, 0x49, // Timestamp
+		0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // SFNodeNetwork
+		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+		0x00, 0x00, 0xff, 0xff, 0xc0, 0xa8, 0x00, 0x01, // IP 192.168.0.1
+		0x20, 0x8e, // Port 8334 in big-endian
+
+	}
+
+	// Message that forces an error by having more than the max allowed
+	// addresses.
+	maxAddr := btcwire.NewMsgAddr()
+	for i := 0; i < btcwire.MaxAddrPerMsg; i++ {
+		maxAddr.AddAddress(na)
+	}
+	maxAddr.AddrList = append(maxAddr.AddrList, na)
+	maxAddrEncoded := []byte{
+		0xfd, 0x03, 0xe9, // Varint for number of addresses (1001)
+	}
+
+	tests := []struct {
+		in       *btcwire.MsgAddr // 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 addresses count
+		{baseAddr, baseAddrEncoded, pver, 0, io.ErrShortWrite, io.EOF},
+		// Force error in address list.
+		{baseAddr, baseAddrEncoded, pver, 1, io.ErrShortWrite, io.EOF},
+		// Force error with greater than max inventory vectors.
+		{maxAddr, maxAddrEncoded, pver, 3, btcwireErr, btcwireErr},
+		// Force error with greater than max inventory vectors for
+		// protocol versions before multiple addresses were allowed.
+		{maxAddr, maxAddrEncoded, pverMA - 1, 3, btcwireErr, btcwireErr},
+	}
+
+	t.Logf("Running %d tests", len(tests))
+	for i, test := range tests {
+		// Encode to wire format.
+		w := newFixedWriter(test.max)
+		err := test.in.BtcEncode(w, test.pver)
+		if reflect.TypeOf(err) != reflect.TypeOf(test.writeErr) {
+			t.Errorf("BtcEncode #%d wrong error got: %v, want: %v",
+				i, err, test.writeErr)
+			continue
+		}
+
+		// For errors which are not of type btcwire.MessageError, check
+		// them for equality.
+		if _, ok := err.(*btcwire.MessageError); !ok {
+			if err != test.writeErr {
+				t.Errorf("BtcEncode #%d wrong error got: %v, "+
+					"want: %v", i, err, test.writeErr)
+				continue
+			}
+		}
+
+		// Decode from wire format.
+		var msg btcwire.MsgAddr
+		r := newFixedReader(test.max, test.buf)
+		err = msg.BtcDecode(r, test.pver)
+		if reflect.TypeOf(err) != reflect.TypeOf(test.readErr) {
+			t.Errorf("BtcDecode #%d wrong error got: %v, want: %v",
+				i, err, test.readErr)
+			continue
+		}
+
+		// For errors which are not of type btcwire.MessageError, check
+		// them for equality.
+		if _, ok := err.(*btcwire.MessageError); !ok {
+			if err != test.readErr {
+				t.Errorf("BtcEncode #%d wrong error got: %v, "+
+					"want: %v", i, err, test.readErr)
+				continue
+			}
+		}
+
+	}
+}

test_coverage.txt

@@ -2,58 +2,60 @@
 github.com/conformal/btcwire/message.go		 ReadMessage				 100.00% (37/37)
 github.com/conformal/btcwire/common.go		 readVarInt				 100.00% (24/24)
 github.com/conformal/btcwire/msgtx.go		 MsgTx.Copy				 100.00% (24/24)
-github.com/conformal/btcwire/netaddress.go	 readNetAddress				 100.00% (20/20)
 github.com/conformal/btcwire/message.go		 makeEmptyMessage			 100.00% (20/20)
+github.com/conformal/btcwire/netaddress.go	 readNetAddress				 100.00% (20/20)
 github.com/conformal/btcwire/common.go		 writeVarInt				 100.00% (16/16)
+github.com/conformal/btcwire/msgaddr.go		 MsgAddr.BtcEncode			 100.00% (15/15)
 github.com/conformal/btcwire/shahash.go		 NewShaHashFromStr			 100.00% (15/15)
 github.com/conformal/btcwire/netaddress.go	 writeNetAddress			 100.00% (14/14)
 github.com/conformal/btcwire/msggetdata.go	 MsgGetData.BtcDecode			 100.00% (13/13)
 github.com/conformal/btcwire/msginv.go		 MsgInv.BtcDecode			 100.00% (13/13)
 github.com/conformal/btcwire/msgnotfound.go	 MsgNotFound.BtcDecode			 100.00% (13/13)
+github.com/conformal/btcwire/msgaddr.go		 MsgAddr.BtcDecode			 100.00% (13/13)
 github.com/conformal/btcwire/protocol.go	 ServiceFlag.String			 100.00% (12/12)
 github.com/conformal/btcwire/msgnotfound.go	 MsgNotFound.BtcEncode			 100.00% (12/12)
 github.com/conformal/btcwire/msggetdata.go	 MsgGetData.BtcEncode			 100.00% (12/12)
 github.com/conformal/btcwire/msginv.go		 MsgInv.BtcEncode			 100.00% (12/12)
-github.com/conformal/btcwire/blockheader.go	 readBlockHeader			 100.00% (10/10)
 github.com/conformal/btcwire/msgblock.go	 MsgBlock.BtcDecode			 100.00% (10/10)
 github.com/conformal/btcwire/message.go		 discardInput				 100.00% (10/10)
+github.com/conformal/btcwire/blockheader.go	 readBlockHeader			 100.00% (10/10)
 github.com/conformal/btcwire/msgblock.go	 MsgBlock.BtcEncode			 100.00% (9/9)
-github.com/conformal/btcwire/blockheader.go	 writeBlockHeader			 100.00% (8/8)
 github.com/conformal/btcwire/common.go		 readVarString				 100.00% (8/8)
-github.com/conformal/btcwire/message.go		 readMessageHeader			 100.00% (7/7)
+github.com/conformal/btcwire/blockheader.go	 writeBlockHeader			 100.00% (8/8)
 github.com/conformal/btcwire/msgversion.go	 NewMsgVersionFromConn			 100.00% (7/7)
-github.com/conformal/btcwire/common.go		 DoubleSha256				 100.00% (7/7)
-github.com/conformal/btcwire/common.go		 randomUint64				 100.00% (7/7)
 github.com/conformal/btcwire/common.go		 writeVarString				 100.00% (7/7)
-github.com/conformal/btcwire/common.go		 readElements				 100.00% (5/5)
+github.com/conformal/btcwire/common.go		 randomUint64				 100.00% (7/7)
-github.com/conformal/btcwire/msggetdata.go	 MsgGetData.AddInvVect			 100.00% (5/5)
+github.com/conformal/btcwire/common.go		 DoubleSha256				 100.00% (7/7)
+github.com/conformal/btcwire/message.go		 readMessageHeader			 100.00% (7/7)
 github.com/conformal/btcwire/shahash.go		 ShaHash.SetBytes			 100.00% (5/5)
-github.com/conformal/btcwire/msgaddr.go		 MsgAddr.AddAddress			 100.00% (5/5)
-github.com/conformal/btcwire/msggetheaders.go	 MsgGetHeaders.AddBlockLocatorHash	 100.00% (5/5)
-github.com/conformal/btcwire/msgaddr.go		 MsgAddr.AddAddresses			 100.00% (5/5)
-github.com/conformal/btcwire/common.go		 writeElements				 100.00% (5/5)
-github.com/conformal/btcwire/msgheaders.go	 MsgHeaders.AddBlockHeader		 100.00% (5/5)
 github.com/conformal/btcwire/msginv.go		 MsgInv.AddInvVect			 100.00% (5/5)
+github.com/conformal/btcwire/msggetblocks.go	 MsgGetBlocks.AddBlockLocatorHash	 100.00% (5/5)
+github.com/conformal/btcwire/msggetheaders.go	 MsgGetHeaders.AddBlockLocatorHash	 100.00% (5/5)
+github.com/conformal/btcwire/msggetdata.go	 MsgGetData.AddInvVect			 100.00% (5/5)
+github.com/conformal/btcwire/msgaddr.go		 MsgAddr.AddAddress			 100.00% (5/5)
 github.com/conformal/btcwire/msgnotfound.go	 MsgNotFound.AddInvVect			 100.00% (5/5)
+github.com/conformal/btcwire/msgheaders.go	 MsgHeaders.AddBlockHeader		 100.00% (5/5)
 github.com/conformal/btcwire/msgping.go		 MsgPing.BtcDecode			 100.00% (5/5)
 github.com/conformal/btcwire/msgping.go		 MsgPing.BtcEncode			 100.00% (5/5)
+github.com/conformal/btcwire/common.go		 writeElements				 100.00% (5/5)
+github.com/conformal/btcwire/common.go		 readElements				 100.00% (5/5)
+github.com/conformal/btcwire/msgaddr.go		 MsgAddr.AddAddresses			 100.00% (5/5)
 github.com/conformal/btcwire/netaddress.go	 NewNetAddress				 100.00% (5/5)
-github.com/conformal/btcwire/msggetblocks.go	 MsgGetBlocks.AddBlockLocatorHash	 100.00% (5/5)
+github.com/conformal/btcwire/msgping.go		 MsgPing.MaxPayloadLength		 100.00% (4/4)
-github.com/conformal/btcwire/msgmempool.go	 MsgMemPool.BtcEncode			 100.00% (4/4)
+github.com/conformal/btcwire/invvect.go		 readInvVect				 100.00% (4/4)
+github.com/conformal/btcwire/invvect.go		 writeInvVect				 100.00% (4/4)
+github.com/conformal/btcwire/shahash.go		 ShaHash.String				 100.00% (4/4)
+github.com/conformal/btcwire/msgmempool.go	 MsgMemPool.BtcDecode			 100.00% (4/4)
 github.com/conformal/btcwire/netaddress.go	 maxNetAddressPayload			 100.00% (4/4)
 github.com/conformal/btcwire/msgpong.go		 MsgPong.MaxPayloadLength		 100.00% (4/4)
-github.com/conformal/btcwire/msgmempool.go	 MsgMemPool.BtcDecode			 100.00% (4/4)
+github.com/conformal/btcwire/msgmempool.go	 MsgMemPool.BtcEncode			 100.00% (4/4)
-github.com/conformal/btcwire/invvect.go		 readInvVect				 100.00% (4/4)
-github.com/conformal/btcwire/msgping.go		 MsgPing.MaxPayloadLength		 100.00% (4/4)
-github.com/conformal/btcwire/shahash.go		 ShaHash.String				 100.00% (4/4)
-github.com/conformal/btcwire/invvect.go		 writeInvVect				 100.00% (4/4)
-github.com/conformal/btcwire/error.go		 MessageError.Error			 100.00% (3/3)
-github.com/conformal/btcwire/msgaddr.go		 MsgAddr.MaxPayloadLength		 100.00% (3/3)
-github.com/conformal/btcwire/msgversion.go	 MsgVersion.HasService			 100.00% (3/3)
-github.com/conformal/btcwire/invvect.go		 InvType.String				 100.00% (3/3)
 github.com/conformal/btcwire/shahash.go		 ShaHash.Bytes				 100.00% (3/3)
+github.com/conformal/btcwire/msgaddr.go		 MsgAddr.MaxPayloadLength		 100.00% (3/3)
 github.com/conformal/btcwire/msgblock.go	 MsgBlock.AddTransaction		 100.00% (3/3)
+github.com/conformal/btcwire/msgversion.go	 MsgVersion.HasService			 100.00% (3/3)
 github.com/conformal/btcwire/netaddress.go	 NetAddress.HasService			 100.00% (3/3)
+github.com/conformal/btcwire/error.go		 MessageError.Error			 100.00% (3/3)
+github.com/conformal/btcwire/invvect.go		 InvType.String				 100.00% (3/3)
 github.com/conformal/btcwire/msgblock.go	 MsgBlock.ClearTransactions		 100.00% (2/2)
 github.com/conformal/btcwire/netaddress.go	 NetAddress.SetAddress			 100.00% (2/2)
 github.com/conformal/btcwire/msgalert.go	 MsgAlert.Command			 100.00% (1/1)
@@ -121,33 +123,31 @@ github.com/conformal/btcwire/msgversion.go	 MsgVersion.MaxPayloadLength		 100.00
 github.com/conformal/btcwire/msgversion.go	 NewMsgVersion				 100.00% (1/1)
 github.com/conformal/btcwire/netaddress.go	 NetAddress.AddService			 100.00% (1/1)
 github.com/conformal/btcwire/shahash.go		 ShaHash.IsEqual			 100.00% (1/1)
-github.com/conformal/btcwire/msgpong.go		 MsgPong.BtcDecode			 85.71% (6/7)
-github.com/conformal/btcwire/msgblock.go	 MsgBlock.TxShas			 85.71% (6/7)
-github.com/conformal/btcwire/msgpong.go		 MsgPong.BtcEncode			 85.71% (6/7)
 github.com/conformal/btcwire/msgtx.go		 MsgTx.TxSha				 85.71% (6/7)
+github.com/conformal/btcwire/msgpong.go		 MsgPong.BtcDecode			 85.71% (6/7)
+github.com/conformal/btcwire/msgpong.go		 MsgPong.BtcEncode			 85.71% (6/7)
+github.com/conformal/btcwire/msgblock.go	 MsgBlock.TxShas			 85.71% (6/7)
 github.com/conformal/btcwire/msgtx.go		 MsgTx.BtcDecode			 80.00% (20/25)
 github.com/conformal/btcwire/shahash.go		 NewShaHash				 80.00% (4/5)
 github.com/conformal/btcwire/msgtx.go		 MsgTx.BtcEncode			 78.26% (18/23)
-github.com/conformal/btcwire/msgaddr.go		 MsgAddr.BtcDecode			 76.92% (10/13)
 github.com/conformal/btcwire/msgtx.go		 readTxIn				 76.47% (13/17)
 github.com/conformal/btcwire/msgtx.go		 readTxOut				 75.00% (9/12)
+github.com/conformal/btcwire/msgalert.go	 MsgAlert.BtcDecode			 75.00% (6/8)
 github.com/conformal/btcwire/blockheader.go	 BlockHeader.BlockSha			 75.00% (6/8)
 github.com/conformal/btcwire/msgalert.go	 MsgAlert.BtcEncode			 75.00% (6/8)
-github.com/conformal/btcwire/msgalert.go	 MsgAlert.BtcDecode			 75.00% (6/8)
-github.com/conformal/btcwire/msgtx.go		 readOutPoint				 75.00% (3/4)
 github.com/conformal/btcwire/msgtx.go		 writeOutPoint				 75.00% (3/4)
+github.com/conformal/btcwire/msgtx.go		 readOutPoint				 75.00% (3/4)
 github.com/conformal/btcwire/msgtx.go		 writeTxIn				 73.33% (11/15)
 github.com/conformal/btcwire/msgtx.go		 writeTxOut				 72.73% (8/11)
 github.com/conformal/btcwire/message.go		 WriteMessage				 70.00% (21/30)
-github.com/conformal/btcwire/msggetheaders.go	 MsgGetHeaders.BtcDecode		 68.42% (13/19)
 github.com/conformal/btcwire/msggetblocks.go	 MsgGetBlocks.BtcDecode			 68.42% (13/19)
+github.com/conformal/btcwire/msggetheaders.go	 MsgGetHeaders.BtcDecode		 68.42% (13/19)
 github.com/conformal/btcwire/msgversion.go	 MsgVersion.BtcDecode			 68.00% (17/25)
-github.com/conformal/btcwire/msggetblocks.go	 MsgGetBlocks.BtcEncode			 66.67% (12/18)
 github.com/conformal/btcwire/msggetheaders.go	 MsgGetHeaders.BtcEncode		 66.67% (12/18)
+github.com/conformal/btcwire/msggetblocks.go	 MsgGetBlocks.BtcEncode			 66.67% (12/18)
 github.com/conformal/btcwire/msgversion.go	 MsgVersion.BtcEncode			 63.64% (14/22)
 github.com/conformal/btcwire/msgheaders.go	 MsgHeaders.BtcDecode			 62.50% (10/16)
 github.com/conformal/btcwire/msgheaders.go	 MsgHeaders.BtcEncode			 60.00% (9/15)
-github.com/conformal/btcwire/msgaddr.go		 MsgAddr.BtcEncode			 60.00% (9/15)
 github.com/conformal/btcwire/msgblock.go	 MsgBlock.BtcDecodeTxLoc		 0.00% (0/16)
-github.com/conformal/btcwire			 ---------------------------------	 86.82% (810/933)
+github.com/conformal/btcwire			 ---------------------------------	 87.78% (819/933)