nim-chronos/tests/testutils.nim
Jacek Sieka 4abd7a5645
exception tracking (#166)
* exception tracking

This PR adds minimal exception tracking to chronos, moving the goalpost
one step further.

In particular, it becomes invalid to raise exceptions from `callSoon`
callbacks: this is critical for writing correct error handling because
there's no reasonable way that a user of chronos can possibly _reason_
about exceptions coming out of there: the event loop will be in an
indeterminite state when the loop is executing an _random_ callback.

As expected, there are several issues in the error handling of chronos:
in particular, it will end up in an inconsistent internal state whenever
the selector loop operations fail, because the internal state update
functions are not written in an exception-safe way. This PR turns this
into a Defect, which probably is not the optimal way of handling things
- expect more work to be done here.

Some API have no way of reporting back errors to callers - for example,
when something fails in the accept loop, there's not much it can do, and
no way to report it back to the user of the API - this has been fixed
with the new accept flow - the old one should be deprecated.

Finally, there is information loss in the API: in composite operations
like `poll` and `waitFor` there's no way to differentiate internal
errors from user-level errors originating from callbacks.

* store `CatchableError` in future
* annotate proc's with correct raises information
* `selectors2` to avoid non-CatchableError IOSelectorsException
* `$` should never raise
* remove unnecessary gcsafe annotations
* fix exceptions leaking out of timer waits
* fix some imports
* functions must signal raising the union of all exceptions across all
platforms to enable cross-platform code
* switch to unittest2
* add `selectors2` which supercedes the std library version and fixes
several exception handling issues in there

* fixes

* docs, platform-independent eh specifiers for some functions

* add feature flag for strict exception mode

also bump version to 3.0.0 - _most_ existing code should be compatible
with this version of exception handling but some things might need
fixing - callbacks, existing raises specifications etc.

* fix AsyncCheck for non-void T
2021-03-24 10:08:33 +01:00

87 lines
2.1 KiB
Nim

# Chronos Test Suite
# (c) Copyright 2020-Present
# Status Research & Development GmbH
#
# Licensed under either of
# Apache License, version 2.0, (LICENSE-APACHEv2)
# MIT license (LICENSE-MIT)
import unittest2
import ../chronos
when defined(nimHasUsed): {.used.}
suite "Asynchronous utilities test suite":
when defined(chronosFutureTracking):
proc getCount(): int =
# This procedure counts number of Future[T] in double-linked list via list
# iteration.
result = 0
for item in pendingFutures():
inc(result)
test "Future clean and leaks test":
when defined(chronosFutureTracking):
if pendingFuturesCount(WithoutFinished) == 0:
if pendingFuturesCount(OnlyFinished) > 0:
poll()
check pendingFuturesCount() == 0
else:
echo dumpPendingFutures()
check false
else:
skip()
test "FutureList basics test":
when defined(chronosFutureTracking):
var fut1 = newFuture[void]()
check:
getCount() == 1
pendingFuturesCount() == 1
var fut2 = newFuture[void]()
check:
getCount() == 2
pendingFuturesCount() == 2
var fut3 = newFuture[void]()
check:
getCount() == 3
pendingFuturesCount() == 3
fut1.complete()
poll()
check:
getCount() == 2
pendingFuturesCount() == 2
fut2.fail(newException(ValueError, ""))
poll()
check:
getCount() == 1
pendingFuturesCount() == 1
fut3.cancel()
poll()
check:
getCount() == 0
pendingFuturesCount() == 0
else:
skip()
test "FutureList async procedure test":
when defined(chronosFutureTracking):
proc simpleProc() {.async.} =
await sleepAsync(10.milliseconds)
var fut = simpleProc()
check:
getCount() == 2
pendingFuturesCount() == 2
waitFor fut
check:
getCount() == 1
pendingFuturesCount() == 1
poll()
check:
getCount() == 0
pendingFuturesCount() == 0
else:
skip()