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.After;
  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.netconf.topology.spi.NetconfTopologySchemaAssembler;
  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.rev231121.NetconfNode;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev231121.NetconfNodeBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  72 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  73 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  74 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  76 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  77 import org.opendaylight.yangtools.concepts.Registration;
  78 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  79 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  80 import org.opendaylight.yangtools.yang.common.Uint16;
  81 import org.opendaylight.yangtools.yang.parser.impl.DefaultYangParserFactory;
  82
  83 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  84 public class NetconfTopologyManagerTest extends AbstractBaseSchemasTest {
  85     private static final Uint16 ACTOR_RESPONSE_WAIT_TIME = Uint16.TEN;
  86     private static final String TOPOLOGY_ID = "topologyID";
  87
  88     private NetconfTopologyManager netconfTopologyManager;
  89
  90     @Mock
  91     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
  92     @Mock
  93     private ListenerRegistration<?> mockListenerReg;
  94     @Mock
  95     private Registration mockRpcReg;
  96     @Mock
  97     private Timer timer;
  98     @Mock
  99     private ExecutorService processingService;
 100     @Mock
 101     private ActorSystem actorSystem;
 102     @Mock
 103     private NetconfClientFactory clientFactory;
 104     @Mock
 105     private DOMMountPointService mountPointService;
 106     @Mock
 107     private AAAEncryptionService encryptionService;
 108     @Mock
 109     private DeviceActionFactory actionFactory;
 110     @Mock
 111     private RpcProviderService rpcProviderService;
 112     @Mock
 113     private NetconfClientConfigurationBuilderFactory builderFactory;
 114
 115     private NetconfTopologySchemaAssembler schemaAssembler;
 116     private DataBroker dataBroker;
 117
 118     private final Map<InstanceIdentifier<Node>, Function<NetconfTopologySetup, NetconfTopologyContext>>
 119             mockContextMap = new HashMap<>();
 120
 121     @Before
 122     public void setUp() throws Exception {
 123         schemaAssembler = new NetconfTopologySchemaAssembler(1, 1, 0, TimeUnit.SECONDS);
 124
 125         AbstractDataBrokerTest dataBrokerTest = new AbstractDataBrokerTest() {
 126             @Override
 127             protected Set<YangModuleInfo> getModuleInfos() throws Exception {
 128                 return Set.of(BindingRuntimeHelpers.getYangModuleInfo(NetworkTopology.class));
 129             }
 130         };
 131
 132         dataBrokerTest.setup();
 133         dataBroker = spy(dataBrokerTest.getDataBroker());
 134
 135         doNothing().when(mockListenerReg).close();
 136         doReturn(mockListenerReg).when(dataBroker).registerDataTreeChangeListener(any(), any());
 137         doReturn(mockRpcReg).when(rpcProviderService).registerRpcImplementations(any());
 138
 139         netconfTopologyManager = new NetconfTopologyManager(BASE_SCHEMAS, dataBroker, clusterSingletonServiceProvider,
 140                 timer, schemaAssembler, actorSystem, clientFactory, mountPointService, encryptionService,
 141                 rpcProviderService, actionFactory, new DefaultSchemaResourceManager(new DefaultYangParserFactory()),
 142                 builderFactory, TOPOLOGY_ID, Uint16.ZERO) {
 143             @Override
 144             protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
 145                 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
 146                 final DeviceActionFactory deviceActionFactory) {
 147                 assertEquals(ACTOR_RESPONSE_WAIT_TIME.toJava(), actorResponseWaitTime.duration().toSeconds());
 148                 return Objects.requireNonNull(mockContextMap.get(setup.getInstanceIdentifier()),
 149                         "No mock context for " + setup.getInstanceIdentifier()).apply(setup);
 150             }
 151         };
 152     }
 153
 154     @After
 155     public void after() {
 156         schemaAssembler.close();
 157     }
 158
 159     @Test
 160     public void testRegisterDataTreeChangeListener() throws Exception {
 161         await().atMost(5, TimeUnit.SECONDS).until(() -> {
 162             try (ReadTransaction readTx = dataBroker.newReadOnlyTransaction()) {
 163                 return readTx.exists(LogicalDatastoreType.OPERATIONAL,
 164                     NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
 165             }
 166         });
 167
 168         // verify registration is called with right parameters
 169
 170         verify(dataBroker).registerDataTreeChangeListener(
 171                 DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION, NetconfTopologyUtils
 172                         .createTopologyListPath(TOPOLOGY_ID).child(Node.class)), netconfTopologyManager);
 173
 174         netconfTopologyManager.close();
 175         verify(mockListenerReg).close();
 176
 177         netconfTopologyManager.close();
 178         verifyNoMoreInteractions(mockListenerReg);
 179     }
 180
 181     @SuppressWarnings("unchecked")
 182     @Test
 183     public void testOnDataTreeChanged() {
 184         // Notify of 2 created Node objects.
 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(List.of(
 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         mockContextMap.clear();
 252
 253         final NetconfNode updatedNetconfNode1 = new NetconfNodeBuilder(netconfNode1)
 254                 .setPort(new PortNumber(Uint16.valueOf(33333))).build();
 255         final Node updatedNode1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(updatedNetconfNode1).build();
 256
 257         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 258         doReturn(updatedNode1).when(dataObjectModification1).getDataAfter();
 259
 260         doReturn(SUBTREE_MODIFIED).when(dataObjectModification2).getModificationType();
 261         doReturn(node2).when(dataObjectModification2).getDataAfter();
 262
 263         doNothing().when(mockContext1).refresh(any());
 264         doNothing().when(mockContext2).refresh(any());
 265
 266         netconfTopologyManager.onDataTreeChanged(List.of(
 267                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 268                         nodeInstanceId1), dataObjectModification1),
 269                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 270                         nodeInstanceId2), dataObjectModification2)));
 271
 272         ArgumentCaptor<NetconfTopologySetup> mockContext1Setup = ArgumentCaptor.forClass(NetconfTopologySetup.class);
 273         verify(mockContext1).refresh(mockContext1Setup.capture());
 274         assertEquals(updatedNode1, mockContext1Setup.getValue().getNode());
 275
 276         verify(mockContext2).refresh(any());
 277
 278         verifyNoMoreInteractions(clusterSingletonServiceProvider);
 279
 280         // Notify of Node 1 deleted.
 281         doReturn(DELETE).when(dataObjectModification1).getModificationType();
 282
 283         netconfTopologyManager.onDataTreeChanged(List.of(
 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         reset(clusterSingletonServiceProvider);
 293
 294         final NetconfTopologyContext newMockContext1 = mock(NetconfTopologyContext.class);
 295         final ClusterSingletonServiceRegistration newMockClusterRegistration1 =
 296                 mock(ClusterSingletonServiceRegistration.class);
 297
 298         doThrow(new RuntimeException("mock error")).doReturn(newMockClusterRegistration1)
 299                 .when(clusterSingletonServiceProvider).registerClusterSingletonService(newMockContext1);
 300
 301         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 302         doReturn(node1).when(dataObjectModification1).getDataAfter();
 303
 304         mockContextMap.put(nodeInstanceId1, setup -> {
 305             assertEquals(node1, setup.getNode());
 306             assertEquals(TOPOLOGY_ID, setup.getTopologyId());
 307             return newMockContext1;
 308         });
 309
 310         netconfTopologyManager.onDataTreeChanged(List.of(
 311                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 312                         nodeInstanceId1), dataObjectModification1)));
 313
 314         verify(clusterSingletonServiceProvider, times(2)).registerClusterSingletonService(newMockContext1);
 315         verifyNoMoreInteractions(mockClusterRegistration1, mockContext1, mockClusterRegistration2, mockContext2,
 316                 newMockContext1, newMockClusterRegistration1, clusterSingletonServiceProvider);
 317
 318         // Test close.
 319         netconfTopologyManager.close();
 320
 321         verify(newMockClusterRegistration1).close();
 322         verify(newMockContext1).close();
 323         verify(mockClusterRegistration2).close();
 324         verify(mockContext2).close();
 325
 326         netconfTopologyManager.close();
 327
 328         verifyNoMoreInteractions(mockClusterRegistration1, mockContext1, mockClusterRegistration2, mockContext2,
 329                 newMockContext1, newMockClusterRegistration1, clusterSingletonServiceProvider);
 330     }
 331
 332     @Test
 333     public void testClusterSingletonServiceRegistrationFailure() throws Exception {
 334         final NodeId nodeId = new NodeId("node-id");
 335         final InstanceIdentifier<Node> nodeInstanceId = NetconfTopologyUtils.createTopologyNodeListPath(
 336                 new NodeKey(nodeId), TOPOLOGY_ID);
 337
 338         final Node node = new NodeBuilder()
 339                 .setNodeId(nodeId)
 340                 .addAugmentation(new NetconfNodeBuilder()
 341                     .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 342                     .setPort(new PortNumber(Uint16.valueOf(10)))
 343                     .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
 344                     .build())
 345                 .build();
 346
 347         final DataObjectModification<Node> dataObjectModification = mock(DataObjectModification.class);
 348         doReturn(WRITE).when(dataObjectModification).getModificationType();
 349         doReturn(node).when(dataObjectModification).getDataAfter();
 350         doReturn(InstanceIdentifier.IdentifiableItem.of(Node.class, new NodeKey(nodeId)))
 351                 .when(dataObjectModification).getIdentifier();
 352
 353         final NetconfTopologyContext mockContext = mock(NetconfTopologyContext.class);
 354         mockContextMap.put(nodeInstanceId, setup -> mockContext);
 355
 356         doThrow(new RuntimeException("mock error")).when(clusterSingletonServiceProvider)
 357                 .registerClusterSingletonService(mockContext);
 358
 359         netconfTopologyManager.onDataTreeChanged(List.of(
 360                 new CustomTreeModification(DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
 361                         nodeInstanceId), dataObjectModification)));
 362
 363         verify(clusterSingletonServiceProvider, times(3)).registerClusterSingletonService(mockContext);
 364         verify(mockContext).close();
 365         verifyNoMoreInteractions(mockListenerReg);
 366
 367         netconfTopologyManager.close();
 368         verifyNoMoreInteractions(mockContext);
 369     }
 370
 371     static class CustomTreeModification  implements DataTreeModification<Node> {
 372
 373         private final DataTreeIdentifier<Node> rootPath;
 374         private final DataObjectModification<Node> rootNode;
 375
 376         CustomTreeModification(final DataTreeIdentifier<Node> rootPath, final DataObjectModification<Node> rootNode) {
 377             this.rootPath = rootPath;
 378             this.rootNode = rootNode;
 379         }
 380
 381         @Override
 382         public DataTreeIdentifier<Node> getRootPath() {
 383             return rootPath;
 384         }
 385
 386         @Override
 387         public DataObjectModification<Node> getRootNode() {
 388             return rootNode;
 389         }
 390     }
 391 }