#[cfg(unix)]
use libc;
use futures::future::{self, Future};
use std::boxed::Box;
use std::ffi::{OsStr, OsString};
use std::fmt;
use std::io;
use std::path::Path;
use std::process::{
Command,
ExitStatus,
Output,
Stdio,
};
use std::sync::{Arc,Mutex};
use tokio_process::{
Child,
ChildStderr,
ChildStdin,
ChildStdout,
CommandExt,
};
use tokio_core::reactor::Handle;
use tokio_io::{AsyncRead, AsyncWrite};
pub trait CommandChild {
type I: AsyncWrite + Sync + Send + 'static;
type O: AsyncRead + Sync + Send + 'static;
type E: AsyncRead + Sync + Send + 'static;
fn take_stdin(&mut self) -> Option<Self::I>;
fn take_stdout(&mut self) -> Option<Self::O>;
fn take_stderr(&mut self) -> Option<Self::E>;
fn wait(self) -> Box<Future<Item = ExitStatus, Error = io::Error>>;
fn wait_with_output(self) -> Box<Future<Item = Output, Error = io::Error>>;
}
pub trait RunCommand: fmt::Debug {
type C: CommandChild + 'static;
fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self;
fn args<S: AsRef<OsStr>>(&mut self, args: &[S]) -> &mut Self;
fn env<K, V>(&mut self, key: K, val: V) -> &mut Self
where K: AsRef<OsStr>,
V: AsRef<OsStr>;
fn envs<I, K, V>(&mut self, vars: I) -> &mut Self
where I: IntoIterator<Item=(K, V)>, K: AsRef<OsStr>, V: AsRef<OsStr>;
fn env_clear(&mut self) -> &mut Self;
fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Self;
fn no_console(&mut self) -> &mut Self;
fn stdin(&mut self, cfg: Stdio) -> &mut Self;
fn stdout(&mut self, cfg: Stdio) -> &mut Self;
fn stderr(&mut self, cfg: Stdio) -> &mut Self;
fn spawn(&mut self) -> io::Result<Self::C>;
}
pub trait CommandCreator {
type Cmd: RunCommand;
fn new(handle: &Handle) -> Self;
fn new_command<S: AsRef<OsStr>>(&mut self, program: S) -> Self::Cmd;
}
pub trait CommandCreatorSync: Clone + 'static {
type Cmd: RunCommand;
fn new(handle: &Handle) -> Self;
fn new_command_sync<S: AsRef<OsStr>>(&mut self, program: S) -> Self::Cmd;
}
impl CommandChild for Child {
type I = ChildStdin;
type O = ChildStdout;
type E = ChildStderr;
fn take_stdin(&mut self) -> Option<ChildStdin> { self.stdin().take() }
fn take_stdout(&mut self) -> Option<ChildStdout> { self.stdout().take() }
fn take_stderr(&mut self) -> Option<ChildStderr> { self.stderr().take() }
fn wait(self) -> Box<Future<Item = ExitStatus, Error = io::Error>> {
Box::new(self)
}
fn wait_with_output(self) -> Box<Future<Item = Output, Error = io::Error>> {
Box::new(self.wait_with_output())
}
}
pub struct AsyncCommand {
inner: Command,
handle: Handle,
}
impl AsyncCommand {
pub fn new<S: AsRef<OsStr>>(program: S, handle: Handle) -> AsyncCommand {
AsyncCommand {
inner: Command::new(program),
handle: handle,
}
}
}
impl RunCommand for AsyncCommand {
type C = Child;
fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut AsyncCommand {
self.inner.arg(arg);
self
}
fn args<S: AsRef<OsStr>>(&mut self, args: &[S]) -> &mut AsyncCommand {
self.inner.args(args);
self
}
fn env<K, V>(&mut self, key: K, val: V) -> &mut AsyncCommand
where K: AsRef<OsStr>,
V: AsRef<OsStr>,
{
self.inner.env(key, val);
self
}
fn envs<I, K, V>(&mut self, vars: I) -> &mut Self
where I: IntoIterator<Item=(K, V)>, K: AsRef<OsStr>, V: AsRef<OsStr>
{
for (k, v) in vars {
self.inner.env(k, v);
}
self
}
fn env_clear(&mut self) -> &mut AsyncCommand {
self.inner.env_clear();
self
}
fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut AsyncCommand {
self.inner.current_dir(dir);
self
}
#[cfg(windows)]
fn no_console(&mut self) -> &mut AsyncCommand {
use std::os::windows::process::CommandExt;
const CREATE_NO_WINDOW: u32 = 0x08000000;
self.inner.creation_flags(CREATE_NO_WINDOW);
self
}
#[cfg(unix)]
fn no_console(&mut self) -> &mut AsyncCommand {
self
}
fn stdin(&mut self, cfg: Stdio) -> &mut AsyncCommand {
self.inner.stdin(cfg);
self
}
fn stdout(&mut self, cfg: Stdio) -> &mut AsyncCommand {
self.inner.stdout(cfg);
self
}
fn stderr(&mut self, cfg: Stdio) -> &mut AsyncCommand {
self.inner.stderr(cfg);
self
}
fn spawn(&mut self) -> io::Result<Child> {
self.inner.spawn_async(&self.handle)
}
}
impl fmt::Debug for AsyncCommand {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
self.inner.fmt(f)
}
}
#[derive(Clone)]
pub struct ProcessCommandCreator {
handle: Handle,
}
impl CommandCreator for ProcessCommandCreator {
type Cmd = AsyncCommand;
fn new(handle: &Handle) -> ProcessCommandCreator {
ProcessCommandCreator {
handle: handle.clone(),
}
}
fn new_command<S: AsRef<OsStr>>(&mut self, program: S) -> AsyncCommand {
AsyncCommand::new(program, self.handle.clone())
}
}
impl CommandCreatorSync for ProcessCommandCreator {
type Cmd = AsyncCommand;
fn new(handle: &Handle) -> ProcessCommandCreator {
CommandCreator::new(handle)
}
fn new_command_sync<S: AsRef<OsStr>>(&mut self, program: S) -> AsyncCommand {
self.new_command(program)
}
}
#[cfg(unix)]
pub type ExitStatusValue = libc::c_int;
#[cfg(windows)]
pub type ExitStatusValue = u32;
#[allow(dead_code)]
struct InnerExitStatus(ExitStatusValue);
#[allow(dead_code)]
pub fn exit_status(v : ExitStatusValue) -> ExitStatus {
use std::mem::transmute;
unsafe { transmute(InnerExitStatus(v)) }
}
#[allow(dead_code)]
#[derive(Debug)]
pub struct MockChild {
pub stdin: Option<io::Cursor<Vec<u8>>>,
pub stdout: Option<io::Cursor<Vec<u8>>>,
pub stderr: Option<io::Cursor<Vec<u8>>>,
pub wait_result: Option<io::Result<ExitStatus>>,
}
impl MockChild {
#[allow(dead_code)]
pub fn new<T: AsRef<[u8]>, U: AsRef<[u8]>>(status: ExitStatus, stdout: T, stderr: U) -> MockChild {
MockChild {
stdin: Some(io::Cursor::new(vec!())),
stdout: Some(io::Cursor::new(stdout.as_ref().to_vec())),
stderr: Some(io::Cursor::new(stderr.as_ref().to_vec())),
wait_result: Some(Ok(status)),
}
}
#[allow(dead_code)]
pub fn with_error(err: io::Error) -> MockChild {
MockChild {
stdin: None,
stdout: None,
stderr: None,
wait_result: Some(Err(err)),
}
}
}
impl CommandChild for MockChild {
type I = io::Cursor<Vec<u8>>;
type O = io::Cursor<Vec<u8>>;
type E = io::Cursor<Vec<u8>>;
fn take_stdin(&mut self) -> Option<io::Cursor<Vec<u8>>> { self.stdin.take() }
fn take_stdout(&mut self) -> Option<io::Cursor<Vec<u8>>> { self.stdout.take() }
fn take_stderr(&mut self) -> Option<io::Cursor<Vec<u8>>> { self.stderr.take() }
fn wait(mut self) -> Box<Future<Item = ExitStatus, Error = io::Error>> {
Box::new(future::result(self.wait_result.take().unwrap()))
}
fn wait_with_output(self) -> Box<Future<Item = Output, Error = io::Error>> {
let MockChild { stdout, stderr, wait_result, .. } = self;
let result = wait_result.unwrap().and_then(|status| {
Ok(Output {
status: status,
stdout: stdout.map(|c| c.into_inner()).unwrap_or(vec!()),
stderr: stderr.map(|c| c.into_inner()).unwrap_or(vec!()),
})
});
Box::new(future::result(result))
}
}
pub enum ChildOrCall {
Child(io::Result<MockChild>),
Call(Box<Fn(&[OsString]) -> io::Result<MockChild> + Send>),
}
impl fmt::Debug for ChildOrCall {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
ChildOrCall::Child(ref r) => write!(f, "ChildOrCall::Child({:?}", r),
ChildOrCall::Call(_) => write!(f, "ChildOrCall::Call(...)"),
}
}
}
#[allow(dead_code)]
#[derive(Debug)]
pub struct MockCommand {
pub child: Option<ChildOrCall>,
pub args: Vec<OsString>,
}
impl RunCommand for MockCommand {
type C = MockChild;
fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut MockCommand {
self.args.push(arg.as_ref().to_owned());
self
}
fn args<S: AsRef<OsStr>>(&mut self, args: &[S]) -> &mut MockCommand {
self.args.extend(args.iter().map(|a| a.as_ref().to_owned()));
self
}
fn env<K, V>(&mut self, _key: K, _val: V) -> &mut MockCommand
where K: AsRef<OsStr>,
V: AsRef<OsStr>,
{
self
}
fn envs<I, K, V>(&mut self, _vars: I) -> &mut Self
where I: IntoIterator<Item=(K, V)>, K: AsRef<OsStr>, V: AsRef<OsStr>
{
self
}
fn env_clear(&mut self) -> &mut MockCommand {
self
}
fn current_dir<P: AsRef<Path>>(&mut self, _dir: P) -> &mut MockCommand {
self
}
fn no_console(&mut self) -> &mut MockCommand {
self
}
fn stdin(&mut self, _cfg: Stdio) -> &mut MockCommand {
self
}
fn stdout(&mut self, _cfg: Stdio) -> &mut MockCommand {
self
}
fn stderr(&mut self, _cfg: Stdio) -> &mut MockCommand {
self
}
fn spawn(&mut self) -> io::Result<MockChild> {
match self.child.take().unwrap() {
ChildOrCall::Child(c) => c,
ChildOrCall::Call(f) => f(&self.args),
}
}
}
#[allow(dead_code)]
pub struct MockCommandCreator {
pub children : Vec<ChildOrCall>,
}
impl MockCommandCreator {
#[allow(dead_code)]
pub fn next_command_spawns(&mut self, child: io::Result<MockChild>) {
self.children.push(ChildOrCall::Child(child));
}
#[allow(dead_code)]
pub fn next_command_calls<C>(&mut self, call: C)
where C: Fn(&[OsString]) -> io::Result<MockChild> + Send + 'static,
{
self.children.push(ChildOrCall::Call(Box::new(call)));
}
}
impl CommandCreator for MockCommandCreator {
type Cmd = MockCommand;
fn new(_handle: &Handle) -> MockCommandCreator {
MockCommandCreator {
children: Vec::new(),
}
}
fn new_command<S: AsRef<OsStr>>(&mut self, _program: S) -> MockCommand {
assert!(self.children.len() > 0, "Too many calls to MockCommandCreator::new_command, or not enough to MockCommandCreator::new_command_spawns!");
MockCommand {
child: Some(self.children.remove(0)),
args: vec![],
}
}
}
impl<T: CommandCreator + 'static> CommandCreatorSync for Arc<Mutex<T>> {
type Cmd = T::Cmd;
fn new(handle: &Handle) -> Arc<Mutex<T>> {
Arc::new(Mutex::new(T::new(handle)))
}
fn new_command_sync<S: AsRef<OsStr>>(&mut self, program: S) -> T::Cmd {
self.lock().unwrap().new_command(program)
}
}
#[cfg(test)]
mod test {
use super::*;
use std::error::Error;
use std::ffi::OsStr;
use std::io;
use futures::Future;
use std::process::{
ExitStatus,
Output,
};
use std::sync::{Arc,Mutex};
use std::thread;
use test::utils::*;
use tokio_core::reactor::Core;
fn spawn_command<T : CommandCreator, S: AsRef<OsStr>>(creator : &mut T, program: S) -> io::Result<<<T as CommandCreator>::Cmd as RunCommand>::C> {
creator.new_command(program).spawn()
}
fn spawn_wait_command<T : CommandCreator, S: AsRef<OsStr>>(creator : &mut T, program: S) -> io::Result<ExitStatus> {
spawn_command(creator, program).and_then(|c| c.wait().wait())
}
fn spawn_output_command<T : CommandCreator, S: AsRef<OsStr>>(creator : &mut T, program: S) -> io::Result<Output> {
spawn_command(creator, program).and_then(|c| c.wait_with_output().wait())
}
fn spawn_on_thread<T : CommandCreatorSync + Send + 'static>(mut t : T, really : bool) -> ExitStatus {
thread::spawn(move || {
if really {
t.new_command_sync("foo").spawn().and_then(|c| {
c.wait().wait()
}).unwrap()
} else {
exit_status(1)
}
}).join().unwrap()
}
#[test]
fn test_mock_command_wait() {
let core = Core::new().unwrap();
let mut creator = MockCommandCreator::new(&core.handle());
creator.next_command_spawns(Ok(MockChild::new(exit_status(0), "hello", "error")));
assert_eq!(0, spawn_wait_command(&mut creator, "foo").unwrap().code().unwrap());
}
#[test]
#[should_panic]
fn test_unexpected_new_command() {
let core = Core::new().unwrap();
let mut creator = MockCommandCreator::new(&core.handle());
creator.new_command("foo").spawn().unwrap();
}
#[test]
fn test_mock_command_output() {
let core = Core::new().unwrap();
let mut creator = MockCommandCreator::new(&core.handle());
creator.next_command_spawns(Ok(MockChild::new(exit_status(0), "hello", "error")));
let output = spawn_output_command(&mut creator, "foo").unwrap();
assert_eq!(0, output.status.code().unwrap());
assert_eq!("hello".as_bytes().to_vec(), output.stdout);
assert_eq!("error".as_bytes().to_vec(), output.stderr);
}
#[test]
fn test_mock_command_calls() {
let core = Core::new().unwrap();
let mut creator = MockCommandCreator::new(&core.handle());
creator.next_command_calls(|_| {
Ok(MockChild::new(exit_status(0), "hello", "error"))
});
let output = spawn_output_command(&mut creator, "foo").unwrap();
assert_eq!(0, output.status.code().unwrap());
assert_eq!("hello".as_bytes().to_vec(), output.stdout);
assert_eq!("error".as_bytes().to_vec(), output.stderr);
}
#[test]
fn test_mock_spawn_error() {
let core = Core::new().unwrap();
let mut creator = MockCommandCreator::new(&core.handle());
creator.next_command_spawns(Err(io::Error::new(io::ErrorKind::Other, "error")));
let e = spawn_command(&mut creator, "foo").err().unwrap();
assert_eq!(io::ErrorKind::Other, e.kind());
assert_eq!("error", e.description());
}
#[test]
fn test_mock_wait_error() {
let core = Core::new().unwrap();
let mut creator = MockCommandCreator::new(&core.handle());
creator.next_command_spawns(Ok(MockChild::with_error(io::Error::new(io::ErrorKind::Other, "error"))));
let e = spawn_wait_command(&mut creator, "foo").err().unwrap();
assert_eq!(io::ErrorKind::Other, e.kind());
assert_eq!("error", e.description());
}
#[test]
fn test_mock_command_sync() {
let core = Core::new().unwrap();
let creator = Arc::new(Mutex::new(MockCommandCreator::new(&core.handle())));
next_command(&creator, Ok(MockChild::new(exit_status(0), "hello", "error")));
assert_eq!(exit_status(0), spawn_on_thread(creator.clone(), true));
}
}