bgp/rib-impl/src/test/java/org/opendaylight/protocol/bgp/rib/impl/config/BgpPeerTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.protocol.bgp.rib.impl.config;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12 import static org.junit.Assert.assertThrows;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.mockito.ArgumentMatchers.any;
  15 import static org.mockito.ArgumentMatchers.anyInt;
  16 import static org.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.times;
  18 import static org.mockito.Mockito.verify;
  19
  20 import java.net.InetSocketAddress;
  21 import java.util.Map;
  22 import java.util.concurrent.ExecutionException;
  23 import org.junit.Before;
  24 import org.junit.Test;
  25 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  26 import org.opendaylight.protocol.bgp.rib.impl.state.BGPStateCollector;
  27 import org.opendaylight.protocol.concepts.KeyMapping;
  28 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
  29 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafiBuilder;
  30 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafiKey;
  31 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AddPaths;
  32 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AddPathsBuilder;
  33 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafis;
  34 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafisBuilder;
  35 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Config;
  36 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.RouteReflector;
  37 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.RouteReflectorBuilder;
  38 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Timers;
  39 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.TimersBuilder;
  40 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Transport;
  41 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.TransportBuilder;
  42 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.add.paths.ConfigBuilder;
  43 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
  44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.NeighborBuilder;
  45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.CommunityType;
  46 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.IPV4UNICAST;
  47 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.PeerType;
  48 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.RrClusterIdType;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instance.protocol.NeighborAddPathsConfigBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instance.protocol.NeighborTransportConfigBuilder;
  54 import org.opendaylight.yangtools.yang.common.Decimal64;
  55 import org.opendaylight.yangtools.yang.common.Uint16;
  56 import org.opendaylight.yangtools.yang.common.Uint8;
  57
  58 public class BgpPeerTest extends AbstractConfig {
  59     static final Uint8 SHORT = Uint8.ZERO;
  60     static final IpAddress NEIGHBOR_ADDRESS = new IpAddress(new Ipv4Address("127.0.0.1"));
  61     static final String MD5_PASSWORD = "123";
  62     static final PortNumber PORT = new PortNumber(Uint16.valueOf(179));
  63     static final AfiSafi AFI_SAFI_IPV4 = new AfiSafiBuilder().setAfiSafiName(IPV4UNICAST.VALUE)
  64             .addAugmentation(new NeighborAddPathsConfigBuilder().setReceive(true).setSendMax(Uint8.ZERO).build())
  65             .build();
  66     static final Map<AfiSafiKey, AfiSafi> AFI_SAFI = Map.of(AFI_SAFI_IPV4.key(), AFI_SAFI_IPV4);
  67     private static final Decimal64 DEFAULT_TIMERS = Decimal64.valueOf(2, 30);
  68     private BgpPeer bgpPeer;
  69
  70     static Neighbor createNeighborExpected(final IpAddress neighborAddress) {
  71         return new NeighborBuilder()
  72                 .setAfiSafis(createAfiSafi())
  73                 .setConfig(createConfig())
  74                 .setNeighborAddress(neighborAddress)
  75                 .setRouteReflector(createRR())
  76                 .setTimers(createTimers())
  77                 .setTransport(createTransport())
  78                 .setAddPaths(createAddPath())
  79                 .build();
  80     }
  81
  82     static Transport createTransport() {
  83         return new TransportBuilder().setConfig(new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009
  84                 .bgp.neighbor.group.transport.ConfigBuilder()
  85                     .setMtuDiscovery(false)
  86                     .setPassiveMode(false)
  87                     .addAugmentation(new NeighborTransportConfigBuilder().setRemotePort(PORT).build())
  88                     .build())
  89                 .build();
  90     }
  91
  92     static Timers createTimers() {
  93         return new TimersBuilder().setConfig(new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009
  94                 .bgp.neighbor.group.timers.ConfigBuilder()
  95                 .setHoldTime(DEFAULT_TIMERS)
  96                 .setMinimumAdvertisementInterval(DEFAULT_TIMERS)
  97                 .setKeepaliveInterval(DEFAULT_TIMERS)
  98                 .setConnectRetry(DEFAULT_TIMERS).build()).build();
  99     }
 100
 101     private static RouteReflector createRR() {
 102         return new RouteReflectorBuilder().setConfig(new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp
 103                 .rev151009.bgp.neighbor.group.route.reflector.ConfigBuilder()
 104                 .setRouteReflectorClusterId(new RrClusterIdType(new Ipv4Address("127.0.0.1")))
 105                 .setRouteReflectorClient(false).build()).build();
 106     }
 107
 108     static Config createConfig() {
 109         return new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group
 110                 .ConfigBuilder()
 111                 .setPeerAs(AS)
 112                 .setLocalAs(LOCAL_AS)
 113                 .setPeerType(PeerType.INTERNAL)
 114                 .setAuthPassword(MD5_PASSWORD)
 115                 .setRouteFlapDamping(false)
 116                 .setSendCommunity(CommunityType.NONE).build();
 117     }
 118
 119     static AfiSafis createAfiSafi() {
 120         return new AfiSafisBuilder().setAfiSafi(AFI_SAFI).build();
 121     }
 122
 123     static AddPaths createAddPath() {
 124         return new AddPathsBuilder().setConfig(new ConfigBuilder().setReceive(true).setSendMax(SHORT).build()).build();
 125     }
 126
 127     @Override
 128     @Before
 129     public void setUp() throws Exception {
 130         super.setUp();
 131         bgpPeer = new BgpPeer(mock(RpcProviderService.class), new BGPStateCollector());
 132     }
 133
 134     @Test
 135     public void testBgpPeer() throws ExecutionException, InterruptedException {
 136         final Neighbor neighbor = new NeighborBuilder()
 137             .setAfiSafis(createAfiSafi())
 138             .setConfig(createConfig())
 139             .setNeighborAddress(NEIGHBOR_ADDRESS)
 140             .setRouteReflector(createRR())
 141             .setTimers(createTimers())
 142             .setTransport(createTransport())
 143             .setAddPaths(createAddPath())
 144             .build();
 145
 146         bgpPeer.start(rib, neighbor, null, peerGroupLoader, tableTypeRegistry);
 147         verify(rib).createPeerDOMChain();
 148         verify(rib, times(2)).getLocalAs();
 149         verify(rib).getLocalTables();
 150
 151         bgpPeer.instantiateServiceInstance();
 152         verify(bgpPeerRegistry).addPeer(any(), any(), any());
 153         verify(dispatcher).createReconnectingClient(any(InetSocketAddress.class), any(), anyInt(),
 154             any(KeyMapping.class));
 155
 156         final var ex = assertThrows(IllegalStateException.class,
 157             () -> bgpPeer.start(rib, neighbor, null, peerGroupLoader, tableTypeRegistry));
 158         assertEquals("Previous peer instance was not closed.", ex.getMessage());
 159         bgpPeer.closeServiceInstance();
 160         verify(bgpPeerRegistry).removePeer(any());
 161         verify(future).cancel(true);
 162         bgpPeer.stop().get();
 163         bgpPeer.start(rib, bgpPeer.getCurrentConfiguration(), null, peerGroupLoader, tableTypeRegistry);
 164         bgpPeer.instantiateServiceInstance();
 165         verify(rib, times(2)).createPeerDOMChain();
 166         verify(rib, times(4)).getLocalAs();
 167         verify(rib, times(2)).getLocalTables();
 168         verify(bgpPeerRegistry, times(2)).addPeer(any(), any(), any());
 169         verify(dispatcher, times(2)).createReconnectingClient(any(InetSocketAddress.class), any(), anyInt(),
 170             any(KeyMapping.class));
 171
 172         final Neighbor neighborExpected = createNeighborExpected(NEIGHBOR_ADDRESS);
 173         assertTrue(bgpPeer.containsEqualConfiguration(neighborExpected));
 174         assertFalse(bgpPeer.containsEqualConfiguration(createNeighborExpected(
 175             new IpAddress(new Ipv4Address("127.0.0.2")))));
 176
 177         bgpPeer.closeServiceInstance();
 178         verify(bgpPeerRegistry, times(2)).removePeer(any());
 179         verify(future, times(2)).cancel(true);
 180
 181         bgpPeer.instantiateServiceInstance();
 182         verify(bgpPeerRegistry, times(3)).addPeer(any(), any(), any());
 183         verify(dispatcher, times(3)).createReconnectingClient(any(InetSocketAddress.class), any(), anyInt(),
 184             any(KeyMapping.class));
 185
 186         bgpPeer.closeServiceInstance();
 187         verify(bgpPeerRegistry, times(3)).removePeer(any());
 188         verify(future, times(3)).cancel(true);
 189         verify(rib, times(3)).createPeerDOMChain();
 190
 191         bgpPeer.stop().get();
 192         bgpPeer.start(rib, bgpPeer.getCurrentConfiguration(), null, peerGroupLoader, tableTypeRegistry);
 193         bgpPeer.instantiateServiceInstance();
 194         verify(rib, times(4)).createPeerDOMChain();
 195         verify(rib, times(6)).getLocalAs();
 196         verify(rib, times(3)).getLocalTables();
 197         verify(bgpPeerRegistry, times(4)).addPeer(any(), any(), any());
 198         verify(dispatcher, times(4)).createReconnectingClient(any(InetSocketAddress.class), any(), anyInt(),
 199             any(KeyMapping.class));
 200         bgpPeer.closeServiceInstance();
 201         verify(bgpPeerRegistry, times(4)).removePeer(any());
 202         verify(future, times(4)).cancel(true);
 203         bgpPeer.stop().get();
 204
 205         final Neighbor neighborDiffConfig = new NeighborBuilder()
 206             .setNeighborAddress(NEIGHBOR_ADDRESS)
 207             .setAfiSafis(createAfiSafi())
 208             .build();
 209         bgpPeer.start(rib, neighborDiffConfig, null, peerGroupLoader, tableTypeRegistry);
 210         assertTrue(bgpPeer.containsEqualConfiguration(neighborDiffConfig));
 211         bgpPeer.stop().get();
 212     }
 213 }