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