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.RIBExtensionProviderContext;
  62 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  63 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev171207.ipv4.routes.ipv4.routes.Ipv4Route;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpTableType;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.BgpRib;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.RibId;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.Rib;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  78 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  79 import org.opendaylight.yangtools.yang.binding.DataObject;
  80 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  81 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  82 import org.opendaylight.yangtools.yang.common.QName;
  83 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  84 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  85 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  86 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  87 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  88 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  89 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  90 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
  91 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
  92 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  93 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  94 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  95 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  96
  97 public class AbstractRIBTestSetup {
  98
  99     protected static final Class<? extends AddressFamily> AFI = Ipv4AddressFamily.class;
 100     protected static final Class<? extends SubsequentAddressFamily> SAFI = UnicastSubsequentAddressFamily.class;
 101     protected static final QName AFI_QNAME = BindingReflections.findQName(AFI).intern();
 102     protected static final QName SAFI_QNAME = BindingReflections.findQName(SAFI).intern();
 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 ClusterIdentifier CLUSTER_ID = new ClusterIdentifier("128.0.0.1");
 106     private static final BgpId RIB_ID = new BgpId("127.0.0.1");
 107     private RIBImpl rib;
 108     private BindingCodecTreeFactory codecFactory;
 109     private RIBActivator a1;
 110     private RIBSupport ribSupport;
 111     @Mock
 112     private BGPDispatcher dispatcher;
 113
 114     @Mock
 115     private DOMDataBroker dom;
 116
 117     @Mock
 118     private BindingTransactionChain chain;
 119
 120     @Mock
 121     private WriteTransaction transWrite;
 122
 123     @Mock
 124     private DOMTransactionChain domChain;
 125
 126     @Mock
 127     private DOMDataWriteTransaction domTransWrite;
 128
 129     @Mock
 130     private CheckedFuture<?, ?> future;
 131
 132     @Mock
 133     private Optional<Rib> o;
 134
 135     @Mock
 136     private DOMDataTreeChangeService service;
 137
 138     @Mock
 139     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
 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         mockRib();
 164     }
 165
 166     public void mockRib() throws Exception {
 167         final RIBExtensionProviderContext context = new SimpleRIBExtensionProviderContext();
 168         final ModuleInfoBackedContext strategy = createClassLoadingStrategy();
 169         final SchemaContext schemaContext = strategy.tryToCreateSchemaContext().get();
 170         this.codecFactory = createCodecFactory(strategy, schemaContext);
 171         final List<BgpTableType> localTables = new ArrayList<>();
 172         localTables.add(new BgpTableTypeImpl(AFI, SAFI));
 173
 174         this.a1 = new RIBActivator();
 175         this.a1.startRIBExtensionProvider(context);
 176         mockedMethods();
 177         doReturn(mock(ClusterSingletonServiceRegistration.class)).when(this.clusterSingletonServiceProvider)
 178                 .registerClusterSingletonService(any(ClusterSingletonService.class));
 179         this.rib = new RIBImpl(new RibId("test"), new AsNumber(5L), RIB_ID, CLUSTER_ID, context,
 180                 this.dispatcher, this.codecFactory, this.dom, localTables,
 181                 Collections.singletonMap(new TablesKey(AFI, SAFI),
 182                         BasePathSelectionModeFactory.createBestPathSelectionStrategy()),
 183                 GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy());
 184         this.rib.onGlobalContextUpdated(schemaContext);
 185         this.ribSupport = getRib().getRibSupportContext().getRIBSupportContext(KEY).getRibSupport();
 186     }
 187
 188     @SuppressWarnings("unchecked")
 189     private void mockedMethods() throws Exception {
 190         MockitoAnnotations.initMocks(this);
 191         final ReadOnlyTransaction readTx = mock(ReadOnlyTransaction.class);
 192         doReturn(new listenerRegistration()).when(this.service)
 193                 .registerDataTreeChangeListener(any(DOMDataTreeIdentifier.class),
 194                         any(ClusteredDOMDataTreeChangeListener.class));
 195         final Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> map = new HashMap<>();
 196         map.put(DOMDataTreeChangeService.class, this.service);
 197         doNothing().when(readTx).close();
 198         final CheckedFuture<Optional<DataObject>, ReadFailedException> readFuture = mock(CheckedFuture.class);
 199         doNothing().when(this.domTransWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 200                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 201         doNothing().when(this.domTransWrite).delete(eq(LogicalDatastoreType.OPERATIONAL),
 202                 any(YangInstanceIdentifier.class));
 203         doNothing().when(this.domTransWrite).merge(eq(LogicalDatastoreType.OPERATIONAL),
 204                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 205         doReturn(Optional.absent()).when(readFuture).checkedGet();
 206         doReturn(readFuture).when(readTx).read(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
 207         doNothing().when(this.domChain).close();
 208         doReturn(this.domTransWrite).when(this.domChain).newWriteOnlyTransaction();
 209         doNothing().when(getTransaction()).put(eq(LogicalDatastoreType.OPERATIONAL),
 210                 eq(YangInstanceIdentifier.of(BgpRib.QNAME)), any(NormalizedNode.class));
 211         doReturn(map).when(this.dom).getSupportedExtensions();
 212         doReturn(this.domChain).when(this.dom).createTransactionChain(any(BGPPeer.class));
 213         doReturn(this.transWrite).when(this.chain).newWriteOnlyTransaction();
 214         doReturn(false).when(this.o).isPresent();
 215         doReturn(this.o).when(this.future).checkedGet();
 216         doReturn(this.future).when(this.domTransWrite).submit();
 217         doNothing().when(this.future).addListener(any(Runnable.class), any(Executor.class));
 218         doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 219                 any(InstanceIdentifier.class), any(DataObject.class), eq(true));
 220         doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 221                 any(InstanceIdentifier.class), any(DataObject.class));
 222         doReturn(this.future).when(this.transWrite).submit();
 223     }
 224
 225     public Collection<DataTreeCandidate> ipv4Input(final YangInstanceIdentifier target,
 226             final ModificationType type, final Ipv4Prefix... prefix) {
 227         final Collection<DataTreeCandidate> col = new HashSet<>();
 228         final DataTreeCandidate candidate = mock(DataTreeCandidate.class);
 229         final DataTreeCandidateNode rootNode = mock(DataTreeCandidateNode.class);
 230         doReturn(rootNode).when(candidate).getRootNode();
 231         doReturn(type).when(rootNode).getModificationType();
 232         doCallRealMethod().when(rootNode).toString();
 233         doReturn(target).when(candidate).getRootPath();
 234         doCallRealMethod().when(candidate).toString();
 235         final Collection<DataTreeCandidateNode> children = new HashSet<>();
 236         for (final Ipv4Prefix p : prefix) {
 237             final NodeIdentifierWithPredicates routekey =
 238                     new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, p);
 239             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b =
 240                     ImmutableNodes.mapEntryBuilder();
 241             b.withNodeIdentifier(routekey);
 242             b.addChild(Builders.leafBuilder()
 243                     .withNodeIdentifier(new NodeIdentifier(PREFIX_QNAME)).withValue(p).build());
 244
 245             final DataTreeCandidateNode child = mock(DataTreeCandidateNode.class);
 246             doReturn(createIdentifier(p)).when(child).getIdentifier();
 247             doReturn(Optional.of(b.build())).when(child).getDataAfter();
 248             doReturn(type).when(child).getModificationType();
 249             children.add(child);
 250         }
 251         doReturn(children).when(rootNode).getChildNodes();
 252         col.add(candidate);
 253         return col;
 254     }
 255
 256     public PathArgument createIdentifier(final Ipv4Prefix prefix) {
 257         final NodeIdentifierWithPredicates routekey =
 258                 new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, prefix);
 259         return YangInstanceIdentifier.of(PREFIX_QNAME).node(routekey).getLastPathArgument();
 260     }
 261
 262     public RIBImpl getRib() {
 263         return this.rib;
 264     }
 265
 266     public DOMDataWriteTransaction getTransaction() {
 267         return this.domTransWrite;
 268     }
 269
 270     @After
 271     public void tearDown() {
 272         this.a1.close();
 273     }
 274
 275     private class listenerRegistration implements ListenerRegistration<EventListener> {
 276         @Override
 277         public EventListener getInstance() {
 278             return null;
 279         }
 280
 281         @Override
 282         public void close() {
 283         }
 284     }
 285 }