bgpsim 0.20.4

A network control-plane simulator
Documentation
// 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 link failures in the network (and the consequent BGP change)

#[generic_tests::define]
mod t {

    use lazy_static::lazy_static;

    use crate::builder::*;
    use crate::ospf::{GlobalOspf, LocalOspf, OspfImpl};
    use crate::prelude::*;

    lazy_static! {
        static ref E1: RouterId = 0.into();
        static ref R1: RouterId = 1.into();
        static ref R2: RouterId = 2.into();
        static ref R3: RouterId = 3.into();
        static ref R4: RouterId = 4.into();
        static ref E4: RouterId = 5.into();
    }

    /// Add link weights according to:
    ///
    /// ```text
    /// E1 ---- R1 --5-- R2
    ///         |        |
    ///         1        1
    ///         |        |
    ///         R3 --5-- R4 ---- E4
    /// ```
    fn link_weights() -> crate::builder::Lookup<LinkWeight> {
        crate::builder::Lookup::new(1.0)
            .with_bidirectional(1.into(), 2.into(), 5.0)
            .with_bidirectional(3.into(), 4.into(), 5.0)
    }

    fn get_test_topo<P: Prefix, Ospf: OspfImpl>() -> Network<P, BasicEventQueue<P>, Ospf> {
        let mut net = Network::default();

        assert_eq!(*E1, net.add_router("E1", ASN(65101)));
        assert_eq!(*R1, net.add_router("R1", 65500));
        assert_eq!(*R2, net.add_router("R2", 65500));
        assert_eq!(*R3, net.add_router("R3", 65500));
        assert_eq!(*R4, net.add_router("R4", 65500));
        assert_eq!(*E4, net.add_router("E4", ASN(65104)));

        net.add_link(*R1, *E1).unwrap();
        net.add_link(*R1, *R2).unwrap();
        net.add_link(*R1, *R3).unwrap();
        net.add_link(*R4, *R2).unwrap();
        net.add_link(*R4, *R3).unwrap();
        net.add_link(*R4, *E4).unwrap();

        net
    }

    #[test]
    fn simple_failure_infinity<P: Prefix, Ospf: OspfImpl>() {
        let _ = env_logger::try_init();

        let mut net = get_test_topo::<P, Ospf>();
        net.build_link_weights(link_weights()).unwrap();
        net.build_ebgp_sessions().unwrap();
        net.build_ibgp_full_mesh().unwrap();

        let p = P::from(0);
        net.advertise_route(*E1, p, [1], None, None).unwrap();
        net.advertise_route(*E4, p, [4], None, None).unwrap();

        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R4, *E4]);
        test_route!(net, *R3, p, [*R3, *R1, *E1]);
        test_route!(net, *R4, p, [*R4, *E4]);
        assert!(!net.get_router(*R3).unwrap().bgp.get_sessions().is_empty());

        net.set_link_weight(*R3, *R1, LinkWeight::INFINITY).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R4, *E4]);
        test_route!(net, *R3, p, [*R3, *R4, *E4]);
        test_route!(net, *R4, p, [*R4, *E4]);
        assert!(!net.get_router(*R3).unwrap().bgp.get_sessions().is_empty());

        net.set_link_weight(*R3, *R4, LinkWeight::INFINITY).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R4, *E4]);
        test_bad_route!(black_hole, net, *R3, p, [*R3]);
        test_route!(net, *R4, p, [*R4, *E4]);
        assert!(net.get_router(*R3).unwrap().bgp.get_sessions().is_empty());

        net.set_link_weight(*R3, *R1, 1.0).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R4, *E4]);
        test_route!(net, *R3, p, [*R3, *R1, *E1]);
        test_route!(net, *R4, p, [*R4, *E4]);
        assert!(!net.get_router(*R3).unwrap().bgp.get_sessions().is_empty());
    }

    #[test]
    fn rr_failure_infinity<P: Prefix, Ospf: OspfImpl>() {
        let _ = env_logger::try_init();

        // let mut net = get_test_topo::<P, Ospf>();
        let mut net = get_test_topo::<P, Ospf>();
        let rr = net.add_router("rr", 65500);
        net.add_link(rr, *R3).unwrap();
        net.build_link_weights(link_weights()).unwrap();
        net.build_ebgp_sessions().unwrap();
        net.build_ibgp_route_reflection(vec![rr]).unwrap();

        let p = P::from(0);
        net.advertise_route(*E1, p, [1], None, None).unwrap();
        net.advertise_route(*E4, p, [4], None, None).unwrap();

        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R1, *E1]);
        test_route!(net, *R3, p, [*R3, *R1, *E1]);
        test_route!(net, *R4, p, [*R4, *E4]);
        test_route!(net, rr, p, [rr, *R3, *R1, *E1]);

        net.set_link_weight(rr, *R3, LinkWeight::INFINITY).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_bad_route!(black_hole, net, *R2, p, [*R2]);
        test_bad_route!(black_hole, net, *R3, p, [*R3]);
        test_route!(net, *R4, p, [*R4, *E4]);
        test_bad_route!(black_hole, net, rr, p, [rr]);

        net.set_link_weight(rr, *R3, 1.0).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R1, *E1]);
        test_route!(net, *R3, p, [*R3, *R1, *E1]);
        test_route!(net, *R4, p, [*R4, *E4]);
        test_route!(net, rr, p, [rr, *R3, *R1, *E1]);
    }

    #[test]
    fn simple_failure<P: Prefix, Ospf: OspfImpl>() {
        let mut net = get_test_topo::<P, Ospf>();
        net.build_link_weights(link_weights()).unwrap();
        net.build_ebgp_sessions().unwrap();
        net.build_ibgp_full_mesh().unwrap();

        let p = P::from(0);
        net.advertise_route(*E1, p, [1], None, None).unwrap();
        net.advertise_route(*E4, p, [4], None, None).unwrap();

        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R4, *E4]);
        test_route!(net, *R3, p, [*R3, *R1, *E1]);
        test_route!(net, *R4, p, [*R4, *E4]);
        assert!(!net.get_router(*R3).unwrap().bgp.get_sessions().is_empty());

        net.remove_link(*R3, *R1).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R4, *E4]);
        test_route!(net, *R3, p, [*R3, *R4, *E4]);
        test_route!(net, *R4, p, [*R4, *E4]);
        assert!(!net.get_router(*R3).unwrap().bgp.get_sessions().is_empty());

        net.remove_link(*R3, *R4).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R4, *E4]);
        test_bad_route!(black_hole, net, *R3, p, [*R3]);
        test_route!(net, *R4, p, [*R4, *E4]);
        assert!(net.get_router(*R3).unwrap().bgp.get_sessions().is_empty());

        net.add_link(*R3, *R1).unwrap();
        net.set_link_weight(*R3, *R1, 1.0).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R4, *E4]);
        test_route!(net, *R3, p, [*R3, *R1, *E1]);
        test_route!(net, *R4, p, [*R4, *E4]);
        assert!(!net.get_router(*R3).unwrap().bgp.get_sessions().is_empty());
    }

    #[test]
    fn rr_failure<P: Prefix, Ospf: OspfImpl>() {
        let mut net = get_test_topo::<P, Ospf>();
        let rr = net.add_router("rr", 65500);
        net.add_link(rr, *R3).unwrap();
        net.build_link_weights(link_weights()).unwrap();
        net.build_ebgp_sessions().unwrap();
        net.build_ibgp_route_reflection(vec![rr]).unwrap();

        let p = P::from(0);
        net.advertise_route(*E1, p, [1], None, None).unwrap();
        net.advertise_route(*E4, p, [4], None, None).unwrap();

        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R1, *E1]);
        test_route!(net, *R3, p, [*R3, *R1, *E1]);
        test_route!(net, *R4, p, [*R4, *E4]);
        test_route!(net, rr, p, [rr, *R3, *R1, *E1]);

        net.remove_link(rr, *R3).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_bad_route!(black_hole, net, *R2, p, [*R2]);
        test_bad_route!(black_hole, net, *R3, p, [*R3]);
        test_route!(net, *R4, p, [*R4, *E4]);
        test_bad_route!(black_hole, net, rr, p, [rr]);

        net.add_link(rr, *R3).unwrap();
        net.set_link_weight(rr, *R3, 1.0).unwrap();
        test_route!(net, *R1, p, [*R1, *E1]);
        test_route!(net, *R2, p, [*R2, *R1, *E1]);
        test_route!(net, *R3, p, [*R3, *R1, *E1]);
        test_route!(net, *R4, p, [*R4, *E4]);
        test_route!(net, rr, p, [rr, *R3, *R1, *E1]);
    }

    #[instantiate_tests(<SinglePrefix, GlobalOspf>)]
    mod single_global {}

    #[instantiate_tests(<SimplePrefix, GlobalOspf>)]
    mod simple_global {}

    #[instantiate_tests(<Ipv4Prefix, GlobalOspf>)]
    mod ipv4_global {}

    #[instantiate_tests(<SinglePrefix, LocalOspf>)]
    mod single_local {}

    #[instantiate_tests(<SimplePrefix, LocalOspf>)]
    mod simple_local {}

    #[instantiate_tests(<Ipv4Prefix, LocalOspf>)]
    mod ipv4_local {}
}