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