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 com.google.common.collect.ImmutableSet;
  28 import io.netty.util.concurrent.EventExecutor;
  29 import java.util.Arrays;
  30 import java.util.HashMap;
  31 import java.util.Map;
  32 import java.util.Objects;
  33 import java.util.Set;
  34 import java.util.concurrent.ExecutorService;
  35 import java.util.concurrent.TimeUnit;
  36 import java.util.function.Function;
  37 import org.junit.Before;
  38 import org.junit.Test;
  39 import org.junit.runner.RunWith;
  40 import org.mockito.ArgumentCaptor;
  41 import org.mockito.Mock;
  42 import org.mockito.junit.MockitoJUnitRunner;
  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.api.RpcProviderService;
  53 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTest;
  54 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  55 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  56 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
  57 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  58 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
  59 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  60 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
  61 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  62 import org.opendaylight.netconf.client.NetconfClientDispatcher;
  63 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
  64 import org.opendaylight.netconf.sal.connect.impl.DefaultSchemaResourceManager;
  65 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  66 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNodeBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  76 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  77 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  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 ImmutableSet.of(BindingReflections.getModuleInfo(NetworkTopology.class),
 111                         BindingReflections.getModuleInfo(Topology.class));
 112             }
 113         };
 114
 115         dataBrokerTest.setup();
 116         dataBroker = spy(dataBrokerTest.getDataBroker());
 117
 118         final DOMRpcProviderService rpcProviderRegistry = mock(DOMRpcProviderService.class);
 119         final ScheduledThreadPool keepaliveExecutor = mock(ScheduledThreadPool.class);
 120         final DOMActionProviderService actionProviderRegistry = mock(DOMActionProviderService.class);
 121         final ThreadPool processingThreadPool = mock(ThreadPool.class);
 122         final ExecutorService processingService = mock(ExecutorService.class);
 123         doReturn(processingService).when(processingThreadPool).getExecutor();
 124         final ActorSystemProvider actorSystemProvider = mock(ActorSystemProvider.class);
 125         final EventExecutor eventExecutor = mock(EventExecutor.class);
 126         final NetconfClientDispatcher clientDispatcher = mock(NetconfClientDispatcher.class);
 127         final DOMMountPointService mountPointService = mock(DOMMountPointService.class);
 128         final AAAEncryptionService encryptionService = mock(AAAEncryptionService.class);
 129         final DeviceActionFactory deviceActionFactory = mock(DeviceActionFactory.class);
 130         final RpcProviderService rpcProviderService = mock(RpcProviderService.class);
 131
 132         final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(Uint16.ZERO).build();
 133         netconfTopologyManager = new NetconfTopologyManager(BASE_SCHEMAS, dataBroker, rpcProviderRegistry,
 134                 actionProviderRegistry, clusterSingletonServiceProvider, keepaliveExecutor, processingThreadPool,
 135                 actorSystemProvider, eventExecutor, clientDispatcher, TOPOLOGY_ID, config,
 136                 mountPointService, encryptionService, rpcProviderService, deviceActionFactory,
 137                 new DefaultSchemaResourceManager(new DefaultYangParserFactory())) {
 138             @Override
 139             protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
 140                 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
 141                 final DeviceActionFactory deviceActionFactory) {
 142                 assertEquals(ACTOR_RESPONSE_WAIT_TIME.toJava(), actorResponseWaitTime.duration().toSeconds());
 143                 return Objects.requireNonNull(mockContextMap.get(setup.getInstanceIdentifier()),
 144                         "No mock context for " + setup.getInstanceIdentifier()).apply(setup);
 145             }
 146         };
 147
 148         doNothing().when(mockListenerReg).close();
 149         doReturn(mockListenerReg).when(dataBroker).registerDataTreeChangeListener(any(), any());
 150     }
 151
 152     @Test
 153     public void testRegisterDataTreeChangeListener() throws Exception {
 154
 155         netconfTopologyManager.init();
 156
 157         await().atMost(5, TimeUnit.SECONDS).until(() -> {
 158             try (ReadTransaction readTx = dataBroker.newReadOnlyTransaction()) {
 159                 return readTx.exists(LogicalDatastoreType.OPERATIONAL,
 160                     NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
 161             }
 162         });
 163
 164         // verify registration is called with right parameters
 165
 166         verify(dataBroker).registerDataTreeChangeListener(
 167                 DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION, NetconfTopologyUtils
 168                         .createTopologyListPath(TOPOLOGY_ID).child(Node.class)), netconfTopologyManager);
 169
 170         netconfTopologyManager.close();
 171         verify(mockListenerReg).close();
 172
 173         netconfTopologyManager.close();
 174         verifyNoMoreInteractions(mockListenerReg);
 175     }
 176
 177     @SuppressWarnings("unchecked")
 178     @Test
 179     public void testOnDataTreeChanged() throws Exception {
 180
 181         // Notify of 2 created Node objects.
 182
 183         final NodeId nodeId1 = new NodeId("node-id-1");
 184         final InstanceIdentifier<Node> nodeInstanceId1 = NetconfTopologyUtils.createTopologyNodeListPath(
 185                 new NodeKey(nodeId1), TOPOLOGY_ID);
 186
 187         final NodeId nodeId2 = new NodeId("node-id-2");
 188         final InstanceIdentifier<Node> nodeInstanceId2 = NetconfTopologyUtils.createTopologyNodeListPath(
 189                 new NodeKey(nodeId2), TOPOLOGY_ID);
 190
 191         final NetconfNode netconfNode1 = new NetconfNodeBuilder()
 192                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 193                 .setPort(new PortNumber(Uint16.valueOf(1111)))
 194                 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
 195                 .build();
 196         final Node node1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(netconfNode1).build();
 197
 198         final DataObjectModification<Node> dataObjectModification1 = mock(DataObjectModification.class);
 199         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 200         doReturn(node1).when(dataObjectModification1).getDataAfter();
 201         doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId1)))
 202                 .when(dataObjectModification1).getIdentifier();
 203
 204         final NetconfNode netconfNode2 = new NetconfNodeBuilder()
 205                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 206                 .setPort(new PortNumber(Uint16.valueOf(2222)))
 207                 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
 208                 .build();
 209         final Node node2 = new NodeBuilder().setNodeId(nodeId2).addAugmentation(netconfNode2).build();
 210
 211         final DataObjectModification<Node> dataObjectModification2 = mock(DataObjectModification.class);
 212         doReturn(WRITE).when(dataObjectModification2).getModificationType();
 213         doReturn(node2).when(dataObjectModification2).getDataAfter();
 214         doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId2)))
 215                 .when(dataObjectModification2).getIdentifier();
 216
 217         final NetconfTopologyContext mockContext1 = mock(NetconfTopologyContext.class);
 218         mockContextMap.put(nodeInstanceId1, setup -> {
 219             assertEquals(node1, setup.getNode());
 220             assertEquals(TOPOLOGY_ID, setup.getTopologyId());
 221             return mockContext1;
 222         });
 223
 224         final NetconfTopologyContext mockContext2 = mock(NetconfTopologyContext.class);
 225         mockContextMap.put(nodeInstanceId2, setup -> {
 226             assertEquals(node2, setup.getNode());
 227             assertEquals(TOPOLOGY_ID, setup.getTopologyId());
 228             return mockContext2;
 229         });
 230
 231         ClusterSingletonServiceRegistration mockClusterRegistration1 = mock(ClusterSingletonServiceRegistration.class);
 232         ClusterSingletonServiceRegistration mockClusterRegistration2 = mock(ClusterSingletonServiceRegistration.class);
 233
 234         doReturn(mockClusterRegistration1).when(clusterSingletonServiceProvider)
 235                 .registerClusterSingletonService(mockContext1);
 236         doReturn(mockClusterRegistration2).when(clusterSingletonServiceProvider)
 237                 .registerClusterSingletonService(mockContext2);
 238
 239         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 240                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 241                         nodeInstanceId1), dataObjectModification1),
 242                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 243                         nodeInstanceId2), dataObjectModification2)));
 244
 245         verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext1);
 246         verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext2);
 247
 248         // Notify of Node 1 replaced and Node 2 subtree modified.
 249
 250         mockContextMap.clear();
 251
 252         final NetconfNode updatedNetconfNode1 = new NetconfNodeBuilder(netconfNode1)
 253                 .setPort(new PortNumber(Uint16.valueOf(33333))).build();
 254         final Node updatedNode1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(updatedNetconfNode1).build();
 255
 256         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 257         doReturn(updatedNode1).when(dataObjectModification1).getDataAfter();
 258
 259         doReturn(SUBTREE_MODIFIED).when(dataObjectModification2).getModificationType();
 260         doReturn(node2).when(dataObjectModification2).getDataAfter();
 261
 262         doNothing().when(mockContext1).refresh(any());
 263         doNothing().when(mockContext2).refresh(any());
 264
 265         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 266                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 267                         nodeInstanceId1), dataObjectModification1),
 268                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 269                         nodeInstanceId2), dataObjectModification2)));
 270
 271         ArgumentCaptor<NetconfTopologySetup> mockContext1Setup = ArgumentCaptor.forClass(NetconfTopologySetup.class);
 272         verify(mockContext1).refresh(mockContext1Setup.capture());
 273         assertEquals(updatedNode1, mockContext1Setup.getValue().getNode());
 274
 275         verify(mockContext2).refresh(any());
 276
 277         verifyNoMoreInteractions(clusterSingletonServiceProvider);
 278
 279         // Notify of Node 1 deleted.
 280
 281         doReturn(DELETE).when(dataObjectModification1).getModificationType();
 282
 283         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 284                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 285                         nodeInstanceId1), dataObjectModification1)));
 286
 287         verify(mockClusterRegistration1).close();
 288         verify(mockContext1).close();
 289         verifyNoMoreInteractions(clusterSingletonServiceProvider, mockClusterRegistration2, mockContext2);
 290
 291         // Notify of Node 1 created again.
 292
 293         reset(clusterSingletonServiceProvider);
 294
 295         final NetconfTopologyContext newMockContext1 = mock(NetconfTopologyContext.class);
 296         final ClusterSingletonServiceRegistration newMockClusterRegistration1 =
 297                 mock(ClusterSingletonServiceRegistration.class);
 298
 299         doThrow(new RuntimeException("mock error")).doReturn(newMockClusterRegistration1)
 300                 .when(clusterSingletonServiceProvider).registerClusterSingletonService(newMockContext1);
 301
 302         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 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 Node node = new NodeBuilder()
 342                 .setNodeId(nodeId)
 343                 .addAugmentation(new NetconfNodeBuilder()
 344                     .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 345                     .setPort(new PortNumber(Uint16.valueOf(10)))
 346                     .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
 347                     .build())
 348                 .build();
 349
 350         final DataObjectModification<Node> dataObjectModification = mock(DataObjectModification.class);
 351         doReturn(WRITE).when(dataObjectModification).getModificationType();
 352         doReturn(node).when(dataObjectModification).getDataAfter();
 353         doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId)))
 354                 .when(dataObjectModification).getIdentifier();
 355
 356         final NetconfTopologyContext mockContext = mock(NetconfTopologyContext.class);
 357         mockContextMap.put(nodeInstanceId, setup -> mockContext);
 358
 359         doThrow(new RuntimeException("mock error")).when(clusterSingletonServiceProvider)
 360                 .registerClusterSingletonService(mockContext);
 361
 362         netconfTopologyManager.init();
 363
 364         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 365                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 366                         nodeInstanceId), dataObjectModification)));
 367
 368         verify(clusterSingletonServiceProvider, times(3)).registerClusterSingletonService(mockContext);
 369         verify(mockContext).close();
 370         verifyNoMoreInteractions(mockListenerReg);
 371
 372         netconfTopologyManager.close();
 373         verifyNoMoreInteractions(mockContext);
 374     }
 375
 376     static class CustomTreeModification  implements DataTreeModification<Node> {
 377
 378         private final DataTreeIdentifier<Node> rootPath;
 379         private final DataObjectModification<Node> rootNode;
 380
 381         CustomTreeModification(final DataTreeIdentifier<Node> rootPath, final DataObjectModification<Node> rootNode) {
 382             this.rootPath = rootPath;
 383             this.rootNode = rootNode;
 384         }
 385
 386         @Override
 387         public DataTreeIdentifier<Node> getRootPath() {
 388             return rootPath;
 389         }
 390
 391         @Override
 392         public DataObjectModification<Node> getRootNode() {
 393             return rootNode;
 394         }
 395     }
 396 }