38050fa460
# Description Since the `TaskExecutor` currently requires a `Weak<Runtime>`, it's impossible to use it in an async test where the `Runtime` is created outside our scope. Whilst we *could* create a new `Runtime` instance inside the async test, dropping that `Runtime` would cause a panic (you can't drop a `Runtime` in an async context). To address this issue, this PR creates the `enum Handle`, which supports either: - A `Weak<Runtime>` (for use in our production code) - A `Handle` to a runtime (for use in testing) In theory, there should be no change to the behaviour of our production code (beyond some slightly different descriptions in HTTP 500 errors), or even our tests. If there is no change, you might ask *"why bother?"*. There are two PRs (#3070 and #3175) that are waiting on these fixes to introduce some new tests. Since we've added the EL to the `BeaconChain` (for the merge), we are now doing more async stuff in tests. I've also added a `RuntimeExecutor` to the `BeaconChainTestHarness`. Whilst that's not immediately useful, it will become useful in the near future with all the new async testing.
69 lines
2.1 KiB
Rust
69 lines
2.1 KiB
Rust
use crate::TaskExecutor;
|
|
use slog::Logger;
|
|
use sloggers::{null::NullLoggerBuilder, Build};
|
|
use std::sync::Arc;
|
|
use tokio::runtime;
|
|
|
|
/// Whilst the `TestRuntime` is not necessarily useful in itself, it provides the necessary
|
|
/// components for creating a `TaskExecutor` during tests.
|
|
///
|
|
/// May create its own runtime or use an existing one.
|
|
///
|
|
/// ## Warning
|
|
///
|
|
/// This struct should never be used in production, only testing.
|
|
pub struct TestRuntime {
|
|
runtime: Option<Arc<tokio::runtime::Runtime>>,
|
|
_runtime_shutdown: exit_future::Signal,
|
|
pub task_executor: TaskExecutor,
|
|
pub log: Logger,
|
|
}
|
|
|
|
impl Default for TestRuntime {
|
|
/// If called *inside* an existing runtime, instantiates `Self` using a handle to that runtime. If
|
|
/// called *outside* any existing runtime, create a new `Runtime` and keep it alive until the
|
|
/// `Self` is dropped.
|
|
fn default() -> Self {
|
|
let (runtime_shutdown, exit) = exit_future::signal();
|
|
let (shutdown_tx, _) = futures::channel::mpsc::channel(1);
|
|
let log = null_logger().unwrap();
|
|
|
|
let (runtime, handle) = if let Ok(handle) = runtime::Handle::try_current() {
|
|
(None, handle)
|
|
} else {
|
|
let runtime = Arc::new(
|
|
runtime::Builder::new_multi_thread()
|
|
.enable_all()
|
|
.build()
|
|
.unwrap(),
|
|
);
|
|
let handle = runtime.handle().clone();
|
|
(Some(runtime), handle)
|
|
};
|
|
|
|
let task_executor = TaskExecutor::new(handle, exit, log.clone(), shutdown_tx);
|
|
|
|
Self {
|
|
runtime,
|
|
_runtime_shutdown: runtime_shutdown,
|
|
task_executor,
|
|
log,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Drop for TestRuntime {
|
|
fn drop(&mut self) {
|
|
if let Some(runtime) = self.runtime.take() {
|
|
Arc::try_unwrap(runtime).unwrap().shutdown_background()
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn null_logger() -> Result<Logger, String> {
|
|
let log_builder = NullLoggerBuilder;
|
|
log_builder
|
|
.build()
|
|
.map_err(|e| format!("Failed to start null logger: {:?}", e))
|
|
}
|