status-im
/
nim-chronos
mirror of https://github.com/status-im/nim-chronos.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-chronos/tests/testutils.nim

88 lines
2.1 KiB
Nim
Raw Normal View History

[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
# 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)
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
Compile-time configuration (#371) This PR moves all compile-time configuration to a single module, simplifying documentation and access to these features. Upcomfing features may be enabled either individually, or through a new `chronosPreviewV4` catch-all designed to allow code to be prepared for increased strictness in future chronos releases. `-d:chronosDebug` may be used to enable the existing debugging helpers together.
2023-03-31 05:35:04 +00:00
import ../chronos, ../chronos/config
[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
Compile-time configuration (#371) This PR moves all compile-time configuration to a single module, simplifying documentation and access to these features. Upcomfing features may be enabled either individually, or through a new `chronosPreviewV4` catch-all designed to allow code to be prepared for increased strictness in future chronos releases. `-d:chronosDebug` may be used to enable the existing debugging helpers together.
2023-03-31 05:35:04 +00:00
{.used.}
[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
suite "Asynchronous utilities test suite":
Compile-time configuration (#371) This PR moves all compile-time configuration to a single module, simplifying documentation and access to these features. Upcomfing features may be enabled either individually, or through a new `chronosPreviewV4` catch-all designed to allow code to be prepared for increased strictness in future chronos releases. `-d:chronosDebug` may be used to enable the existing debugging helpers together.
2023-03-31 05:35:04 +00:00
when chronosFutureTracking:
Change Future identifier type from `int` to `uint`. (#228) * Change Future identifier type from `int` to `uint64`. * Fix compilation error and tests. * Add integer overflow test, to avoid confusion with next Nim versions, we expect that unsigned integers do not raise any exceptions if overflow happens. * Switch from `uint64` to `uint` type. * Add `uint` overflow tests.
2021-10-21 14:22:11 +00:00
proc getCount(): uint =
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
# This procedure counts number of Future[T] in double-linked list via list
# iteration.
Change Future identifier type from `int` to `uint`. (#228) * Change Future identifier type from `int` to `uint64`. * Fix compilation error and tests. * Add integer overflow test, to avoid confusion with next Nim versions, we expect that unsigned integers do not raise any exceptions if overflow happens. * Switch from `uint64` to `uint` type. * Add `uint` overflow tests.
2021-10-21 14:22:11 +00:00
var res = 0'u
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
for item in pendingFutures():
Change Future identifier type from `int` to `uint`. (#228) * Change Future identifier type from `int` to `uint64`. * Fix compilation error and tests. * Add integer overflow test, to avoid confusion with next Nim versions, we expect that unsigned integers do not raise any exceptions if overflow happens. * Switch from `uint64` to `uint` type. * Add `uint` overflow tests.
2021-10-21 14:22:11 +00:00
inc(res)
res
[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
test "Future clean and leaks test":
Compile-time configuration (#371) This PR moves all compile-time configuration to a single module, simplifying documentation and access to these features. Upcomfing features may be enabled either individually, or through a new `chronosPreviewV4` catch-all designed to allow code to be prepared for increased strictness in future chronos releases. `-d:chronosDebug` may be used to enable the existing debugging helpers together.
2023-03-31 05:35:04 +00:00
when chronosFutureTracking:
Future cleanup (#393) * FutureState.Finished -> FutureState.Completed (to avoid name clash with `proc finished` which means not-pending) * deprecate `done` - to avoid additional confusion over completed vs finished * remove ad leftovers in stack trace formatting * avoid some generic bloat * avoid unnecessary allocations in `race`/`one`
2023-05-25 15:31:35 +00:00
if pendingFuturesCount(WithoutCompleted) == 0'u:
if pendingFuturesCount(OnlyCompleted) > 0'u:
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
poll()
Change Future identifier type from `int` to `uint`. (#228) * Change Future identifier type from `int` to `uint64`. * Fix compilation error and tests. * Add integer overflow test, to avoid confusion with next Nim versions, we expect that unsigned integers do not raise any exceptions if overflow happens. * Switch from `uint64` to `uint` type. * Add `uint` overflow tests.
2021-10-21 14:22:11 +00:00
check pendingFuturesCount() == 0'u
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
else:
echo dumpPendingFutures()
check false
[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
else:
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
skip()
[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
test "FutureList basics test":
Compile-time configuration (#371) This PR moves all compile-time configuration to a single module, simplifying documentation and access to these features. Upcomfing features may be enabled either individually, or through a new `chronosPreviewV4` catch-all designed to allow code to be prepared for increased strictness in future chronos releases. `-d:chronosDebug` may be used to enable the existing debugging helpers together.
2023-03-31 05:35:04 +00:00
when chronosFutureTracking:
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
var fut1 = newFuture[void]()
check:
Change Future identifier type from `int` to `uint`. (#228) * Change Future identifier type from `int` to `uint64`. * Fix compilation error and tests. * Add integer overflow test, to avoid confusion with next Nim versions, we expect that unsigned integers do not raise any exceptions if overflow happens. * Switch from `uint64` to `uint` type. * Add `uint` overflow tests.
2021-10-21 14:22:11 +00:00
getCount() == 1'u
pendingFuturesCount() == 1'u
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
var fut2 = newFuture[void]()
check:
Change Future identifier type from `int` to `uint`. (#228) * Change Future identifier type from `int` to `uint64`. * Fix compilation error and tests. * Add integer overflow test, to avoid confusion with next Nim versions, we expect that unsigned integers do not raise any exceptions if overflow happens. * Switch from `uint64` to `uint` type. * Add `uint` overflow tests.
2021-10-21 14:22:11 +00:00
getCount() == 2'u
pendingFuturesCount() == 2'u
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
var fut3 = newFuture[void]()
check:
Change Future identifier type from `int` to `uint`. (#228) * Change Future identifier type from `int` to `uint64`. * Fix compilation error and tests. * Add integer overflow test, to avoid confusion with next Nim versions, we expect that unsigned integers do not raise any exceptions if overflow happens. * Switch from `uint64` to `uint` type. * Add `uint` overflow tests.
2021-10-21 14:22:11 +00:00
getCount() == 3'u
pendingFuturesCount() == 3'u
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
fut1.complete()
poll()
check:
Change Future identifier type from `int` to `uint`. (#228) * Change Future identifier type from `int` to `uint64`. * Fix compilation error and tests. * Add integer overflow test, to avoid confusion with next Nim versions, we expect that unsigned integers do not raise any exceptions if overflow happens. * Switch from `uint64` to `uint` type. * Add `uint` overflow tests.
2021-10-21 14:22:11 +00:00
getCount() == 2'u
pendingFuturesCount() == 2'u
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
fut2.fail(newException(ValueError, ""))
poll()
check:
Change Future identifier type from `int` to `uint`. (#228) * Change Future identifier type from `int` to `uint64`. * Fix compilation error and tests. * Add integer overflow test, to avoid confusion with next Nim versions, we expect that unsigned integers do not raise any exceptions if overflow happens. * Switch from `uint64` to `uint` type. * Add `uint` overflow tests.
2021-10-21 14:22:11 +00:00
getCount() == 1'u
pendingFuturesCount() == 1'u
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
fut3.cancel()
poll()
check:
Fix identifiers to be `uint` instead of `uint64`.
2021-10-21 14:46:06 +00:00
getCount() == 0'u
pendingFuturesCount() == 0'u
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
else:
skip()
[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
test "FutureList async procedure test":
Compile-time configuration (#371) This PR moves all compile-time configuration to a single module, simplifying documentation and access to these features. Upcomfing features may be enabled either individually, or through a new `chronosPreviewV4` catch-all designed to allow code to be prepared for increased strictness in future chronos releases. `-d:chronosDebug` may be used to enable the existing debugging helpers together.
2023-03-31 05:35:04 +00:00
when chronosFutureTracking:
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
proc simpleProc() {.async.} =
await sleepAsync(10.milliseconds)
[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
var fut = simpleProc()
check:
Fix identifiers to be `uint` instead of `uint64`.
2021-10-21 14:46:06 +00:00
getCount() == 2'u
pendingFuturesCount() == 2'u
[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
waitFor fut
check:
Fix identifiers to be `uint` instead of `uint64`.
2021-10-21 14:46:06 +00:00
getCount() == 1'u
pendingFuturesCount() == 1'u
[WIP] Zero-cost unattended Future[T] tracking mechanism. (#106) * Zero-cost unattended Future[T] tracking mechanism with tests and tracking of test suite.
2020-07-06 06:33:13 +00:00
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
poll()
check:
Fix identifiers to be `uint` instead of `uint64`.
2021-10-21 14:46:06 +00:00
getCount() == 0'u
pendingFuturesCount() == 0'u
Make Future tracking and stack traces optional (#108) * Make Future tracking optional via -d:chronosDutureTracking compilation flag. * Stack traces is now optional, use -d:chronosStackTraces. * Fix mistypes and add test for chronosStackTrace option.
2020-07-08 16:48:01 +00:00
else:
skip()