reformatting tests and add proper blocking test

Author: Jaremy J. Creechley

tests/.gitignore

@@ -0,0 +1,2 @@
+t*
+!t*.nim

tests/common.nim

@@ -14,41 +14,46 @@ template runMultithreadInOrderTest*[T](chan: Chan[T]) =
 
   # Launch the first worker.
   createThread(worker1) do:
+    var lg = newConsoleLogger(logLevel, verboseFmtStr)
+    lg.log(lvlDebug, "[worker1] sending message... ")
     chan.send("Hello World!")
 
   # Wait for the thread to exit before moving on to the next example.
   worker1.joinThread()
 
   var dest = ""
   chan.recv(dest)
-  logger.log(lvlDebug, "Received msg: " & $dest)
+  logger.log(lvlDebug, "[main] Received msg: " & $dest)
   doAssert dest == "Hello World!"
 
 
-template runMultithreadBockTest*[T](chan: Chan[T]) =
+template runMultithreadNonRecvBlockTest*[T](chan: Chan[T]) =
   var worker2: Thread[void]
   # Launch the other worker.
   createThread(worker2) do: 
     # This is another proc to run in a background thread. This proc takes a while
     # to send the message since it sleeps for 2 seconds (or 2000 milliseconds).
+    var lg = newConsoleLogger(logLevel, verboseFmtStr)
     sleep(2000)
+    lg.log(lvlDebug, "[worker2] sending message... ")
     chan.send("Another message")
 
   # This time, use a non-blocking approach with tryRecv.
   # Since the main thread is not blocked, it could be used to perform other
   # useful work while it waits for data to arrive on the channel.
 
+  logger.log(lvlDebug, "[main] running non-blocking tryRecv")
   var messages: seq[string]
   var msg = ""
   while true:
     let tried = chan.tryRecv(msg)
     if tried:
-      logger.log(lvlDebug, "Receive msg: " & $msg)
+      logger.log(lvlDebug, "[main] Receive msg: " & $msg)
       messages.add move(msg)
       break
 
     messages.add "Pretend I'm doing useful work..."
-    logger.log(lvlDebug, "add fakeMsg to messages (other work): " & $messages.len())
+    logger.log(lvlDebug, "[main] add fakeMsg to messages (other work): " & $messages.len())
     sleep(400)
 
   # Wait for the second thread to exit before cleaning up the channel.
@@ -57,3 +62,37 @@ template runMultithreadBockTest*[T](chan: Chan[T]) =
   # Clean up the channel.
   check messages[^1] == "Another message"
   check messages.len >= 2
+
+template runMultithreadRecvBlockTest*[T](chan: Chan[T]) =
+  var worker2: Thread[void]
+  # Launch the other worker.
+  createThread(worker2) do: 
+    # This is another proc to run in a background thread. This proc takes a while
+    # to send the message since it sleeps for 2 seconds (or 2000 milliseconds).
+    var lg = newConsoleLogger(logLevel, verboseFmtStr)
+    sleep(2000)
+    lg.log(lvlDebug, "[worker2] sending message... ")
+    chan.send("Another message")
+
+  # This time, use a non-blocking approach with tryRecv.
+  # Since the main thread is not blocked, it could be used to perform other
+  # useful work while it waits for data to arrive on the channel.
+
+  logger.log(lvlDebug, "[main] running blocking recv")
+  var messages: seq[string]
+  var msg = ""
+
+  chan.recv(msg)
+  logger.log(lvlDebug, "[main] Receive msg: " & $msg)
+  messages.add move(msg)
+
+  messages.add "Pretend I'm doing useful work..."
+  logger.log(lvlDebug, "[main] add fakeMsg to messages (other work): " & $messages.len())
+  sleep(400)
+
+  # Wait for the second thread to exit before cleaning up the channel.
+  worker2.joinThread()
+
+  # Clean up the channel.
+  check messages[0] == "Another message"
+  check messages.len >= 2

tests/tchannels_overwrite.nim

@@ -38,14 +38,16 @@ suite "testing Chan with overwrite mode":
     check messages == @["msg7", "msg8", "msg9", "msg10"]
 
   test "basic overwrite tests":
-
     var chan = newChan[string](elements = 4, overwrite = true)
-
     runMultithreadInOrderTest(chan)
 
-  test "basic blocking multithread":
-    var chan = newChan[string]()
-    runMultithreadBockTest(chan)
+  test "basic non-blocking recv multithread":
+    var chan = newChan[string](overwrite=true)
+    runMultithreadNonRecvBlockTest(chan)
+
+  test "basic blocking recv multithread":
+    var chan = newChan[string](overwrite=true)
+    runMultithreadRecvBlockTest(chan)
 
 
 

tests/tchannels_simple.nim

@@ -25,6 +25,10 @@ suite "testing Chan with overwrite mode":
     var chan = newChan[string]()
     runMultithreadInOrderTest(chan)
 
-  test "basic blocking multithread":
+  test "basic non-blocking multithread":
     var chan = newChan[string]()
-    runMultithreadBockTest(chan)
+    runMultithreadNonRecvBlockTest(chan)
+
+  test "basic blocking multithread":
+    var chan = newChan[string](overwrite=true)
+    runMultithreadRecvBlockTest(chan)