nmstate 2.2.60

Library for networking management in a declarative manner
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
// SPDX-License-Identifier: Apache-2.0

use crate::{ErrorKind, Interface, Interfaces, MergedInterfaces};

#[test]
fn test_can_have_dup_profile_name_when_not_refered() {
    let desired = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          profile-name: port1
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2A
        - name: dummy2
          profile-name: port1
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2B
        - name: port2
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2C
        - name: bond0
          type: bond
          state: up
          link-aggregation:
            mode: balance-rr
            port:
            - port2
        ",
    )
    .unwrap();

    let current = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2A
        - name: dummy2
          type: dummy
          state: up
          mac-address: 32:BB:72:65:19:2B
        - name: dummy3
          type: dummy
          state: up
          mac-address: 32:BB:72:65:19:2C
        ",
    )
    .unwrap();

    MergedInterfaces::new(desired, current, Default::default(), false).unwrap();
}

#[test]
fn test_port_refer_to_kernel_interface() {
    let desired = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          type: dummy
          state: up
          mac-address: 32:BB:72:65:19:2A
        - name: dummy2
          profile-name: dummy1
          type: dummy
          state: up
          mac-address: 32:BB:72:65:19:2B
        - name: br0
          type: linux-bridge
          state: up
          bridge:
            ports:
            - name: dummy1
        ",
    )
    .unwrap();

    let mut merged = MergedInterfaces::new(
        desired,
        Interfaces::default(),
        Default::default(),
        false,
    )
    .unwrap();

    let dummy1 = merged
        .kernel_ifaces
        .remove("dummy1")
        .unwrap()
        .for_apply
        .unwrap();

    assert_eq!(dummy1.name(), "dummy1");
    assert_eq!(dummy1.base_iface().controller.as_deref(), Some("br0"));
    assert!(dummy1.base_iface().identifier.as_ref().is_none());
    assert_eq!(
        dummy1.base_iface().mac_address.as_deref(),
        Some("32:BB:72:65:19:2A")
    );
}

#[test]
fn test_port_cannot_refer_to_interfaces_holding_profile_name() {
    let desired = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: br0
          type: linux-bridge
          state: up
          bridge:
            ports:
            - name: port1
        ",
    )
    .unwrap();

    let current = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          profile-name: port1
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2A
        - name: dummy2
          profile-name: port1
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2B
        ",
    )
    .unwrap();

    let result =
        MergedInterfaces::new(desired, current, Default::default(), false);

    assert!(result.is_err());

    if let Err(e) = result {
        assert_eq!(e.kind(), ErrorKind::InvalidArgument);
    }
}

#[test]
fn test_port_ref_not_found() {
    let desired = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: br0
          type: linux-bridge
          state: up
          bridge:
            ports:
            - name: port1
        ",
    )
    .unwrap();

    let current = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          profile-name: port2
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2A
        ",
    )
    .unwrap();

    let result =
        MergedInterfaces::new(desired, current, Default::default(), false);

    assert!(result.is_err());

    if let Err(e) = result {
        assert_eq!(e.kind(), ErrorKind::InvalidArgument);
    }
}

#[test]
fn test_vlan_parent_ref_by_profile_name() {
    let desired = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: vlan0
          type: vlan
          state: up
          vlan:
            base-iface: wan0
            id: 100
        ",
    )
    .unwrap();

    let current = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          profile-name: wan0
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2A
        ",
    )
    .unwrap();

    let merged_ifaces =
        MergedInterfaces::new(desired, current, Default::default(), false)
            .unwrap();

    let merged_iface = merged_ifaces.kernel_ifaces.get("vlan0").unwrap();

    if let Interface::Vlan(vlan_iface) = merged_iface.desired.as_ref().unwrap()
    {
        assert_eq!(
            vlan_iface.vlan.as_ref().unwrap().base_iface.as_deref(),
            Some("dummy1")
        );
    } else {
        panic!("failed to find VLAN interface");
    }

    if let Interface::Vlan(vlan_iface) =
        merged_iface.for_apply.as_ref().unwrap()
    {
        assert_eq!(
            vlan_iface.vlan.as_ref().unwrap().base_iface.as_deref(),
            Some("dummy1")
        );
    } else {
        panic!("failed to find VLAN interface");
    }

    if let Interface::Vlan(vlan_iface) =
        merged_iface.for_verify.as_ref().unwrap()
    {
        assert_eq!(
            vlan_iface.vlan.as_ref().unwrap().base_iface.as_deref(),
            Some("dummy1")
        );
    } else {
        panic!("failed to find VLAN interface");
    }
}

#[test]
fn test_vxlan_parent_ref_by_profile_name() {
    let desired = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: vxlan0
          type: vxlan
          state: up
          vxlan:
            base-iface: wan0
            id: 100
            remote: 192.0.2.251
            destination-port: 1235
        ",
    )
    .unwrap();

    let current = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          profile-name: wan0
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2A
        ",
    )
    .unwrap();

    let merged_ifaces =
        MergedInterfaces::new(desired, current, Default::default(), false)
            .unwrap();

    let merged_iface = merged_ifaces.kernel_ifaces.get("vxlan0").unwrap();

    if let Interface::Vxlan(vxlan_iface) =
        merged_iface.for_apply.as_ref().unwrap()
    {
        assert_eq!(
            vxlan_iface.vxlan.as_ref().unwrap().base_iface.as_str(),
            "dummy1"
        );
    } else {
        panic!("failed to find VxLAN interface");
    }
}

#[test]
fn test_macsec_parent_ref_by_profile_name() {
    let desired = serde_yaml::from_str::<Interfaces>(
        r"---
- name: macsec0
  type: macsec
  state: up
  macsec:
    encrypt: true
    base-iface: wan0
    mka-cak: 50b71a8ef0bd5751ea76de6d6c98c03a
    mka-ckn: f2b4297d39da7330910a74abc0449feb45b5c0b9fc23df1430e1898fcf1c4550
    port: 0
    validation: strict
    send-sci: true
    offload: off",
    )
    .unwrap();

    let current = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          profile-name: wan0
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2A
        ",
    )
    .unwrap();

    let merged_ifaces =
        MergedInterfaces::new(desired, current, Default::default(), false)
            .unwrap();

    let merged_iface = merged_ifaces.kernel_ifaces.get("macsec0").unwrap();

    if let Interface::MacSec(macsec_iface) =
        merged_iface.for_apply.as_ref().unwrap()
    {
        assert_eq!(
            macsec_iface.macsec.as_ref().unwrap().base_iface.as_str(),
            "dummy1"
        );
    } else {
        panic!("failed to find MacSec interface");
    }
}

#[test]
fn test_macvlan_parent_ref_by_profile_name() {
    let desired = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: macvlan0
          type: mac-vlan
          state: up
          mac-vlan:
            base-iface: wan0
            mode: passthru",
    )
    .unwrap();

    let current = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          profile-name: wan0
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2A
        ",
    )
    .unwrap();

    let merged_ifaces =
        MergedInterfaces::new(desired, current, Default::default(), false)
            .unwrap();

    let merged_iface = merged_ifaces.kernel_ifaces.get("macvlan0").unwrap();

    if let Interface::MacVlan(mac_vlan_iface) =
        merged_iface.for_apply.as_ref().unwrap()
    {
        assert_eq!(
            mac_vlan_iface
                .mac_vlan
                .as_ref()
                .unwrap()
                .base_iface
                .as_str(),
            "dummy1"
        );
    } else {
        panic!("failed to find MacSec interface");
    }
}

#[test]
fn test_macvtap_parent_ref_by_profile_name() {
    let desired = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: macvtap0
          type: mac-vtap
          state: up
          mac-vtap:
            base-iface: wan0
            mode: passthru",
    )
    .unwrap();

    let current = serde_yaml::from_str::<Interfaces>(
        r"---
        - name: dummy1
          profile-name: wan0
          type: dummy
          state: up
          identifier: mac-address
          mac-address: 32:BB:72:65:19:2A
        ",
    )
    .unwrap();

    let merged_ifaces =
        MergedInterfaces::new(desired, current, Default::default(), false)
            .unwrap();

    let merged_iface = merged_ifaces.kernel_ifaces.get("macvtap0").unwrap();

    if let Interface::MacVtap(mac_vtap_iface) =
        merged_iface.for_apply.as_ref().unwrap()
    {
        assert_eq!(
            mac_vtap_iface
                .mac_vtap
                .as_ref()
                .unwrap()
                .base_iface
                .as_str(),
            "dummy1"
        );
    } else {
        panic!("failed to find MacSec interface");
    }
}