nym-test-utils 1.20.4

Helpers, traits, and mock definitions for tests
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

// Copyright 2025 - Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: Apache-2.0

use crate::helpers::{leak, spawn_timeboxed};
use std::future::{Future, IntoFuture};
use std::time::Duration;
use tokio::task::JoinHandle;
use tokio::time::error::Elapsed;

// a helper trait for use in tests to easily convert `T` into `&'static mut T`
pub trait Leak {
    fn leak(self) -> &'static mut Self;
}

impl<T> Leak for T {
    fn leak(self) -> &'static mut T {
        leak(self)
    }
}

// those are internal testing traits so we're not concerned about auto traits
#[allow(async_fn_in_trait)]
pub trait Timeboxed: IntoFuture + Sized {
    async fn timeboxed(self) -> Result<Self::Output, Elapsed> {
        self.execute_with_deadline(Duration::from_millis(200)).await
    }

    async fn execute_with_deadline(self, timeout: Duration) -> Result<Self::Output, Elapsed> {
        tokio::time::timeout(timeout, self).await
    }
}

impl<T> Timeboxed for T where T: IntoFuture + Sized {}

pub trait ElapsedExt {
    fn has_elapsed(&self) -> bool;
}

impl<T> ElapsedExt for Result<T, Elapsed> {
    fn has_elapsed(&self) -> bool {
        self.is_err()
    }
}

// those are internal testing traits so we're not concerned about auto traits
#[allow(async_fn_in_trait)]
pub trait Spawnable: Future + Sized + Send + 'static {
    fn spawn(self) -> JoinHandle<Self::Output>
    where
        <Self as Future>::Output: Send + 'static,
    {
        tokio::spawn(self)
    }
}

impl<T> Spawnable for T where T: Future + Sized + Send + 'static {}

pub trait TimeboxedSpawnable: Timeboxed + Spawnable {
    fn spawn_timeboxed(self) -> JoinHandle<Result<<Self as Future>::Output, Elapsed>>
    where
        <Self as Future>::Output: Send,
    {
        spawn_timeboxed(self)
    }
}

impl<T> TimeboxedSpawnable for T where T: Spawnable + Future + Send {}