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