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