bgp/rib-impl/src/test/java/org/opendaylight/protocol/bgp/rib/impl/AbstractRIBTestSetup.java

   1 /*
   2  * Copyright (c) 2015 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.mockito.Matchers.any;
  11 import static org.mockito.Matchers.eq;
  12 import static org.mockito.Mockito.doCallRealMethod;
  13 import static org.mockito.Mockito.doNothing;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.mock;
  16
  17 import com.google.common.base.Optional;
  18 import com.google.common.util.concurrent.CheckedFuture;
  19 import com.google.common.util.concurrent.FluentFuture;
  20 import java.util.ArrayList;
  21 import java.util.Collection;
  22 import java.util.Collections;
  23 import java.util.EventListener;
  24 import java.util.HashMap;
  25 import java.util.HashSet;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.concurrent.Executor;
  29 import javassist.ClassPool;
  30 import org.junit.After;
  31 import org.junit.Before;
  32 import org.mockito.Mock;
  33 import org.mockito.MockitoAnnotations;
  34 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  35 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  36 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  37 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  38 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  39 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
  40 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  41 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
  42 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  43 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
  44 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  45 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  46 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
  47 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerGenerator;
  48 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
  49 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  50 import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
  51 import org.opendaylight.mdsal.binding.generator.impl.GeneratedClassLoadingStrategy;
  52 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  53 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
  54 import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
  55 import org.opendaylight.mdsal.common.api.CommitInfo;
  56 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
  57 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  58 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
  59 import org.opendaylight.protocol.bgp.inet.RIBActivator;
  60 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
  61 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  62 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
  63 import org.opendaylight.protocol.bgp.rib.spi.BGPPeerTracker;
  64 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
  65 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  66 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpId;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
  80 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  81 import org.opendaylight.yangtools.yang.binding.DataObject;
  82 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  83 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  84 import org.opendaylight.yangtools.yang.common.QName;
  85 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  86 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  87 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  88 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  89 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  90 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  91 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  92 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
  93 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
  94 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  95 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  96 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  97 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  98
  99 public class AbstractRIBTestSetup extends DefaultRibPoliciesMockTest {
 100
 101     protected static final Class<? extends AddressFamily> AFI = Ipv4AddressFamily.class;
 102     protected static final Class<? extends SubsequentAddressFamily> SAFI = UnicastSubsequentAddressFamily.class;
 103     protected static final TablesKey KEY = new TablesKey(AFI, SAFI);
 104     protected static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
 105     private static final BgpId RIB_ID = new BgpId("127.0.0.1");
 106     private RIBImpl rib;
 107     private BindingCodecTreeFactory codecFactory;
 108     private RIBActivator a1;
 109     private RIBSupport ribSupport;
 110     @Mock
 111     private BGPDispatcher dispatcher;
 112
 113     @Mock
 114     private DOMDataBroker dom;
 115
 116     @Mock
 117     private BindingTransactionChain chain;
 118
 119     @Mock
 120     private WriteTransaction transWrite;
 121
 122     @Mock
 123     private DOMTransactionChain domChain;
 124
 125     @Mock
 126     private DOMDataWriteTransaction domTransWrite;
 127
 128     @Mock
 129     private FluentFuture<? extends CommitInfo> future;
 130
 131     @Mock
 132     private Optional<Rib> o;
 133
 134     @Mock
 135     private DOMDataTreeChangeService service;
 136
 137     @Mock
 138     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
 139     private BGPPeerTracker peerTracker = new BGPPeerTrackerImpl();
 140
 141     private static ModuleInfoBackedContext createClassLoadingStrategy() {
 142         final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
 143         try {
 144             ctx.registerModuleInfo(BindingReflections.getModuleInfo(Ipv4Route.class));
 145         } catch (final RuntimeException e) {
 146             throw e;
 147         } catch (final Exception e) {
 148             throw new RuntimeException(e);
 149         }
 150         return ctx;
 151     }
 152
 153     private static BindingCodecTreeFactory createCodecFactory(final ClassLoadingStrategy str, final SchemaContext ctx) {
 154         final DataObjectSerializerGenerator generator = StreamWriterGenerator
 155                 .create(JavassistUtils.forClassPool(ClassPool.getDefault()));
 156         final BindingNormalizedNodeCodecRegistry codec = new BindingNormalizedNodeCodecRegistry(generator);
 157         codec.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(str, ctx));
 158         return codec;
 159     }
 160
 161     @Before
 162     public void setUp() throws Exception {
 163         super.setUp();
 164         mockRib();
 165     }
 166
 167     public void mockRib() throws Exception {
 168         final RIBExtensionProviderContext context = new SimpleRIBExtensionProviderContext();
 169         final ModuleInfoBackedContext strategy = createClassLoadingStrategy();
 170         final SchemaContext schemaContext = strategy.tryToCreateSchemaContext().get();
 171         this.codecFactory = createCodecFactory(strategy, schemaContext);
 172         final List<BgpTableType> localTables = new ArrayList<>();
 173         localTables.add(new BgpTableTypeImpl(AFI, SAFI));
 174
 175         this.a1 = new RIBActivator();
 176         this.a1.startRIBExtensionProvider(context, this.mappingService);
 177
 178         final CodecsRegistryImpl codecsRegistry = CodecsRegistryImpl.create(this.codecFactory,
 179                 GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy());
 180
 181         mockedMethods();
 182         doReturn(mock(ClusterSingletonServiceRegistration.class)).when(this.clusterSingletonServiceProvider)
 183                 .registerClusterSingletonService(any(ClusterSingletonService.class));
 184         this.rib = new RIBImpl(new RibId("test"), new AsNumber(5L), RIB_ID, context,
 185                 this.dispatcher, codecsRegistry, this.dom, getDataBroker(), this.policies, this.peerTracker,
 186                 localTables, Collections.singletonMap(new TablesKey(AFI, SAFI),
 187                 BasePathSelectionModeFactory.createBestPathSelectionStrategy(this.peerTracker)));
 188         this.rib.onGlobalContextUpdated(schemaContext);
 189         this.ribSupport = getRib().getRibSupportContext().getRIBSupport(KEY);
 190     }
 191
 192     @SuppressWarnings("unchecked")
 193     private void mockedMethods() throws Exception {
 194         MockitoAnnotations.initMocks(this);
 195         final ReadOnlyTransaction readTx = mock(ReadOnlyTransaction.class);
 196         doReturn(new listenerRegistration()).when(this.service)
 197                 .registerDataTreeChangeListener(any(DOMDataTreeIdentifier.class),
 198                         any(ClusteredDOMDataTreeChangeListener.class));
 199         final Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> map = new HashMap<>();
 200         map.put(DOMDataTreeChangeService.class, this.service);
 201         doNothing().when(readTx).close();
 202         final CheckedFuture<Optional<DataObject>, ReadFailedException> readFuture = mock(CheckedFuture.class);
 203         doNothing().when(this.domTransWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 204                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 205         doNothing().when(this.domTransWrite).delete(eq(LogicalDatastoreType.OPERATIONAL),
 206                 any(YangInstanceIdentifier.class));
 207         doNothing().when(this.domTransWrite).merge(eq(LogicalDatastoreType.OPERATIONAL),
 208                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 209         doReturn(Optional.absent()).when(readFuture).checkedGet();
 210         doReturn(readFuture).when(readTx).read(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
 211         doNothing().when(this.domChain).close();
 212         doReturn(this.domTransWrite).when(this.domChain).newWriteOnlyTransaction();
 213         doNothing().when(getTransaction()).put(eq(LogicalDatastoreType.OPERATIONAL),
 214                 eq(YangInstanceIdentifier.of(BgpRib.QNAME)), any(NormalizedNode.class));
 215         doReturn(map).when(this.dom).getSupportedExtensions();
 216         doReturn(this.domChain).when(this.dom).createTransactionChain(any(BGPPeer.class));
 217         doReturn(this.transWrite).when(this.chain).newWriteOnlyTransaction();
 218         doReturn(false).when(this.o).isPresent();
 219         doReturn(this.o).when(this.future).get();
 220         doReturn(this.future).when(this.domTransWrite).commit();
 221         doNothing().when(this.future).addListener(any(Runnable.class), any(Executor.class));
 222         doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 223                 any(InstanceIdentifier.class), any(DataObject.class), eq(true));
 224         doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 225                 any(InstanceIdentifier.class), any(DataObject.class));
 226         doReturn(this.future).when(this.transWrite).commit();
 227     }
 228
 229     public Collection<DataTreeCandidate> ipv4Input(final YangInstanceIdentifier target,
 230             final ModificationType type, final Ipv4Prefix... prefix) {
 231         final Collection<DataTreeCandidate> col = new HashSet<>();
 232         final DataTreeCandidate candidate = mock(DataTreeCandidate.class);
 233         final DataTreeCandidateNode rootNode = mock(DataTreeCandidateNode.class);
 234         doReturn(rootNode).when(candidate).getRootNode();
 235         doReturn(type).when(rootNode).getModificationType();
 236         doCallRealMethod().when(rootNode).toString();
 237         doReturn(target).when(candidate).getRootPath();
 238         doCallRealMethod().when(candidate).toString();
 239         final Collection<DataTreeCandidateNode> children = new HashSet<>();
 240         for (final Ipv4Prefix p : prefix) {
 241             final NodeIdentifierWithPredicates routekey =
 242                     new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, p);
 243             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b =
 244                     ImmutableNodes.mapEntryBuilder();
 245             b.withNodeIdentifier(routekey);
 246             b.addChild(Builders.leafBuilder()
 247                     .withNodeIdentifier(new NodeIdentifier(PREFIX_QNAME)).withValue(p).build());
 248
 249             final DataTreeCandidateNode child = mock(DataTreeCandidateNode.class);
 250             doReturn(createIdentifier(p)).when(child).getIdentifier();
 251             doReturn(java.util.Optional.of(b.build())).when(child).getDataAfter();
 252             doReturn(type).when(child).getModificationType();
 253             children.add(child);
 254         }
 255         doReturn(children).when(rootNode).getChildNodes();
 256         col.add(candidate);
 257         return col;
 258     }
 259
 260     public PathArgument createIdentifier(final Ipv4Prefix prefix) {
 261         final NodeIdentifierWithPredicates routekey =
 262                 new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, prefix);
 263         return YangInstanceIdentifier.of(PREFIX_QNAME).node(routekey).getLastPathArgument();
 264     }
 265
 266     public RIBImpl getRib() {
 267         return this.rib;
 268     }
 269
 270     public DOMDataWriteTransaction getTransaction() {
 271         return this.domTransWrite;
 272     }
 273
 274     @After
 275     public void tearDown() {
 276         this.a1.close();
 277     }
 278
 279     private class listenerRegistration implements ListenerRegistration<EventListener> {
 280         @Override
 281         public EventListener getInstance() {
 282             return null;
 283         }
 284
 285         @Override
 286         public void close() {
 287         }
 288     }
 289 }