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