bgp/rib-impl/src/test/java/org/opendaylight/protocol/bgp/rib/impl/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.bgp.rib.impl;
   9
  10 import static org.junit.Assert.assertFalse;
  11 import static org.junit.Assert.assertTrue;
  12 import static org.mockito.Matchers.any;
  13 import static org.mockito.Mockito.doReturn;
  14
  15 import com.google.common.base.Optional;
  16 import com.google.common.base.Throwables;
  17 import com.google.common.collect.Collections2;
  18 import com.google.common.collect.ImmutableList;
  19 import com.google.common.collect.Lists;
  20 import com.google.common.eventbus.EventBus;
  21 import io.netty.util.concurrent.GlobalEventExecutor;
  22 import java.io.IOException;
  23 import java.net.InetSocketAddress;
  24 import java.util.Collection;
  25 import java.util.Collections;
  26 import java.util.List;
  27 import java.util.concurrent.ExecutionException;
  28 import org.junit.After;
  29 import org.junit.Before;
  30 import org.junit.Test;
  31 import org.mockito.Mock;
  32 import org.mockito.Mockito;
  33 import org.mockito.MockitoAnnotations;
  34 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  35 import org.opendaylight.controller.md.sal.binding.test.AbstractDataBrokerTest;
  36 import org.opendaylight.controller.md.sal.binding.test.DataBrokerTestCustomizer;
  37 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  38 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  39 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
  40 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  41 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
  42 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
  43 import org.opendaylight.protocol.bgp.inet.RIBActivator;
  44 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
  45 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  46 import org.opendaylight.protocol.bgp.parser.spi.pojo.ServiceLoaderBGPExtensionProviderContext;
  47 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
  48 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
  49 import org.opendaylight.protocol.bgp.rib.mock.BGPMock;
  50 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBExtensionProviderActivator;
  51 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
  52 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
  53 import org.opendaylight.protocol.bgp.util.HexDumpBGPFileParser;
  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.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv6.routes.ipv6.routes.Ipv6Route;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.LinkstateAddressFamily;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.LinkstateSubsequentAddressFamily;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.routes.linkstate.routes.LinkstateRoute;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.RibKey;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  74 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  75 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
  76 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  77 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  78
  79 public class ParserToSalTest extends AbstractDataBrokerTest {
  80
  81     private static final String TEST_RIB_ID = "testRib";
  82     private BGPMock mock;
  83     private AbstractRIBExtensionProviderActivator baseact, lsact;
  84     private RIBExtensionProviderContext ext1, ext2;
  85     private static final TablesKey TABLE_KEY = new TablesKey(LinkstateAddressFamily.class, LinkstateSubsequentAddressFamily.class);
  86     private String localAddress = "127.0.0.1";
  87     private final IpAddress neighborAddress = new IpAddress(new Ipv4Address(localAddress));
  88     @Mock
  89     BGPDispatcher dispatcher;
  90     @Mock
  91     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
  92     private BindingCodecTreeFactory codecFactory;
  93
  94     private SchemaService schemaService;
  95
  96     @Before
  97     public void setUp() throws Exception {
  98         super.setup();
  99         doReturn(Mockito.mock(ClusterSingletonServiceRegistration.class)).when(this.clusterSingletonServiceProvider).
 100             registerClusterSingletonService(any(ClusterSingletonService.class));
 101     }
 102
 103     @Override
 104     protected java.lang.Iterable<org.opendaylight.yangtools.yang.binding.YangModuleInfo> getModuleInfos() throws Exception {
 105         return ImmutableList.of(BindingReflections.getModuleInfo(Ipv4Route.class), BindingReflections.getModuleInfo(Ipv6Route.class), BindingReflections.getModuleInfo(LinkstateRoute.class));
 106     }
 107
 108     @Override
 109     protected DataBrokerTestCustomizer createDataBrokerTestCustomizer() {
 110         final DataBrokerTestCustomizer customizer = super.createDataBrokerTestCustomizer();
 111         this.codecFactory = customizer.getBindingToNormalized();
 112         this.schemaService = customizer.getSchemaService();
 113         return customizer;
 114     }
 115
 116     @Override
 117     protected void setupWithDataBroker(final DataBroker dataBroker) {
 118         MockitoAnnotations.initMocks(this);
 119         final List<byte[]> bgpMessages;
 120         try {
 121             final String hexMessages = "/bgp_hex.txt";
 122             bgpMessages = HexDumpBGPFileParser.parseMessages(ParserToSalTest.class.getResourceAsStream(hexMessages));
 123         } catch (final IOException e) {
 124             throw Throwables.propagate(e);
 125         }
 126         this.mock = new BGPMock(new EventBus("test"), ServiceLoaderBGPExtensionProviderContext.getSingletonInstance().getMessageRegistry(), Lists.newArrayList(fixMessages(bgpMessages)));
 127
 128         Mockito.doReturn(GlobalEventExecutor.INSTANCE.newSucceededFuture(null)).when(this.dispatcher).createReconnectingClient(
 129                 Mockito.any(InetSocketAddress.class), Mockito.any(BGPPeerRegistry.class), Mockito.anyInt(), Mockito.any(Optional.class));
 130
 131         this.ext1 = new SimpleRIBExtensionProviderContext();
 132         this.ext2 = new SimpleRIBExtensionProviderContext();
 133         this.baseact = new RIBActivator();
 134         this.lsact = new org.opendaylight.protocol.bgp.linkstate.impl.RIBActivator();
 135
 136         this.baseact.startRIBExtensionProvider(this.ext1);
 137         this.lsact.startRIBExtensionProvider(this.ext2);
 138     }
 139
 140     @After
 141     public void tearDown() {
 142         this.lsact.close();
 143         this.baseact.close();
 144     }
 145
 146     @Test
 147     public void testWithLinkstate() throws InterruptedException, ExecutionException {
 148         final List<BgpTableType> tables = ImmutableList.of(
 149                 new BgpTableTypeImpl(LinkstateAddressFamily.class, LinkstateSubsequentAddressFamily.class));
 150         final RIBImpl rib = new RIBImpl(this.clusterSingletonServiceProvider, new RibId(TEST_RIB_ID), new AsNumber(72L), new BgpId("127.0.0.1"),
 151             null, this.ext2, this.dispatcher, this.codecFactory, getDomBroker(), tables, Collections.singletonMap(TABLE_KEY,
 152             BasePathSelectionModeFactory.createBestPathSelectionStrategy()), GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy(), null);
 153         rib.instantiateServiceInstance();
 154         assertTablesExists(tables, true);
 155         rib.onGlobalContextUpdated(this.schemaService.getGlobalContext());
 156         final BGPPeer peer = new BGPPeer(this.localAddress, rib, PeerRole.Ibgp, null, Collections.emptySet(),
 157             Collections.emptySet());
 158         peer.instantiateServiceInstance();
 159         final ListenerRegistration<?> reg = this.mock.registerUpdateListener(peer);
 160         reg.close();
 161     }
 162
 163     @Test
 164     public void testWithoutLinkstate() throws InterruptedException, ExecutionException {
 165         final List<BgpTableType> tables = ImmutableList.of(new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class));
 166         final RIBImpl rib = new RIBImpl(this.clusterSingletonServiceProvider, new RibId(TEST_RIB_ID), new AsNumber(72L), new BgpId("127.0.0.1"), null,
 167             this.ext1, this.dispatcher, this.codecFactory, getDomBroker(), tables, Collections.singletonMap(TABLE_KEY,
 168             BasePathSelectionModeFactory.createBestPathSelectionStrategy()), GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy(), null);
 169         rib.instantiateServiceInstance();
 170         rib.onGlobalContextUpdated(this.schemaService.getGlobalContext());
 171         assertTablesExists(tables, true);
 172         final BGPPeer peer = new BGPPeer(this.localAddress, rib, PeerRole.Ibgp, null, Collections.emptySet(),
 173             Collections.emptySet());
 174         peer.instantiateServiceInstance();
 175         final ListenerRegistration<?> reg = this.mock.registerUpdateListener(peer);
 176         reg.close();
 177     }
 178
 179     private static Collection<byte[]> fixMessages(final Collection<byte[]> bgpMessages) {
 180         return Collections2.transform(bgpMessages, input -> {
 181             final byte[] ret = new byte[input.length + 1];
 182             // ff
 183             ret[0] = -1;
 184             System.arraycopy(input, 0, ret, 1, input.length);
 185             return ret;
 186         });
 187     }
 188
 189     private void assertTablesExists(final List<BgpTableType> expectedTables, final boolean uptodate) throws InterruptedException, ExecutionException {
 190         final Optional<LocRib> lockRib = getLocRibTable();
 191         assertTrue(lockRib.isPresent());
 192         final List<Tables> tables = lockRib.get().getTables();
 193         assertFalse(tables.isEmpty());
 194         for (final BgpTableType tableType : expectedTables) {
 195             boolean found = false;
 196             for (final Tables table : tables) {
 197                 if(table.getAfi().equals(tableType.getAfi()) && table.getSafi().equals(tableType.getSafi())) {
 198                     found = true;
 199                     assertTrue(Boolean.valueOf(uptodate).equals(table.getAttributes().isUptodate()));
 200                 }
 201             }
 202             assertTrue(found);
 203         }
 204     }
 205
 206     private Optional<LocRib> getLocRibTable() throws InterruptedException, ExecutionException {
 207         return getDataBroker().newReadOnlyTransaction().read(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.builder(BgpRib.class).child(Rib.class, new RibKey(new RibId(TEST_RIB_ID))).child(LocRib.class).build()).get();
 208     }
 209 }