## Nim-Libp2p ## Copyright (c) 2018 Status Research & Development GmbH ## Licensed under either of ## * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE)) ## * MIT license ([LICENSE-MIT](LICENSE-MIT)) ## at your option. ## This file may not be copied, modified, or distributed except according to ## those terms. import unittest, sequtils, options, tables, sets import chronos import utils, ../../libp2p/[switch, peer, peerinfo, connection, crypto/crypto, stream/bufferstream, protocols/pubsub/pubsub, protocols/pubsub/gossipsub] proc createGossipSub(): GossipSub = var peerInfo: PeerInfo var seckey = some(PrivateKey.random(RSA)) peerInfo.peerId = some(PeerID.init(seckey.get())) result = newPubSub(GossipSub, peerInfo) suite "GossipSub": test "should add remote peer topic subscriptions": proc testRun(): Future[bool] {.async.} = proc handler(topic: string, data: seq[byte]) {.async, gcsafe.} = discard let gossip1 = createGossipSub() let gossip2 = createGossipSub() var buf1 = newBufferStream() var conn1 = newConnection(buf1) conn1.peerInfo = gossip1.peerInfo var buf2 = newBufferStream() var conn2 = newConnection(buf2) conn2.peerInfo = gossip2.peerInfo buf1 = buf1 | buf2 | buf1 await gossip1.subscribeToPeer(conn2) asyncCheck gossip2.handleConn(conn1, GossipSubCodec) await gossip1.subscribe("foobar", handler) await sleepAsync(1.seconds) check: "foobar" in gossip2.gossipsub gossip1.peerInfo.peerId.get().pretty in gossip2.gossipsub["foobar"] result = true check: waitFor(testRun()) == true test "e2e - should add remote peer topic subscriptions": proc testBasicGossipSub(): Future[bool] {.async.} = proc handler(topic: string, data: seq[byte]) {.async, gcsafe.} = discard var nodes: seq[Switch] = newSeq[Switch]() for i in 0..<2: nodes.add(createNode(gossip = true)) var awaitters: seq[Future[void]] for node in nodes: awaitters.add(await node.start()) await nodes[1].subscribe("foobar", handler) await sleepAsync(100.millis) await subscribeNodes(nodes) let gossip1 = GossipSub(nodes[0].pubSub.get()) let gossip2 = GossipSub(nodes[1].pubSub.get()) check: "foobar" in gossip2.topics "foobar" in gossip1.gossipsub gossip2.peerInfo.peerId.get().pretty in gossip1.gossipsub["foobar"] await allFutures(nodes.mapIt(it.stop())) await allFutures(awaitters) result = true check: waitFor(testBasicGossipSub()) == true test "should add remote peer topic subscriptions if both peers are subscribed": proc testRun(): Future[bool] {.async.} = proc handler(topic: string, data: seq[byte]) {.async, gcsafe.} = discard let gossip1 = createGossipSub() let gossip2 = createGossipSub() var buf1 = newBufferStream() var conn1 = newConnection(buf1) conn1.peerInfo = gossip1.peerInfo var buf2 = newBufferStream() var conn2 = newConnection(buf2) conn2.peerInfo = gossip2.peerInfo buf1 = buf1 | buf2 | buf1 await gossip1.subscribeToPeer(conn2) asyncCheck gossip1.handleConn(conn1, GossipSubCodec) await gossip2.subscribeToPeer(conn1) asyncCheck gossip2.handleConn(conn2, GossipSubCodec) await gossip1.subscribe("foobar", handler) await gossip2.subscribe("foobar", handler) await sleepAsync(1.seconds) check: "foobar" in gossip1.topics "foobar" in gossip2.topics "foobar" in gossip1.gossipsub "foobar" in gossip2.gossipsub # TODO: in a real setting, we would be checking for the peerId from # gossip1 in gossip2 and vice versa, but since we're doing some mockery # with connection piping and such, this is fine - do not change! gossip1.peerInfo.peerId.get().pretty in gossip1.gossipsub["foobar"] gossip2.peerInfo.peerId.get().pretty in gossip2.gossipsub["foobar"] result = true check: waitFor(testRun()) == true test "e2e - should add remote peer topic subscriptions if both peers are subscribed": proc testBasicGossipSub(): Future[bool] {.async.} = proc handler(topic: string, data: seq[byte]) {.async, gcsafe.} = discard var nodes: seq[Switch] = newSeq[Switch]() for i in 0..<2: nodes.add(createNode(gossip = true)) var awaitters: seq[Future[void]] for node in nodes: awaitters.add(await node.start()) await nodes[0].subscribe("foobar", handler) await sleepAsync(100.millis) await nodes[1].subscribe("foobar", handler) await sleepAsync(100.millis) await subscribeNodes(nodes) let gossip1 = GossipSub(nodes[0].pubSub.get()) let gossip2 = GossipSub(nodes[1].pubSub.get()) check: "foobar" in gossip1.topics "foobar" in gossip2.topics "foobar" in gossip1.gossipsub "foobar" in gossip2.gossipsub gossip1.peerInfo.peerId.get().pretty in gossip2.gossipsub["foobar"] gossip2.peerInfo.peerId.get().pretty in gossip1.gossipsub["foobar"] await allFutures(nodes.mapIt(it.stop())) await allFutures(awaitters) result = true check: waitFor(testBasicGossipSub()) == true # test "send over fanout A -> B": # proc testRun(): Future[bool] {.async.} = # var handlerFut = newFuture[bool]() # proc handler(topic: string, data: seq[byte]) {.async, gcsafe.} = # check: # topic == "foobar" # cast[string](data) == "Hello!" # handlerFut.complete(true) # let gossip1 = createGossipSub() # let gossip2 = createGossipSub() # var buf1 = newBufferStream() # var conn1 = newConnection(buf1) # var buf2 = newBufferStream() # var conn2 = newConnection(buf2) # conn1.peerInfo = gossip2.peerInfo # conn2.peerInfo = gossip1.peerInfo # buf1 = buf1 | buf2 | buf1 # await gossip1.subscribeToPeer(conn2) # asyncCheck gossip1.handleConn(conn1, GossipSubCodec) # await gossip2.subscribeToPeer(conn1) # asyncCheck gossip2.handleConn(conn2, GossipSubCodec) # await gossip1.subscribe("foobar", handler) # await sleepAsync(1.seconds) # await gossip2.publish("foobar", cast[seq[byte]]("Hello!")) # await sleepAsync(1.seconds) # result = await handlerFut # check: # waitFor(testRun()) == true test "e2e - send over fanout A -> B": proc testRun(): Future[bool] {.async.} = var passed: bool proc handler(topic: string, data: seq[byte]) {.async, gcsafe.} = check topic == "foobar" passed = true var nodes = generateNodes(2, true) var wait = newSeq[Future[void]]() wait.add(await nodes[0].start()) wait.add(await nodes[1].start()) await subscribeNodes(nodes) await nodes[1].subscribe("foobar", handler) await sleepAsync(3.seconds) await nodes[0].publish("foobar", cast[seq[byte]]("Hello!")) await sleepAsync(3.seconds) var gossipSub1: GossipSub = GossipSub(nodes[0].pubSub.get()) check: "foobar" in gossipSub1.gossipsub await nodes[1].stop() await nodes[0].stop() await allFutures(wait) result = passed check: waitFor(testRun()) == true # test "send over mesh A -> B": # proc testRun(): Future[bool] {.async.} = # var passed: bool # proc handler(topic: string, data: seq[byte]) {.async, gcsafe.} = # check: # topic == "foobar" # cast[string](data) == "Hello!" # passed = true # let gossip1 = createGossipSub() # let gossip2 = createGossipSub() # var buf1 = newBufferStream() # var conn1 = newConnection(buf1) # conn1.peerInfo = gossip1.peerInfo # var buf2 = newBufferStream() # var conn2 = newConnection(buf2) # conn2.peerInfo = gossip2.peerInfo # buf1 = buf1 | buf2 | buf1 # await gossip1.subscribeToPeer(conn2) # await gossip2.subscribeToPeer(conn1) # await gossip1.subscribe("foobar", handler) # await sleepAsync(1.seconds) # await gossip2.subscribe("foobar", handler) # await sleepAsync(1.seconds) # await gossip2.publish("foobar", cast[seq[byte]]("Hello!")) # await sleepAsync(1.seconds) # result = passed # check: # waitFor(testRun()) == true # test "e2e - send over mesh A -> B": # proc testRun(): Future[bool] {.async.} = # var passed: bool # proc handler(topic: string, data: seq[byte]) {.async, gcsafe.} = # check topic == "foobar" # passed = true # var nodes = generateNodes(2, true) # var wait = await nodes[1].start() # await nodes[0].subscribeToPeer(nodes[1].peerInfo) # await sleepAsync(100.millis) # await nodes[0].subscribe("foobar", handler) # await sleepAsync(100.millis) # await nodes[1].subscribe("foobar", handler) # await sleepAsync(100.millis) # await nodes[0].publish("foobar", cast[seq[byte]]("Hello!")) # await sleepAsync(1000.millis) # await nodes[1].stop() # await allFutures(wait) # result = passed # check: # waitFor(testRun()) == true # test "with multiple peers": # proc testRun(): Future[bool] {.async.} = # var nodes: seq[GossipSub] # for i in 0..<10: # nodes.add(createGossipSub()) # var pending: seq[Future[void]] # var awaitters: seq[Future[void]] # var seen: Table[string, int] # for dialer in nodes: # var handler: TopicHandler # closureScope: # var dialerNode = dialer # handler = proc(topic: string, data: seq[byte]) {.async, gcsafe, closure.} = # if dialerNode.peerInfo.peerId.get().pretty notin seen: # seen[dialerNode.peerInfo.peerId.get().pretty] = 0 # seen[dialerNode.peerInfo.peerId.get().pretty].inc # check topic == "foobar" # await dialer.subscribe("foobar", handler) # await sleepAsync(20.millis) # for i, node in nodes: # if dialer.peerInfo.peerId != node.peerInfo.peerId: # var buf1 = newBufferStream() # var conn1 = newConnection(buf1) # conn1.peerInfo = dialer.peerInfo # var buf2 = newBufferStream() # var conn2 = newConnection(buf2) # conn2.peerInfo = node.peerInfo # buf1 = buf2 | buf1 # buf2 = buf1 | buf2 # pending.add(dialer.subscribeToPeer(conn2)) # pending.add(node.subscribeToPeer(conn1)) # await sleepAsync(10.millis) # awaitters.add(dialer.start()) # await nodes[0].publish("foobar", # cast[seq[byte]]("from node " & # nodes[1].peerInfo.peerId.get().pretty)) # await sleepAsync(1000.millis) # await allFutures(nodes.mapIt(it.stop())) # await allFutures(awaitters) # check: seen.len == 9 # for k, v in seen.pairs: # check: v == 1 # result = true # check: # waitFor(testRun()) == true test "e2e - with multiple peers": proc testRun(): Future[bool] {.async.} = var nodes: seq[Switch] = newSeq[Switch]() var awaitters: seq[Future[void]] for i in 0..<10: nodes.add(createNode(none(PrivateKey), "/ip4/127.0.0.1/tcp/0", true, true)) awaitters.add((await nodes[i].start())) var seen: Table[string, int] for dialer in nodes: var handler: TopicHandler closureScope: var dialerNode = dialer handler = proc(topic: string, data: seq[byte]) {.async, gcsafe, closure.} = if dialerNode.peerInfo.peerId.get().pretty notin seen: seen[dialerNode.peerInfo.peerId.get().pretty] = 0 seen[dialerNode.peerInfo.peerId.get().pretty].inc check topic == "foobar" await dialer.subscribe("foobar", handler) await sleepAsync(20.millis) await subscribeNodes(nodes) await sleepAsync(10.millis) await nodes[0].publish("foobar", cast[seq[byte]]("from node " & nodes[1].peerInfo.peerId.get().pretty)) await sleepAsync(1000.millis) await allFutures(nodes.mapIt(it.stop())) await allFutures(awaitters) check: seen.len == 10 for k, v in seen.pairs: check: v == 1 result = true check: waitFor(testRun()) == true