system-harness 0.4.0

An system harness abstraction and configuration serialization provider for virtualization and emulation systems
Documentation
use crate::{Error, ErrorKind, Status, SystemHarness};
use serde::{Deserialize, Serialize};
use std::io::{Read, Write};
use std::process::{Command, Output, Stdio, Child};

fn strip_last_newline(input: &str) -> &str {
    input
        .strip_suffix("\r\n")
        .or(input.strip_suffix("\n"))
        .unwrap_or(input)
}

/// Process output to result
fn output_to_result(output: Output) -> Result<String, Error> {
    match output.status.success() {
        true => Ok(strip_last_newline(
                std::str::from_utf8(&output.stdout)?
        ).to_string()),
        false => {
            let error = std::str::from_utf8(&output.stderr)?;
            Err(Error::new(ErrorKind::HarnessError, error))
        }
    }
}

/// A container system config
#[derive(Clone, Serialize, Deserialize)]
pub struct ContainerSystemConfig {

    /// Container runtime
    tool: String,

    /// Container image
    image: String,

}

impl ContainerSystemConfig {

    /// Build and run a container based on name
    pub fn build(&self) -> Result<ContainerSystem, Error> {
        let id = Command::new(&self.tool)
            .arg("create")
            .arg("-t") 
            .arg(&self.image)
            .output()
            .map_err(|err| err.into())
            .and_then(output_to_result)
            .map_err(|err| { log::warn!("{err}"); err })?;
        log::trace!("Created container: {id}");

        let process = Command::new(&self.tool)
            .stdout(Stdio::piped())
            .stdin(Stdio::piped())
            .arg("start")
            .arg("-a")
            .arg(&id)
            .spawn()?;

        Ok(ContainerSystem {
            id,
            tool: self.tool.clone(),
            process: Some(process)
        })
    }

}

pub struct ContainerSystem {
    tool: String,
    id: String,
    process: Option<Child>
}

#[derive(Deserialize)]
#[serde(rename_all = "PascalCase")]
struct State {
    running: bool,
    paused: bool
}

#[derive(Deserialize)]
#[serde(rename_all = "PascalCase")]
struct Inspect {
    state: State
}

impl SystemHarness for ContainerSystem {

    fn send_key(&mut self, _key: crate::Key) -> Result<(), Error> {
        Err(Error::new(ErrorKind::HarnessError, "Sending a keystroke not supported"))
    }

    fn pause(&mut self) -> Result<(), Error> {
        log::trace!("Pausing container: {}", &self.id); 
        Command::new(&self.tool)
            .arg("pause")
            .arg(&self.id)
            .output()
            .map_err(|err| err.into())
            .and_then(output_to_result)
            .map(|_| log::trace!("Paused container: {}", self.id))
    }

    fn resume(&mut self) -> Result<(), Error> {
        log::trace!("Resuming container: {}", &self.id); 
        Command::new(&self.tool)
            .arg("unpause")
            .arg(&self.id)
            .output()
            .map_err(|err| err.into())
            .and_then(output_to_result)
            .map(|_| log::trace!("Resumed container: {}", self.id))
    }

    fn shutdown(&mut self) -> Result<(), Error> {
        log::trace!("Shutting down container: {}", &self.id); 
        if let Some(mut process) = self.process.take() {
            if let Err(err) = process.kill() {
                log::warn!("{err}");
            }
            Ok(())
        } else {
            Err(Error::new(ErrorKind::HarnessError, "Container not running"))
        }
    }

    fn status(&mut self) -> Result<Status, Error> {
        Command::new(&self.tool)
            .arg("inspect")
            .arg(&self.id)
            .output()
            .map_err(|err| err.into())
            .and_then(output_to_result)
            .map_err(|err| { log::warn!("{err}"); err })
            .and_then(|stdout| {
                let inspect: Vec<Inspect> = serde_json::from_str(&stdout)?;
                inspect.into_iter()
                    .next()
                    .ok_or(Error::new(ErrorKind::HarnessError, "Container doesn't exist"))
                    .and_then(|inspect| {
                        let state = &inspect.state;
                        if state.running {
                            Ok(Status::Running)
                        } else if state.paused {
                            Ok(Status::Paused)
                        } else if !state.running && !state.paused {
                            Ok(Status::Shutdown)
                        } else {
                            Err(Error::new(ErrorKind::HarnessError,
                                    format!("Unhandled status")))
                        }
                    })
            })
    }

    fn running(&mut self) -> Result<bool, Error> {
        self.status().map(|status| status == Status::Running)
    }

}

impl Read for ContainerSystem {
    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
        self.process.as_mut()
            .and_then(|process| process.stdout.as_mut())
            .ok_or(std::io::Error::new(
                    std::io::ErrorKind::BrokenPipe, 
                    "Can't read from container"
                    ))
            .and_then(|stdout| stdout.read(buf))
    }
}

impl Write for ContainerSystem {
    fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
        self.process.as_mut()
            .and_then(|process| process.stdin.as_mut())
            .ok_or(std::io::Error::new(
                    std::io::ErrorKind::BrokenPipe, 
                    "Can't write to container"
                    ))
            .and_then(|stdin| stdin.write(buf))
    }

    fn flush(&mut self) -> std::io::Result<()> {
        self.process.as_mut()
            .and_then(|process| process.stdin.as_mut())
            .ok_or(std::io::Error::new(
                    std::io::ErrorKind::BrokenPipe, 
                    "Can't write to container"
                    ))
            .and_then(|stdin| stdin.flush())
    }
}

impl Drop for ContainerSystem {
    fn drop(&mut self) {
        if let Ok(running) = self.running() {
            if running {
                if let Ok(()) = self.shutdown() {
                    log::trace!("Deleting container: {}", &self.id); 
                    let _ = Command::new(&self.tool)
                        .args(&["rm", "-f", &self.id])
                        .output();
                } else {
                    log::warn!("Failed to shutdown: {}", &self.id);
                }
            }
        }
    }
}