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