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