distant/tests/cli/fixtures.rs
Chip Senkbeil 0a11ec65a2
Add native ssh (#57)
* Bump to 0.15.0
* Add new distant-ssh2 subcrate to provide an alternate session as an ssh client
* Add rpassword & wezterm-ssh dependencies
* Rename core -> distant-core in project directory structure and move ssh2 feature into distant-ssh2 crate
* Upgrade tokio to 1.12,
* Update github actions to detect changes and apply testing for only those changes
* Add method parameter to support distant & ssh methods for action and lsp subcommands
* Add ssh-host, ssh-port, and ssh-user parameters to specify information for ssh method
2021-09-28 00:04:26 -05:00

104 lines
3.5 KiB
Rust

use crate::cli::utils;
use assert_cmd::Command;
use distant_core::*;
use once_cell::sync::OnceCell;
use rstest::*;
use std::{ffi::OsStr, net::SocketAddr, thread};
use tokio::{runtime::Runtime, sync::mpsc};
const LOG_PATH: &str = "/tmp/test.distant.server.log";
/// Context for some listening distant server
pub struct DistantServerCtx {
pub addr: SocketAddr,
pub key: String,
done_tx: mpsc::Sender<()>,
}
impl DistantServerCtx {
pub fn initialize() -> Self {
let ip_addr = "127.0.0.1".parse().unwrap();
let (done_tx, mut done_rx) = mpsc::channel(1);
let (started_tx, mut started_rx) = mpsc::channel(1);
// NOTE: We spawn a dedicated thread that runs our tokio runtime separately
// from our test itself because using assert_cmd blocks the thread
// and prevents our runtime from working unless we make the tokio
// test multi-threaded using `tokio::test(flavor = "multi_thread", worker_threads = 1)`
// which isn't great because we're only using async tests for our
// server itself; so, we hide that away since our test logic doesn't need to be async
thread::spawn(move || match Runtime::new() {
Ok(rt) => {
rt.block_on(async move {
let logger = utils::init_logging(LOG_PATH);
let opts = DistantServerOptions {
shutdown_after: None,
max_msg_capacity: 100,
};
let key = SecretKey::default();
let key_hex_string = key.unprotected_to_hex_key();
let codec = XChaCha20Poly1305Codec::from(key);
let (_server, port) =
DistantServer::bind(ip_addr, "0".parse().unwrap(), codec, opts)
.await
.unwrap();
started_tx.send(Ok((port, key_hex_string))).await.unwrap();
let _ = done_rx.recv().await;
logger.flush();
logger.shutdown();
});
}
Err(x) => {
started_tx.blocking_send(Err(x)).unwrap();
}
});
// Extract our server startup data if we succeeded
let (port, key) = started_rx.blocking_recv().unwrap().unwrap();
Self {
addr: SocketAddr::new(ip_addr, port),
key,
done_tx,
}
}
/// Produces a new test command that configures some distant command
/// configured with an environment that can talk to a remote distant server
pub fn new_cmd(&self, subcommand: impl AsRef<OsStr>) -> Command {
let mut cmd = Command::cargo_bin(env!("CARGO_PKG_NAME")).unwrap();
cmd.arg(subcommand)
.args(&["--session", "environment"])
.env("DISTANT_HOST", self.addr.ip().to_string())
.env("DISTANT_PORT", self.addr.port().to_string())
.env("DISTANT_KEY", self.key.as_str());
cmd
}
}
impl Drop for DistantServerCtx {
/// Kills server upon drop
fn drop(&mut self) {
let _ = self.done_tx.send(());
}
}
#[fixture]
pub fn ctx() -> &'static DistantServerCtx {
static CTX: OnceCell<DistantServerCtx> = OnceCell::new();
CTX.get_or_init(DistantServerCtx::initialize)
}
#[fixture]
pub fn action_cmd(ctx: &'_ DistantServerCtx) -> Command {
ctx.new_cmd("action")
}
#[fixture]
pub fn lsp_cmd(ctx: &'_ DistantServerCtx) -> Command {
ctx.new_cmd("lsp")
}