qtest 0.2.0

Connector for working with the QTest socket
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

/// Register module, used to represent and interact with hardware registers.
pub mod register;
/// Parser module, interface to interact with qtest
pub mod session;
/// Socket module, used to serve and manage qtest socket connections.
pub mod socket;

pub mod dispatcher;

/// QTest Response enum
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum Response {
    /// Successfull response, without any additional data
    Ok,
    /// Successfull response, with additional data
    OkVal(String),
    /// Error in processing the request
    Err(String),
}

impl From<&str> for Response {
    fn from(s: &str) -> Self {
        let mut s_parts = s.split_whitespace();
        if s_parts.next() != Some("OK") {
            return Self::Err(s.to_string());
        }
        match s_parts.next() {
            Some(val) => {
                let msg = std::iter::once(val)
                    .chain(s_parts)
                    .collect::<Vec<_>>()
                    .join(" ");
                Self::OkVal(msg)
            }
            None => Self::Ok,
        }
    }
}

/// Struct for defining IRQ events propagated by QEMU.
///
/// The line and state depends on the machine that emits the event.
/// Refer to QEMU documentation for your desired machine.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Irq {
    /// The line of the IRQ event
    pub line: usize,
    /// The state of the IRQ event
    pub state: IrqState,
}

impl Irq {
    /// Creates a new IRQ instance
    pub fn new(line: usize, state: IrqState) -> Self {
        Irq { line, state }
    }
}

/// Enum for defining the state of an IRQ event
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum IrqState {
    /// The IRQ event is raised
    Raise,
    /// The IRQ event is lowered
    Lower,
}

impl TryFrom<&str> for Irq {
    type Error = &'static str;

    fn try_from(s: &str) -> Result<Self, Self::Error> {
        let mut s_parts = s.split_whitespace();

        if s_parts.next() != Some("IRQ") {
            return Err("Invalid IRQ string");
        }
        let ty = match s_parts.next() {
            Some("raise") => IrqState::Raise,
            Some("lower") => IrqState::Lower,
            _ => return Err("Invalid IRQ type"),
        };
        let line = s_parts
            .next()
            .ok_or("Invalid IRQ line")?
            .parse()
            .map_err(|_| "Invalid IRQ line")?;

        match s_parts.next() {
            Some(_) => Err("Invalid IRQ string"),
            None => Ok(Irq::new(line, ty)),
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn test_response_from() {
        let response = Response::from("OK");
        assert_eq!(response, Response::Ok);

        let response = Response::from("OK val");
        assert_eq!(response, Response::OkVal("val".to_string()));

        let response = Response::from("ERR error");
        assert_eq!(response, Response::Err("ERR error".to_string()));
    }

    #[test]
    fn test_irq_try_from() {
        let irq = Irq::try_from("invalid");
        assert_eq!(irq, Err("Invalid IRQ string"));

        let irq = Irq::try_from("IRQ invalid");
        assert_eq!(irq, Err("Invalid IRQ type"));

        let irq = Irq::try_from("IRQ raise -1");
        assert_eq!(irq, Err("Invalid IRQ line"));

        let irq = Irq::try_from("IRQ raise 1 invalid");
        assert_eq!(irq, Err("Invalid IRQ string"));

        let irq = Irq::try_from("IRQ raise 1");
        assert_eq!(irq, Ok(Irq::new(1, IrqState::Raise)));

        let irq = Irq::try_from("IRQ lower 2");
        assert_eq!(irq, Ok(Irq::new(2, IrqState::Lower)));
    }
}