breaking up tests some

Author: Jaremy J. Creechley

tests/common.nim

@@ -0,0 +1,59 @@
+import std/[os, logging, unittest, strutils, strformat]
+export os, logging, unittest, strutils, strformat
+
+import threading/channels
+
+const
+  testLogLevel {.strdefine.}: string = "lvlInfo"
+  logLevel*: Level = parseEnum[Level](testLogLevel)
+
+var logger* = newConsoleLogger(logLevel, verboseFmtStr)
+
+template runMultithreadInOrderTest*[T](chan: Chan[T]) =
+  var worker1: Thread[void]
+
+  # Launch the first worker.
+  createThread(worker1) do:
+    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)
+  doAssert dest == "Hello World!"
+
+
+template runMultithreadBockTest*[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).
+    sleep(2000)
+    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.
+
+  var messages: seq[string]
+  var msg = ""
+  while true:
+    let tried = chan.tryRecv(msg)
+    if tried:
+      logger.log(lvlDebug, "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())
+    sleep(400)
+
+  # Wait for the second thread to exit before cleaning up the channel.
+  worker2.joinThread()
+
+  # Clean up the channel.
+  check messages[^1] == "Another message"
+  check messages.len >= 2

tests/tchannels_overwrite.nim

@@ -5,7 +5,7 @@ discard """
 
 import threading/channels
 import std/[os, logging, unittest]
-from tchannels_simple import runMultithreadTest
+import common
 
 suite "testing Chan with overwrite mode":
   var logger = newConsoleLogger(levelThreshold=lvlInfo)
@@ -41,7 +41,11 @@ suite "testing Chan with overwrite mode":
 
     var chan = newChan[string](elements = 4, overwrite = true)
 
-    runMultithreadTest(chan)
+    runMultithreadInOrderTest(chan)
+
+  test "basic blocking multithread":
+    var chan = newChan[string]()
+    runMultithreadBockTest(chan)
 
 
 

tests/tchannels_simple.nim

@@ -5,58 +5,10 @@ discard """
 
 import threading/channels
 import std/[os, logging, unittest]
-
-template runMultithreadTest*[T](chan: Chan[T]) =
-  var worker1: Thread[void]
-  var worker2: Thread[void]
-
-  # Launch the first worker.
-  createThread(worker1, proc () =
-    # This proc will be run in another thread using the threads module.
-    chan.send("Hello World!"))
-
-  # Block until the message arrives, then print it out.
-  var dest = ""
-  chan.recv(dest)
-  doAssert dest == "Hello World!"
-
-  # Wait for the thread to exit before moving on to the next example.
-  worker1.joinThread()
-
-  # Launch the other worker.
-  createThread(worker2, proc () =
-    # 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).
-    sleep(2000)
-    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.
-
-  var messages: seq[string]
-  var msg = ""
-  while true:
-    let tried = chan.tryRecv(msg)
-    if tried:
-      messages.add move(msg)
-      break
-
-    messages.add "Pretend I'm doing useful work..."
-    # For this example, sleep in order not to flood stdout with the above
-    # message.
-    sleep(400)
-
-  # Wait for the second thread to exit before cleaning up the channel.
-  worker2.joinThread()
-
-  # Clean up the channel.
-  check messages[^1] == "Another message"
-  check messages.len >= 2
+import common
 
 
 suite "testing Chan with overwrite mode":
-  var logger = newConsoleLogger(levelThreshold=lvlInfo)
 
   setup:
     discard "run before each test"
@@ -71,4 +23,8 @@ suite "testing Chan with overwrite mode":
 
   test "basic multithread":
     var chan = newChan[string]()
-    runMultithreadTest(chan)
+    runMultithreadInOrderTest(chan)
+
+  test "basic blocking multithread":
+    var chan = newChan[string]()
+    runMultithreadBockTest(chan)

threading/channels.nim

@@ -151,7 +151,7 @@ proc isUnbuffered(chan: ChannelRaw): bool =
 
 proc isClosed(chan: ChannelRaw): bool {.inline.} = load(chan.closed, moRelaxed)
 
-proc peek(chan: ChannelRaw): int {.inline.} =
+proc peek(chan: ChannelRaw): int =
   (if chan.isUnbuffered: numItemsUnbuf(chan) else: numItems(chan))
 
 
@@ -399,7 +399,7 @@ when false:
   proc close*[T](c: Chan[T]) {.inline.} =
     store(c.d.closed, true, moRelaxed)
 
-proc peek*[T](c: Chan[T]): int {.inline.} = peek(c.d)
+proc peek*[T](c: Chan[T]): int = peek(c.d)
 
 proc newChan*[T](elements = 30, overwrite = false): Chan[T] =
   ## create a new channel implemented using a ring buffer