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