testground 0.4.0

The Rust SDK for developing Testground test plans.
Documentation
use serde::Deserialize;
use serde_with::{serde_as, NoneAsEmptyString};

#[derive(Deserialize, Debug)]
pub struct SignalEntry {
    pub seq: u64,
}

#[derive(Deserialize, Debug)]
pub struct Publish {
    pub seq: u64,
}

#[serde_as]
#[derive(Deserialize, Debug)]
pub struct RawResponse {
    pub id: String,

    #[serde_as(as = "NoneAsEmptyString")]
    pub error: Option<String>,

    #[serde_as(as = "NoneAsEmptyString")]
    pub subscribe: Option<String>,

    pub signal_entry: Option<SignalEntry>,

    pub publish: Option<Publish>,
}

#[derive(Debug, PartialEq, Eq)]
pub enum ResponseType {
    SignalEntry { seq: u64 },
    Publish { seq: u64 },
    Subscribe(serde_json::Value),
    Error(String),
    Barrier,
}

#[derive(Debug, PartialEq, Eq)]
pub struct Response {
    pub id: String,
    pub response: ResponseType,
}

impl From<RawResponse> for Response {
    fn from(raw_response: RawResponse) -> Self {
        let RawResponse {
            id,
            error,
            subscribe,
            signal_entry,
            publish,
        } = raw_response;

        let response = match (error, subscribe, signal_entry, publish) {
            (None, None, None, None) => ResponseType::Barrier,
            (Some(error), None, None, None) => {
                // Hack to remove extra escape characters
                let error = serde_json::from_str(&error).expect("JSON Deserialization");
                ResponseType::Error(error)
            }
            (None, Some(msg), None, None) => {
                // The Subscribe payload is a json encoded string, so we need to deserialize it.
                let payload = serde_json::from_str(&msg).expect("JSON Deserialization");
                ResponseType::Subscribe(payload)
            }
            (None, None, Some(signal), None) => ResponseType::SignalEntry { seq: signal.seq },
            (None, None, None, Some(publish)) => ResponseType::Publish { seq: publish.seq },
            (error, subscribe, signal_entry, publish) => {
                panic!(
                    "Incompatible Raw Response {:?}",
                    RawResponse {
                        id,
                        error,
                        subscribe,
                        signal_entry,
                        publish,
                    }
                );
            }
        };

        Self { id, response }
    }
}

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

    #[test]
    fn serde_test() {
        let raw_response =
            "{\"id\":\"0\",\"error\":\"\",\"subscribe\":\"\",\"publish\":{\"seq\":1},\"signal_entry\":null}";

        let response: RawResponse = serde_json::from_str(raw_response).unwrap();

        let response: Response = response.into();

        assert_eq!(
            Response {
                id: "0".to_owned(),
                response: ResponseType::Publish { seq: 1 }
            },
            response
        );
    }
    #[test]
    fn serde_test_complex_subscribe() {
        let raw_response = "{\"id\":\"1\",\"error\":\"\",\"subscribe\":\"{\\\"Addrs\\\":[\\\"/ip4/16.3.0.3/tcp/45369\\\"],\\\"ID\\\":\\\"QmbSLMEMackm7vHiUGMB2EFAPbzeJNpeB9yTpzYKoojDWc\\\"}\"}";

        let response: RawResponse = serde_json::from_str(raw_response).unwrap();

        let response: Response = response.into();

        assert_eq!(
            Response {
                id: "1".to_owned(),
                response: ResponseType::Subscribe(serde_json::json!({
                    "Addrs": ["/ip4/16.3.0.3/tcp/45369"],
                    "ID": "QmbSLMEMackm7vHiUGMB2EFAPbzeJNpeB9yTpzYKoojDWc"
                }))
            },
            response
        );
    }
}