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