fips-core 0.3.11

Reusable FIPS mesh, endpoint, transport, and protocol library
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

//! Control socket protocol types.
//!
//! Line-delimited JSON protocol for the Unix domain socket.
//! Each request is one JSON line, each response is one JSON line.

use serde::{Deserialize, Serialize};

/// A control request from a client.
#[derive(Debug, Deserialize)]
pub struct Request {
    /// The command to execute (e.g., "show_status", "connect").
    pub command: String,
    /// Optional parameters for mutating commands.
    #[serde(default)]
    pub params: Option<serde_json::Value>,
}

/// A control response to a client.
#[derive(Debug, Serialize)]
pub struct Response {
    /// "ok" or "error".
    pub status: String,
    /// Response data (present on success).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<serde_json::Value>,
    /// Error message (present on failure).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

impl Response {
    /// Create a success response with data.
    pub fn ok(data: serde_json::Value) -> Self {
        Self {
            status: "ok".to_string(),
            data: Some(data),
            message: None,
        }
    }

    /// Create an error response with a message.
    pub fn error(message: impl Into<String>) -> Self {
        Self {
            status: "error".to_string(),
            data: None,
            message: Some(message.into()),
        }
    }
}

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

    #[test]
    fn test_deserialize_request() {
        let json = r#"{"command": "show_status"}"#;
        let req: Request = serde_json::from_str(json).unwrap();
        assert_eq!(req.command, "show_status");
    }

    #[test]
    fn test_serialize_ok_response() {
        let resp = Response::ok(serde_json::json!({"state": "running"}));
        let json = serde_json::to_string(&resp).unwrap();
        assert!(json.contains("\"status\":\"ok\""));
        assert!(json.contains("\"state\":\"running\""));
        assert!(!json.contains("\"message\""));
    }

    #[test]
    fn test_serialize_error_response() {
        let resp = Response::error("unknown command: foo");
        let json = serde_json::to_string(&resp).unwrap();
        assert!(json.contains("\"status\":\"error\""));
        assert!(json.contains("unknown command: foo"));
        assert!(!json.contains("\"data\""));
    }

    #[test]
    fn test_deserialize_unknown_fields_ignored() {
        let json = r#"{"command": "show_peers", "extra": true}"#;
        let req: Request = serde_json::from_str(json).unwrap();
        assert_eq!(req.command, "show_peers");
    }

    #[test]
    fn test_deserialize_request_with_params() {
        let json = r#"{"command": "connect", "params": {"npub": "npub1abc", "address": "1.2.3.4:2121", "transport": "udp"}}"#;
        let req: Request = serde_json::from_str(json).unwrap();
        assert_eq!(req.command, "connect");
        let params = req.params.unwrap();
        assert_eq!(params["npub"], "npub1abc");
        assert_eq!(params["transport"], "udp");
    }

    #[test]
    fn test_deserialize_request_without_params() {
        let json = r#"{"command": "show_status"}"#;
        let req: Request = serde_json::from_str(json).unwrap();
        assert_eq!(req.command, "show_status");
        assert!(req.params.is_none());
    }

    #[test]
    fn test_deserialize_malformed_request() {
        let json = r#"{"not_command": "foo"}"#;
        let result: Result<Request, _> = serde_json::from_str(json);
        assert!(result.is_err());
    }
}