bgpsim 0.20.4

A network control-plane simulator
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

// BgpSim: BGP Network Simulator written in Rust
// Copyright 2022-2024 Tibor Schneider <sctibor@ethz.ch>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Test the `record` module

use crate::{
    event::EventQueue,
    network::Network,
    record::RecordNetwork,
    types::{NetworkError, RouterId, SinglePrefix as P, ASN},
};

use pretty_assertions::assert_eq;

/// Setup the simple network, and return `(e0, b0, r0, r1, b1, e1)`
/// All weights are 1, r0 and b0 form a iBGP cluster, and so does r1 and b1
///
/// r0 ----- r1
/// |        |
/// |        |
/// b0       b1   internal
/// |........|............
/// |        |    external
/// e0       e1
fn setup_simple<Q>(
    net: &mut Network<P, Q>,
) -> Result<(RouterId, RouterId, RouterId, RouterId, RouterId, RouterId), NetworkError>
where
    Q: EventQueue<P>,
{
    let e0 = net.add_router("E0", ASN(1));
    let b0 = net.add_router("B0", 65500);
    let r0 = net.add_router("R0", 65500);
    let r1 = net.add_router("R1", 65500);
    let b1 = net.add_router("B1", 65500);
    let e1 = net.add_router("E1", ASN(1));

    net.add_link(e0, b0)?;
    net.add_link(b0, r0)?;
    net.add_link(r0, r1)?;
    net.add_link(r1, b1)?;
    net.add_link(b1, e1)?;

    net.set_link_weight(b0, r0, 1.0)?;
    net.set_link_weight(r0, b0, 1.0)?;
    net.set_link_weight(r0, r1, 1.0)?;
    net.set_link_weight(r1, r0, 1.0)?;
    net.set_link_weight(r1, b1, 1.0)?;
    net.set_link_weight(b1, r1, 1.0)?;
    net.set_bgp_session(e0, b0, Some(false))?;
    net.set_bgp_session(r0, b0, Some(true))?;
    net.set_bgp_session(r0, r1, Some(false))?;
    net.set_bgp_session(r1, b1, Some(true))?;
    net.set_bgp_session(e1, b1, Some(false))?;

    Ok((e0, b0, r0, r1, b1, e1))
}

#[test]
fn test_simple_deterministic() {
    let mut net: Network<P, _> = Network::default();
    let prefix = P::from(0);

    let (e0, b0, r0, r1, b1, e1) = setup_simple(&mut net).unwrap();

    // advertise the same prefix on both routers
    net.advertise_route(e0, prefix, vec![ASN(1), ASN(2), ASN(3)], None, None)
        .unwrap();

    let mut rec = net
        .record(|n| n.advertise_route(e1, prefix, vec![ASN(4), ASN(5)], None, None))
        .unwrap();

    assert_eq!(
        rec.trace(),
        &vec![
            (vec![(e1, vec![b1], vec![u32::MAX.into()])], None.into()),
            (vec![(b1, vec![r1], vec![e1])], None.into()),
            (vec![(r1, vec![r0], vec![b1])], None.into()),
            (vec![(r0, vec![b0], vec![r1])], None.into()),
            (vec![(b0, vec![e0], vec![r0])], None.into()),
        ]
    );

    // test all paths
    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, b0, e0]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, r0, b0, e0]]);
    assert_eq!(
        s.get_paths(b1, prefix).unwrap(),
        vec![vec![b1, r1, r0, b0, e0]]
    );

    // perform one step
    rec.step().unwrap();

    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, b0, e0]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, r0, b0, e0]]);
    assert_eq!(
        s.get_paths(b1, prefix).unwrap(),
        vec![vec![b1, r1, r0, b0, e0]]
    );

    // perform one step
    rec.step().unwrap();

    // test all paths
    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, b0, e0]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, r0, b0, e0]]);
    assert_eq!(s.get_paths(b1, prefix).unwrap(), vec![vec![b1, e1]]);

    // perform one step
    rec.step().unwrap();

    // test all paths
    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, b0, e0]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, b1, e1]]);
    assert_eq!(s.get_paths(b1, prefix).unwrap(), vec![vec![b1, e1]]);

    // perform one step
    rec.step().unwrap();

    // test all paths
    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, r1, b1, e1]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, b1, e1]]);
    assert_eq!(s.get_paths(b1, prefix).unwrap(), vec![vec![b1, e1]]);

    // perform one step
    rec.step().unwrap();

    // test all paths
    let s = rec.state();
    assert_eq!(
        s.get_paths(b0, prefix).unwrap(),
        vec![vec![b0, r0, r1, b1, e1]]
    );
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, r1, b1, e1]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, b1, e1]]);
    assert_eq!(s.get_paths(b1, prefix).unwrap(), vec![vec![b1, e1]]);

    // go back and test the same thing again.
    rec.back().unwrap();

    // test all paths
    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, r1, b1, e1]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, b1, e1]]);
    assert_eq!(s.get_paths(b1, prefix).unwrap(), vec![vec![b1, e1]]);

    // perform one step
    rec.back().unwrap();

    // test all paths
    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, b0, e0]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, b1, e1]]);
    assert_eq!(s.get_paths(b1, prefix).unwrap(), vec![vec![b1, e1]]);

    // perform one step
    rec.back().unwrap();

    // test all paths
    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, b0, e0]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, r0, b0, e0]]);
    assert_eq!(s.get_paths(b1, prefix).unwrap(), vec![vec![b1, e1]]);

    // perform one step
    rec.back().unwrap();

    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, b0, e0]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, r0, b0, e0]]);
    assert_eq!(
        s.get_paths(b1, prefix).unwrap(),
        vec![vec![b1, r1, r0, b0, e0]]
    );

    // perform one step
    rec.back().unwrap();

    let s = rec.state();
    assert_eq!(s.get_paths(b0, prefix).unwrap(), vec![vec![b0, e0]]);
    assert_eq!(s.get_paths(r0, prefix).unwrap(), vec![vec![r0, b0, e0]]);
    assert_eq!(s.get_paths(r1, prefix).unwrap(), vec![vec![r1, r0, b0, e0]]);
    assert_eq!(
        s.get_paths(b1, prefix).unwrap(),
        vec![vec![b1, r1, r0, b0, e0]]
    );
}