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.ArgumentMatchers.any;
  11 import static org.mockito.ArgumentMatchers.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 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.impl.BindingNormalizedNodeCodecRegistry;
  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.spec.reflect.BindingReflections;
  51 import org.opendaylight.mdsal.common.api.CommitInfo;
  52 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
  53 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  54 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
  55 import org.opendaylight.protocol.bgp.inet.RIBActivator;
  56 import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
  57 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  58 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
  59 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
  60 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  61 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpId;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv6AddressFamily;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
  76 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  77 import org.opendaylight.yangtools.yang.binding.DataObject;
  78 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  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 extends DefaultRibPoliciesMockTest {
  95
  96     static final Class<? extends AddressFamily> IPV4_AFI = Ipv4AddressFamily.class;
  97     private static final Class<? extends AddressFamily> IPV6_AFI = Ipv6AddressFamily.class;
  98     static final Class<? extends SubsequentAddressFamily> SAFI = UnicastSubsequentAddressFamily.class;
  99     static final TablesKey KEY = new TablesKey(IPV4_AFI, SAFI);
 100     static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
 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 FluentFuture<? extends CommitInfo> future;
 126
 127     @Mock
 128     private Optional<Rib> optRib;
 129
 130     @Mock
 131     private DOMDataTreeChangeService service;
 132
 133     @Mock
 134     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
 135
 136     private static ModuleInfoBackedContext createClassLoadingStrategy() throws Exception {
 137         final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
 138         ctx.registerModuleInfo(BindingReflections.getModuleInfo(Ipv4Route.class));
 139         return ctx;
 140     }
 141
 142     @Override
 143     @Before
 144     public void setUp() throws Exception {
 145         super.setUp();
 146         mockRib();
 147     }
 148
 149     public void mockRib() throws Exception {
 150         final RIBExtensionProviderContext context = new SimpleRIBExtensionProviderContext();
 151         final ModuleInfoBackedContext strategy = createClassLoadingStrategy();
 152         final SchemaContext schemaContext = strategy.tryToCreateSchemaContext().get();
 153         this.codecFactory = new BindingNormalizedNodeCodecRegistry(
 154             BindingRuntimeContext.create(strategy, schemaContext));
 155         final List<BgpTableType> localTables = new ArrayList<>();
 156         localTables.add(new BgpTableTypeImpl(IPV4_AFI, SAFI));
 157         localTables.add(new BgpTableTypeImpl(IPV6_AFI, SAFI));
 158
 159         this.a1 = new RIBActivator();
 160         this.a1.startRIBExtensionProvider(context, this.mappingService);
 161
 162         final CodecsRegistryImpl codecsRegistry = CodecsRegistryImpl.create(this.codecFactory,
 163                 GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy());
 164
 165         mockedMethods();
 166         doReturn(mock(ClusterSingletonServiceRegistration.class)).when(this.clusterSingletonServiceProvider)
 167                 .registerClusterSingletonService(any(ClusterSingletonService.class));
 168         this.rib = new RIBImpl(this.tableRegistry, new RibId("test"), new AsNumber(5L), RIB_ID, context,
 169                 this.dispatcher, codecsRegistry, this.dom, getDataBroker(), this.policies,
 170                 localTables, Collections.singletonMap(KEY,
 171                 BasePathSelectionModeFactory.createBestPathSelectionStrategy()));
 172         this.rib.onGlobalContextUpdated(schemaContext);
 173         this.ribSupport = getRib().getRibSupportContext().getRIBSupport(KEY);
 174     }
 175
 176     @SuppressWarnings("unchecked")
 177     private void mockedMethods() throws Exception {
 178         MockitoAnnotations.initMocks(this);
 179         final ReadOnlyTransaction readTx = mock(ReadOnlyTransaction.class);
 180         doReturn(new TestListenerRegistration()).when(this.service)
 181                 .registerDataTreeChangeListener(any(DOMDataTreeIdentifier.class),
 182                         any(ClusteredDOMDataTreeChangeListener.class));
 183         final Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> map = new HashMap<>();
 184         map.put(DOMDataTreeChangeService.class, this.service);
 185         doNothing().when(readTx).close();
 186         final CheckedFuture<Optional<DataObject>, ReadFailedException> readFuture = mock(CheckedFuture.class);
 187         doNothing().when(this.domTransWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 188                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 189         doNothing().when(this.domTransWrite).delete(eq(LogicalDatastoreType.OPERATIONAL),
 190                 any(YangInstanceIdentifier.class));
 191         doNothing().when(this.domTransWrite).merge(eq(LogicalDatastoreType.OPERATIONAL),
 192                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 193         doReturn(Optional.absent()).when(readFuture).checkedGet();
 194         doReturn(readFuture).when(readTx).read(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
 195         doNothing().when(this.domChain).close();
 196         doReturn(this.domTransWrite).when(this.domChain).newWriteOnlyTransaction();
 197         doNothing().when(getTransaction()).put(eq(LogicalDatastoreType.OPERATIONAL),
 198                 eq(YangInstanceIdentifier.of(BgpRib.QNAME)), any(NormalizedNode.class));
 199         doReturn(map).when(this.dom).getSupportedExtensions();
 200         doReturn(this.domChain).when(this.dom).createTransactionChain(any(AbstractPeer.class));
 201         doReturn(this.transWrite).when(this.chain).newWriteOnlyTransaction();
 202         doReturn(false).when(this.optRib).isPresent();
 203         doReturn(this.optRib).when(this.future).get();
 204         doReturn(this.future).when(this.domTransWrite).commit();
 205         doNothing().when(this.future).addListener(any(Runnable.class), any(Executor.class));
 206         doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 207                 any(InstanceIdentifier.class), any(DataObject.class), eq(true));
 208         doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 209                 any(InstanceIdentifier.class), any(DataObject.class));
 210         doReturn(this.future).when(this.transWrite).commit();
 211     }
 212
 213     public Collection<DataTreeCandidate> ipv4Input(final YangInstanceIdentifier target,
 214             final ModificationType type, final Ipv4Prefix... prefix) {
 215         final Collection<DataTreeCandidate> col = new HashSet<>();
 216         final DataTreeCandidate candidate = mock(DataTreeCandidate.class);
 217         final DataTreeCandidateNode rootNode = mock(DataTreeCandidateNode.class);
 218         doReturn(rootNode).when(candidate).getRootNode();
 219         doReturn(type).when(rootNode).getModificationType();
 220         doCallRealMethod().when(rootNode).toString();
 221         doReturn(target).when(candidate).getRootPath();
 222         doCallRealMethod().when(candidate).toString();
 223         final Collection<DataTreeCandidateNode> children = new HashSet<>();
 224         for (final Ipv4Prefix p : prefix) {
 225             final NodeIdentifierWithPredicates routekey =
 226                     new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, p);
 227             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b =
 228                     ImmutableNodes.mapEntryBuilder();
 229             b.withNodeIdentifier(routekey);
 230             b.addChild(Builders.leafBuilder()
 231                     .withNodeIdentifier(new NodeIdentifier(PREFIX_QNAME)).withValue(p).build());
 232
 233             final DataTreeCandidateNode child = mock(DataTreeCandidateNode.class);
 234             doReturn(createIdentifier(p)).when(child).getIdentifier();
 235             doReturn(java.util.Optional.of(b.build())).when(child).getDataAfter();
 236             doReturn(type).when(child).getModificationType();
 237             children.add(child);
 238         }
 239         doReturn(children).when(rootNode).getChildNodes();
 240         col.add(candidate);
 241         return col;
 242     }
 243
 244     public PathArgument createIdentifier(final Ipv4Prefix prefix) {
 245         final NodeIdentifierWithPredicates routekey =
 246                 new NodeIdentifierWithPredicates(Ipv4Route.QNAME, PREFIX_QNAME, prefix);
 247         return YangInstanceIdentifier.of(PREFIX_QNAME).node(routekey).getLastPathArgument();
 248     }
 249
 250     public RIBImpl getRib() {
 251         return this.rib;
 252     }
 253
 254     public DOMDataWriteTransaction getTransaction() {
 255         return this.domTransWrite;
 256     }
 257
 258     @Override
 259     @After
 260     public void tearDown() {
 261         this.a1.close();
 262     }
 263
 264     private class TestListenerRegistration implements ListenerRegistration<EventListener> {
 265         @Override
 266         public EventListener getInstance() {
 267             return null;
 268         }
 269
 270         @Override
 271         public void close() {
 272         }
 273     }
 274 }