pezsc-rpc 29.0.0

Bizinikiwi Client RPC
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

// This file is part of Bizinikiwi.

// Copyright (C) Parity Technologies (UK) Ltd. and Dijital Kurdistan Tech Institute
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! Testing utils used by the RPC tests.

use std::{future::Future, sync::Arc};

use jsonrpsee::Extensions;
use pezsc_rpc_api::DenyUnsafe;

/// A task executor that can be used for running RPC tests.
///
/// Warning: the tokio runtime must be initialized before calling this.
#[derive(Clone)]
pub struct TokioTestExecutor(tokio::runtime::Handle);

impl TokioTestExecutor {
	/// Create a new instance of `Self`.
	pub fn new() -> Self {
		Self(tokio::runtime::Handle::current())
	}
}

impl Default for TokioTestExecutor {
	fn default() -> Self {
		Self::new()
	}
}

impl pezsp_core::traits::SpawnNamed for TokioTestExecutor {
	fn spawn_blocking(
		&self,
		_name: &'static str,
		_group: Option<&'static str>,
		future: futures::future::BoxFuture<'static, ()>,
	) {
		let handle = self.0.clone();
		self.0.spawn_blocking(move || {
			handle.block_on(future);
		});
	}
	fn spawn(
		&self,
		_name: &'static str,
		_group: Option<&'static str>,
		future: futures::future::BoxFuture<'static, ()>,
	) {
		self.0.spawn(future);
	}
}

/// Executor for testing.
pub fn test_executor() -> Arc<TokioTestExecutor> {
	Arc::new(TokioTestExecutor::default())
}

/// Wrap a future in a timeout a little more concisely
pub fn timeout_secs<I, F: Future<Output = I>>(s: u64, f: F) -> tokio::time::Timeout<F> {
	tokio::time::timeout(std::time::Duration::from_secs(s), f)
}

/// Helper to create an extension that denies unsafe calls.
pub fn deny_unsafe() -> Extensions {
	let mut ext = Extensions::new();
	ext.insert(DenyUnsafe::Yes);
	ext
}

/// Helper to create an extension that allows unsafe calls.
pub fn allow_unsafe() -> Extensions {
	let mut ext = Extensions::new();
	ext.insert(DenyUnsafe::No);
	ext
}