bgp/rib-impl/src/test/java/org/opendaylight/protocol/bgp/rib/impl/SynchronizationAndExceptionTest.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
   9 package org.opendaylight.protocol.bgp.rib.impl;
  10
  11 import static org.mockito.Matchers.any;
  12 import static org.mockito.Matchers.eq;
  13 import static org.mockito.Mockito.doAnswer;
  14 import static org.mockito.Mockito.doNothing;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.verify;
  18 import static org.mockito.internal.verification.VerificationModeFactory.times;
  19 import static org.opendaylight.protocol.bgp.rib.impl.AdjRibInWriter.ATTRIBUTES_UPTODATE_FALSE;
  20
  21 import com.google.common.base.Optional;
  22 import com.google.common.collect.ImmutableList;
  23 import com.google.common.collect.ImmutableMap;
  24 import com.google.common.collect.Lists;
  25 import com.google.common.util.concurrent.CheckedFuture;
  26 import io.netty.channel.Channel;
  27 import io.netty.channel.ChannelFuture;
  28 import io.netty.channel.ChannelHandler;
  29 import io.netty.channel.ChannelPipeline;
  30 import io.netty.channel.EventLoop;
  31 import io.netty.channel.embedded.EmbeddedChannel;
  32 import io.netty.util.concurrent.GlobalEventExecutor;
  33 import java.net.InetAddress;
  34 import java.net.InetSocketAddress;
  35 import java.util.Collections;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.concurrent.Executor;
  39 import java.util.concurrent.TimeUnit;
  40 import org.junit.Before;
  41 import org.junit.Test;
  42 import org.mockito.Matchers;
  43 import org.mockito.Mock;
  44 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  45 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  46 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  47 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  48 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  49 import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
  50 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
  51 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
  52 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  53 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Notify;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Open;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OpenBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.ProtocolVersion;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParametersBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilities;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPath;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPathBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.LocalPrefBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Origin;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.OriginBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.message.NlriBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.GracefulRestartCapabilityBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.MultiprotocolCapabilityBuilder;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Attributes;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpOrigin;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.ipv4.next.hop._case.Ipv4NextHopBuilder;
  97 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  98 import org.opendaylight.yangtools.yang.common.QName;
  99 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 100 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 101 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 102
 103 public class SynchronizationAndExceptionTest extends AbstractAddPathTest {
 104     private static final int HOLD_TIMER = 3;
 105     private static final AsNumber AS_NUMBER = new AsNumber(30L);
 106     private static final Ipv4Address BGP_ID = new Ipv4Address("1.1.1.2");
 107     private static final String LOCAL_IP = "1.1.1.4";
 108     private final IpAddress neighbor = new IpAddress(new Ipv4Address(LOCAL_IP));
 109     private static final int LOCAL_PORT = 12345;
 110     private final BgpTableType ipv4tt = new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
 111     private Open classicOpen;
 112     @Mock
 113     private EventLoop eventLoop;
 114     @Mock
 115     private ChannelPipeline pipeline;
 116     @Mock
 117     private Channel speakerListener;
 118     @Mock
 119     private DOMDataBroker domBroker;
 120     @Mock
 121     private DOMTransactionChain domChain;
 122     @Mock
 123     private DOMDataWriteTransaction tx;
 124     private static final String RIB_ID = "1.1.1.2";
 125     private static final YangInstanceIdentifier PEER_PATH = YangInstanceIdentifier.builder().node(BgpRib.QNAME).node(Rib.QNAME)
 126         .nodeWithKey(Rib.QNAME, QName.create(Rib.QNAME, "id").intern(), RIB_ID)
 127         .node(Peer.QNAME).nodeWithKey(Peer.QNAME, AdjRibInWriter.PEER_ID_QNAME, "bgp://1.1.1.2").build();
 128     private static final YangInstanceIdentifier TABLE_PATH = PEER_PATH.node(AdjRibIn.QNAME).node(Tables.QNAME)
 129         .node(RibSupportUtils.toYangTablesKey(new TablesKey(Ipv4AddressFamily.class,
 130             UnicastSubsequentAddressFamily.class))).node(Attributes.QNAME).node(QName.create(Attributes.QNAME, "uptodate"));
 131
 132     @Override
 133     @Before
 134     public void setUp() throws Exception {
 135         super.setUp();
 136         new EmbeddedChannel();
 137         final List<BgpParameters> tlvs = Lists.newArrayList();
 138         this.classicOpen = new OpenBuilder().setMyAsNumber(AS_NUMBER.getValue().intValue()).setHoldTimer(HOLD_TIMER)
 139             .setVersion(new ProtocolVersion((short) 4)).setBgpParameters(tlvs).setBgpIdentifier(BGP_ID).build();
 140
 141         final List<OptionalCapabilities> capa = Lists.newArrayList();
 142         capa.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 143             new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder()
 144                 .setAfi(this.ipv4tt.getAfi()).setSafi(this.ipv4tt.getSafi()).build())
 145                 .setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().build()).build())
 146             .setAs4BytesCapability(new As4BytesCapabilityBuilder().setAsNumber(AS_NUMBER).build()).build()).build());
 147         capa.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
 148         tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(capa).build());
 149
 150         doReturn(null).when(mock(ChannelFuture.class)).addListener(any());
 151         doReturn(this.eventLoop).when(this.speakerListener).eventLoop();
 152         doReturn(true).when(this.speakerListener).isActive();
 153         doAnswer(invocation -> {
 154             final Runnable command = (Runnable) invocation.getArguments()[0];
 155             final long delay = (long) invocation.getArguments()[1];
 156             final TimeUnit unit = (TimeUnit) invocation.getArguments()[2];
 157             GlobalEventExecutor.INSTANCE.schedule(command, delay, unit);
 158             return null;
 159         }).when(this.eventLoop).schedule(any(Runnable.class), any(long.class), any(TimeUnit.class));
 160         doReturn("TestingChannel").when(this.speakerListener).toString();
 161         doReturn(true).when(this.speakerListener).isWritable();
 162         doReturn(new InetSocketAddress(InetAddress.getByName(BGP_ID.getValue()), 179)).when(this.speakerListener).remoteAddress();
 163         doReturn(new InetSocketAddress(InetAddress.getByName(LOCAL_IP), LOCAL_PORT)).when(this.speakerListener).localAddress();
 164         doReturn(this.pipeline).when(this.speakerListener).pipeline();
 165         doReturn(this.pipeline).when(this.pipeline).replace(any(ChannelHandler.class), any(String.class), any(ChannelHandler.class));
 166         doReturn(null).when(this.pipeline).replace(Matchers.<Class<ChannelHandler>>any(), any(String.class), any(ChannelHandler.class));
 167         doReturn(this.pipeline).when(this.pipeline).addLast(any(ChannelHandler.class));
 168         final ChannelFuture futureChannel = mock(ChannelFuture.class);
 169         doReturn(null).when(futureChannel).addListener(any());
 170         doReturn(futureChannel).when(this.speakerListener).close();
 171         doReturn(futureChannel).when(this.speakerListener).writeAndFlush(any(Notify.class));
 172         doReturn(this.domChain).when(this.domBroker).createTransactionChain(any());
 173         doReturn(this.tx).when(this.domChain).newWriteOnlyTransaction();
 174         final DOMDataTreeChangeService dOMDataTreeChangeService = mock(DOMDataTreeChangeService.class);
 175         final ListenerRegistration<?> listener = mock(ListenerRegistration.class);
 176         doReturn(listener).when(dOMDataTreeChangeService).registerDataTreeChangeListener(any(), any());
 177         doNothing().when(listener).close();
 178
 179         doReturn(Collections.singletonMap(DOMDataTreeChangeService.class, dOMDataTreeChangeService))
 180             .when(this.domBroker).getSupportedExtensions();
 181         doNothing().when(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL),
 182             any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 183         doNothing().when(this.tx).put(eq(LogicalDatastoreType.OPERATIONAL),
 184             any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 185         doNothing().when(this.tx).delete(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class));
 186         final CheckedFuture<?, ?> future = mock(CheckedFuture.class);
 187         doAnswer(invocation -> {
 188             final Runnable callback = (Runnable) invocation.getArguments()[0];
 189             callback.run();
 190             return null;
 191         }).when(future).addListener(any(Runnable.class), any(Executor.class));
 192         doReturn(future).when(this.tx).submit();
 193         doReturn(mock(Optional.class)).when(future).checkedGet();
 194     }
 195
 196     @Test
 197     public void testHandleMessageAfterException() throws InterruptedException {
 198         final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
 199             BasePathSelectionModeFactory.createBestPathSelectionStrategy());
 200         final RIBImpl ribImpl = new RIBImpl(this.clusterSingletonServiceProvider, new RibId(RIB_ID), AS_NUMBER,
 201             new BgpId(RIB_ID), null, this.ribExtension, this.serverDispatcher, this.mappingService.getCodecFactory(),
 202             this.domBroker, ImmutableList.of(this.ipv4tt), pathTables, this.ribExtension.getClassLoadingStrategy());
 203         ribImpl.instantiateServiceInstance();
 204         ribImpl.onGlobalContextUpdated(this.schemaContext);
 205
 206         final BGPPeer bgpPeer = new BGPPeer(LOCAL_IP, ribImpl, PeerRole.Ibgp, null, AFI_SAFIS_ADVERTIZED,
 207             Collections.emptySet());
 208         bgpPeer.instantiateServiceInstance();
 209         final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen, this.classicOpen.getHoldTimer(), null);
 210         bgpSession.setChannelExtMsgCoder(this.classicOpen);
 211         bgpPeer.onSessionUp(bgpSession);
 212
 213         final List<Ipv4Prefix> prefs = Lists.newArrayList(new Ipv4Prefix("8.0.1.0/28"), new Ipv4Prefix("127.0.0.1/32"), new Ipv4Prefix("2.2.2.2/24"));
 214         final UpdateBuilder wrongMessage = new UpdateBuilder();
 215         wrongMessage.setNlri(new NlriBuilder().setNlri(prefs).build());
 216         final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
 217         final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
 218         final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder().setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
 219         final AttributesBuilder ab = new AttributesBuilder();
 220         wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
 221
 222         final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
 223         correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref((long) 100).build()).build());
 224
 225         bgpSession.handleMessage(correct.build());
 226         verify(this.tx, times(4)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 227         bgpSession.handleMessage(wrongMessage.build());
 228         verify(this.tx, times(4)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 229         bgpSession.handleMessage(new UpdateBuilder().build());
 230         verify(this.tx, times(4)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 231         verify(this.tx).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));
 232         verify(this.tx, times(0)).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
 233             eq(ImmutableNodes.leafNode(ATTRIBUTES_UPTODATE_FALSE.getNodeType(), Boolean.TRUE)));
 234     }
 235
 236     @Test
 237     public void testUseCase1() throws InterruptedException {
 238         final Map<TablesKey, PathSelectionMode> pathTables = ImmutableMap.of(TABLES_KEY,
 239             BasePathSelectionModeFactory.createBestPathSelectionStrategy());
 240         final RIBImpl ribImpl = new RIBImpl(this.clusterSingletonServiceProvider, new RibId(RIB_ID), AS_NUMBER,
 241             new BgpId(RIB_ID), null, this.ribExtension, this.serverDispatcher, this.mappingService.getCodecFactory(),
 242             this.domBroker, ImmutableList.of(this.ipv4tt), pathTables, this.ribExtension.getClassLoadingStrategy());
 243         ribImpl.instantiateServiceInstance();
 244         ribImpl.onGlobalContextUpdated(this.schemaContext);
 245
 246         final BGPPeer bgpPeer = new BGPPeer(LOCAL_IP, ribImpl, PeerRole.Ibgp, null, AFI_SAFIS_ADVERTIZED,
 247             Collections.emptySet());
 248         bgpPeer.instantiateServiceInstance();
 249         final BGPSessionImpl bgpSession = new BGPSessionImpl(bgpPeer, this.speakerListener, this.classicOpen, this.classicOpen.getHoldTimer(), null);
 250         bgpSession.setChannelExtMsgCoder(this.classicOpen);
 251         bgpPeer.onSessionUp(bgpSession);
 252
 253         final List<Ipv4Prefix> prefs = Lists.newArrayList(new Ipv4Prefix("8.0.1.0/28"), new Ipv4Prefix("127.0.0.1/32"), new Ipv4Prefix("2.2.2.2/24"));
 254         final UpdateBuilder wrongMessage = new UpdateBuilder();
 255         wrongMessage.setNlri(new NlriBuilder().setNlri(prefs).build());
 256         final Origin origin = new OriginBuilder().setValue(BgpOrigin.Igp).build();
 257         final AsPath asPath = new AsPathBuilder().setSegments(Collections.emptyList()).build();
 258         final CNextHop nextHop = new Ipv4NextHopCaseBuilder().setIpv4NextHop(new Ipv4NextHopBuilder().setGlobal(new Ipv4Address("127.0.0.1")).build()).build();
 259         final AttributesBuilder ab = new AttributesBuilder();
 260         wrongMessage.setAttributes(ab.setOrigin(origin).setAsPath(asPath).setCNextHop(nextHop).build());
 261
 262         final UpdateBuilder correct = new UpdateBuilder(wrongMessage.build());
 263         correct.setAttributes(ab.setLocalPref(new LocalPrefBuilder().setPref((long) 100).build()).build());
 264
 265         bgpSession.handleMessage(correct.build());
 266         verify(this.tx, times(4)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 267         bgpSession.handleMessage(new UpdateBuilder().build());
 268         verify(this.tx, times(5)).merge(eq(LogicalDatastoreType.OPERATIONAL), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 269
 270         verify(this.tx).merge(eq(LogicalDatastoreType.OPERATIONAL), eq(TABLE_PATH),
 271             eq(ImmutableNodes.leafNode(ATTRIBUTES_UPTODATE_FALSE.getNodeType(), Boolean.TRUE)));
 272         verify(this.tx, times(0)).delete(eq(LogicalDatastoreType.OPERATIONAL), eq(PEER_PATH));
 273     }
 274 }