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.adapter.CurrentAdapterSerializer;
  35 import org.opendaylight.mdsal.common.api.CommitInfo;
  36 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  37 import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener;
  38 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  39 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
  40 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  41 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  42 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  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 RIBActivator a1;
  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 = new RIBActivator();
 136         this.a1.startRIBExtensionProvider(context, serializer);
 137
 138         mockedMethods();
 139         doReturn(mock(ClusterSingletonServiceRegistration.class)).when(this.clusterSingletonServiceProvider)
 140                 .registerClusterSingletonService(any(ClusterSingletonService.class));
 141         this.rib = new RIBImpl(this.tableRegistry, new RibId("test"), new AsNumber(Uint32.valueOf(5)), RIB_ID, context,
 142                 this.dispatcher, new ConstantCodecsRegistry(serializer), this.dom, getDataBroker(), this.policies,
 143                 localTables, Collections.singletonMap(KEY,
 144                 BasePathSelectionModeFactory.createBestPathSelectionStrategy()));
 145     }
 146
 147     @SuppressWarnings("unchecked")
 148     private void mockedMethods() throws Exception {
 149         MockitoAnnotations.initMocks(this);
 150         final ReadTransaction readTx = mock(ReadTransaction.class);
 151         doReturn(new TestListenerRegistration()).when(this.service)
 152                 .registerDataTreeChangeListener(any(DOMDataTreeIdentifier.class),
 153                         any(ClusteredDOMDataTreeChangeListener.class));
 154         doNothing().when(readTx).close();
 155         doNothing().when(this.domTransWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 156                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 157         doNothing().when(this.domTransWrite).delete(eq(LogicalDatastoreType.OPERATIONAL),
 158                 any(YangInstanceIdentifier.class));
 159         doNothing().when(this.domTransWrite).merge(eq(LogicalDatastoreType.OPERATIONAL),
 160                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 161         doReturn(FluentFutures.immediateFluentFuture(Optional.empty())).when(readTx)
 162             .read(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
 163         doNothing().when(this.domChain).close();
 164         doReturn(this.domTransWrite).when(this.domChain).newWriteOnlyTransaction();
 165         doNothing().when(getTransaction()).put(eq(LogicalDatastoreType.OPERATIONAL),
 166                 eq(YangInstanceIdentifier.of(BgpRib.QNAME)), any(NormalizedNode.class));
 167         doReturn(ImmutableClassToInstanceMap.of(DOMDataTreeChangeService.class, this.service)).when(this.dom)
 168             .getExtensions();
 169         doReturn(this.domChain).when(this.dom).createMergingTransactionChain(any(AbstractPeer.class));
 170         doReturn(this.transWrite).when(this.chain).newWriteOnlyTransaction();
 171         doReturn(Optional.empty()).when(this.future).get();
 172         doReturn(this.future).when(this.domTransWrite).commit();
 173         doNothing().when(this.future).addListener(any(Runnable.class), any(Executor.class));
 174         doNothing().when(this.transWrite).mergeParentStructurePut(eq(LogicalDatastoreType.OPERATIONAL),
 175                 any(InstanceIdentifier.class), any(DataObject.class));
 176         doNothing().when(this.transWrite).put(eq(LogicalDatastoreType.OPERATIONAL),
 177                 any(InstanceIdentifier.class), any(DataObject.class));
 178         doReturn(this.future).when(this.transWrite).commit();
 179     }
 180
 181     public Collection<DataTreeCandidate> ipv4Input(final YangInstanceIdentifier target,
 182             final ModificationType type, final Ipv4Prefix... prefix) {
 183         final Collection<DataTreeCandidate> col = new HashSet<>();
 184         final DataTreeCandidate candidate = mock(DataTreeCandidate.class);
 185         final DataTreeCandidateNode rootNode = mock(DataTreeCandidateNode.class);
 186         doReturn(rootNode).when(candidate).getRootNode();
 187         doReturn(type).when(rootNode).getModificationType();
 188         doCallRealMethod().when(rootNode).toString();
 189         doReturn(target).when(candidate).getRootPath();
 190         doCallRealMethod().when(candidate).toString();
 191         final Collection<DataTreeCandidateNode> children = new HashSet<>();
 192         for (final Ipv4Prefix p : prefix) {
 193             final NodeIdentifierWithPredicates routekey =
 194                     NodeIdentifierWithPredicates.of(Ipv4Route.QNAME, PREFIX_QNAME, p);
 195             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> b =
 196                     ImmutableNodes.mapEntryBuilder();
 197             b.withNodeIdentifier(routekey);
 198             b.addChild(Builders.leafBuilder()
 199                     .withNodeIdentifier(new NodeIdentifier(PREFIX_QNAME)).withValue(p).build());
 200
 201             final DataTreeCandidateNode child = mock(DataTreeCandidateNode.class);
 202             doReturn(createIdentifier(p)).when(child).getIdentifier();
 203             doReturn(java.util.Optional.of(b.build())).when(child).getDataAfter();
 204             doReturn(type).when(child).getModificationType();
 205             children.add(child);
 206         }
 207         doReturn(children).when(rootNode).getChildNodes();
 208         col.add(candidate);
 209         return col;
 210     }
 211
 212     public PathArgument createIdentifier(final Ipv4Prefix prefix) {
 213         final NodeIdentifierWithPredicates routekey =
 214                 NodeIdentifierWithPredicates.of(Ipv4Route.QNAME, PREFIX_QNAME, prefix);
 215         return YangInstanceIdentifier.of(PREFIX_QNAME).node(routekey).getLastPathArgument();
 216     }
 217
 218     public RIBImpl getRib() {
 219         return this.rib;
 220     }
 221
 222     public DOMDataTreeWriteTransaction getTransaction() {
 223         return this.domTransWrite;
 224     }
 225
 226     @Override
 227     @After
 228     public void tearDown() {
 229         this.a1.close();
 230     }
 231
 232     private class TestListenerRegistration implements ListenerRegistration<EventListener> {
 233         @Override
 234         public EventListener getInstance() {
 235             return null;
 236         }
 237
 238         @Override
 239         public void close() {
 240         }
 241     }
 242 }