netconf/netconf-topology-singleton/src/test/java/org/opendaylight/netconf/topology/singleton/impl/MountPointEndToEndTest.java

   1 /*
   2  * Copyright (c) 2018 Inocybe Technologies 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.junit.Assert.assertFalse;
  13 import static org.junit.Assert.assertNotNull;
  14 import static org.junit.Assert.assertNull;
  15 import static org.junit.Assert.assertTrue;
  16 import static org.junit.Assert.fail;
  17 import static org.mockito.ArgumentMatchers.any;
  18 import static org.mockito.Mockito.doAnswer;
  19 import static org.mockito.Mockito.doReturn;
  20 import static org.mockito.Mockito.never;
  21 import static org.mockito.Mockito.spy;
  22 import static org.mockito.Mockito.timeout;
  23 import static org.mockito.Mockito.verify;
  24 import static org.mockito.MockitoAnnotations.initMocks;
  25
  26 import akka.actor.ActorSystem;
  27 import akka.testkit.javadsl.TestKit;
  28 import akka.util.Timeout;
  29 import com.google.common.collect.ImmutableList;
  30 import com.google.common.collect.ImmutableSet;
  31 import com.google.common.util.concurrent.FluentFuture;
  32 import com.google.common.util.concurrent.Futures;
  33 import com.google.common.util.concurrent.ListenableFuture;
  34 import com.google.common.util.concurrent.MoreExecutors;
  35 import com.google.common.util.concurrent.SettableFuture;
  36 import com.typesafe.config.ConfigFactory;
  37 import io.netty.util.concurrent.EventExecutor;
  38 import io.netty.util.concurrent.GlobalEventExecutor;
  39 import io.netty.util.concurrent.SucceededFuture;
  40 import java.io.File;
  41 import java.util.AbstractMap.SimpleEntry;
  42 import java.util.Arrays;
  43 import java.util.Collections;
  44 import java.util.Iterator;
  45 import java.util.Map.Entry;
  46 import java.util.Optional;
  47 import java.util.Set;
  48 import java.util.concurrent.ExecutionException;
  49 import java.util.concurrent.TimeUnit;
  50 import java.util.concurrent.TimeoutException;
  51 import org.apache.commons.io.FileUtils;
  52 import org.junit.After;
  53 import org.junit.Before;
  54 import org.junit.Test;
  55 import org.mockito.Mock;
  56 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  57 import org.opendaylight.controller.cluster.ActorSystemProvider;
  58 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
  59 import org.opendaylight.controller.config.threadpool.ThreadPool;
  60 import org.opendaylight.mdsal.binding.api.DataBroker;
  61 import org.opendaylight.mdsal.binding.api.DataObjectModification;
  62 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  63 import org.opendaylight.mdsal.binding.api.DataTreeModification;
  64 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  65 import org.opendaylight.mdsal.binding.api.Transaction;
  66 import org.opendaylight.mdsal.binding.api.TransactionChain;
  67 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
  68 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  69 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractConcurrentDataBrokerTest;
  70 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  71 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  72 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  73 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  74 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
  75 import org.opendaylight.mdsal.dom.api.DOMActionService;
  76 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  77 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadOperations;
  78 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  79 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  80 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  81 import org.opendaylight.mdsal.dom.api.DOMMountPointListener;
  82 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  83 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  84 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
  85 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
  86 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  87 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  88 import org.opendaylight.mdsal.dom.api.DOMService;
  89 import org.opendaylight.mdsal.dom.broker.DOMMountPointServiceImpl;
  90 import org.opendaylight.mdsal.dom.broker.DOMRpcRouter;
  91 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  92 import org.opendaylight.mdsal.eos.dom.simple.SimpleDOMEntityOwnershipService;
  93 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  94 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
  95 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  96 import org.opendaylight.mdsal.singleton.dom.impl.DOMClusterSingletonServiceProviderImpl;
  97 import org.opendaylight.netconf.client.NetconfClientDispatcher;
  98 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
  99 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
 100 import org.opendaylight.netconf.topology.singleton.impl.utils.ClusteringRpcException;
 101 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
 102 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
 103 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
 104 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
 105 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
 106 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.Keystore;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPwUnencryptedBuilder;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencryptedBuilder;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.Config;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.topology.singleton.config.rev170419.ConfigBuilder;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.GetTopOutputBuilder;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.PutTopInputBuilder;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.Top;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelList;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.list.rev140701.two.level.list.TopLevelListBuilder;
 121 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
 122 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
 123 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
 124 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
 125 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
 126 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
 127 import org.opendaylight.yangtools.rcf8528.data.util.EmptyMountPointContext;
 128 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
 129 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 130 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
 131 import org.opendaylight.yangtools.yang.common.QName;
 132 import org.opendaylight.yangtools.yang.common.RpcError;
 133 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
 134 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 135 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 136 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 137 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
 138 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
 139 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 140 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
 141 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 142 import org.opendaylight.yangtools.yang.model.api.Module;
 143 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 144 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 145 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 146 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
 147 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
 148 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
 149 import org.slf4j.Logger;
 150 import org.slf4j.LoggerFactory;
 151
 152 /**
 153  * Tests netconf mount points end-to-end.
 154  *
 155  * @author Thomas Pantelis
 156  */
 157 public class MountPointEndToEndTest {
 158     private static final Logger LOG = LoggerFactory.getLogger(MountPointEndToEndTest.class);
 159
 160     private static final String TOP_MODULE_NAME = "opendaylight-mdsal-list-test";
 161     private static final String ACTOR_SYSTEM_NAME = "test";
 162     private static final String TOPOLOGY_ID = TopologyNetconf.QNAME.getLocalName();
 163     private static final NodeId NODE_ID = new NodeId("node-id");
 164     private static final InstanceIdentifier<Node> NODE_INSTANCE_ID = NetconfTopologyUtils.createTopologyNodeListPath(
 165             new NodeKey(NODE_ID), TOPOLOGY_ID);
 166
 167     @Mock private DOMRpcProviderService mockRpcProviderRegistry;
 168     @Mock private DOMActionProviderService mockActionProviderRegistry;
 169     @Mock private NetconfClientDispatcher mockClientDispatcher;
 170     @Mock private AAAEncryptionService mockEncryptionService;
 171     @Mock private ThreadPool mockThreadPool;
 172     @Mock private ScheduledThreadPool mockKeepaliveExecutor;
 173     @Mock private DeviceActionFactory deviceActionFactory;
 174
 175     @Mock private ActorSystemProvider mockMasterActorSystemProvider;
 176     @Mock private DOMMountPointListener masterMountPointListener;
 177     private final DOMMountPointService masterMountPointService = new DOMMountPointServiceImpl();
 178     private final DOMRpcRouter deviceRpcService = new DOMRpcRouter();
 179     private DOMClusterSingletonServiceProviderImpl masterClusterSingletonServiceProvider;
 180     private DataBroker masterDataBroker;
 181     private DOMDataBroker deviceDOMDataBroker;
 182     private ActorSystem masterSystem;
 183     private NetconfTopologyManager masterNetconfTopologyManager;
 184     private volatile SettableFuture<MasterSalFacade> masterSalFacadeFuture = SettableFuture.create();
 185
 186     @Mock private ActorSystemProvider mockSlaveActorSystemProvider;
 187     @Mock private ClusterSingletonServiceProvider mockSlaveClusterSingletonServiceProvider;
 188     @Mock private ClusterSingletonServiceRegistration mockSlaveClusterSingletonServiceReg;
 189     @Mock private DOMMountPointListener slaveMountPointListener;
 190     private final DOMMountPointService slaveMountPointService = new DOMMountPointServiceImpl();
 191     private DataBroker slaveDataBroker;
 192     private ActorSystem slaveSystem;
 193     private NetconfTopologyManager slaveNetconfTopologyManager;
 194     private final SettableFuture<NetconfTopologyContext> slaveNetconfTopologyContextFuture = SettableFuture.create();
 195     private TransactionChain slaveTxChain;
 196
 197     private final EventExecutor eventExecutor = GlobalEventExecutor.INSTANCE;
 198     private final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(0).build();
 199     private SchemaContext deviceSchemaContext;
 200     private YangModuleInfo topModuleInfo;
 201     private SchemaPath putTopRpcSchemaPath;
 202     private SchemaPath getTopRpcSchemaPath;
 203     private BindingNormalizedNodeSerializer bindingToNormalized;
 204     private YangInstanceIdentifier yangNodeInstanceId;
 205     private final TopDOMRpcImplementation topRpcImplementation = new TopDOMRpcImplementation();
 206
 207     @SuppressWarnings({ "unchecked", "rawtypes" })
 208     @Before
 209     public void setUp() throws Exception {
 210         initMocks(this);
 211
 212         deleteCacheDir();
 213
 214         topModuleInfo = BindingReflections.getModuleInfo(Top.class);
 215
 216         final ModuleInfoBackedContext moduleContext = ModuleInfoBackedContext.create();
 217         moduleContext.addModuleInfos(Arrays.asList(topModuleInfo));
 218         deviceSchemaContext = moduleContext.tryToCreateSchemaContext().get();
 219
 220         deviceRpcService.onGlobalContextUpdated(deviceSchemaContext);
 221
 222         putTopRpcSchemaPath = findRpcDefinition("put-top").getPath();
 223         getTopRpcSchemaPath = findRpcDefinition("get-top").getPath();
 224
 225         deviceRpcService.getRpcProviderService().registerRpcImplementation(topRpcImplementation,
 226                 DOMRpcIdentifier.create(putTopRpcSchemaPath), DOMRpcIdentifier.create(getTopRpcSchemaPath));
 227
 228         setupMaster();
 229
 230         setupSlave();
 231
 232         yangNodeInstanceId = bindingToNormalized.toYangInstanceIdentifier(NODE_INSTANCE_ID);
 233
 234         doReturn(new SucceededFuture(GlobalEventExecutor.INSTANCE, null)).when(mockClientDispatcher)
 235                 .createReconnectingClient(any());
 236
 237         LOG.info("****** Setup complete");
 238     }
 239
 240     private static void deleteCacheDir() {
 241         FileUtils.deleteQuietly(new File(NetconfTopologyUtils.CACHE_DIRECTORY));
 242     }
 243
 244     @After
 245     public void tearDown() throws Exception {
 246         deleteCacheDir();
 247         TestKit.shutdownActorSystem(slaveSystem, true);
 248         TestKit.shutdownActorSystem(masterSystem, true);
 249     }
 250
 251     private void setupMaster() throws Exception {
 252         AbstractConcurrentDataBrokerTest dataBrokerTest = newDataBrokerTest();
 253         masterDataBroker = dataBrokerTest.getDataBroker();
 254         deviceDOMDataBroker = dataBrokerTest.getDomBroker();
 255         bindingToNormalized = dataBrokerTest.getDataBrokerTestCustomizer().getBindingToNormalized();
 256
 257         masterSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Master"));
 258
 259         masterClusterSingletonServiceProvider = new DOMClusterSingletonServiceProviderImpl(
 260                 new SimpleDOMEntityOwnershipService());
 261         masterClusterSingletonServiceProvider.initializeProvider();
 262
 263         doReturn(masterSystem).when(mockMasterActorSystemProvider).getActorSystem();
 264
 265         doReturn(MoreExecutors.newDirectExecutorService()).when(mockThreadPool).getExecutor();
 266
 267         NetconfTopologyUtils.DEFAULT_SCHEMA_REPOSITORY.registerSchemaSource(
 268             id -> Futures.immediateFuture(YangTextSchemaSource.delegateForByteSource(id,
 269                     topModuleInfo.getYangTextByteSource())),
 270             PotentialSchemaSource.create(RevisionSourceIdentifier.create(TOP_MODULE_NAME,
 271                     topModuleInfo.getName().getRevision()), YangTextSchemaSource.class, 1));
 272
 273         masterNetconfTopologyManager = new NetconfTopologyManager(masterDataBroker, mockRpcProviderRegistry,
 274             mockActionProviderRegistry, masterClusterSingletonServiceProvider, mockKeepaliveExecutor, mockThreadPool,
 275                 mockMasterActorSystemProvider, eventExecutor, mockClientDispatcher, TOPOLOGY_ID, config,
 276                 masterMountPointService, mockEncryptionService, deviceActionFactory) {
 277             @Override
 278             protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
 279                 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
 280                 final DeviceActionFactory deviceActionFact) {
 281                 NetconfTopologyContext context =
 282                     super.newNetconfTopologyContext(setup, serviceGroupIdent, actorResponseWaitTime, deviceActionFact);
 283
 284                 NetconfTopologyContext spiedContext = spy(context);
 285                 doAnswer(invocation -> {
 286                     final MasterSalFacade spiedFacade = (MasterSalFacade) spy(invocation.callRealMethod());
 287                     doReturn(deviceDOMDataBroker).when(spiedFacade).newDeviceDataBroker();
 288                     masterSalFacadeFuture.set(spiedFacade);
 289                     return spiedFacade;
 290                 }).when(spiedContext).newMasterSalFacade();
 291
 292                 return spiedContext;
 293             }
 294         };
 295
 296         masterNetconfTopologyManager.init();
 297
 298         verifyTopologyNodesCreated(masterDataBroker);
 299     }
 300
 301     private void setupSlave() throws Exception {
 302         AbstractConcurrentDataBrokerTest dataBrokerTest = newDataBrokerTest();
 303         slaveDataBroker = dataBrokerTest.getDataBroker();
 304
 305         slaveSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Slave"));
 306
 307         doReturn(slaveSystem).when(mockSlaveActorSystemProvider).getActorSystem();
 308
 309         doReturn(mockSlaveClusterSingletonServiceReg).when(mockSlaveClusterSingletonServiceProvider)
 310                 .registerClusterSingletonService(any());
 311
 312         slaveNetconfTopologyManager = new NetconfTopologyManager(slaveDataBroker, mockRpcProviderRegistry,
 313             mockActionProviderRegistry, mockSlaveClusterSingletonServiceProvider, mockKeepaliveExecutor, mockThreadPool,
 314                 mockSlaveActorSystemProvider, eventExecutor, mockClientDispatcher, TOPOLOGY_ID, config,
 315                 slaveMountPointService, mockEncryptionService, deviceActionFactory) {
 316             @Override
 317             protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
 318                 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
 319                 final DeviceActionFactory actionFactory) {
 320                 NetconfTopologyContext spiedContext = spy(super.newNetconfTopologyContext(setup, serviceGroupIdent,
 321                     actorResponseWaitTime, actionFactory));
 322
 323                 slaveNetconfTopologyContextFuture.set(spiedContext);
 324                 return spiedContext;
 325             }
 326         };
 327
 328         slaveNetconfTopologyManager.init();
 329
 330         verifyTopologyNodesCreated(slaveDataBroker);
 331
 332         slaveTxChain = slaveDataBroker.createTransactionChain(new TransactionChainListener() {
 333             @Override
 334             public void onTransactionChainSuccessful(final TransactionChain chain) {
 335             }
 336
 337             @Override
 338             public void onTransactionChainFailed(final TransactionChain chain, final Transaction transaction,
 339                     final Throwable cause) {
 340                 LOG.error("Slave transaction chain failed", cause);
 341             }
 342         });
 343     }
 344
 345     @Test
 346     public void test() throws Exception {
 347         testMaster();
 348
 349         testSlave();
 350
 351         final MasterSalFacade masterSalFacade = testMasterNodeUpdated();
 352
 353         testMasterDisconnected(masterSalFacade);
 354
 355         testCleanup();
 356     }
 357
 358     private MasterSalFacade testMaster() throws InterruptedException, ExecutionException, TimeoutException {
 359         LOG.info("****** Testing master");
 360
 361         writeNetconfNode(NetconfTopologyUtils.DEFAULT_CACHE_DIRECTORY, masterDataBroker);
 362
 363         final MasterSalFacade masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
 364
 365         masterSalFacade.onDeviceConnected(new EmptyMountPointContext(deviceSchemaContext),
 366                 NetconfSessionPreferences.fromStrings(Collections.emptyList()), deviceRpcService.getRpcService());
 367
 368         DOMMountPoint masterMountPoint = awaitMountPoint(masterMountPointService);
 369
 370         LOG.info("****** Testing master DOMDataBroker operations");
 371
 372         testDOMDataBrokerOperations(getDOMDataBroker(masterMountPoint));
 373
 374         LOG.info("****** Testing master DOMRpcService");
 375
 376         testDOMRpcService(getDOMRpcService(masterMountPoint));
 377         return masterSalFacade;
 378     }
 379
 380     private void testSlave() throws InterruptedException, ExecutionException, TimeoutException {
 381         LOG.info("****** Testing slave");
 382
 383         writeNetconfNode("slave", slaveDataBroker);
 384
 385         verify(mockSlaveClusterSingletonServiceProvider, timeout(5000)).registerClusterSingletonService(any());
 386
 387         // Since the master and slave use separate DataBrokers we need to copy the master's oper node to the slave.
 388         // This is essentially what happens in a clustered environment but we'll use a DTCL here.
 389
 390         masterDataBroker.registerDataTreeChangeListener(
 391             DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL, NODE_INSTANCE_ID), changes -> {
 392                 final WriteTransaction slaveTx = slaveTxChain.newWriteOnlyTransaction();
 393                 for (DataTreeModification<Node> dataTreeModification : changes) {
 394                     DataObjectModification<Node> rootNode = dataTreeModification.getRootNode();
 395                     InstanceIdentifier<Node> path = dataTreeModification.getRootPath().getRootIdentifier();
 396                     switch (rootNode.getModificationType()) {
 397                         case WRITE:
 398                         case SUBTREE_MODIFIED:
 399                             slaveTx.merge(LogicalDatastoreType.OPERATIONAL, path, rootNode.getDataAfter());
 400                             break;
 401                         case DELETE:
 402                             slaveTx.delete(LogicalDatastoreType.OPERATIONAL, path);
 403                             break;
 404                         default:
 405                             break;
 406                     }
 407                 }
 408
 409                 slaveTx.commit();
 410             });
 411
 412         DOMMountPoint slaveMountPoint = awaitMountPoint(slaveMountPointService);
 413
 414         final NetconfTopologyContext slaveNetconfTopologyContext =
 415                 slaveNetconfTopologyContextFuture.get(5, TimeUnit.SECONDS);
 416         verify(slaveNetconfTopologyContext, never()).newMasterSalFacade();
 417
 418         LOG.info("****** Testing slave DOMDataBroker operations");
 419
 420         testDOMDataBrokerOperations(getDOMDataBroker(slaveMountPoint));
 421
 422         LOG.info("****** Testing slave DOMRpcService");
 423
 424         testDOMRpcService(getDOMRpcService(slaveMountPoint));
 425     }
 426
 427     private MasterSalFacade testMasterNodeUpdated() throws InterruptedException, ExecutionException, TimeoutException {
 428         LOG.info("****** Testing update master node");
 429
 430         masterMountPointService.registerProvisionListener(masterMountPointListener);
 431         slaveMountPointService.registerProvisionListener(slaveMountPointListener);
 432
 433         masterSalFacadeFuture = SettableFuture.create();
 434         writeNetconfNode(NetconfTopologyUtils.DEFAULT_CACHE_DIRECTORY, masterDataBroker);
 435
 436         verify(masterMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
 437
 438         MasterSalFacade masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
 439
 440         masterSalFacade.onDeviceConnected(new EmptyMountPointContext(deviceSchemaContext),
 441                 NetconfSessionPreferences.fromStrings(Collections.emptyList()), deviceRpcService.getRpcService());
 442
 443         verify(masterMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
 444
 445         verify(slaveMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
 446         verify(slaveMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
 447
 448         return masterSalFacade;
 449     }
 450
 451     private void testMasterDisconnected(final MasterSalFacade masterSalFacade)
 452             throws InterruptedException, ExecutionException, TimeoutException {
 453         LOG.info("****** Testing master disconnected");
 454
 455         masterSalFacade.onDeviceDisconnected();
 456
 457         awaitMountPointNotPresent(masterMountPointService);
 458
 459         await().atMost(5, TimeUnit.SECONDS).until(() -> {
 460             try (ReadTransaction readTx = masterDataBroker.newReadOnlyTransaction()) {
 461                 Optional<Node> node = readTx.read(LogicalDatastoreType.OPERATIONAL,
 462                         NODE_INSTANCE_ID).get(5, TimeUnit.SECONDS);
 463                 assertTrue(node.isPresent());
 464                 final NetconfNode netconfNode = node.get().augmentation(NetconfNode.class);
 465                 return netconfNode.getConnectionStatus() != NetconfNodeConnectionStatus.ConnectionStatus.Connected;
 466             }
 467         });
 468
 469         awaitMountPointNotPresent(slaveMountPointService);
 470     }
 471
 472     private void testCleanup() throws Exception {
 473         LOG.info("****** Testing cleanup");
 474
 475         slaveNetconfTopologyManager.close();
 476         verify(mockSlaveClusterSingletonServiceReg).close();
 477     }
 478
 479     private void testDOMRpcService(final DOMRpcService domRpcService)
 480             throws InterruptedException, ExecutionException, TimeoutException {
 481         testPutTopRpc(domRpcService, new DefaultDOMRpcResult((NormalizedNode<?, ?>)null));
 482         testPutTopRpc(domRpcService, null);
 483         testPutTopRpc(domRpcService, new DefaultDOMRpcResult(ImmutableList.of(
 484                 RpcResultBuilder.newError(ErrorType.APPLICATION, "tag1", "error1"),
 485                 RpcResultBuilder.newError(ErrorType.APPLICATION, "tag2", "error2"))));
 486
 487         testGetTopRpc(domRpcService, new DefaultDOMRpcResult(bindingToNormalized.toNormalizedNodeRpcData(
 488                 new GetTopOutputBuilder().setTopLevelList(Arrays.asList(new TopLevelListBuilder().setName("one")
 489                         .build())).build())));
 490
 491         testFailedRpc(domRpcService, getTopRpcSchemaPath, null);
 492     }
 493
 494     private void testPutTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
 495             throws InterruptedException, ExecutionException, TimeoutException {
 496         ContainerNode putTopInput = bindingToNormalized.toNormalizedNodeRpcData(
 497                 new PutTopInputBuilder().setTopLevelList(Arrays.asList(new TopLevelListBuilder().setName("one")
 498                         .build())).build());
 499         testRpc(domRpcService, putTopRpcSchemaPath, putTopInput, result);
 500     }
 501
 502     private void testGetTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
 503             throws InterruptedException, ExecutionException, TimeoutException {
 504         testRpc(domRpcService, getTopRpcSchemaPath, null, result);
 505     }
 506
 507     private void testRpc(final DOMRpcService domRpcService, final SchemaPath schemaPath,
 508             final NormalizedNode<?, ?> input, final DOMRpcResult result) throws InterruptedException,
 509             ExecutionException, TimeoutException {
 510         final FluentFuture<DOMRpcResult> future = result == null ? FluentFutures.immediateNullFluentFuture()
 511                 : FluentFutures.immediateFluentFuture(result);
 512         final DOMRpcResult actual = invokeRpc(domRpcService, schemaPath, input, future);
 513         if (result == null) {
 514             assertNull(actual);
 515             return;
 516         }
 517
 518         assertNotNull(actual);
 519         assertEquals(result.getResult(), actual.getResult());
 520
 521         assertEquals(result.getErrors().size(), actual.getErrors().size());
 522         Iterator<? extends RpcError> iter1 = result.getErrors().iterator();
 523         Iterator<? extends RpcError> iter2 = actual.getErrors().iterator();
 524         while (iter1.hasNext() && iter2.hasNext()) {
 525             RpcError err1 = iter1.next();
 526             RpcError err2 = iter2.next();
 527             assertEquals(err1.getErrorType(), err2.getErrorType());
 528             assertEquals(err1.getTag(), err2.getTag());
 529             assertEquals(err1.getMessage(), err2.getMessage());
 530             assertEquals(err1.getSeverity(), err2.getSeverity());
 531             assertEquals(err1.getApplicationTag(), err2.getApplicationTag());
 532             assertEquals(err1.getInfo(), err2.getInfo());
 533         }
 534     }
 535
 536     private void testFailedRpc(final DOMRpcService domRpcService, final SchemaPath schemaPath,
 537             final NormalizedNode<?, ?> input) throws InterruptedException, TimeoutException {
 538         try {
 539             invokeRpc(domRpcService, schemaPath, input, FluentFutures.immediateFailedFluentFuture(
 540                     new ClusteringRpcException("mock")));
 541             fail("Expected exception");
 542         } catch (ExecutionException e) {
 543             assertTrue(e.getCause() instanceof ClusteringRpcException);
 544             assertEquals("mock", e.getCause().getMessage());
 545         }
 546     }
 547
 548     private DOMRpcResult invokeRpc(final DOMRpcService domRpcService, final SchemaPath schemaPath,
 549             final NormalizedNode<?, ?> input, final FluentFuture<DOMRpcResult> returnFuture)
 550                     throws InterruptedException, ExecutionException, TimeoutException {
 551         topRpcImplementation.init(returnFuture);
 552         final ListenableFuture<DOMRpcResult> resultFuture = domRpcService.invokeRpc(schemaPath, input);
 553
 554         topRpcImplementation.verify(DOMRpcIdentifier.create(schemaPath), input);
 555
 556         return resultFuture.get(5, TimeUnit.SECONDS);
 557     }
 558
 559     private static void testDOMDataBrokerOperations(final DOMDataBroker dataBroker)
 560             throws InterruptedException, ExecutionException, TimeoutException {
 561
 562         DOMDataTreeWriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
 563
 564         final ContainerNode topNode = Builders.containerBuilder()
 565                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(Top.QNAME)).build();
 566         final YangInstanceIdentifier topPath = YangInstanceIdentifier.of(Top.QNAME);
 567         writeTx.put(LogicalDatastoreType.CONFIGURATION, topPath, topNode);
 568
 569         final QName name = QName.create(TopLevelList.QNAME, "name");
 570         final YangInstanceIdentifier listPath = YangInstanceIdentifier.builder(topPath)
 571                 .node(TopLevelList.QNAME).build();
 572         final MapEntryNode listEntryNode = ImmutableNodes.mapEntry(TopLevelList.QNAME, name, "one");
 573         final MapNode listNode = ImmutableNodes.mapNodeBuilder(TopLevelList.QNAME).addChild(listEntryNode).build();
 574         writeTx.merge(LogicalDatastoreType.CONFIGURATION, listPath, listNode);
 575         writeTx.commit().get(5, TimeUnit.SECONDS);
 576
 577         verifyDataInStore(dataBroker.newReadWriteTransaction(), YangInstanceIdentifier.builder(listPath)
 578                 .nodeWithKey(TopLevelList.QNAME, name, "one").build(), listEntryNode);
 579
 580         writeTx = dataBroker.newWriteOnlyTransaction();
 581         writeTx.delete(LogicalDatastoreType.CONFIGURATION, topPath);
 582         writeTx.commit().get(5, TimeUnit.SECONDS);
 583
 584         DOMDataTreeReadWriteTransaction readTx = dataBroker.newReadWriteTransaction();
 585         assertFalse(readTx.exists(LogicalDatastoreType.CONFIGURATION, topPath).get(5, TimeUnit.SECONDS));
 586         assertTrue(readTx.cancel());
 587     }
 588
 589     private static void writeNetconfNode(final String cacheDir, final DataBroker databroker)
 590             throws InterruptedException, ExecutionException, TimeoutException {
 591         final NetconfNode netconfNode = new NetconfNodeBuilder()
 592                 .setHost(new Host(new IpAddress(new Ipv4Address("127.0.0.1"))))
 593                 .setPort(new PortNumber(1234))
 594                 .setActorResponseWaitTime(10)
 595                 .setTcpOnly(Boolean.TRUE)
 596                 .setSchemaless(Boolean.FALSE)
 597                 .setKeepaliveDelay(0L)
 598                 .setConnectionTimeoutMillis(5000L)
 599                 .setDefaultRequestTimeoutMillis(5000L)
 600                 .setMaxConnectionAttempts(1L)
 601                 .setCredentials(new LoginPwUnencryptedBuilder().setLoginPasswordUnencrypted(
 602                         new LoginPasswordUnencryptedBuilder().setUsername("user").setPassword("pass").build()).build())
 603                 .setSchemaCacheDirectory(cacheDir)
 604                 .build();
 605         final Node node = new NodeBuilder().setNodeId(NODE_ID).addAugmentation(NetconfNode.class, netconfNode).build();
 606
 607         final WriteTransaction writeTx = databroker.newWriteOnlyTransaction();
 608         writeTx.put(LogicalDatastoreType.CONFIGURATION, NODE_INSTANCE_ID, node);
 609         writeTx.commit().get(5, TimeUnit.SECONDS);
 610     }
 611
 612     private static void verifyDataInStore(final DOMDataTreeReadOperations readTx, final YangInstanceIdentifier path,
 613             final NormalizedNode<?, ?> expNode) throws InterruptedException, ExecutionException, TimeoutException {
 614         final Optional<NormalizedNode<?, ?>> read = readTx.read(LogicalDatastoreType.CONFIGURATION, path)
 615                 .get(5, TimeUnit.SECONDS);
 616         assertTrue(read.isPresent());
 617         assertEquals(expNode, read.get());
 618
 619         final Boolean exists = readTx.exists(LogicalDatastoreType.CONFIGURATION, path).get(5, TimeUnit.SECONDS);
 620         assertTrue(exists);
 621     }
 622
 623     private static void verifyTopologyNodesCreated(final DataBroker dataBroker) {
 624         await().atMost(5, TimeUnit.SECONDS).until(() -> {
 625             try (ReadTransaction readTx = dataBroker.newReadOnlyTransaction()) {
 626                 Optional<Topology> configTopology = readTx.read(LogicalDatastoreType.CONFIGURATION,
 627                         NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
 628                 Optional<Topology> operTopology = readTx.read(LogicalDatastoreType.OPERATIONAL,
 629                         NetconfTopologyUtils.createTopologyListPath(TOPOLOGY_ID)).get(3, TimeUnit.SECONDS);
 630                 return configTopology.isPresent() && operTopology.isPresent();
 631             }
 632         });
 633     }
 634
 635     private AbstractConcurrentDataBrokerTest newDataBrokerTest() throws Exception {
 636         AbstractConcurrentDataBrokerTest dataBrokerTest = new AbstractConcurrentDataBrokerTest(true) {
 637             @Override
 638             protected Set<YangModuleInfo> getModuleInfos() throws Exception {
 639                 return ImmutableSet.of(BindingReflections.getModuleInfo(NetconfNode.class),
 640                         BindingReflections.getModuleInfo(NetworkTopology.class),
 641                         BindingReflections.getModuleInfo(Topology.class),
 642                         BindingReflections.getModuleInfo(Keystore.class),
 643                         topModuleInfo);
 644             }
 645         };
 646
 647         dataBrokerTest.setup();
 648         return dataBrokerTest;
 649     }
 650
 651     private void awaitMountPointNotPresent(final DOMMountPointService mountPointService) {
 652         await().atMost(5, TimeUnit.SECONDS).until(
 653             () -> !mountPointService.getMountPoint(yangNodeInstanceId).isPresent());
 654     }
 655
 656     private static DOMDataBroker getDOMDataBroker(final DOMMountPoint mountPoint) {
 657         return getMountPointService(mountPoint, DOMDataBroker.class);
 658     }
 659
 660     private static DOMRpcService getDOMRpcService(final DOMMountPoint mountPoint) {
 661         return getMountPointService(mountPoint, DOMRpcService.class);
 662     }
 663
 664     private static DOMActionService getDomActionService(final DOMMountPoint mountPoint) {
 665         return getMountPointService(mountPoint, DOMActionService.class);
 666     }
 667
 668     private static <T extends DOMService> T getMountPointService(final DOMMountPoint mountPoint,
 669             final Class<T> serviceClass) {
 670         final Optional<T> maybeService = mountPoint.getService(serviceClass);
 671         assertTrue(maybeService.isPresent());
 672         return maybeService.get();
 673     }
 674
 675     private DOMMountPoint awaitMountPoint(final DOMMountPointService mountPointService) {
 676         await().atMost(5, TimeUnit.SECONDS).until(() ->
 677                 mountPointService.getMountPoint(yangNodeInstanceId).isPresent());
 678
 679         return mountPointService.getMountPoint(yangNodeInstanceId).get();
 680     }
 681
 682     private RpcDefinition findRpcDefinition(final String rpc) {
 683         Module topModule = deviceSchemaContext.findModule(TOP_MODULE_NAME, topModuleInfo.getName().getRevision()).get();
 684         RpcDefinition rpcDefinition = null;
 685         for (RpcDefinition def: topModule.getRpcs()) {
 686             if (def.getQName().getLocalName().equals(rpc)) {
 687                 rpcDefinition = def;
 688                 break;
 689             }
 690         }
 691
 692         assertNotNull(rpc + " rpc not found in " + topModule.getRpcs(), rpcDefinition);
 693         return rpcDefinition;
 694     }
 695
 696     private static class TopDOMRpcImplementation implements DOMRpcImplementation {
 697         private volatile SettableFuture<Entry<DOMRpcIdentifier, NormalizedNode<?, ?>>> rpcInvokedFuture;
 698         private volatile FluentFuture<DOMRpcResult> returnFuture;
 699
 700         @Override
 701         public FluentFuture<DOMRpcResult> invokeRpc(final DOMRpcIdentifier rpc,
 702                 final NormalizedNode<?, ?> input) {
 703             rpcInvokedFuture.set(new SimpleEntry<>(rpc, input));
 704             return returnFuture;
 705         }
 706
 707         void init(final FluentFuture<DOMRpcResult> retFuture) {
 708             this.returnFuture = retFuture;
 709             rpcInvokedFuture = SettableFuture.create();
 710         }
 711
 712         void verify(final DOMRpcIdentifier expRpc, final NormalizedNode<?, ?> expInput)
 713                 throws InterruptedException, ExecutionException, TimeoutException {
 714             final Entry<DOMRpcIdentifier, NormalizedNode<?, ?>> actual = rpcInvokedFuture.get(5, TimeUnit.SECONDS);
 715             assertEquals(expRpc, actual.getKey());
 716             assertEquals(expInput, actual.getValue());
 717         }
 718     }
 719 }