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