integration-tests/src/test/java/org/opendaylight/protocol/integration/bgp/ParserToSalTest.java

   1 /*
   2  * Copyright (c) 2013 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.integration.bgp;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.collect.Collections2;
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.Lists;
  14 import com.google.common.eventbus.EventBus;
  15
  16 import io.netty.util.concurrent.GlobalEventExecutor;
  17
  18 import java.net.InetSocketAddress;
  19 import java.util.Collection;
  20 import java.util.HashMap;
  21 import java.util.List;
  22 import java.util.concurrent.ExecutionException;
  23 import java.util.concurrent.Future;
  24 import java.util.concurrent.TimeUnit;
  25 import java.util.concurrent.TimeoutException;
  26
  27 import javax.annotation.Nullable;
  28
  29 import org.junit.After;
  30 import org.junit.Before;
  31 import org.junit.Test;
  32 import org.mockito.Matchers;
  33 import org.mockito.Mock;
  34 import org.mockito.Mockito;
  35 import org.mockito.MockitoAnnotations;
  36 import org.mockito.invocation.InvocationOnMock;
  37 import org.mockito.stubbing.Answer;
  38 import org.opendaylight.bgpcep.tcpmd5.KeyMapping;
  39 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  40 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  41 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  42 import org.opendaylight.protocol.bgp.parser.BGPSessionListener;
  43 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  44 import org.opendaylight.protocol.bgp.parser.spi.pojo.ServiceLoaderBGPExtensionProviderContext;
  45 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
  46 import org.opendaylight.protocol.bgp.rib.impl.RIBActivator;
  47 import org.opendaylight.protocol.bgp.rib.impl.RIBImpl;
  48 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
  49 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
  50 import org.opendaylight.protocol.bgp.rib.mock.BGPMock;
  51 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBExtensionProviderActivator;
  52 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
  53 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
  54 import org.opendaylight.protocol.bgp.util.HexDumpBGPFileParser;
  55 import org.opendaylight.protocol.framework.ReconnectStrategyFactory;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev131125.LinkstateAddressFamily;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev131125.LinkstateSubsequentAddressFamily;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Attributes;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.AttributesBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  70 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  71 import org.opendaylight.yangtools.yang.binding.DataObject;
  72 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  73 import org.opendaylight.yangtools.yang.common.RpcResult;
  74 import org.slf4j.Logger;
  75 import org.slf4j.LoggerFactory;
  76
  77 public class ParserToSalTest {
  78
  79     private static final Logger LOG = LoggerFactory.getLogger(ParserToSalTest.class);
  80     private static final InstanceIdentifier<Attributes> attrId = InstanceIdentifier.builder(BgpRib.class).child(Rib.class).child(
  81             LocRib.class).child(Tables.class).child(Attributes.class).build();
  82
  83     private final String hex_messages = "/bgp_hex.txt";
  84
  85     private BGPMock mock;
  86     private AbstractRIBExtensionProviderActivator baseact, lsact;
  87     private RIBExtensionProviderContext ext;
  88
  89     @Mock
  90     DataModificationTransaction mockedTransaction;
  91
  92     @Mock
  93     DataProviderService providerService;
  94
  95     @Mock
  96     BGPDispatcher dispatcher;
  97
  98     @Mock
  99     ReconnectStrategyFactory tcpStrategyFactory;
 100
 101     @Mock
 102     ReconnectStrategyFactory sessionStrategy;
 103
 104     @Before
 105     public void setUp() throws Exception {
 106         MockitoAnnotations.initMocks(this);
 107         final List<byte[]> bgpMessages = HexDumpBGPFileParser.parseMessages(ParserToSalTest.class.getResourceAsStream(this.hex_messages));
 108         this.mock = new BGPMock(new EventBus("test"), ServiceLoaderBGPExtensionProviderContext.getSingletonInstance().getMessageRegistry(), Lists.newArrayList(fixMessages(bgpMessages)));
 109
 110         Mockito.doReturn(this.mockedTransaction).when(this.providerService).beginTransaction();
 111
 112         Mockito.doReturn(new Future<RpcResult<TransactionStatus>>() {
 113             int i = 0;
 114
 115             @Override
 116             public boolean cancel(final boolean mayInterruptIfRunning) {
 117                 LOG.debug("Cancel.");
 118                 return false;
 119             }
 120
 121             @Override
 122             public boolean isCancelled() {
 123                 return false;
 124             }
 125
 126             @Override
 127             public boolean isDone() {
 128                 this.i++;
 129                 LOG.debug("Done. {}", this.i);
 130                 return true;
 131             }
 132
 133             @Override
 134             public RpcResult<TransactionStatus> get() throws InterruptedException, ExecutionException {
 135                 return null;
 136             }
 137
 138             @Override
 139             public RpcResult<TransactionStatus> get(final long timeout, final TimeUnit unit) throws InterruptedException,
 140             ExecutionException, TimeoutException {
 141                 return null;
 142             }
 143         }).when(this.mockedTransaction).commit();
 144
 145         final HashMap<Object, Object> data = new HashMap<>();
 146
 147         Mockito.doAnswer(new Answer<String>() {
 148             @Override
 149             public String answer(final InvocationOnMock invocation) {
 150                 final Object[] args = invocation.getArguments();
 151                 LOG.debug("Put value {}", args[1]);
 152                 data.put(args[0], args[1]);
 153                 return null;
 154             }
 155
 156         }).when(this.mockedTransaction).putOperationalData(Matchers.any(InstanceIdentifier.class), Matchers.any(DataObject.class));
 157
 158         Mockito.doAnswer(new Answer<Object>() {
 159             @Override
 160             public Object answer(final InvocationOnMock invocation) {
 161                 final Object[] args = invocation.getArguments();
 162                 final InstanceIdentifier<?> id = (InstanceIdentifier<?>) args[0];
 163
 164                 LOG.debug("Remove key {}", id);
 165                 data.remove(id);
 166                 return null;
 167             }
 168         }).when(this.mockedTransaction).removeOperationalData(Matchers.any(InstanceIdentifier.class));
 169
 170         Mockito.doAnswer(new Answer<Object>() {
 171             @Override
 172             public Object answer(final InvocationOnMock invocation) {
 173                 final Object[] args = invocation.getArguments();
 174                 final InstanceIdentifier<?> id = (InstanceIdentifier<?>) args[0];
 175
 176                 LOG.debug("Get key {}", id);
 177                 Object ret = data.get(id);
 178                 if (ret != null) {
 179                     return ret;
 180                 }
 181
 182                 if (attrId.containsWildcarded(id)) {
 183                     return new AttributesBuilder().setUptodate(true).build();
 184                 }
 185                 return null;
 186             }
 187
 188         }).when(this.mockedTransaction).readOperationalData(Matchers.any(InstanceIdentifier.class));
 189
 190         Mockito.doReturn(GlobalEventExecutor.INSTANCE.newSucceededFuture(null)).when(this.dispatcher).createReconnectingClient(
 191                 Mockito.any(InetSocketAddress.class), Mockito.any(BGPSessionPreferences.class), Mockito.any(AsNumber.class),
 192                 Mockito.any(BGPSessionListener.class), Mockito.eq(this.tcpStrategyFactory), Mockito.eq(this.sessionStrategy),
 193                 Mockito.any(KeyMapping.class));
 194
 195         this.ext = new SimpleRIBExtensionProviderContext();
 196         this.baseact = new RIBActivator();
 197         this.lsact = new org.opendaylight.protocol.bgp.linkstate.RIBActivator();
 198
 199         this.baseact.startRIBExtensionProvider(this.ext);
 200         this.lsact.startRIBExtensionProvider(this.ext);
 201     }
 202
 203     @After
 204     public void tearDown() {
 205         this.lsact.close();
 206         this.baseact.close();
 207     }
 208
 209     private void runTestWithTables(final List<BgpTableType> tables) {
 210         final RIBImpl rib = new RIBImpl(new RibId("testRib"), new AsNumber(72L), new Ipv4Address("127.0.0.1"), this.ext, this.dispatcher, this.tcpStrategyFactory, this.sessionStrategy, this.providerService, tables);
 211         final BGPPeer peer = new BGPPeer("peer-" + this.mock.toString(), null, null, null, rib.getLocalAs(), rib);
 212
 213         ListenerRegistration<?> reg = this.mock.registerUpdateListener(peer);
 214         reg.close();
 215
 216         Mockito.verify(this.mockedTransaction, Mockito.times(31)).commit();
 217     }
 218
 219     @Test
 220     public void testWithLinkstate() {
 221         runTestWithTables(ImmutableList.of(
 222                 (BgpTableType) new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class),
 223                 new BgpTableTypeImpl(LinkstateAddressFamily.class, LinkstateSubsequentAddressFamily.class)));
 224
 225         Mockito.verify(this.mockedTransaction, Mockito.times(83)).putOperationalData(Matchers.any(InstanceIdentifier.class),
 226                 Matchers.any(DataObject.class));
 227     }
 228
 229     @Test
 230     public void testWithoutLinkstate() {
 231         runTestWithTables(ImmutableList.of((BgpTableType) new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class)));
 232
 233         Mockito.verify(this.mockedTransaction, Mockito.times(28)).putOperationalData(Matchers.any(InstanceIdentifier.class),
 234                 Matchers.any(DataObject.class));
 235     }
 236
 237     private Collection<byte[]> fixMessages(final Collection<byte[]> bgpMessages) {
 238         return Collections2.transform(bgpMessages, new Function<byte[], byte[]>() {
 239
 240             @Nullable
 241             @Override
 242             public byte[] apply(@Nullable final byte[] input) {
 243                 final byte[] ret = new byte[input.length + 1];
 244                 // ff
 245                 ret[0] = -1;
 246                 for (int i = 0; i < input.length; i++) {
 247                     ret[i + 1] = input[i];
 248                 }
 249                 return ret;
 250             }
 251         });
 252     }
 253 }