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