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
// SPDX-License-Identifier: Apache-2.0

use crate::{
    Interface, InterfaceType, Interfaces, MergedNetworkState, NetworkState,
    RouteRuleEntry,
    nm::route_rule::store_route_rule_config,
    unit_tests::testlib::{
        TEST_NIC, TEST_RULE_IPV4_FROM, TEST_RULE_IPV4_TO, TEST_RULE_IPV6_FROM,
        TEST_RULE_IPV6_TO, TEST_RULE_PRIORITY1, TEST_RULE_PRIORITY2,
        TEST_TABLE_ID1, TEST_TABLE_ID2, gen_test_routes_conf,
        gen_test_rules_conf, new_eth_iface, new_test_nic_with_static_ip,
    },
};

fn get_iface<'a>(
    merged_state: &'a MergedNetworkState,
    ifname: &str,
    iface_type: InterfaceType,
) -> &'a Interface {
    merged_state
        .interfaces
        .get_iface(ifname, iface_type)
        .unwrap()
        .for_apply
        .as_ref()
        .unwrap()
}

fn get_routing_rules(iface: &Interface, ipv6: bool) -> Vec<RouteRuleEntry> {
    let rules = match ipv6 {
        false => iface.base_iface().ipv4.as_ref().unwrap().rules.as_ref(),
        true => iface.base_iface().ipv6.as_ref().unwrap().rules.as_ref(),
    };
    let mut rules: Vec<_> = rules.unwrap().iter().cloned().collect();
    rules.sort();
    rules
}

#[test]
fn test_add_rules_to_new_interface() {
    let mut cur_net_state = NetworkState::new();
    cur_net_state.interfaces.push(new_eth_iface(TEST_NIC));

    let des_iface = new_test_nic_with_static_ip();
    let mut des_ifaces = Interfaces::new();
    des_ifaces.push(des_iface);
    let mut des_net_state = NetworkState::new();
    des_net_state.interfaces = des_ifaces;
    des_net_state.routes = gen_test_routes_conf();
    des_net_state.rules = gen_test_rules_conf();

    let mut merged_state = MergedNetworkState::new(
        des_net_state,
        cur_net_state,
        Default::default(),
        false,
    )
    .unwrap();
    store_route_rule_config(&mut merged_state).unwrap();

    let iface = get_iface(&merged_state, TEST_NIC, InterfaceType::Unknown);
    let ipv6_config_rules = get_routing_rules(iface, true);
    let ipv4_config_rules = get_routing_rules(iface, false);

    assert_eq!(ipv6_config_rules.len(), 1);
    assert_eq!(
        ipv6_config_rules[0].ip_from.as_ref().unwrap().as_str(),
        TEST_RULE_IPV6_FROM,
    );
    assert_eq!(
        ipv6_config_rules[0].ip_to.as_ref().unwrap().as_str(),
        TEST_RULE_IPV6_TO,
    );
    assert_eq!(ipv6_config_rules[0].priority.unwrap(), TEST_RULE_PRIORITY1);
    assert_eq!(ipv6_config_rules[0].table_id.unwrap(), TEST_TABLE_ID1);

    assert_eq!(ipv4_config_rules.len(), 1);
    assert_eq!(
        ipv4_config_rules[0].ip_from.as_ref().unwrap().as_str(),
        TEST_RULE_IPV4_FROM,
    );
    assert_eq!(
        ipv4_config_rules[0].ip_to.as_ref().unwrap().as_str(),
        TEST_RULE_IPV4_TO,
    );
    assert_eq!(ipv4_config_rules[0].priority.unwrap(), TEST_RULE_PRIORITY2);
    assert_eq!(ipv4_config_rules[0].table_id.unwrap(), TEST_TABLE_ID2);
}

#[test]
fn test_route_rule_ignore_absent_ifaces() {
    let desired: NetworkState = serde_yaml::from_str(
        r"
        interfaces:
        - name: br0
          state: absent
          type: linux-bridge
        route-rules:
          config:
          - route-table: 200
            state: absent
        ",
    )
    .unwrap();

    let current: NetworkState = serde_yaml::from_str(
        r"
        interfaces:
        - name: eth1
          type: ethernet
          state: up
        - name: br0
          type: linux-bridge
          state: up
          ipv4:
            address:
            - ip: 192.0.2.251
              prefix-length: 24
            dhcp: false
            enabled: true
          bridge:
            options:
              stp:
                enabled: false
            port:
            - name: eth1
        routes:
          config:
            - destination: 198.51.100.0/24
              metric: 150
              next-hop-address: 192.0.2.1
              next-hop-interface: br0
              table-id: 200
        route-rules:
          config:
            - ip-from: 192.51.100.2/32
              route-table: 200
        ",
    )
    .unwrap();

    let mut merged_state =
        MergedNetworkState::new(desired, current, Default::default(), false)
            .unwrap();

    store_route_rule_config(&mut merged_state).unwrap();

    let eth1_iface = get_iface(&merged_state, "eth1", InterfaceType::Ethernet);
    let br0_iface = get_iface(&merged_state, "br0", InterfaceType::LinuxBridge);

    assert!(eth1_iface.is_up());
    assert!(br0_iface.is_absent());
}

#[test]
fn test_route_rule_use_auto_route_table_id() {
    let current: NetworkState = serde_yaml::from_str(
        r"---
        interfaces:
          - name: br0
            type: ovs-interface
            state: up
            ipv4:
              enabled: true
              dhcp: true
              auto-dns: false
              auto-routes: true
              auto-gateway: true
              auto-route-table-id: 500
            ipv6:
              enabled: false
          - name: br0
            type: ovs-bridge
            state: up
            bridge:
              port:
                - name: br0
        ",
    )
    .unwrap();

    let desired: NetworkState = serde_yaml::from_str(
        r"---
        route-rules:
          config:
            - route-table: 500
              priority: 3200
              ip-to: 192.0.3.0/24
            - route-table: 500
              priority: 3200
              ip-from: 192.0.3.0/24
        interfaces:
          - name: br0
            type: ovs-interface
        ",
    )
    .unwrap();

    let expected_rules: Vec<RouteRuleEntry> = serde_yaml::from_str(
        r"
        - route-table: 500
          priority: 3200
          ip-to: 192.0.3.0/24
        - route-table: 500
          priority: 3200
          ip-from: 192.0.3.0/24
        ",
    )
    .unwrap();

    let mut merged_state =
        MergedNetworkState::new(desired, current, Default::default(), false)
            .unwrap();

    store_route_rule_config(&mut merged_state).unwrap();

    let ovs_iface =
        get_iface(&merged_state, "br0", InterfaceType::OvsInterface);
    let ipv4_rules = get_routing_rules(ovs_iface, false);

    assert_eq!(ovs_iface.iface_type(), InterfaceType::OvsInterface);
    assert_eq!(ipv4_rules, expected_rules);
}

#[test]
fn test_route_rule_use_default_auto_route_table_id() {
    let current: NetworkState = serde_yaml::from_str(
        r"---
        interfaces:
          - name: eth1
            type: ethernet
            state: up
            ipv4:
              enabled: true
              dhcp: true
              auto-dns: true
              auto-routes: true
              auto-gateway: true
            ipv6:
              enabled: false
        ",
    )
    .unwrap();

    let desired: NetworkState = serde_yaml::from_str(
        r"---
        route-rules:
          config:
            - priority: 3200
              ip-to: 192.0.3.0/24
            - priority: 3200
              ip-from: 192.0.3.0/24
        interfaces:
          - name: eth1",
    )
    .unwrap();

    let expected_rules: Vec<RouteRuleEntry> = serde_yaml::from_str(
        r"
        - route-table: 254
          priority: 3200
          ip-to: 192.0.3.0/24
        - route-table: 254
          priority: 3200
          ip-from: 192.0.3.0/24
        ",
    )
    .unwrap();

    let mut merged_state =
        MergedNetworkState::new(desired, current, Default::default(), false)
            .unwrap();

    store_route_rule_config(&mut merged_state).unwrap();

    let iface = get_iface(&merged_state, "eth1", InterfaceType::Ethernet);
    let ipv4_rules = get_routing_rules(iface, false);

    assert_eq!(ipv4_rules, expected_rules);
}

#[test]
fn test_route_rule_use_loopback() {
    let current: NetworkState = serde_yaml::from_str(
        r"---
        interfaces:
          - name: lo
            type: loopback
            state: up
            mtu: 65536
            ipv4:
              enabled: true
              address:
              - ip: 127.0.0.1
                prefix-length: 8
            ipv6:
              enabled: true
              address:
              - ip: ::1
                prefix-length: 128",
    )
    .unwrap();

    let desired: NetworkState = serde_yaml::from_str(
        r"---
        route-rules:
          config:
            - priority: 3200
              route-table: 255
              family: ipv4
            - priority: 3200
              route-table: 255
              family: ipv6",
    )
    .unwrap();

    let expected_ipv4_rules: Vec<RouteRuleEntry> = serde_yaml::from_str(
        r"
        - priority: 3200
          route-table: 255
          family: ipv4",
    )
    .unwrap();

    let expected_ipv6_rules: Vec<RouteRuleEntry> = serde_yaml::from_str(
        r"
        - priority: 3200
          route-table: 255
          family: ipv6",
    )
    .unwrap();

    let mut merged_state =
        MergedNetworkState::new(desired, current, Default::default(), false)
            .unwrap();

    store_route_rule_config(&mut merged_state).unwrap();

    let iface = get_iface(&merged_state, "lo", InterfaceType::Loopback);
    let ipv4_rules = get_routing_rules(iface, false);
    let ipv6_rules = get_routing_rules(iface, true);

    assert_eq!(ipv4_rules, expected_ipv4_rules);
    assert_eq!(ipv6_rules, expected_ipv6_rules);
}

#[test]
fn test_route_rule_add_twice() {
    let current: NetworkState = serde_yaml::from_str(
        r"---
        interfaces:
          - name: eth1
            type: ethernet
            state: up
            ipv4:
              enabled: true
              dhcp: true
              auto-dns: true
              auto-routes: true
              auto-gateway: true
            ipv6:
              enabled: false
        ",
    )
    .unwrap();

    let desired: NetworkState = serde_yaml::from_str(
        r"---
        route-rules:
          config:
            - priority: 3200
              ip-to: 192.0.3.0/24
            - priority: 3200
              ip-from: 192.0.3.0/24
        interfaces:
          - name: eth1",
    )
    .unwrap();

    let mut expected_rules: Vec<RouteRuleEntry> = serde_yaml::from_str(
        r"
        - route-table: 254
          priority: 3200
          ip-to: 192.0.3.0/24
        - route-table: 254
          priority: 3200
          ip-from: 192.0.3.0/24
        ",
    )
    .unwrap();
    expected_rules.sort();

    let mut merged_state =
        MergedNetworkState::new(desired, current, Default::default(), false)
            .unwrap();

    store_route_rule_config(&mut merged_state).unwrap();
    store_route_rule_config(&mut merged_state).unwrap();

    let iface = get_iface(&merged_state, "eth1", InterfaceType::Ethernet);
    let ipv4_rules = get_routing_rules(iface, false);

    assert_eq!(ipv4_rules, expected_rules);
}