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