netconf/netconf-topology-singleton/src/test/java/org/opendaylight/netconf/topology/singleton/impl/NetconfTopologyManagerTest.java

   1 /*
   2  * Copyright (c) 2016 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.netconf.topology.singleton.impl;
   9
  10 import static org.awaitility.Awaitility.await;
  11 import static org.junit.Assert.assertEquals;
  12 import static org.mockito.ArgumentMatchers.any;
  13 import static org.mockito.Mockito.doNothing;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.doThrow;
  16 import static org.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.reset;
  18 import static org.mockito.Mockito.spy;
  19 import static org.mockito.Mockito.times;
  20 import static org.mockito.Mockito.verify;
  21 import static org.mockito.Mockito.verifyNoMoreInteractions;
  22 import static org.mockito.MockitoAnnotations.initMocks;
  23 import static org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType.DELETE;
  24 import static org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType.SUBTREE_MODIFIED;
  25 import static org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType.WRITE;
  26
  27 import akka.util.Timeout;
  28 import com.google.common.collect.ImmutableSet;
  29 import io.netty.util.concurrent.EventExecutor;
  30 import java.util.Arrays;
  31 import java.util.HashMap;
  32 import java.util.Map;
  33 import java.util.Objects;
  34 import java.util.Optional;
  35 import java.util.Set;
  36 import java.util.concurrent.ExecutorService;
  37 import java.util.concurrent.TimeUnit;
  38 import java.util.function.Function;
  39 import org.junit.Before;
  40 import org.junit.Test;
  41 import org.mockito.ArgumentCaptor;
  42 import org.mockito.Mock;
  43 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  44 import org.opendaylight.controller.cluster.ActorSystemProvider;
  45 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
  46 import org.opendaylight.controller.config.threadpool.ThreadPool;
  47 import org.opendaylight.mdsal.binding.api.DataBroker;
  48 import org.opendaylight.mdsal.binding.api.DataObjectModification;
  49 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  50 import org.opendaylight.mdsal.binding.api.DataTreeModification;
  51 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  52 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTest;
  53 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  54 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  55 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  56 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
  57 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  58 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
  59 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  60 import org.opendaylight.netconf.client.NetconfClientDispatcher;
  61 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  62 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  72 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  73 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  74 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  75 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  77 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  78 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  79 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  80
  81 public class NetconfTopologyManagerTest {
  82     private static final int ACTOR_RESPONSE_WAIT_TIME = 10;
  83     private static final String TOPOLOGY_ID = "topologyID";
  84
  85     private NetconfTopologyManager netconfTopologyManager;
  86
  87     @Mock
  88     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
  89
  90     @Mock
  91     private ListenerRegistration<?> mockListenerReg;
  92
  93     private DataBroker dataBroker;
  94
  95     private final Map<InstanceIdentifier<Node>, Function<NetconfTopologySetup, NetconfTopologyContext>>
  96             mockContextMap = new HashMap<>();
  97
  98     @Before
  99     public void setUp() throws Exception {
 100         initMocks(this);
 101
 102         AbstractDataBrokerTest dataBrokerTest = new AbstractDataBrokerTest() {
 103             @Override
 104             protected Set<YangModuleInfo> getModuleInfos() throws Exception {
 105                 return ImmutableSet.of(BindingReflections.getModuleInfo(NetworkTopology.class),
 106                         BindingReflections.getModuleInfo(Topology.class));
 107             }
 108         };
 109
 110         dataBrokerTest.setup();
 111         dataBroker = spy(dataBrokerTest.getDataBroker());
 112
 113         final DOMRpcProviderService rpcProviderRegistry = mock(DOMRpcProviderService.class);
 114         final ScheduledThreadPool keepaliveExecutor = mock(ScheduledThreadPool.class);
 115         final ThreadPool processingThreadPool = mock(ThreadPool.class);
 116         final ExecutorService processingService = mock(ExecutorService.class);
 117         doReturn(processingService).when(processingThreadPool).getExecutor();
 118         final ActorSystemProvider actorSystemProvider = mock(ActorSystemProvider.class);
 119         final EventExecutor eventExecutor = mock(EventExecutor.class);
 120         final NetconfClientDispatcher clientDispatcher = mock(NetconfClientDispatcher.class);
 121         final DOMMountPointService mountPointService = mock(DOMMountPointService.class);
 122         final AAAEncryptionService encryptionService = mock(AAAEncryptionService.class);
 123
 124         final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(0).build();
 125         netconfTopologyManager = new NetconfTopologyManager(dataBroker, rpcProviderRegistry,
 126                 clusterSingletonServiceProvider, keepaliveExecutor, processingThreadPool,
 127                 actorSystemProvider, eventExecutor, clientDispatcher, TOPOLOGY_ID, config,
 128                 mountPointService, encryptionService) {
 129             @Override
 130             protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
 131                     final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime) {
 132                 assertEquals(ACTOR_RESPONSE_WAIT_TIME, actorResponseWaitTime.duration().toSeconds());
 133                 return Objects.requireNonNull(mockContextMap.get(setup.getInstanceIdentifier()),
 134                         "No mock context for " + setup.getInstanceIdentifier()).apply(setup);
 135             }
 136         };
 137
 138         doNothing().when(mockListenerReg).close();
 139         doReturn(mockListenerReg).when(dataBroker).registerDataTreeChangeListener(any(), any());
 140     }
 141
 142     @Test
 143     public void testRegisterDataTreeChangeListener() throws Exception {
 144
 145         netconfTopologyManager.init();
 146
 147         await().atMost(5, TimeUnit.SECONDS).until(() -> {
 148             ReadTransaction readTx = dataBroker.newReadOnlyTransaction();
 149             Optional<Topology> config = readTx.read(LogicalDatastoreType.CONFIGURATION,
 150                     NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
 151             Optional<Topology> oper = readTx.read(LogicalDatastoreType.OPERATIONAL,
 152                     NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
 153             return config.isPresent() && oper.isPresent();
 154         });
 155
 156         // verify registration is called with right parameters
 157
 158         verify(dataBroker).registerDataTreeChangeListener(
 159                 DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION, NetconfTopologyUtils
 160                         .createTopologyListPath(TOPOLOGY_ID).child(Node.class)), netconfTopologyManager);
 161
 162         netconfTopologyManager.close();
 163         verify(mockListenerReg).close();
 164
 165         netconfTopologyManager.close();
 166         verifyNoMoreInteractions(mockListenerReg);
 167     }
 168
 169     @SuppressWarnings("unchecked")
 170     @Test
 171     public void testOnDataTreeChanged() throws Exception {
 172
 173         // Notify of 2 created Node objects.
 174
 175         final NodeId nodeId1 = new NodeId("node-id-1");
 176         final InstanceIdentifier<Node> nodeInstanceId1 = NetconfTopologyUtils.createTopologyNodeListPath(
 177                 new NodeKey(nodeId1), TOPOLOGY_ID);
 178
 179         final NodeId nodeId2 = new NodeId("node-id-2");
 180         final InstanceIdentifier<Node> nodeInstanceId2 = NetconfTopologyUtils.createTopologyNodeListPath(
 181                 new NodeKey(nodeId2), TOPOLOGY_ID);
 182
 183         final NetconfNode netconfNode1 = new NetconfNodeBuilder()
 184                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 185                 .setPort(new PortNumber(1111))
 186                 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
 187                 .build();
 188         final Node node1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(NetconfNode.class,
 189                 netconfNode1).build();
 190
 191         final DataObjectModification<Node> dataObjectModification1 = mock(DataObjectModification.class);
 192         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 193         doReturn(node1).when(dataObjectModification1).getDataAfter();
 194         doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId1)))
 195                 .when(dataObjectModification1).getIdentifier();
 196
 197         final NetconfNode netconfNode2 = new NetconfNodeBuilder()
 198                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 199                 .setPort(new PortNumber(2222))
 200                 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
 201                 .build();
 202         final Node node2 = new NodeBuilder().setNodeId(nodeId2).addAugmentation(NetconfNode.class,
 203                 netconfNode2).build();
 204
 205         final DataObjectModification<Node> dataObjectModification2 = mock(DataObjectModification.class);
 206         doReturn(WRITE).when(dataObjectModification2).getModificationType();
 207         doReturn(node2).when(dataObjectModification2).getDataAfter();
 208         doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId2)))
 209                 .when(dataObjectModification2).getIdentifier();
 210
 211         final NetconfTopologyContext mockContext1 = mock(NetconfTopologyContext.class);
 212         mockContextMap.put(nodeInstanceId1, setup -> {
 213             assertEquals(node1, setup.getNode());
 214             assertEquals(TOPOLOGY_ID, setup.getTopologyId());
 215             return mockContext1;
 216         });
 217
 218         final NetconfTopologyContext mockContext2 = mock(NetconfTopologyContext.class);
 219         mockContextMap.put(nodeInstanceId2, setup -> {
 220             assertEquals(node2, setup.getNode());
 221             assertEquals(TOPOLOGY_ID, setup.getTopologyId());
 222             return mockContext2;
 223         });
 224
 225         ClusterSingletonServiceRegistration mockClusterRegistration1 = mock(ClusterSingletonServiceRegistration.class);
 226         ClusterSingletonServiceRegistration mockClusterRegistration2 = mock(ClusterSingletonServiceRegistration.class);
 227
 228         doReturn(mockClusterRegistration1).when(clusterSingletonServiceProvider)
 229                 .registerClusterSingletonService(mockContext1);
 230         doReturn(mockClusterRegistration2).when(clusterSingletonServiceProvider)
 231                 .registerClusterSingletonService(mockContext2);
 232
 233         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 234                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 235                         nodeInstanceId1), dataObjectModification1),
 236                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 237                         nodeInstanceId2), dataObjectModification2)));
 238
 239         verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext1);
 240         verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext2);
 241
 242         // Notify of Node 1 replaced and Node 2 subtree modified.
 243
 244         mockContextMap.clear();
 245
 246         final NetconfNode updatedNetconfNode1 = new NetconfNodeBuilder(netconfNode1)
 247                 .setPort(new PortNumber(33333)).build();
 248         final Node updatedNode1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(NetconfNode.class,
 249                 updatedNetconfNode1).build();
 250
 251         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 252         doReturn(node1).when(dataObjectModification1).getDataBefore();
 253         doReturn(updatedNode1).when(dataObjectModification1).getDataAfter();
 254
 255         doReturn(SUBTREE_MODIFIED).when(dataObjectModification2).getModificationType();
 256         doReturn(node2).when(dataObjectModification2).getDataBefore();
 257         doReturn(node2).when(dataObjectModification2).getDataAfter();
 258
 259         doNothing().when(mockContext1).refresh(any());
 260         doNothing().when(mockContext2).refresh(any());
 261
 262         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 263                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 264                         nodeInstanceId1), dataObjectModification1),
 265                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 266                         nodeInstanceId2), dataObjectModification2)));
 267
 268         ArgumentCaptor<NetconfTopologySetup> mockContext1Setup = ArgumentCaptor.forClass(NetconfTopologySetup.class);
 269         verify(mockContext1).refresh(mockContext1Setup.capture());
 270         assertEquals(updatedNode1, mockContext1Setup.getValue().getNode());
 271
 272         verify(mockContext2).refresh(any());
 273
 274         verifyNoMoreInteractions(clusterSingletonServiceProvider);
 275
 276         // Notify of Node 1 deleted.
 277
 278         doReturn(DELETE).when(dataObjectModification1).getModificationType();
 279         doReturn(updatedNode1).when(dataObjectModification1).getDataBefore();
 280         doReturn(null).when(dataObjectModification1).getDataAfter();
 281
 282         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 283                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 284                         nodeInstanceId1), dataObjectModification1)));
 285
 286         verify(mockClusterRegistration1).close();
 287         verify(mockContext1).close();
 288         verifyNoMoreInteractions(clusterSingletonServiceProvider, mockClusterRegistration2, mockContext2);
 289
 290         // Notify of Node 1 created again.
 291
 292         reset(clusterSingletonServiceProvider);
 293
 294         final NetconfTopologyContext newMockContext1 = mock(NetconfTopologyContext.class);
 295         final ClusterSingletonServiceRegistration newMockClusterRegistration1 =
 296                 mock(ClusterSingletonServiceRegistration.class);
 297
 298         doThrow(new RuntimeException("mock error")).doReturn(newMockClusterRegistration1)
 299                 .when(clusterSingletonServiceProvider).registerClusterSingletonService(newMockContext1);
 300
 301         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 302         doReturn(null).when(dataObjectModification1).getDataBefore();
 303         doReturn(node1).when(dataObjectModification1).getDataAfter();
 304
 305         mockContextMap.put(nodeInstanceId1, setup -> {
 306             assertEquals(node1, setup.getNode());
 307             assertEquals(TOPOLOGY_ID, setup.getTopologyId());
 308             return newMockContext1;
 309         });
 310
 311         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 312                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 313                         nodeInstanceId1), dataObjectModification1)));
 314
 315         verify(clusterSingletonServiceProvider, times(2)).registerClusterSingletonService(newMockContext1);
 316
 317         verifyNoMoreInteractions(mockClusterRegistration1, mockContext1, mockClusterRegistration2, mockContext2,
 318                 newMockContext1, newMockClusterRegistration1, clusterSingletonServiceProvider);
 319
 320         // Test close.
 321
 322         netconfTopologyManager.close();
 323
 324         verify(newMockClusterRegistration1).close();
 325         verify(newMockContext1).close();
 326         verify(mockClusterRegistration2).close();
 327         verify(mockContext2).close();
 328
 329         netconfTopologyManager.close();
 330
 331         verifyNoMoreInteractions(mockClusterRegistration1, mockContext1, mockClusterRegistration2, mockContext2,
 332                 newMockContext1, newMockClusterRegistration1, clusterSingletonServiceProvider);
 333     }
 334
 335     @Test
 336     public void testClusterSingletonServiceRegistrationFailure() throws Exception {
 337         final NodeId nodeId = new NodeId("node-id");
 338         final InstanceIdentifier<Node> nodeInstanceId = NetconfTopologyUtils.createTopologyNodeListPath(
 339                 new NodeKey(nodeId), TOPOLOGY_ID);
 340
 341         final NetconfNode netconfNode = new NetconfNodeBuilder()
 342                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 343                 .setPort(new PortNumber(10))
 344                 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME).build();
 345         final Node node = new NodeBuilder().setNodeId(nodeId).addAugmentation(NetconfNode.class,
 346                 netconfNode).build();
 347
 348         final DataObjectModification<Node> dataObjectModification = mock(DataObjectModification.class);
 349         doReturn(WRITE).when(dataObjectModification).getModificationType();
 350         doReturn(node).when(dataObjectModification).getDataAfter();
 351         doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId)))
 352                 .when(dataObjectModification).getIdentifier();
 353
 354         final NetconfTopologyContext mockContext = mock(NetconfTopologyContext.class);
 355         mockContextMap.put(nodeInstanceId, setup -> mockContext);
 356
 357         doThrow(new RuntimeException("mock error")).when(clusterSingletonServiceProvider)
 358                 .registerClusterSingletonService(mockContext);
 359
 360         netconfTopologyManager.init();
 361
 362         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 363                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 364                         nodeInstanceId), dataObjectModification)));
 365
 366         verify(clusterSingletonServiceProvider, times(3)).registerClusterSingletonService(mockContext);
 367         verify(mockContext).close();
 368         verifyNoMoreInteractions(mockListenerReg);
 369
 370         netconfTopologyManager.close();
 371         verifyNoMoreInteractions(mockContext);
 372     }
 373
 374     static class CustomTreeModification  implements DataTreeModification<Node> {
 375
 376         private final DataTreeIdentifier<Node> rootPath;
 377         private final DataObjectModification<Node> rootNode;
 378
 379         CustomTreeModification(final DataTreeIdentifier<Node> rootPath, final DataObjectModification<Node> rootNode) {
 380             this.rootPath = rootPath;
 381             this.rootNode = rootNode;
 382         }
 383
 384         @Override
 385         public DataTreeIdentifier<Node> getRootPath() {
 386             return rootPath;
 387         }
 388
 389         @Override
 390         public DataObjectModification<Node> getRootNode() {
 391             return rootNode;
 392         }
 393     }
 394 }