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