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