github.com/aquanetwork/aquachain@v1.7.8/p2p/discv5/udp_test.go (about) 1 // Copyright 2016 The aquachain Authors 2 // This file is part of the aquachain library. 3 // 4 // The aquachain library is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU Lesser General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // The aquachain library is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU Lesser General Public License for more details. 13 // 14 // You should have received a copy of the GNU Lesser General Public License 15 // along with the aquachain library. If not, see <http://www.gnu.org/licenses/>. 16 17 package discv5 18 19 import ( 20 "encoding/hex" 21 "net" 22 "reflect" 23 "testing" 24 25 "github.com/davecgh/go-spew/spew" 26 "gitlab.com/aquachain/aquachain/common" 27 "gitlab.com/aquachain/aquachain/crypto" 28 "gitlab.com/aquachain/aquachain/rlp" 29 ) 30 31 func init() { 32 spew.Config.DisableMethods = true 33 } 34 35 // shared test variables 36 var ( 37 // futureExp = uint64(time.Now().Add(10 * time.Hour).Unix()) 38 // testTarget = NodeID{0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1} 39 // testRemote = rpcEndpoint{IP: net.ParseIP("1.1.1.1").To4(), UDP: 1, TCP: 2} 40 // testLocalAnnounced = rpcEndpoint{IP: net.ParseIP("2.2.2.2").To4(), UDP: 3, TCP: 4} 41 // testLocal = rpcEndpoint{IP: net.ParseIP("3.3.3.3").To4(), UDP: 5, TCP: 6} 42 ) 43 44 // type udpTest struct { 45 // t *testing.T 46 // pipe *dgramPipe 47 // table *Table 48 // udp *udp 49 // sent [][]byte 50 // localkey, remotekey *ecdsa.PrivateKey 51 // remoteaddr *net.UDPAddr 52 // } 53 // 54 // func newUDPTest(t *testing.T) *udpTest { 55 // test := &udpTest{ 56 // t: t, 57 // pipe: newpipe(), 58 // localkey: newkey(), 59 // remotekey: newkey(), 60 // remoteaddr: &net.UDPAddr{IP: net.IP{1, 2, 3, 4}, Port: 30303}, 61 // } 62 // test.table, test.udp, _ = newUDP(test.localkey, test.pipe, nil, "") 63 // return test 64 // } 65 // 66 // // handles a packet as if it had been sent to the transport. 67 // func (test *udpTest) packetIn(wantError error, ptype byte, data packet) error { 68 // enc, err := encodePacket(test.remotekey, ptype, data) 69 // if err != nil { 70 // return test.errorf("packet (%d) encode error: %v", ptype, err) 71 // } 72 // test.sent = append(test.sent, enc) 73 // if err = test.udp.handlePacket(test.remoteaddr, enc); err != wantError { 74 // return test.errorf("error mismatch: got %q, want %q", err, wantError) 75 // } 76 // return nil 77 // } 78 // 79 // // waits for a packet to be sent by the transport. 80 // // validate should have type func(*udpTest, X) error, where X is a packet type. 81 // func (test *udpTest) waitPacketOut(validate interface{}) error { 82 // dgram := test.pipe.waitPacketOut() 83 // p, _, _, err := decodePacket(dgram) 84 // if err != nil { 85 // return test.errorf("sent packet decode error: %v", err) 86 // } 87 // fn := reflect.ValueOf(validate) 88 // exptype := fn.Type().In(0) 89 // if reflect.TypeOf(p) != exptype { 90 // return test.errorf("sent packet type mismatch, got: %v, want: %v", reflect.TypeOf(p), exptype) 91 // } 92 // fn.Call([]reflect.Value{reflect.ValueOf(p)}) 93 // return nil 94 // } 95 // 96 // func (test *udpTest) errorf(format string, args ...interface{}) error { 97 // _, file, line, ok := runtime.Caller(2) // errorf + waitPacketOut 98 // if ok { 99 // file = filepath.Base(file) 100 // } else { 101 // file = "???" 102 // line = 1 103 // } 104 // err := fmt.Errorf(format, args...) 105 // fmt.Printf("\t%s:%d: %v\n", file, line, err) 106 // test.t.Fail() 107 // return err 108 // } 109 // 110 // func TestUDP_packetErrors(t *testing.T) { 111 // test := newUDPTest(t) 112 // defer test.table.Close() 113 // 114 // test.packetIn(errExpired, pingPacket, &ping{From: testRemote, To: testLocalAnnounced, Version: Version}) 115 // test.packetIn(errUnsolicitedReply, pongPacket, &pong{ReplyTok: []byte{}, Expiration: futureExp}) 116 // test.packetIn(errUnknownNode, findnodePacket, &findnode{Expiration: futureExp}) 117 // test.packetIn(errUnsolicitedReply, neighborsPacket, &neighbors{Expiration: futureExp}) 118 // } 119 // 120 // func TestUDP_findnode(t *testing.T) { 121 // test := newUDPTest(t) 122 // defer test.table.Close() 123 // 124 // // put a few nodes into the table. their exact 125 // // distribution shouldn't matter much, although we need to 126 // // take care not to overflow any bucket. 127 // targetHash := crypto.Keccak256Hash(testTarget[:]) 128 // nodes := &nodesByDistance{target: targetHash} 129 // for i := 0; i < bucketSize; i++ { 130 // nodes.push(nodeAtDistance(test.table.self.sha, i+2), bucketSize) 131 // } 132 // test.table.stuff(nodes.entries) 133 // 134 // // ensure there's a bond with the test node, 135 // // findnode won't be accepted otherwise. 136 // test.table.db.updateNode(NewNode( 137 // PubkeyID(&test.remotekey.PublicKey), 138 // test.remoteaddr.IP, 139 // uint16(test.remoteaddr.Port), 140 // 99, 141 // )) 142 // // check that closest neighbors are returned. 143 // test.packetIn(nil, findnodePacket, &findnode{Target: testTarget, Expiration: futureExp}) 144 // expected := test.table.closest(targetHash, bucketSize) 145 // 146 // waitNeighbors := func(want []*Node) { 147 // test.waitPacketOut(func(p *neighbors) { 148 // if len(p.Nodes) != len(want) { 149 // t.Errorf("wrong number of results: got %d, want %d", len(p.Nodes), bucketSize) 150 // } 151 // for i := range p.Nodes { 152 // if p.Nodes[i].ID != want[i].ID { 153 // t.Errorf("result mismatch at %d:\n got: %v\n want: %v", i, p.Nodes[i], expected.entries[i]) 154 // } 155 // } 156 // }) 157 // } 158 // waitNeighbors(expected.entries[:maxNeighbors]) 159 // waitNeighbors(expected.entries[maxNeighbors:]) 160 // } 161 // 162 // func TestUDP_findnodeMultiReply(t *testing.T) { 163 // test := newUDPTest(t) 164 // defer test.table.Close() 165 // 166 // // queue a pending findnode request 167 // resultc, errc := make(chan []*Node), make(chan error) 168 // go func() { 169 // rid := PubkeyID(&test.remotekey.PublicKey) 170 // ns, err := test.udp.findnode(rid, test.remoteaddr, testTarget) 171 // if err != nil && len(ns) == 0 { 172 // errc <- err 173 // } else { 174 // resultc <- ns 175 // } 176 // }() 177 // 178 // // wait for the findnode to be sent. 179 // // after it is sent, the transport is waiting for a reply 180 // test.waitPacketOut(func(p *findnode) { 181 // if p.Target != testTarget { 182 // t.Errorf("wrong target: got %v, want %v", p.Target, testTarget) 183 // } 184 // }) 185 // 186 // // send the reply as two packets. 187 // list := []*Node{ 188 // MustParseNode("enode://ba85011c70bcc5c04d8607d3a0ed29aa6179c092cbdda10d5d32684fb33ed01bd94f588ca8f91ac48318087dcb02eaf36773a7a453f0eedd6742af668097b29c@10.0.1.16:30303?discport=30304"), 189 // MustParseNode("enode://81fa361d25f157cd421c60dcc28d8dac5ef6a89476633339c5df30287474520caca09627da18543d9079b5b288698b542d56167aa5c09111e55acdbbdf2ef799@10.0.1.16:30303"), 190 // MustParseNode("enode://9bffefd833d53fac8e652415f4973bee289e8b1a5c6c4cbe70abf817ce8a64cee11b823b66a987f51aaa9fba0d6a91b3e6bf0d5a5d1042de8e9eeea057b217f8@10.0.1.36:30301?discport=17"), 191 // MustParseNode("enode://1b5b4aa662d7cb44a7221bfba67302590b643028197a7d5214790f3bac7aaa4a3241be9e83c09cf1f6c69d007c634faae3dc1b1221793e8446c0b3a09de65960@10.0.1.16:30303"), 192 // } 193 // rpclist := make([]rpcNode, len(list)) 194 // for i := range list { 195 // rpclist[i] = nodeToRPC(list[i]) 196 // } 197 // test.packetIn(nil, neighborsPacket, &neighbors{Expiration: futureExp, Nodes: rpclist[:2]}) 198 // test.packetIn(nil, neighborsPacket, &neighbors{Expiration: futureExp, Nodes: rpclist[2:]}) 199 // 200 // // check that the sent neighbors are all returned by findnode 201 // select { 202 // case result := <-resultc: 203 // if !reflect.DeepEqual(result, list) { 204 // t.Errorf("neighbors mismatch:\n got: %v\n want: %v", result, list) 205 // } 206 // case err := <-errc: 207 // t.Errorf("findnode error: %v", err) 208 // case <-time.After(5 * time.Second): 209 // t.Error("findnode did not return within 5 seconds") 210 // } 211 // } 212 // 213 // func TestUDP_successfulPing(t *testing.T) { 214 // test := newUDPTest(t) 215 // added := make(chan *Node, 1) 216 // test.table.nodeAddedHook = func(n *Node) { added <- n } 217 // defer test.table.Close() 218 // 219 // // The remote side sends a ping packet to initiate the exchange. 220 // go test.packetIn(nil, pingPacket, &ping{From: testRemote, To: testLocalAnnounced, Version: Version, Expiration: futureExp}) 221 // 222 // // the ping is replied to. 223 // test.waitPacketOut(func(p *pong) { 224 // pinghash := test.sent[0][:macSize] 225 // if !bytes.Equal(p.ReplyTok, pinghash) { 226 // t.Errorf("got pong.ReplyTok %x, want %x", p.ReplyTok, pinghash) 227 // } 228 // wantTo := rpcEndpoint{ 229 // // The mirrored UDP address is the UDP packet sender 230 // IP: test.remoteaddr.IP, UDP: uint16(test.remoteaddr.Port), 231 // // The mirrored TCP port is the one from the ping packet 232 // TCP: testRemote.TCP, 233 // } 234 // if !reflect.DeepEqual(p.To, wantTo) { 235 // t.Errorf("got pong.To %v, want %v", p.To, wantTo) 236 // } 237 // }) 238 // 239 // // remote is unknown, the table pings back. 240 // test.waitPacketOut(func(p *ping) error { 241 // if !reflect.DeepEqual(p.From, test.udp.ourEndpoint) { 242 // t.Errorf("got ping.From %v, want %v", p.From, test.udp.ourEndpoint) 243 // } 244 // wantTo := rpcEndpoint{ 245 // // The mirrored UDP address is the UDP packet sender. 246 // IP: test.remoteaddr.IP, UDP: uint16(test.remoteaddr.Port), 247 // TCP: 0, 248 // } 249 // if !reflect.DeepEqual(p.To, wantTo) { 250 // t.Errorf("got ping.To %v, want %v", p.To, wantTo) 251 // } 252 // return nil 253 // }) 254 // test.packetIn(nil, pongPacket, &pong{Expiration: futureExp}) 255 // 256 // // the node should be added to the table shortly after getting the 257 // // pong packet. 258 // select { 259 // case n := <-added: 260 // rid := PubkeyID(&test.remotekey.PublicKey) 261 // if n.ID != rid { 262 // t.Errorf("node has wrong ID: got %v, want %v", n.ID, rid) 263 // } 264 // if !bytes.Equal(n.IP, test.remoteaddr.IP) { 265 // t.Errorf("node has wrong IP: got %v, want: %v", n.IP, test.remoteaddr.IP) 266 // } 267 // if int(n.UDP) != test.remoteaddr.Port { 268 // t.Errorf("node has wrong UDP port: got %v, want: %v", n.UDP, test.remoteaddr.Port) 269 // } 270 // if n.TCP != testRemote.TCP { 271 // t.Errorf("node has wrong TCP port: got %v, want: %v", n.TCP, testRemote.TCP) 272 // } 273 // case <-time.After(2 * time.Second): 274 // t.Errorf("node was not added within 2 seconds") 275 // } 276 // } 277 278 var testPackets = []struct { 279 input string 280 wantPacket interface{} 281 }{ 282 { 283 input: "71dbda3a79554728d4f94411e42ee1f8b0d561c10e1e5f5893367948c6a7d70bb87b235fa28a77070271b6c164a2dce8c7e13a5739b53b5e96f2e5acb0e458a02902f5965d55ecbeb2ebb6cabb8b2b232896a36b737666c55265ad0a68412f250001ea04cb847f000001820cfa8215a8d790000000000000000000000000000000018208ae820d058443b9a355", 284 wantPacket: &ping{ 285 Version: 4, 286 From: rpcEndpoint{net.ParseIP("127.0.0.1").To4(), 3322, 5544}, 287 To: rpcEndpoint{net.ParseIP("::1"), 2222, 3333}, 288 Expiration: 1136239445, 289 Rest: []rlp.RawValue{}, 290 }, 291 }, 292 { 293 input: "e9614ccfd9fc3e74360018522d30e1419a143407ffcce748de3e22116b7e8dc92ff74788c0b6663aaa3d67d641936511c8f8d6ad8698b820a7cf9e1be7155e9a241f556658c55428ec0563514365799a4be2be5a685a80971ddcfa80cb422cdd0101ec04cb847f000001820cfa8215a8d790000000000000000000000000000000018208ae820d058443b9a3550102", 294 wantPacket: &ping{ 295 Version: 4, 296 From: rpcEndpoint{net.ParseIP("127.0.0.1").To4(), 3322, 5544}, 297 To: rpcEndpoint{net.ParseIP("::1"), 2222, 3333}, 298 Expiration: 1136239445, 299 Rest: []rlp.RawValue{{0x01}, {0x02}}, 300 }, 301 }, 302 { 303 input: "577be4349c4dd26768081f58de4c6f375a7a22f3f7adda654d1428637412c3d7fe917cadc56d4e5e7ffae1dbe3efffb9849feb71b262de37977e7c7a44e677295680e9e38ab26bee2fcbae207fba3ff3d74069a50b902a82c9903ed37cc993c50001f83e82022bd79020010db83c4d001500000000abcdef12820cfa8215a8d79020010db885a308d313198a2e037073488208ae82823a8443b9a355c5010203040531b9019afde696e582a78fa8d95ea13ce3297d4afb8ba6433e4154caa5ac6431af1b80ba76023fa4090c408f6b4bc3701562c031041d4702971d102c9ab7fa5eed4cd6bab8f7af956f7d565ee1917084a95398b6a21eac920fe3dd1345ec0a7ef39367ee69ddf092cbfe5b93e5e568ebc491983c09c76d922dc3", 304 wantPacket: &ping{ 305 Version: 555, 306 From: rpcEndpoint{net.ParseIP("2001:db8:3c4d:15::abcd:ef12"), 3322, 5544}, 307 To: rpcEndpoint{net.ParseIP("2001:db8:85a3:8d3:1319:8a2e:370:7348"), 2222, 33338}, 308 Expiration: 1136239445, 309 Rest: []rlp.RawValue{{0xC5, 0x01, 0x02, 0x03, 0x04, 0x05}}, 310 }, 311 }, 312 { 313 input: "09b2428d83348d27cdf7064ad9024f526cebc19e4958f0fdad87c15eb598dd61d08423e0bf66b2069869e1724125f820d851c136684082774f870e614d95a2855d000f05d1648b2d5945470bc187c2d2216fbe870f43ed0909009882e176a46b0102f846d79020010db885a308d313198a2e037073488208ae82823aa0fbc914b16819237dcd8801d7e53f69e9719adecb3cc0e790c57e91ca4461c9548443b9a355c6010203c2040506a0c969a58f6f9095004c0177a6b47f451530cab38966a25cca5cb58f055542124e", 314 wantPacket: &pong{ 315 To: rpcEndpoint{net.ParseIP("2001:db8:85a3:8d3:1319:8a2e:370:7348"), 2222, 33338}, 316 ReplyTok: common.Hex2Bytes("fbc914b16819237dcd8801d7e53f69e9719adecb3cc0e790c57e91ca4461c954"), 317 Expiration: 1136239445, 318 Rest: []rlp.RawValue{{0xC6, 0x01, 0x02, 0x03, 0xC2, 0x04, 0x05}, {0x06}}, 319 }, 320 }, 321 { 322 input: "c7c44041b9f7c7e41934417ebac9a8e1a4c6298f74553f2fcfdcae6ed6fe53163eb3d2b52e39fe91831b8a927bf4fc222c3902202027e5e9eb812195f95d20061ef5cd31d502e47ecb61183f74a504fe04c51e73df81f25c4d506b26db4517490103f84eb840ca634cae0d49acb401d8a4c6b6fe8c55b70d115bf400769cc1400f3258cd31387574077f301b421bc84df7266c44e9e6d569fc56be00812904767bf5ccd1fc7f8443b9a35582999983999999280dc62cc8255c73471e0a61da0c89acdc0e035e260add7fc0c04ad9ebf3919644c91cb247affc82b69bd2ca235c71eab8e49737c937a2c396", 323 wantPacket: &findnode{ 324 Target: MustHexID("ca634cae0d49acb401d8a4c6b6fe8c55b70d115bf400769cc1400f3258cd31387574077f301b421bc84df7266c44e9e6d569fc56be00812904767bf5ccd1fc7f"), 325 Expiration: 1136239445, 326 Rest: []rlp.RawValue{{0x82, 0x99, 0x99}, {0x83, 0x99, 0x99, 0x99}}, 327 }, 328 }, 329 { 330 input: "c679fc8fe0b8b12f06577f2e802d34f6fa257e6137a995f6f4cbfc9ee50ed3710faf6e66f932c4c8d81d64343f429651328758b47d3dbc02c4042f0fff6946a50f4a49037a72bb550f3a7872363a83e1b9ee6469856c24eb4ef80b7535bcf99c0004f9015bf90150f84d846321163782115c82115db8403155e1427f85f10a5c9a7755877748041af1bcd8d474ec065eb33df57a97babf54bfd2103575fa829115d224c523596b401065a97f74010610fce76382c0bf32f84984010203040101b840312c55512422cf9b8a4097e9a6ad79402e87a15ae909a4bfefa22398f03d20951933beea1e4dfa6f968212385e829f04c2d314fc2d4e255e0d3bc08792b069dbf8599020010db83c4d001500000000abcdef12820d05820d05b84038643200b172dcfef857492156971f0e6aa2c538d8b74010f8e140811d53b98c765dd2d96126051913f44582e8c199ad7c6d6819e9a56483f637feaac9448aacf8599020010db885a308d313198a2e037073488203e78203e8b8408dcab8618c3253b558d459da53bd8fa68935a719aff8b811197101a4b2b47dd2d47295286fc00cc081bb542d760717d1bdd6bec2c37cd72eca367d6dd3b9df738443b9a355010203b525a138aa34383fec3d2719a0", 331 wantPacket: &neighbors{ 332 Nodes: []rpcNode{ 333 { 334 ID: MustHexID("3155e1427f85f10a5c9a7755877748041af1bcd8d474ec065eb33df57a97babf54bfd2103575fa829115d224c523596b401065a97f74010610fce76382c0bf32"), 335 IP: net.ParseIP("99.33.22.55").To4(), 336 UDP: 4444, 337 TCP: 4445, 338 }, 339 { 340 ID: MustHexID("312c55512422cf9b8a4097e9a6ad79402e87a15ae909a4bfefa22398f03d20951933beea1e4dfa6f968212385e829f04c2d314fc2d4e255e0d3bc08792b069db"), 341 IP: net.ParseIP("1.2.3.4").To4(), 342 UDP: 1, 343 TCP: 1, 344 }, 345 { 346 ID: MustHexID("38643200b172dcfef857492156971f0e6aa2c538d8b74010f8e140811d53b98c765dd2d96126051913f44582e8c199ad7c6d6819e9a56483f637feaac9448aac"), 347 IP: net.ParseIP("2001:db8:3c4d:15::abcd:ef12"), 348 UDP: 3333, 349 TCP: 3333, 350 }, 351 { 352 ID: MustHexID("8dcab8618c3253b558d459da53bd8fa68935a719aff8b811197101a4b2b47dd2d47295286fc00cc081bb542d760717d1bdd6bec2c37cd72eca367d6dd3b9df73"), 353 IP: net.ParseIP("2001:db8:85a3:8d3:1319:8a2e:370:7348"), 354 UDP: 999, 355 TCP: 1000, 356 }, 357 }, 358 Expiration: 1136239445, 359 Rest: []rlp.RawValue{{0x01}, {0x02}, {0x03}}, 360 }, 361 }, 362 } 363 364 func TestForwardCompatibility(t *testing.T) { 365 t.Skip("skipped while working on discovery v5") 366 367 testkey, _ := crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291") 368 wantNodeID := PubkeyID(&testkey.PublicKey) 369 370 for _, test := range testPackets { 371 input, err := hex.DecodeString(test.input) 372 if err != nil { 373 t.Fatalf("invalid hex: %s", test.input) 374 } 375 var pkt ingressPacket 376 if err := decodePacket(input, &pkt); err != nil { 377 t.Errorf("did not accept packet %s\n%v", test.input, err) 378 continue 379 } 380 if !reflect.DeepEqual(pkt.data, test.wantPacket) { 381 t.Errorf("got %s\nwant %s", spew.Sdump(pkt.data), spew.Sdump(test.wantPacket)) 382 } 383 if pkt.remoteID != wantNodeID { 384 t.Errorf("got id %v\nwant id %v", pkt.remoteID, wantNodeID) 385 } 386 } 387 } 388 389 /* 390 // dgramPipe is a fake UDP socket. It queues all sent datagrams. 391 type dgramPipe struct { 392 mu *sync.Mutex 393 cond *sync.Cond 394 closing chan struct{} 395 closed bool 396 queue [][]byte 397 } 398 399 func newpipe() *dgramPipe { 400 mu := new(sync.Mutex) 401 return &dgramPipe{ 402 closing: make(chan struct{}), 403 cond: &sync.Cond{L: mu}, 404 mu: mu, 405 } 406 } 407 408 // WriteToUDP queues a datagram. 409 func (c *dgramPipe) WriteToUDP(b []byte, to *net.UDPAddr) (n int, err error) { 410 msg := make([]byte, len(b)) 411 copy(msg, b) 412 c.mu.Lock() 413 defer c.mu.Unlock() 414 if c.closed { 415 return 0, errors.New("closed") 416 } 417 c.queue = append(c.queue, msg) 418 c.cond.Signal() 419 return len(b), nil 420 } 421 422 // ReadFromUDP just hangs until the pipe is closed. 423 func (c *dgramPipe) ReadFromUDP(b []byte) (n int, addr *net.UDPAddr, err error) { 424 <-c.closing 425 return 0, nil, io.EOF 426 } 427 428 func (c *dgramPipe) Close() error { 429 c.mu.Lock() 430 defer c.mu.Unlock() 431 if !c.closed { 432 close(c.closing) 433 c.closed = true 434 } 435 return nil 436 } 437 438 func (c *dgramPipe) LocalAddr() net.Addr { 439 return &net.UDPAddr{IP: testLocal.IP, Port: int(testLocal.UDP)} 440 } 441 442 func (c *dgramPipe) waitPacketOut() []byte { 443 c.mu.Lock() 444 defer c.mu.Unlock() 445 for len(c.queue) == 0 { 446 c.cond.Wait() 447 } 448 p := c.queue[0] 449 copy(c.queue, c.queue[1:]) 450 c.queue = c.queue[:len(c.queue)-1] 451 return p 452 } */