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