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