nim-libp2p/tests/testmultistream.nim

433 lines
12 KiB
Nim
Raw Normal View History

import unittest, strutils, strformat, stew/byteutils
2019-08-30 05:16:55 +00:00
import chronos
import ../libp2p/errors,
2019-09-06 07:13:03 +00:00
../libp2p/multistream,
2020-02-12 14:43:42 +00:00
../libp2p/stream/bufferstream,
../libp2p/stream/connection,
../libp2p/multiaddress,
../libp2p/transports/transport,
../libp2p/transports/tcptransport,
../libp2p/protocols/protocol
2019-08-30 05:16:55 +00:00
import ./helpers
when defined(nimHasUsed): {.used.}
2019-08-30 05:16:55 +00:00
## Mock stream for select test
type
TestSelectStream = ref object of Connection
2019-08-30 05:16:55 +00:00
step*: int
method readOnce*(s: TestSelectStream,
pbytes: pointer,
nbytes: int): Future[int] {.async, gcsafe.} =
2019-08-30 05:16:55 +00:00
case s.step:
of 1:
var buf = newSeq[byte](1)
buf[0] = 19
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
2019-08-30 05:16:55 +00:00
s.step = 2
return buf.len
2019-08-30 05:16:55 +00:00
of 2:
var buf = "/multistream/1.0.0\n"
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
2019-08-30 05:16:55 +00:00
s.step = 3
return buf.len
2019-08-30 05:16:55 +00:00
of 3:
var buf = newSeq[byte](1)
buf[0] = 18
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
2019-08-30 05:16:55 +00:00
s.step = 4
return buf.len
2019-08-30 05:16:55 +00:00
of 4:
var buf = "/test/proto/1.0.0\n"
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
return buf.len
2019-08-30 05:16:55 +00:00
else:
2019-09-01 00:23:11 +00:00
copyMem(pbytes,
2019-08-30 05:16:55 +00:00
cstring("\0x3na\n"),
"\0x3na\n".len())
return "\0x3na\n".len()
method write*(s: TestSelectStream, msg: seq[byte]) {.async, gcsafe.} = discard
2019-09-08 07:59:14 +00:00
2020-02-12 14:43:42 +00:00
method close(s: TestSelectStream) {.async, gcsafe.} =
s.isClosed = true
s.isEof = true
2019-09-06 07:13:03 +00:00
2019-08-30 05:16:55 +00:00
proc newTestSelectStream(): TestSelectStream =
new result
result.step = 1
## Mock stream for handles `ls` test
type
2019-10-04 20:10:01 +00:00
LsHandler = proc(procs: seq[byte]): Future[void] {.gcsafe.}
2019-08-30 05:16:55 +00:00
TestLsStream = ref object of Connection
2019-08-30 05:16:55 +00:00
step*: int
ls*: LsHandler
method readOnce*(s: TestLsStream,
pbytes: pointer,
nbytes: int):
Future[int] {.async.} =
2019-08-30 05:16:55 +00:00
case s.step:
of 1:
var buf = newSeq[byte](1)
buf[0] = 19
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
2019-08-30 05:16:55 +00:00
s.step = 2
return buf.len()
2019-08-30 05:16:55 +00:00
of 2:
var buf = "/multistream/1.0.0\n"
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
2019-08-30 05:16:55 +00:00
s.step = 3
return buf.len()
2019-08-30 05:16:55 +00:00
of 3:
var buf = newSeq[byte](1)
buf[0] = 3
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
2019-08-30 05:16:55 +00:00
s.step = 4
return buf.len()
2019-08-30 05:16:55 +00:00
of 4:
var buf = "ls\n"
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
return buf.len()
2019-08-30 05:16:55 +00:00
else:
var buf = "na\n"
copyMem(pbytes, addr buf[0], buf.len())
return buf.len()
2019-08-30 05:16:55 +00:00
method write*(s: TestLsStream, msg: seq[byte]) {.async, gcsafe.} =
2019-08-30 05:16:55 +00:00
if s.step == 4:
await s.ls(msg)
2020-02-12 14:43:42 +00:00
method close(s: TestLsStream) {.async, gcsafe.} =
s.isClosed = true
s.isEof = true
2019-09-01 17:31:24 +00:00
2019-10-04 20:10:01 +00:00
proc newTestLsStream(ls: LsHandler): TestLsStream {.gcsafe.} =
2019-08-30 05:16:55 +00:00
new result
result.ls = ls
result.step = 1
## Mock stream for handles `na` test
type
2019-10-04 20:10:01 +00:00
NaHandler = proc(procs: string): Future[void] {.gcsafe.}
2019-08-30 05:16:55 +00:00
TestNaStream = ref object of Connection
2019-08-30 05:16:55 +00:00
step*: int
na*: NaHandler
method readOnce*(s: TestNaStream,
pbytes: pointer,
nbytes: int):
Future[int] {.async, gcsafe.} =
2019-08-30 05:16:55 +00:00
case s.step:
of 1:
var buf = newSeq[byte](1)
buf[0] = 19
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
2019-08-30 05:16:55 +00:00
s.step = 2
return buf.len()
2019-08-30 05:16:55 +00:00
of 2:
var buf = "/multistream/1.0.0\n"
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
2019-08-30 05:16:55 +00:00
s.step = 3
return buf.len()
2019-08-30 05:16:55 +00:00
of 3:
var buf = newSeq[byte](1)
buf[0] = 18
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
2019-08-30 05:16:55 +00:00
s.step = 4
return buf.len()
2019-08-30 05:16:55 +00:00
of 4:
var buf = "/test/proto/1.0.0\n"
2019-09-01 00:23:11 +00:00
copyMem(pbytes, addr buf[0], buf.len())
return buf.len()
2019-08-30 05:16:55 +00:00
else:
2019-09-01 00:23:11 +00:00
copyMem(pbytes,
2019-08-30 05:16:55 +00:00
cstring("\0x3na\n"),
"\0x3na\n".len())
return "\0x3na\n".len()
method write*(s: TestNaStream, msg: seq[byte]) {.async, gcsafe.} =
2019-08-30 05:16:55 +00:00
if s.step == 4:
await s.na(string.fromBytes(msg))
2019-08-30 05:16:55 +00:00
2020-02-12 14:43:42 +00:00
method close(s: TestNaStream) {.async, gcsafe.} =
s.isClosed = true
s.isEof = true
2019-09-01 17:31:24 +00:00
2019-08-30 05:16:55 +00:00
proc newTestNaStream(na: NaHandler): TestNaStream =
new result
result.na = na
result.step = 1
suite "Multistream select":
teardown:
checkTrackers()
2019-08-30 05:16:55 +00:00
test "test select custom proto":
proc testSelect(): Future[bool] {.async.} =
let ms = newMultistream()
let conn = newTestSelectStream()
result = (await ms.select(conn, @["/test/proto/1.0.0"])) == "/test/proto/1.0.0"
await conn.close()
2019-08-30 05:16:55 +00:00
check:
waitFor(testSelect()) == true
test "test handle custom proto":
proc testHandle(): Future[bool] {.async.} =
let ms = newMultistream()
let conn = newTestSelectStream()
2019-08-30 05:16:55 +00:00
var protocol: LPProtocol = new LPProtocol
2019-08-30 23:45:57 +00:00
proc testHandler(conn: Connection,
proto: string):
2019-08-30 23:45:57 +00:00
Future[void] {.async, gcsafe.} =
2019-08-30 05:16:55 +00:00
check proto == "/test/proto/1.0.0"
2019-09-06 07:13:03 +00:00
await conn.close()
2019-08-30 05:16:55 +00:00
2019-08-30 23:45:57 +00:00
protocol.handler = testHandler
ms.addHandler("/test/proto/1.0.0", protocol)
2019-08-30 05:16:55 +00:00
await ms.handle(conn)
result = true
check:
waitFor(testHandle()) == true
test "test handle `ls`":
proc testLs(): Future[bool] {.async.} =
let ms = newMultistream()
2019-10-04 20:10:01 +00:00
proc testLsHandler(proto: seq[byte]) {.async, gcsafe.} # forward declaration
let conn = Connection(newTestLsStream(testLsHandler))
let done = newFuture[void]()
2019-10-04 20:10:01 +00:00
proc testLsHandler(proto: seq[byte]) {.async, gcsafe.} =
2020-06-03 02:21:11 +00:00
var strProto: string = string.fromBytes(proto)
2019-08-30 05:16:55 +00:00
check strProto == "\x26/test/proto1/1.0.0\n/test/proto2/1.0.0\n"
await conn.close()
done.complete()
2019-08-30 05:16:55 +00:00
2020-02-12 14:43:42 +00:00
proc testHandler(conn: Connection, proto: string): Future[void]
{.async, gcsafe.} = discard
var protocol: LPProtocol = new LPProtocol
2019-08-30 23:45:57 +00:00
protocol.handler = testHandler
ms.addHandler("/test/proto1/1.0.0", protocol)
ms.addHandler("/test/proto2/1.0.0", protocol)
2019-08-30 05:16:55 +00:00
await ms.handle(conn)
result = true
await done.wait(5.seconds)
2019-08-30 05:16:55 +00:00
check:
waitFor(testLs()) == true
test "test handle `na`":
proc testNa(): Future[bool] {.async.} =
let ms = newMultistream()
2019-10-04 20:10:01 +00:00
proc testNaHandler(msg: string): Future[void] {.async, gcsafe.}
let conn = newTestNaStream(testNaHandler)
2019-08-30 05:16:55 +00:00
2019-10-04 20:10:01 +00:00
proc testNaHandler(msg: string): Future[void] {.async, gcsafe.} =
echo msg
check msg == Na
2019-08-30 05:16:55 +00:00
await conn.close()
var protocol: LPProtocol = new LPProtocol
2019-08-30 23:45:57 +00:00
proc testHandler(conn: Connection,
proto: string):
2019-08-31 18:52:56 +00:00
Future[void] {.async, gcsafe.} = discard
2019-08-30 23:45:57 +00:00
protocol.handler = testHandler
ms.addHandler("/unabvailable/proto/1.0.0", protocol)
2019-08-30 05:16:55 +00:00
await ms.handle(conn)
result = true
check:
waitFor(testNa()) == true
test "e2e - handle":
proc endToEnd(): Future[bool] {.async.} =
let ma: MultiAddress = Multiaddress.init("/ip4/0.0.0.0/tcp/0").tryGet()
2019-08-30 23:45:57 +00:00
let
handlerWait1 = newFuture[void]()
handlerWait2 = newFuture[void]()
var protocol: LPProtocol = new LPProtocol
2019-08-30 23:45:57 +00:00
proc testHandler(conn: Connection,
proto: string):
2019-08-31 18:52:56 +00:00
Future[void] {.async, gcsafe.} =
2019-08-30 05:16:55 +00:00
check proto == "/test/proto/1.0.0"
await conn.writeLp("Hello!")
await conn.close()
handlerWait1.complete()
2019-08-30 05:16:55 +00:00
2019-08-30 23:45:57 +00:00
protocol.handler = testHandler
2019-08-30 05:16:55 +00:00
let msListen = newMultistream()
2019-08-30 23:45:57 +00:00
msListen.addHandler("/test/proto/1.0.0", protocol)
2019-08-30 05:16:55 +00:00
proc connHandler(conn: Connection): Future[void] {.async, gcsafe.} =
await msListen.handle(conn)
await conn.close()
handlerWait2.complete()
2019-08-30 05:16:55 +00:00
let transport1: TcpTransport = TcpTransport.init()
asyncCheck transport1.listen(ma, connHandler)
2019-08-30 05:16:55 +00:00
let msDial = newMultistream()
let transport2: TcpTransport = TcpTransport.init()
2019-10-04 20:10:01 +00:00
let conn = await transport2.dial(transport1.ma)
2019-08-30 05:16:55 +00:00
2019-09-06 07:13:03 +00:00
check (await msDial.select(conn, "/test/proto/1.0.0")) == true
2019-08-30 05:16:55 +00:00
2020-06-03 02:21:11 +00:00
let hello = string.fromBytes(await conn.readLp(1024))
2019-08-30 05:16:55 +00:00
result = hello == "Hello!"
await conn.close()
await transport2.close()
await transport1.close()
await allFuturesThrowing(
handlerWait1.wait(30.seconds),
handlerWait2.wait(30.seconds))
2019-08-30 05:16:55 +00:00
check:
waitFor(endToEnd()) == true
test "e2e - ls":
proc endToEnd(): Future[bool] {.async.} =
let ma: MultiAddress = Multiaddress.init("/ip4/0.0.0.0/tcp/0").tryGet()
2019-08-30 05:16:55 +00:00
let
handlerWait = newFuture[void]()
2019-08-30 05:16:55 +00:00
let msListen = newMultistream()
var protocol: LPProtocol = new LPProtocol
2019-09-05 15:19:15 +00:00
protocol.handler = proc(conn: Connection, proto: string) {.async, gcsafe.} =
# never reached
discard
2019-08-30 23:45:57 +00:00
proc testHandler(conn: Connection,
proto: string):
Future[void] {.async.} =
# never reached
discard
2019-08-30 23:45:57 +00:00
protocol.handler = testHandler
msListen.addHandler("/test/proto1/1.0.0", protocol)
msListen.addHandler("/test/proto2/1.0.0", protocol)
2019-08-30 05:16:55 +00:00
let transport1: TcpTransport = TcpTransport.init()
2019-08-30 05:16:55 +00:00
proc connHandler(conn: Connection): Future[void] {.async, gcsafe.} =
try:
await msListen.handle(conn)
except LPStreamEOFError:
discard
except LPStreamClosedError:
discard
finally:
await conn.close()
let listenFut = transport1.listen(ma, connHandler)
2019-08-30 05:16:55 +00:00
let msDial = newMultistream()
let transport2: TcpTransport = TcpTransport.init()
2019-10-04 20:10:01 +00:00
let conn = await transport2.dial(transport1.ma)
2019-08-30 05:16:55 +00:00
let ls = await msDial.list(conn)
let protos: seq[string] = @["/test/proto1/1.0.0", "/test/proto2/1.0.0"]
2019-08-30 05:16:55 +00:00
result = ls == protos
await conn.close()
await transport2.close()
await transport1.close()
discard await listenFut.wait(5.seconds)
2019-08-30 05:16:55 +00:00
check:
waitFor(endToEnd()) == true
2019-09-05 15:19:15 +00:00
test "e2e - select one from a list with unsupported protos":
proc endToEnd(): Future[bool] {.async.} =
let ma: MultiAddress = Multiaddress.init("/ip4/0.0.0.0/tcp/0").tryGet()
var protocol: LPProtocol = new LPProtocol
proc testHandler(conn: Connection,
proto: string):
Future[void] {.async, gcsafe.} =
check proto == "/test/proto/1.0.0"
await conn.writeLp("Hello!")
await conn.close()
protocol.handler = testHandler
let msListen = newMultistream()
msListen.addHandler("/test/proto/1.0.0", protocol)
proc connHandler(conn: Connection): Future[void] {.async, gcsafe.} =
await msListen.handle(conn)
let transport1: TcpTransport = TcpTransport.init()
asyncCheck transport1.listen(ma, connHandler)
let msDial = newMultistream()
let transport2: TcpTransport = TcpTransport.init()
2019-10-04 20:10:01 +00:00
let conn = await transport2.dial(transport1.ma)
check (await msDial.select(conn,
@["/test/proto/1.0.0", "/test/no/proto/1.0.0"])) == "/test/proto/1.0.0"
2020-06-03 02:21:11 +00:00
let hello = string.fromBytes(await conn.readLp(1024))
result = hello == "Hello!"
await conn.close()
await transport2.close()
await transport1.close()
check:
waitFor(endToEnd()) == true
test "e2e - select one with both valid":
proc endToEnd(): Future[bool] {.async.} =
let ma: MultiAddress = Multiaddress.init("/ip4/0.0.0.0/tcp/0").tryGet()
var protocol: LPProtocol = new LPProtocol
proc testHandler(conn: Connection,
proto: string):
Future[void] {.async, gcsafe.} =
await conn.writeLp(&"Hello from {proto}!")
await conn.close()
protocol.handler = testHandler
let msListen = newMultistream()
msListen.addHandler("/test/proto1/1.0.0", protocol)
msListen.addHandler("/test/proto2/1.0.0", protocol)
proc connHandler(conn: Connection): Future[void] {.async, gcsafe.} =
await msListen.handle(conn)
let transport1: TcpTransport = TcpTransport.init()
asyncCheck transport1.listen(ma, connHandler)
let msDial = newMultistream()
let transport2: TcpTransport = TcpTransport.init()
2019-10-04 20:10:01 +00:00
let conn = await transport2.dial(transport1.ma)
check (await msDial.select(conn, @["/test/proto2/1.0.0", "/test/proto1/1.0.0"])) == "/test/proto2/1.0.0"
2020-06-03 02:21:11 +00:00
result = string.fromBytes(await conn.readLp(1024)) == "Hello from /test/proto2/1.0.0!"
await conn.close()
await transport2.close()
await transport1.close()
check:
2019-09-05 15:19:15 +00:00
waitFor(endToEnd()) == true