netconf/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.Matchers.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.mockito.MockitoAnnotations.initMocks;
  23 import static org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType.DELETE;
  24 import static org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType.SUBTREE_MODIFIED;
  25 import static org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType.WRITE;
  26
  27 import akka.util.Timeout;
  28 import com.google.common.base.Optional;
  29 import com.google.common.collect.ImmutableSet;
  30 import io.netty.util.concurrent.EventExecutor;
  31 import java.util.Arrays;
  32 import java.util.HashMap;
  33 import java.util.Map;
  34 import java.util.Objects;
  35 import java.util.concurrent.TimeUnit;
  36 import java.util.function.Function;
  37 import javax.annotation.Nonnull;
  38 import org.junit.Before;
  39 import org.junit.Test;
  40 import org.mockito.ArgumentCaptor;
  41 import org.mockito.Mock;
  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.controller.md.sal.binding.api.DataBroker;
  47 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  48 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  49 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  50 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  51 import org.opendaylight.controller.md.sal.binding.test.ConstantSchemaAbstractDataBrokerTest;
  52 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  53 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  54 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  55 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  56 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  57 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
  58 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  59 import org.opendaylight.netconf.client.NetconfClientDispatcher;
  60 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  61 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
  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;
  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.yang.binding.InstanceIdentifier;
  78 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  79
  80 public class NetconfTopologyManagerTest {
  81     private static final int ACTOR_RESPONSE_WAIT_TIME = 10;
  82     private static final String TOPOLOGY_ID = "topologyID";
  83
  84     private NetconfTopologyManager netconfTopologyManager;
  85
  86     @Mock
  87     private ClusterSingletonServiceProvider clusterSingletonServiceProvider;
  88
  89     @Mock
  90     private ListenerRegistration<?> mockListenerReg;
  91
  92     private DataBroker dataBroker;
  93
  94     private final Map<InstanceIdentifier<Node>, Function<NetconfTopologySetup, NetconfTopologyContext>>
  95             mockContextMap = new HashMap<>();
  96
  97     @Before
  98     public void setUp() throws Exception {
  99         initMocks(this);
 100
 101         ConstantSchemaAbstractDataBrokerTest dataBrokerTest = new ConstantSchemaAbstractDataBrokerTest(false) {
 102             @Override
 103             protected Iterable<YangModuleInfo> getModuleInfos() throws Exception {
 104                 return ImmutableSet.of(BindingReflections.getModuleInfo(NetworkTopology.class),
 105                         BindingReflections.getModuleInfo(Topology.class));
 106             }
 107         };
 108
 109         dataBrokerTest.setup();
 110         dataBroker = spy(dataBrokerTest.getDataBroker());
 111
 112         final RpcProviderRegistry rpcProviderRegistry = mock(RpcProviderRegistry.class);
 113         final ScheduledThreadPool keepaliveExecutor = mock(ScheduledThreadPool.class);
 114         final ThreadPool processingExecutor = mock(ThreadPool.class);
 115         final ActorSystemProvider actorSystemProvider = mock(ActorSystemProvider.class);
 116         final EventExecutor eventExecutor = mock(EventExecutor.class);
 117         final NetconfClientDispatcher clientDispatcher = mock(NetconfClientDispatcher.class);
 118         final DOMMountPointService mountPointService = mock(DOMMountPointService.class);
 119         final AAAEncryptionService encryptionService = mock(AAAEncryptionService.class);
 120
 121         final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(0).build();
 122         netconfTopologyManager = new NetconfTopologyManager(dataBroker, rpcProviderRegistry,
 123                 clusterSingletonServiceProvider, keepaliveExecutor, processingExecutor,
 124                 actorSystemProvider, eventExecutor, clientDispatcher, TOPOLOGY_ID, config,
 125                 mountPointService, encryptionService) {
 126             @Override
 127             protected NetconfTopologyContext newNetconfTopologyContext(NetconfTopologySetup setup,
 128                     ServiceGroupIdentifier serviceGroupIdent, Timeout actorResponseWaitTime) {
 129                 assertEquals(ACTOR_RESPONSE_WAIT_TIME, actorResponseWaitTime.duration().toSeconds());
 130                 return Objects.requireNonNull(mockContextMap.get(setup.getInstanceIdentifier()),
 131                         "No mock context for " + setup.getInstanceIdentifier()).apply(setup);
 132             }
 133         };
 134
 135         doNothing().when(mockListenerReg).close();
 136         doReturn(mockListenerReg).when(dataBroker).registerDataTreeChangeListener(any(), any());
 137     }
 138
 139     @Test
 140     public void testRegisterDataTreeChangeListener() throws Exception {
 141
 142         netconfTopologyManager.init();
 143
 144         await().atMost(5, TimeUnit.SECONDS).until(() -> {
 145             ReadOnlyTransaction readTx = dataBroker.newReadOnlyTransaction();
 146             Optional<Topology> config = readTx.read(LogicalDatastoreType.CONFIGURATION,
 147                     NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
 148             Optional<Topology> oper = readTx.read(LogicalDatastoreType.OPERATIONAL,
 149                     NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
 150             return config.isPresent() && oper.isPresent();
 151         });
 152
 153         // verify registration is called with right parameters
 154
 155         verify(dataBroker).registerDataTreeChangeListener(
 156                 new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, NetconfTopologyUtils
 157                         .createTopologyListPath(TOPOLOGY_ID).child(Node.class)), netconfTopologyManager);
 158
 159         netconfTopologyManager.close();
 160         verify(mockListenerReg).close();
 161
 162         netconfTopologyManager.close();
 163         verifyNoMoreInteractions(mockListenerReg);
 164     }
 165
 166     @SuppressWarnings("unchecked")
 167     @Test
 168     public void testOnDataTreeChanged() throws Exception {
 169
 170         // Notify of 2 created Node objects.
 171
 172         final NodeId nodeId1 = new NodeId("node-id-1");
 173         final InstanceIdentifier<Node> nodeInstanceId1 = NetconfTopologyUtils.createTopologyNodeListPath(
 174                 new NodeKey(nodeId1), TOPOLOGY_ID);
 175
 176         final NodeId nodeId2 = new NodeId("node-id-2");
 177         final InstanceIdentifier<Node> nodeInstanceId2 = NetconfTopologyUtils.createTopologyNodeListPath(
 178                 new NodeKey(nodeId2), TOPOLOGY_ID);
 179
 180         final NetconfNode netconfNode1 = new NetconfNodeBuilder()
 181                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 182                 .setPort(new PortNumber(1111))
 183                 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
 184                 .build();
 185         final Node node1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(NetconfNode.class,
 186                 netconfNode1).build();
 187
 188         final DataObjectModification<Node> dataObjectModification1 = mock(DataObjectModification.class);
 189         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 190         doReturn(node1).when(dataObjectModification1).getDataAfter();
 191         doReturn(new InstanceIdentifier.IdentifiableItem<>(Node.class, new NodeKey(nodeId1)))
 192                 .when(dataObjectModification1).getIdentifier();
 193
 194         final NetconfNode netconfNode2 = new NetconfNodeBuilder()
 195                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 196                 .setPort(new PortNumber(2222))
 197                 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME)
 198                 .build();
 199         final Node node2 = new NodeBuilder().setNodeId(nodeId2).addAugmentation(NetconfNode.class,
 200                 netconfNode2).build();
 201
 202         final DataObjectModification<Node> dataObjectModification2 = mock(DataObjectModification.class);
 203         doReturn(WRITE).when(dataObjectModification2).getModificationType();
 204         doReturn(node2).when(dataObjectModification2).getDataAfter();
 205         doReturn(new InstanceIdentifier.IdentifiableItem<>(Node.class, new NodeKey(nodeId2)))
 206                 .when(dataObjectModification2).getIdentifier();
 207
 208         final NetconfTopologyContext mockContext1 = mock(NetconfTopologyContext.class);
 209         mockContextMap.put(nodeInstanceId1, setup -> {
 210             assertEquals(node1, setup.getNode());
 211             assertEquals(TOPOLOGY_ID, setup.getTopologyId());
 212             return mockContext1;
 213         });
 214
 215         final NetconfTopologyContext mockContext2 = mock(NetconfTopologyContext.class);
 216         mockContextMap.put(nodeInstanceId2, setup -> {
 217             assertEquals(node2, setup.getNode());
 218             assertEquals(TOPOLOGY_ID, setup.getTopologyId());
 219             return mockContext2;
 220         });
 221
 222         ClusterSingletonServiceRegistration mockClusterRegistration1 = mock(ClusterSingletonServiceRegistration.class);
 223         ClusterSingletonServiceRegistration mockClusterRegistration2 = mock(ClusterSingletonServiceRegistration.class);
 224
 225         doReturn(mockClusterRegistration1).when(clusterSingletonServiceProvider)
 226                 .registerClusterSingletonService(mockContext1);
 227         doReturn(mockClusterRegistration2).when(clusterSingletonServiceProvider)
 228                 .registerClusterSingletonService(mockContext2);
 229
 230         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 231                 new CustomTreeModification(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
 232                         nodeInstanceId1), dataObjectModification1),
 233                 new CustomTreeModification(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
 234                         nodeInstanceId2), dataObjectModification2)));
 235
 236         verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext1);
 237         verify(clusterSingletonServiceProvider).registerClusterSingletonService(mockContext2);
 238
 239         // Notify of Node 1 replaced and Node 2 subtree modified.
 240
 241         mockContextMap.clear();
 242
 243         final NetconfNode updatedNetconfNode1 = new NetconfNodeBuilder(netconfNode1)
 244                 .setPort(new PortNumber(33333)).build();
 245         final Node updatedNode1 = new NodeBuilder().setNodeId(nodeId1).addAugmentation(NetconfNode.class,
 246                 updatedNetconfNode1).build();
 247
 248         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 249         doReturn(node1).when(dataObjectModification1).getDataBefore();
 250         doReturn(updatedNode1).when(dataObjectModification1).getDataAfter();
 251
 252         doReturn(SUBTREE_MODIFIED).when(dataObjectModification2).getModificationType();
 253         doReturn(node2).when(dataObjectModification2).getDataBefore();
 254         doReturn(node2).when(dataObjectModification2).getDataAfter();
 255
 256         doNothing().when(mockContext1).refresh(any());
 257         doNothing().when(mockContext2).refresh(any());
 258
 259         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 260                 new CustomTreeModification(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
 261                         nodeInstanceId1), dataObjectModification1),
 262                 new CustomTreeModification(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
 263                         nodeInstanceId2), dataObjectModification2)));
 264
 265         ArgumentCaptor<NetconfTopologySetup> mockContext1Setup = ArgumentCaptor.forClass(NetconfTopologySetup.class);
 266         verify(mockContext1).refresh(mockContext1Setup.capture());
 267         assertEquals(updatedNode1, mockContext1Setup.getValue().getNode());
 268
 269         verify(mockContext2).refresh(any());
 270
 271         verifyNoMoreInteractions(clusterSingletonServiceProvider);
 272
 273         // Notify of Node 1 deleted.
 274
 275         doReturn(DELETE).when(dataObjectModification1).getModificationType();
 276         doReturn(updatedNode1).when(dataObjectModification1).getDataBefore();
 277         doReturn(null).when(dataObjectModification1).getDataAfter();
 278
 279         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 280                 new CustomTreeModification(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
 281                         nodeInstanceId1), dataObjectModification1)));
 282
 283         verify(mockClusterRegistration1).close();
 284         verify(mockContext1).close();
 285         verifyNoMoreInteractions(clusterSingletonServiceProvider, mockClusterRegistration2, mockContext2);
 286
 287         // Notify of Node 1 created again.
 288
 289         reset(clusterSingletonServiceProvider);
 290
 291         final NetconfTopologyContext newMockContext1 = mock(NetconfTopologyContext.class);
 292         final ClusterSingletonServiceRegistration newMockClusterRegistration1 =
 293                 mock(ClusterSingletonServiceRegistration.class);
 294
 295         doThrow(new RuntimeException("mock error")).doReturn(newMockClusterRegistration1)
 296                 .when(clusterSingletonServiceProvider).registerClusterSingletonService(newMockContext1);
 297
 298         doReturn(WRITE).when(dataObjectModification1).getModificationType();
 299         doReturn(null).when(dataObjectModification1).getDataBefore();
 300         doReturn(node1).when(dataObjectModification1).getDataAfter();
 301
 302         mockContextMap.put(nodeInstanceId1, setup -> {
 303             assertEquals(node1, setup.getNode());
 304             assertEquals(TOPOLOGY_ID, setup.getTopologyId());
 305             return newMockContext1;
 306         });
 307
 308         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 309                 new CustomTreeModification(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
 310                         nodeInstanceId1), dataObjectModification1)));
 311
 312         verify(clusterSingletonServiceProvider, times(2)).registerClusterSingletonService(newMockContext1);
 313
 314         verifyNoMoreInteractions(mockClusterRegistration1, mockContext1, mockClusterRegistration2, mockContext2,
 315                 newMockContext1, newMockClusterRegistration1, clusterSingletonServiceProvider);
 316
 317         // Test close.
 318
 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 NetconfNode netconfNode = new NetconfNodeBuilder()
 339                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 340                 .setPort(new PortNumber(10))
 341                 .setActorResponseWaitTime(ACTOR_RESPONSE_WAIT_TIME).build();
 342         final Node node = new NodeBuilder().setNodeId(nodeId).addAugmentation(NetconfNode.class,
 343                 netconfNode).build();
 344
 345         final DataObjectModification<Node> dataObjectModification = mock(DataObjectModification.class);
 346         doReturn(WRITE).when(dataObjectModification).getModificationType();
 347         doReturn(node).when(dataObjectModification).getDataAfter();
 348         doReturn(new InstanceIdentifier.IdentifiableItem<>(Node.class, new NodeKey(nodeId)))
 349                 .when(dataObjectModification).getIdentifier();
 350
 351         final NetconfTopologyContext mockContext = mock(NetconfTopologyContext.class);
 352         mockContextMap.put(nodeInstanceId, setup -> mockContext);
 353
 354         doThrow(new RuntimeException("mock error")).when(clusterSingletonServiceProvider)
 355                 .registerClusterSingletonService(mockContext);
 356
 357         netconfTopologyManager.init();
 358
 359         netconfTopologyManager.onDataTreeChanged(Arrays.asList(
 360                 new CustomTreeModification(new DataTreeIdentifier<>(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         @Nonnull
 382         @Override
 383         public DataTreeIdentifier<Node> getRootPath() {
 384             return rootPath;
 385         }
 386
 387         @Nonnull
 388         @Override
 389         public DataObjectModification<Node> getRootNode() {
 390             return rootNode;
 391         }
 392     }
 393 }