Unit testing of asynchrononous code in Nim
Go to file
Mark Spanbroek 3882ed64ed Run CI also on older version of Nim 2021-07-07 10:36:37 +02:00
.github/workflows Run CI also on older version of Nim 2021-07-07 10:36:37 +02:00
asynctest Add support for unittest2 2021-07-07 10:33:52 +02:00
testmodules Add support for unittest2 2021-07-07 10:33:52 +02:00
.editorconfig Asynchronous testing in Nim 2021-01-11 13:35:19 +01:00
.gitignore Asynchronous testing in Nim 2021-01-11 13:35:19 +01:00
.tool-versions Nim 1.4.8 2021-07-07 10:33:52 +02:00
Readme.md version 0.3.0 2021-07-07 10:33:52 +02:00
asynctest.nim Add support for unittest2 2021-07-07 10:33:52 +02:00
asynctest.nimble version 0.3.0 2021-07-07 10:33:52 +02:00

Readme.md

asynctest

Complements the standard unittest module in Nim to allow testing of asynchronous code.

Installation

Use the Nimble package manager to add asynctest to an existing project. Add the following to its .nimble file:

requires "asynctest >= 0.3.0 & < 0.4.0"

Usage

Simply replace import unittest with import asynctest, and you can await asynchronous calls in tests, setup and teardown.

Example


import asynctest
import asyncdispatch # alternatively: import chronos

proc someAsyncProc {.async.} =
  # perform some async operations using await

suite "test async proc":

  setup:
    # invoke await in the test setup:
    await someAsyncProc()

  teardown:
    # invoke await in the test teardown:
    await someAsyncProc()

  test "async test":
    # invoke await in tests:
    await someAsyncProc()

Unittest2

The unittest2 package is supported. Make sure that you import asynctest/unittest2 instead of the normal import.