From 4aea957b19571ed30f104d1b5abc7acd76b14af5 Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Thu, 9 May 2013 23:01:09 -0500 Subject: [PATCH] Add negative tests for NetAddress. This commit adds tests for the error paths when encoding and decoding NetAddress with and without the timestamp field. --- netaddress_test.go | 78 ++++++++++++++++++++++++++++++++++++++++++++++ test_coverage.txt | 62 ++++++++++++++++++------------------ 2 files changed, 109 insertions(+), 31 deletions(-) diff --git a/netaddress_test.go b/netaddress_test.go index 692af3c9e..aed675030 100644 --- a/netaddress_test.go +++ b/netaddress_test.go @@ -8,6 +8,7 @@ import ( "bytes" "github.com/conformal/btcwire" "github.com/davecgh/go-spew/spew" + "io" "net" "reflect" "testing" @@ -213,3 +214,80 @@ func TestNetAddressWire(t *testing.T) { } } } + +// TestNetAddressWireErrors performs negative tests against wire encode and +// decode NetAddress to confirm error paths work correctly. +func TestNetAddressWireErrors(t *testing.T) { + pver := btcwire.ProtocolVersion + pverNAT := btcwire.NetAddressTimeVersion - 1 + + // baseNetAddr is used in the various tests as a baseline NetAddress. + baseNetAddr := 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, + } + + tests := []struct { + in *btcwire.NetAddress // Value to encode + buf []byte // Wire encoding + pver uint32 // Protocol version for wire encoding + ts bool // Include timestamp flag + max int // Max size of fixed buffer to induce errors + writeErr error // Expected write error + readErr error // Expected read error + }{ + // Latest protocol version with timestamp and intentional + // read/write errors. + // Force errors on timestamp. + {&baseNetAddr, []byte{}, pver, true, 0, io.ErrShortWrite, io.EOF}, + // Force errors on services. + {&baseNetAddr, []byte{}, pver, true, 4, io.ErrShortWrite, io.EOF}, + // Force errors on ip. + {&baseNetAddr, []byte{}, pver, true, 12, io.ErrShortWrite, io.EOF}, + // Force errors on port. + {&baseNetAddr, []byte{}, pver, true, 28, io.ErrShortWrite, io.EOF}, + + // Latest protocol version with no timestamp and intentional + // read/write errors. + // Force errors on services. + {&baseNetAddr, []byte{}, pver, false, 0, io.ErrShortWrite, io.EOF}, + // Force errors on ip. + {&baseNetAddr, []byte{}, pver, false, 8, io.ErrShortWrite, io.EOF}, + // Force errors on port. + {&baseNetAddr, []byte{}, pver, false, 24, io.ErrShortWrite, io.EOF}, + + // Protocol version before NetAddressTimeVersion with timestamp + // flag set (should not have timestamp due to old protocol + // version) and intentional read/write errors. + // Force errors on services. + {&baseNetAddr, []byte{}, pverNAT, true, 0, io.ErrShortWrite, io.EOF}, + // Force errors on ip. + {&baseNetAddr, []byte{}, pverNAT, true, 8, io.ErrShortWrite, io.EOF}, + // Force errors on port. + {&baseNetAddr, []byte{}, pverNAT, true, 24, io.ErrShortWrite, io.EOF}, + } + + t.Logf("Running %d tests", len(tests)) + for i, test := range tests { + // Encode to wire format. + w := newFixedWriter(test.max) + err := btcwire.TstWriteNetAddress(w, test.pver, test.in, test.ts) + if err != test.writeErr { + t.Errorf("writeNetAddress #%d wrong error got: %v, want: %v", + i, err, test.writeErr) + continue + } + + // Decode from wire format. + var na btcwire.NetAddress + r := newFixedReader(test.max, test.buf) + err = btcwire.TstReadNetAddress(r, test.pver, &na, test.ts) + if err != test.readErr { + t.Errorf("readNetAddress #%d wrong error got: %v, want: %v", + i, err, test.readErr) + continue + } + } +} diff --git a/test_coverage.txt b/test_coverage.txt index 92a62c0b1..486bffd04 100644 --- a/test_coverage.txt +++ b/test_coverage.txt @@ -1,45 +1,47 @@ github.com/conformal/btcwire/message.go ReadMessage 100.00% (37/37) -github.com/conformal/btcwire/msgtx.go MsgTx.Copy 100.00% (24/24) 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/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/shahash.go NewShaHashFromStr 100.00% (15/15) +github.com/conformal/btcwire/netaddress.go writeNetAddress 100.00% (14/14) github.com/conformal/btcwire/protocol.go ServiceFlag.String 100.00% (12/12) github.com/conformal/btcwire/message.go discardInput 100.00% (10/10) github.com/conformal/btcwire/common.go readVarString 100.00% (8/8) +github.com/conformal/btcwire/common.go randomUint64 100.00% (7/7) +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/msgversion.go NewMsgVersionFromConn 100.00% (7/7) github.com/conformal/btcwire/common.go writeVarString 100.00% (7/7) -github.com/conformal/btcwire/message.go readMessageHeader 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/msggetdata.go MsgGetData.AddInvVect 100.00% (5/5) github.com/conformal/btcwire/netaddress.go NewNetAddress 100.00% (5/5) -github.com/conformal/btcwire/common.go readElements 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/shahash.go ShaHash.SetBytes 100.00% (5/5) github.com/conformal/btcwire/msggetblocks.go MsgGetBlocks.AddBlockLocatorHash 100.00% (5/5) -github.com/conformal/btcwire/msginv.go MsgInv.AddInvVect 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/msgnotfound.go MsgNotFound.AddInvVect 100.00% (5/5) -github.com/conformal/btcwire/msgheaders.go MsgHeaders.AddBlockHeader 100.00% (5/5) +github.com/conformal/btcwire/msggetdata.go MsgGetData.AddInvVect 100.00% (5/5) github.com/conformal/btcwire/msgping.go MsgPing.BtcEncode 100.00% (5/5) github.com/conformal/btcwire/msgping.go MsgPing.BtcDecode 100.00% (5/5) -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/msgnotfound.go MsgNotFound.AddInvVect 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/common.go readElements 100.00% (5/5) +github.com/conformal/btcwire/msginv.go MsgInv.AddInvVect 100.00% (5/5) +github.com/conformal/btcwire/msgpong.go MsgPong.MaxPayloadLength 100.00% (4/4) github.com/conformal/btcwire/shahash.go ShaHash.String 100.00% (4/4) +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/msgmempool.go MsgMemPool.BtcDecode 100.00% (4/4) -github.com/conformal/btcwire/msgping.go MsgPing.MaxPayloadLength 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/netaddress.go NetAddress.HasService 100.00% (3/3) +github.com/conformal/btcwire/error.go MessageError.Error 100.00% (3/3) github.com/conformal/btcwire/msgversion.go MsgVersion.HasService 100.00% (3/3) github.com/conformal/btcwire/msgaddr.go MsgAddr.MaxPayloadLength 100.00% (3/3) -github.com/conformal/btcwire/netaddress.go NetAddress.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/error.go MessageError.Error 100.00% (3/3) github.com/conformal/btcwire/msgblock.go MsgBlock.AddTransaction 100.00% (3/3) +github.com/conformal/btcwire/shahash.go ShaHash.Bytes 100.00% (3/3) github.com/conformal/btcwire/netaddress.go NetAddress.SetAddress 100.00% (2/2) github.com/conformal/btcwire/msgblock.go MsgBlock.ClearTransactions 100.00% (2/2) github.com/conformal/btcwire/msgalert.go MsgAlert.Command 100.00% (1/1) @@ -107,47 +109,45 @@ 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/netaddress.go readNetAddress 90.00% (18/20) github.com/conformal/btcwire/msgtx.go MsgTx.TxSha 85.71% (6/7) github.com/conformal/btcwire/msgblock.go MsgBlock.TxShas 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/blockheader.go readBlockHeader 80.00% (8/10) +github.com/conformal/btcwire/msgpong.go MsgPong.BtcDecode 85.71% (6/7) github.com/conformal/btcwire/msgblock.go MsgBlock.BtcDecode 80.00% (8/10) +github.com/conformal/btcwire/blockheader.go readBlockHeader 80.00% (8/10) github.com/conformal/btcwire/shahash.go NewShaHash 80.00% (4/5) -github.com/conformal/btcwire/netaddress.go writeNetAddress 78.57% (11/14) github.com/conformal/btcwire/msgblock.go MsgBlock.BtcEncode 77.78% (7/9) 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 MsgTx.BtcDecode 76.00% (19/25) github.com/conformal/btcwire/msgtx.go readTxOut 75.00% (9/12) -github.com/conformal/btcwire/blockheader.go BlockHeader.BlockSha 75.00% (6/8) -github.com/conformal/btcwire/blockheader.go writeBlockHeader 75.00% (6/8) github.com/conformal/btcwire/msgalert.go MsgAlert.BtcEncode 75.00% (6/8) +github.com/conformal/btcwire/blockheader.go writeBlockHeader 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/blockheader.go BlockHeader.BlockSha 75.00% (6/8) 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/invvect.go writeInvVect 75.00% (3/4) github.com/conformal/btcwire/invvect.go readInvVect 75.00% (3/4) github.com/conformal/btcwire/msgtx.go MsgTx.BtcEncode 73.91% (17/23) 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/msginv.go MsgInv.BtcDecode 69.23% (9/13) github.com/conformal/btcwire/msggetdata.go MsgGetData.BtcDecode 69.23% (9/13) github.com/conformal/btcwire/msgnotfound.go MsgNotFound.BtcDecode 69.23% (9/13) -github.com/conformal/btcwire/msginv.go MsgInv.BtcDecode 69.23% (9/13) 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/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/msginv.go MsgInv.BtcEncode 66.67% (8/12) +github.com/conformal/btcwire/msggetblocks.go MsgGetBlocks.BtcEncode 66.67% (12/18) github.com/conformal/btcwire/msgnotfound.go MsgNotFound.BtcEncode 66.67% (8/12) +github.com/conformal/btcwire/msginv.go MsgInv.BtcEncode 66.67% (8/12) github.com/conformal/btcwire/msggetdata.go MsgGetData.BtcEncode 66.67% (8/12) 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/msgheaders.go MsgHeaders.BtcEncode 60.00% (9/15) github.com/conformal/btcwire/msgblock.go MsgBlock.BtcDecodeTxLoc 0.00% (0/16) -github.com/conformal/btcwire --------------------------------- 82.42% (769/933) +github.com/conformal/btcwire --------------------------------- 82.96% (774/933)