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