matroskin 0.1.0

whatsminer api client lib
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! Implement `set.system.net_config` command
//!
//! Configures the device's network settings. The device will reboot
//! to apply the new configuration.
//!
//! - Command: [SetSystemNetConfig]
//! - ApiDoc: <https://apidoc.whatsminer.com/#api-System-system_net_config>
use core::str;

use serde::Serialize;

use crate::{
    command::{Command, CommandLevel},
    error::Result,
};

/// Static IP network configuration.
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub struct StaticNetConfig {
    /// The static IP address.
    pub ip: String,
    /// The subnet mask.
    pub netmask: String,
    /// The gateway address.
    pub gateway: String,
    /// The DNS server address.
    pub dns: String,
}

/// Parameter for [SetSystemNetConfig].
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum NetConfigParam {
    /// Enable DHCP.
    Dhcp,
    /// Configure a static IP address.
    Static(StaticNetConfig),
}

impl serde::Serialize for NetConfigParam {
    fn serialize<S: serde::Serializer>(
        &self,
        serializer: S,
    ) -> std::result::Result<S::Ok, S::Error> {
        match self {
            Self::Dhcp => "dhcp".serialize(serializer),
            Self::Static(config) => config.serialize(serializer),
        }
    }
}

/// This command represents the `set.system.net_config` operation.
///
/// Configures the device's network settings. The device will reboot
/// to apply the new configuration.
///
/// - ApiDoc: <https://apidoc.whatsminer.com/#api-System-system_net_config>
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SetSystemNetConfig {
    /// Network configuration parameter
    pub config: NetConfigParam,
}

impl SetSystemNetConfig {
    /// Create a new `set.system.net_config` command with specified configuration.
    pub fn new(config: NetConfigParam) -> Self {
        Self { config }
    }

    /// Configure network to use DHCP.
    pub fn dhcp() -> Self {
        Self {
            config: NetConfigParam::Dhcp,
        }
    }

    /// Configure network to use static IP settings.
    pub fn static_ip(config: StaticNetConfig) -> Self {
        Self {
            config: NetConfigParam::Static(config),
        }
    }
}

impl Command for SetSystemNetConfig {
    type Response = String;
    const CMD_NAME: &'static str = "set.system.net_config";
    const LEVEL: CommandLevel = CommandLevel::Secured;

    fn params(&self) -> Result<Option<impl serde::Serialize>> {
        Ok(Some(&self.config))
    }
}

#[cfg(test)]
mod tests {
    use crate::account::Account;
    use crate::auth_data::AuthData;

    use super::*;

    const RESPONSE_JSON: &str =
        r#"{"code":0,"when":1672281726,"msg":"ok","desc":"set.system.net_config"}"#;

    #[test]
    fn request_dhcp_mode() {
        let cmd = SetSystemNetConfig::dhcp();
        assert!(cmd.is_secured());
        assert!(!cmd.is_encrypted());

        let auth = AuthData::new::<SetSystemNetConfig>(Account::Super, "pass", "salt").unwrap();
        let encoded = cmd.encode(Some(auth)).unwrap();
        let json: serde_json::Value = serde_json::from_slice(&encoded.0).unwrap();

        assert_eq!(json["cmd"], "set.system.net_config");
        assert_eq!(json["param"], "dhcp");
        assert_eq!(json["account"], "super");
        assert!(json["ts"].as_u64().unwrap() > 0);
        assert_eq!(json["token"].as_str().unwrap().len(), 8);
    }

    #[test]
    fn request_static_mode() {
        let cmd = SetSystemNetConfig::static_ip(StaticNetConfig {
            ip: "192.168.2.22".to_string(),
            netmask: "255.255.255.0".to_string(),
            gateway: "192.168.2.1".to_string(),
            dns: "192.168.2.1".to_string(),
        });

        let auth = AuthData::new::<SetSystemNetConfig>(Account::Super, "pass", "salt").unwrap();
        let encoded = cmd.encode(Some(auth)).unwrap();
        let json: serde_json::Value = serde_json::from_slice(&encoded.0).unwrap();

        assert_eq!(json["cmd"], "set.system.net_config");
        assert_eq!(json["param"]["ip"], "192.168.2.22");
    }

    #[test]
    fn request_without_auth_omits_token() {
        let cmd = SetSystemNetConfig::dhcp();
        let encoded = cmd.encode(None).unwrap();
        let json: serde_json::Value = serde_json::from_slice(&encoded.0).unwrap();
        assert!(json.get("token").is_none());
        assert_eq!(json["param"], "dhcp");
    }

    #[test]
    fn deserialize_response_fixture() {
        let response = SetSystemNetConfig::parse_response(RESPONSE_JSON.as_bytes()).unwrap();
        assert!(response.code.is_success());
        assert_eq!(response.desc, "set.system.net_config");
        assert_eq!(response.when, 1672281726);
        assert_eq!(response.msg, "ok");
    }
}