nmrs 2.3.0

A Rust library for NetworkManager over D-Bus
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312

//! Bluetooth connection management module.
//!
//! This module provides functions to create and manage Bluetooth network connections
//! using NetworkManager's D-Bus API. It includes builders for Bluetooth PAN (Personal Area
//! Network) connections and DUN (Dial-Up Networking) connections.
//!
//! # Usage
//!
//! Most users should use the high-level [`NetworkManager`](crate::NetworkManager) API
//! instead of calling these builders directly. These are exposed for advanced use cases
//! where you need fine-grained control over connection settings.
//!
//! # Example
//!
//! ```rust
//! use nmrs::builders::build_bluetooth_connection;
//! use nmrs::models::{BluetoothIdentity, BluetoothNetworkRole};
//!
//! let bt_settings = BluetoothIdentity::new(
//!    "00:1A:7D:DA:71:13".into(),
//!    BluetoothNetworkRole::PanU,
//! ).unwrap();
//! ```

use std::collections::HashMap;
use zvariant::Value;

use crate::{
    ConnectionOptions,
    models::{BluetoothIdentity, BluetoothNetworkRole},
};

/// Builds the `connection` section with type, id, uuid, and autoconnect settings.
#[must_use]
pub fn base_connection_section(
    name: &str,
    opts: &ConnectionOptions,
) -> HashMap<&'static str, Value<'static>> {
    let mut s = HashMap::new();
    s.insert("type", Value::from("bluetooth"));
    s.insert("id", Value::from(name.to_string()));
    s.insert("uuid", Value::from(uuid::Uuid::new_v4().to_string()));
    s.insert("autoconnect", Value::from(opts.autoconnect));

    if let Some(p) = opts.autoconnect_priority {
        s.insert("autoconnect-priority", Value::from(p));
    }

    if let Some(r) = opts.autoconnect_retries {
        s.insert("autoconnect-retries", Value::from(r));
    }

    s
}

/// Builds a Bluetooth connection settings dictionary.
fn bluetooth_section(settings: &BluetoothIdentity) -> HashMap<&'static str, Value<'static>> {
    let mut s = HashMap::new();
    s.insert("bdaddr", Value::from(settings.bdaddr.clone()));
    let bt_type = match settings.bt_device_type {
        BluetoothNetworkRole::PanU => "panu",
        BluetoothNetworkRole::Dun => "dun",
    };
    s.insert("type", Value::from(bt_type));
    s
}

#[must_use]
pub fn build_bluetooth_connection(
    name: &str,
    settings: &BluetoothIdentity,
    opts: &ConnectionOptions,
) -> HashMap<&'static str, HashMap<&'static str, Value<'static>>> {
    let mut conn: HashMap<&'static str, HashMap<&'static str, Value<'static>>> = HashMap::new();

    // Base connections
    conn.insert("connection", base_connection_section(name, opts));
    conn.insert("bluetooth", bluetooth_section(settings));

    let mut ipv4 = HashMap::new();
    ipv4.insert("method", Value::from("auto"));
    conn.insert("ipv4", ipv4);

    let mut ipv6 = HashMap::new();
    ipv6.insert("method", Value::from("auto"));
    conn.insert("ipv6", ipv6);

    conn
}

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

    fn create_test_opts() -> ConnectionOptions {
        ConnectionOptions {
            autoconnect: true,
            autoconnect_priority: Some(10),
            autoconnect_retries: Some(3),
        }
    }

    fn create_test_identity_panu() -> BluetoothIdentity {
        BluetoothIdentity::new("00:1A:7D:DA:71:13".into(), BluetoothNetworkRole::PanU).unwrap()
    }

    fn create_test_identity_dun() -> BluetoothIdentity {
        BluetoothIdentity::new("C8:1F:E8:F0:51:57".into(), BluetoothNetworkRole::Dun).unwrap()
    }

    #[test]
    fn test_base_connection_section() {
        let opts = create_test_opts();
        let section = base_connection_section("TestBluetooth", &opts);

        // Check required fields
        assert!(section.contains_key("type"));
        assert!(section.contains_key("id"));
        assert!(section.contains_key("uuid"));
        assert!(section.contains_key("autoconnect"));

        // Verify values
        if let Some(Value::Str(conn_type)) = section.get("type") {
            assert_eq!(conn_type.as_str(), "bluetooth");
        } else {
            panic!("type field not found or wrong type");
        }

        if let Some(Value::Str(id)) = section.get("id") {
            assert_eq!(id.as_str(), "TestBluetooth");
        } else {
            panic!("id field not found or wrong type");
        }

        if let Some(Value::Bool(autoconnect)) = section.get("autoconnect") {
            assert!(*autoconnect, "{}", true);
        } else {
            panic!("autoconnect field not found or wrong type");
        }

        // Check optional fields
        assert!(section.contains_key("autoconnect-priority"));
        assert!(section.contains_key("autoconnect-retries"));
    }

    #[test]
    fn test_base_connection_section_without_optional_fields() {
        let opts = ConnectionOptions {
            autoconnect: false,
            autoconnect_priority: None,
            autoconnect_retries: None,
        };
        let section = base_connection_section("MinimalBT", &opts);

        assert!(section.contains_key("type"));
        assert!(section.contains_key("id"));
        assert!(section.contains_key("uuid"));
        assert!(section.contains_key("autoconnect"));

        // Optional fields should not be present
        assert!(!section.contains_key("autoconnect-priority"));
        assert!(!section.contains_key("autoconnect-retries"));
    }

    #[test]
    fn test_bluetooth_section_panu() {
        let identity = create_test_identity_panu();
        let section = bluetooth_section(&identity);

        assert!(section.contains_key("bdaddr"));
        assert!(section.contains_key("type"));

        if let Some(Value::Str(bdaddr)) = section.get("bdaddr") {
            assert_eq!(bdaddr.as_str(), "00:1A:7D:DA:71:13");
        } else {
            panic!("bdaddr field not found or wrong type");
        }

        if let Some(Value::Str(bt_type)) = section.get("type") {
            assert_eq!(bt_type.as_str(), "panu");
        } else {
            panic!("type field not found or wrong type");
        }
    }

    #[test]
    fn test_bluetooth_section_dun() {
        let identity = create_test_identity_dun();
        let section = bluetooth_section(&identity);

        assert!(section.contains_key("bdaddr"));
        assert!(section.contains_key("type"));

        if let Some(Value::Str(bdaddr)) = section.get("bdaddr") {
            assert_eq!(bdaddr.as_str(), "C8:1F:E8:F0:51:57");
        } else {
            panic!("bdaddr field not found or wrong type");
        }

        if let Some(Value::Str(bt_type)) = section.get("type") {
            assert_eq!(bt_type.as_str(), "dun");
        } else {
            panic!("type field not found or wrong type");
        }
    }

    #[test]
    fn test_build_bluetooth_connection_panu() {
        let identity = create_test_identity_panu();
        let opts = create_test_opts();
        let conn = build_bluetooth_connection("MyPhone", &identity, &opts);

        // Check main sections
        assert!(conn.contains_key("connection"));
        assert!(conn.contains_key("bluetooth"));
        assert!(conn.contains_key("ipv4"));
        assert!(conn.contains_key("ipv6"));

        // Verify connection section
        let connection_section = conn.get("connection").unwrap();
        if let Some(Value::Str(id)) = connection_section.get("id") {
            assert_eq!(id.as_str(), "MyPhone");
        }

        // Verify bluetooth section
        let bt_section = conn.get("bluetooth").unwrap();
        if let Some(Value::Str(bdaddr)) = bt_section.get("bdaddr") {
            assert_eq!(bdaddr.as_str(), "00:1A:7D:DA:71:13");
        }
        if let Some(Value::Str(bt_type)) = bt_section.get("type") {
            assert_eq!(bt_type.as_str(), "panu");
        }

        // Verify IP sections
        let ipv4_section = conn.get("ipv4").unwrap();
        if let Some(Value::Str(method)) = ipv4_section.get("method") {
            assert_eq!(method.as_str(), "auto");
        }

        let ipv6_section = conn.get("ipv6").unwrap();
        if let Some(Value::Str(method)) = ipv6_section.get("method") {
            assert_eq!(method.as_str(), "auto");
        }
    }

    #[test]
    fn test_build_bluetooth_connection_dun() {
        let identity = create_test_identity_dun();
        let opts = ConnectionOptions {
            autoconnect: false,
            autoconnect_priority: None,
            autoconnect_retries: None,
        };
        let conn = build_bluetooth_connection("MobileHotspot", &identity, &opts);

        assert!(conn.contains_key("connection"));
        assert!(conn.contains_key("bluetooth"));
        assert!(conn.contains_key("ipv4"));
        assert!(conn.contains_key("ipv6"));

        // Verify DUN type
        let bt_section = conn.get("bluetooth").unwrap();
        if let Some(Value::Str(bt_type)) = bt_section.get("type") {
            assert_eq!(bt_type.as_str(), "dun");
        }
    }

    #[test]
    fn test_uuid_is_unique() {
        let identity = create_test_identity_panu();
        let opts = create_test_opts();

        let conn1 = build_bluetooth_connection("BT1", &identity, &opts);
        let conn2 = build_bluetooth_connection("BT2", &identity, &opts);

        let uuid1 = if let Some(section) = conn1.get("connection") {
            if let Some(Value::Str(uuid)) = section.get("uuid") {
                uuid.as_str()
            } else {
                panic!("uuid not found in conn1");
            }
        } else {
            panic!("connection section not found in conn1");
        };

        let uuid2 = if let Some(section) = conn2.get("connection") {
            if let Some(Value::Str(uuid)) = section.get("uuid") {
                uuid.as_str()
            } else {
                panic!("uuid not found in conn2");
            }
        } else {
            panic!("connection section not found in conn2");
        };

        // UUIDs should be different
        assert_ne!(uuid1, uuid2, "UUIDs should be unique");
    }

    #[test]
    fn test_bdaddr_format_preserved() {
        let identity =
            BluetoothIdentity::new("AA:BB:CC:DD:EE:FF".into(), BluetoothNetworkRole::PanU).unwrap();
        let opts = create_test_opts();
        let conn = build_bluetooth_connection("Test", &identity, &opts);

        let bt_section = conn.get("bluetooth").unwrap();
        if let Some(Value::Str(bdaddr)) = bt_section.get("bdaddr") {
            assert_eq!(bdaddr.as_str(), "AA:BB:CC:DD:EE:FF");
        }
    }
}