2019-02-06 14:49:11 +00:00
|
|
|
# Chronos Test Suite
|
|
|
|
# (c) Copyright 2018-Present
|
2018-05-25 01:05:13 +00:00
|
|
|
# Status Research & Development GmbH
|
|
|
|
#
|
|
|
|
# Licensed under either of
|
|
|
|
# Apache License, version 2.0, (LICENSE-APACHEv2)
|
|
|
|
# MIT license (LICENSE-MIT)
|
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 09:08:33 +00:00
|
|
|
import unittest2
|
2023-06-01 22:53:20 +00:00
|
|
|
import ../chronos, ../chronos/oserrno
|
2018-05-25 01:05:13 +00:00
|
|
|
|
2023-03-31 05:35:04 +00:00
|
|
|
{.used.}
|
2019-10-24 13:01:57 +00:00
|
|
|
|
2018-05-25 01:05:13 +00:00
|
|
|
when not defined(windows):
|
|
|
|
import posix
|
|
|
|
|
2019-03-30 22:31:10 +00:00
|
|
|
suite "Signal handling test suite":
|
2023-06-01 22:53:20 +00:00
|
|
|
proc testSignal(signal, value: int): Future[bool] {.async.} =
|
2022-04-11 09:56:30 +00:00
|
|
|
var
|
|
|
|
signalCounter = 0
|
2023-06-01 22:53:20 +00:00
|
|
|
sigFd: SignalHandle
|
|
|
|
handlerFut = newFuture[void]("signal.handler")
|
2019-03-30 22:31:10 +00:00
|
|
|
|
2023-06-01 22:53:20 +00:00
|
|
|
proc signalHandler(udata: pointer) {.gcsafe.} =
|
2022-04-11 09:56:30 +00:00
|
|
|
signalCounter = cast[int](udata)
|
2023-06-01 22:53:20 +00:00
|
|
|
let res = removeSignal2(sigFd)
|
|
|
|
if res.isErr():
|
|
|
|
handlerFut.fail(newException(ValueError, osErrorMsg(res.error())))
|
|
|
|
else:
|
|
|
|
handlerFut.complete()
|
2019-03-30 22:31:10 +00:00
|
|
|
|
2023-06-01 22:53:20 +00:00
|
|
|
sigFd =
|
|
|
|
block:
|
|
|
|
let res = addSignal2(signal, signalHandler, cast[pointer](value))
|
|
|
|
if res.isErr():
|
|
|
|
raiseAssert osErrorMsg(res.error())
|
|
|
|
res.get()
|
2019-03-30 22:31:10 +00:00
|
|
|
|
2023-06-01 22:53:20 +00:00
|
|
|
when defined(windows):
|
|
|
|
discard raiseSignal(cint(signal))
|
|
|
|
else:
|
2019-03-30 22:31:10 +00:00
|
|
|
discard posix.kill(posix.getpid(), cint(signal))
|
2022-06-28 21:53:09 +00:00
|
|
|
|
2023-06-01 22:53:20 +00:00
|
|
|
await handlerFut.wait(5.seconds)
|
|
|
|
return signalCounter == value
|
|
|
|
|
|
|
|
proc testWait(signal: int): Future[bool] {.async.} =
|
|
|
|
var fut = waitSignal(signal)
|
|
|
|
when defined(windows):
|
|
|
|
discard raiseSignal(cint(signal))
|
|
|
|
else:
|
2022-06-28 21:53:09 +00:00
|
|
|
discard posix.kill(posix.getpid(), cint(signal))
|
2023-06-01 22:53:20 +00:00
|
|
|
await fut.wait(5.seconds)
|
|
|
|
return true
|
|
|
|
|
|
|
|
when defined(windows):
|
|
|
|
proc testCtrlC(): Future[bool] {.async, used.} =
|
|
|
|
var fut = waitSignal(SIGINT)
|
|
|
|
let res = raiseConsoleCtrlSignal()
|
|
|
|
if res.isErr():
|
|
|
|
raiseAssert osErrorMsg(res.error())
|
|
|
|
await fut.wait(5.seconds)
|
|
|
|
return true
|
2019-03-30 22:31:10 +00:00
|
|
|
|
|
|
|
test "SIGINT test":
|
2023-06-01 22:53:20 +00:00
|
|
|
let res = waitFor testSignal(SIGINT, 31337)
|
|
|
|
check res == true
|
2022-06-28 21:53:09 +00:00
|
|
|
|
2019-03-30 22:31:10 +00:00
|
|
|
test "SIGTERM test":
|
2023-06-01 22:53:20 +00:00
|
|
|
let res = waitFor testSignal(SIGTERM, 65537)
|
|
|
|
check res == true
|
2022-06-28 21:53:09 +00:00
|
|
|
|
|
|
|
test "waitSignal(SIGINT) test":
|
2023-06-01 22:53:20 +00:00
|
|
|
let res = waitFor testWait(SIGINT)
|
|
|
|
check res == true
|
2022-06-28 21:53:09 +00:00
|
|
|
|
|
|
|
test "waitSignal(SIGTERM) test":
|
2023-06-01 22:53:20 +00:00
|
|
|
let res = waitFor testWait(SIGTERM)
|
|
|
|
check res == true
|
|
|
|
|
|
|
|
# This test doesn't work well in test suite, because it generates CTRL+C
|
|
|
|
# event in Windows console, parent process receives this signal and stops
|
|
|
|
# test suite execution.
|
|
|
|
|
|
|
|
# test "Windows [CTRL+C] test":
|
|
|
|
# when defined(windows):
|
|
|
|
# let res = waitFor testCtrlC()
|
|
|
|
# check res == true
|
|
|
|
# else:
|
|
|
|
# skip()
|