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.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.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 RpcProviderService mockRpcProviderService;
 184     @Mock private DOMActionProviderService mockActionProviderRegistry;
 185     @Mock private NetconfClientDispatcher mockClientDispatcher;
 186     @Mock private AAAEncryptionService mockEncryptionService;
 187     @Mock private ThreadPool mockThreadPool;
 188     @Mock private ScheduledThreadPool mockKeepaliveExecutor;
 189     @Mock private DeviceActionFactory deviceActionFactory;
 190
 191     @Mock private ActorSystemProvider mockMasterActorSystemProvider;
 192     @Mock private DOMMountPointListener masterMountPointListener;
 193     private final DOMMountPointService masterMountPointService = new DOMMountPointServiceImpl();
 194     private final DOMRpcRouter deviceRpcService = new DOMRpcRouter();
 195     private DOMClusterSingletonServiceProviderImpl masterClusterSingletonServiceProvider;
 196     private DataBroker masterDataBroker;
 197     private DOMDataBroker deviceDOMDataBroker;
 198     private ActorSystem masterSystem;
 199     private NetconfTopologyManager masterNetconfTopologyManager;
 200     private volatile SettableFuture<MasterSalFacade> masterSalFacadeFuture = SettableFuture.create();
 201
 202     @Mock private ActorSystemProvider mockSlaveActorSystemProvider;
 203     @Mock private ClusterSingletonServiceProvider mockSlaveClusterSingletonServiceProvider;
 204     @Mock private ClusterSingletonServiceRegistration mockSlaveClusterSingletonServiceReg;
 205     @Mock private DOMMountPointListener slaveMountPointListener;
 206     private final DOMMountPointService slaveMountPointService = new DOMMountPointServiceImpl();
 207     private DataBroker slaveDataBroker;
 208     private ActorSystem slaveSystem;
 209     private NetconfTopologyManager slaveNetconfTopologyManager;
 210     private final SettableFuture<NetconfTopologyContext> slaveNetconfTopologyContextFuture = SettableFuture.create();
 211     private TransactionChain slaveTxChain;
 212
 213     private final EventExecutor eventExecutor = GlobalEventExecutor.INSTANCE;
 214     private final Config config = new ConfigBuilder().setWriteTransactionIdleTimeout(Uint16.ZERO).build();
 215     private EffectiveModelContext deviceSchemaContext;
 216     private YangModuleInfo topModuleInfo;
 217     private QName putTopRpcSchemaPath;
 218     private QName getTopRpcSchemaPath;
 219     private BindingNormalizedNodeSerializer bindingToNormalized;
 220     private YangInstanceIdentifier yangNodeInstanceId;
 221     private final TopDOMRpcImplementation topRpcImplementation = new TopDOMRpcImplementation();
 222     private final ContainerNode getTopInput = ImmutableNodes.containerNode(GetTopInput.QNAME);
 223
 224     private SchemaResourceManager resourceManager;
 225
 226     @SuppressWarnings({ "unchecked", "rawtypes" })
 227     @Before
 228     public void setUp() throws Exception {
 229         deleteCacheDir();
 230
 231         resourceManager = new DefaultSchemaResourceManager(new YangParserFactoryImpl(), TEST_ROOT_DIRECTORY,
 232             TEST_DEFAULT_SUBDIR);
 233
 234         topModuleInfo = BindingReflections.getModuleInfo(Top.class);
 235
 236         deviceSchemaContext = BindingRuntimeHelpers.createEffectiveModel(Top.class);
 237
 238         deviceRpcService.onModelContextUpdated(deviceSchemaContext);
 239
 240         putTopRpcSchemaPath = findRpcDefinition("put-top").getQName();
 241         getTopRpcSchemaPath = findRpcDefinition("get-top").getQName();
 242
 243         deviceRpcService.getRpcProviderService().registerRpcImplementation(topRpcImplementation,
 244                 DOMRpcIdentifier.create(putTopRpcSchemaPath), DOMRpcIdentifier.create(getTopRpcSchemaPath));
 245
 246         setupMaster();
 247
 248         setupSlave();
 249
 250         yangNodeInstanceId = bindingToNormalized.toYangInstanceIdentifier(NODE_INSTANCE_ID);
 251
 252         doReturn(new SucceededFuture(GlobalEventExecutor.INSTANCE, null)).when(mockClientDispatcher)
 253                 .createReconnectingClient(any());
 254
 255         LOG.info("****** Setup complete");
 256     }
 257
 258     private static void deleteCacheDir() {
 259         FileUtils.deleteQuietly(new File(TEST_ROOT_DIRECTORY));
 260     }
 261
 262     @After
 263     public void tearDown() throws Exception {
 264         deleteCacheDir();
 265         TestKit.shutdownActorSystem(slaveSystem, true);
 266         TestKit.shutdownActorSystem(masterSystem, true);
 267     }
 268
 269     private void setupMaster() throws Exception {
 270         AbstractConcurrentDataBrokerTest dataBrokerTest = newDataBrokerTest();
 271         masterDataBroker = dataBrokerTest.getDataBroker();
 272         deviceDOMDataBroker = dataBrokerTest.getDomBroker();
 273         bindingToNormalized = dataBrokerTest.getDataBrokerTestCustomizer().getAdapterContext().currentSerializer();
 274
 275         masterSystem = ActorSystem.create(ACTOR_SYSTEM_NAME, ConfigFactory.load().getConfig("Master"));
 276
 277         masterClusterSingletonServiceProvider = new DOMClusterSingletonServiceProviderImpl();
 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                 mockRpcProviderService, 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, mockRpcProviderService, deviceActionFactory,
 336                 resourceManager) {
 337             @Override
 338             protected NetconfTopologyContext newNetconfTopologyContext(final NetconfTopologySetup setup,
 339                 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
 340                 final DeviceActionFactory actionFactory) {
 341                 NetconfTopologyContext spiedContext = spy(super.newNetconfTopologyContext(setup, serviceGroupIdent,
 342                     actorResponseWaitTime, actionFactory));
 343
 344                 slaveNetconfTopologyContextFuture.set(spiedContext);
 345                 return spiedContext;
 346             }
 347         };
 348
 349         slaveNetconfTopologyManager.init();
 350
 351         verifyTopologyNodesCreated(slaveDataBroker);
 352
 353         slaveTxChain = slaveDataBroker.createTransactionChain(new TransactionChainListener() {
 354             @Override
 355             public void onTransactionChainSuccessful(final TransactionChain chain) {
 356             }
 357
 358             @Override
 359             public void onTransactionChainFailed(final TransactionChain chain, final Transaction transaction,
 360                     final Throwable cause) {
 361                 LOG.error("Slave transaction chain failed", cause);
 362             }
 363         });
 364     }
 365
 366     @Test
 367     public void test() throws Exception {
 368         testMaster();
 369
 370         testSlave();
 371
 372         final MasterSalFacade masterSalFacade = testMasterNodeUpdated();
 373
 374         testMasterDisconnected(masterSalFacade);
 375
 376         testCleanup();
 377     }
 378
 379     private MasterSalFacade testMaster() throws InterruptedException, ExecutionException, TimeoutException {
 380         LOG.info("****** Testing master");
 381
 382         writeNetconfNode(TEST_DEFAULT_SUBDIR, masterDataBroker);
 383
 384         final MasterSalFacade masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
 385         final ArrayList<String> capabilities = Lists.newArrayList(
 386             NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
 387
 388         masterSalFacade.onDeviceConnected(new EmptyMountPointContext(deviceSchemaContext),
 389                 NetconfSessionPreferences.fromStrings(capabilities), deviceRpcService.getRpcService());
 390
 391         DOMMountPoint masterMountPoint = awaitMountPoint(masterMountPointService);
 392
 393         LOG.info("****** Testing master DOMDataBroker operations");
 394
 395         testDOMDataBrokerOperations(getDOMDataBroker(masterMountPoint));
 396
 397         LOG.info("****** Testing master DOMRpcService");
 398
 399         testDOMRpcService(getDOMRpcService(masterMountPoint));
 400         return masterSalFacade;
 401     }
 402
 403     private void testSlave() throws InterruptedException, ExecutionException, TimeoutException {
 404         LOG.info("****** Testing slave");
 405
 406         writeNetconfNode("slave", slaveDataBroker);
 407
 408         verify(mockSlaveClusterSingletonServiceProvider, timeout(5000)).registerClusterSingletonService(any());
 409
 410         // Since the master and slave use separate DataBrokers we need to copy the master's oper node to the slave.
 411         // This is essentially what happens in a clustered environment but we'll use a DTCL here.
 412
 413         masterDataBroker.registerDataTreeChangeListener(
 414             DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL, NODE_INSTANCE_ID), changes -> {
 415                 final WriteTransaction slaveTx = slaveTxChain.newWriteOnlyTransaction();
 416                 for (DataTreeModification<Node> dataTreeModification : changes) {
 417                     DataObjectModification<Node> rootNode = dataTreeModification.getRootNode();
 418                     InstanceIdentifier<Node> path = dataTreeModification.getRootPath().getRootIdentifier();
 419                     switch (rootNode.getModificationType()) {
 420                         case WRITE:
 421                         case SUBTREE_MODIFIED:
 422                             slaveTx.merge(LogicalDatastoreType.OPERATIONAL, path, rootNode.getDataAfter());
 423                             break;
 424                         case DELETE:
 425                             slaveTx.delete(LogicalDatastoreType.OPERATIONAL, path);
 426                             break;
 427                         default:
 428                             break;
 429                     }
 430                 }
 431
 432                 slaveTx.commit();
 433             });
 434
 435         DOMMountPoint slaveMountPoint = awaitMountPoint(slaveMountPointService);
 436
 437         final NetconfTopologyContext slaveNetconfTopologyContext =
 438                 slaveNetconfTopologyContextFuture.get(5, TimeUnit.SECONDS);
 439         verify(slaveNetconfTopologyContext, never()).newMasterSalFacade();
 440
 441         LOG.info("****** Testing slave DOMDataBroker operations");
 442
 443         testDOMDataBrokerOperations(getDOMDataBroker(slaveMountPoint));
 444
 445         LOG.info("****** Testing slave DOMRpcService");
 446
 447         testDOMRpcService(getDOMRpcService(slaveMountPoint));
 448     }
 449
 450     private MasterSalFacade testMasterNodeUpdated() throws InterruptedException, ExecutionException, TimeoutException {
 451         LOG.info("****** Testing update master node");
 452
 453         masterMountPointService.registerProvisionListener(masterMountPointListener);
 454         slaveMountPointService.registerProvisionListener(slaveMountPointListener);
 455
 456         masterSalFacadeFuture = SettableFuture.create();
 457         writeNetconfNode(TEST_DEFAULT_SUBDIR, masterDataBroker);
 458
 459         verify(masterMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
 460
 461         MasterSalFacade masterSalFacade = masterSalFacadeFuture.get(5, TimeUnit.SECONDS);
 462         final ArrayList<String> capabilities = Lists.newArrayList(
 463             NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
 464
 465         masterSalFacade.onDeviceConnected(new EmptyMountPointContext(deviceSchemaContext),
 466                 NetconfSessionPreferences.fromStrings(capabilities), deviceRpcService.getRpcService());
 467
 468         verify(masterMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
 469
 470         verify(slaveMountPointListener, timeout(5000)).onMountPointRemoved(yangNodeInstanceId);
 471         verify(slaveMountPointListener, timeout(5000)).onMountPointCreated(yangNodeInstanceId);
 472
 473         return masterSalFacade;
 474     }
 475
 476     private void testMasterDisconnected(final MasterSalFacade masterSalFacade)
 477             throws InterruptedException, ExecutionException, TimeoutException {
 478         LOG.info("****** Testing master disconnected");
 479
 480         masterSalFacade.onDeviceDisconnected();
 481
 482         awaitMountPointNotPresent(masterMountPointService);
 483
 484         await().atMost(5, TimeUnit.SECONDS).until(() -> {
 485             try (ReadTransaction readTx = masterDataBroker.newReadOnlyTransaction()) {
 486                 Optional<Node> node = readTx.read(LogicalDatastoreType.OPERATIONAL,
 487                         NODE_INSTANCE_ID).get(5, TimeUnit.SECONDS);
 488                 assertTrue(node.isPresent());
 489                 final NetconfNode netconfNode = node.get().augmentation(NetconfNode.class);
 490                 return netconfNode.getConnectionStatus() != NetconfNodeConnectionStatus.ConnectionStatus.Connected;
 491             }
 492         });
 493
 494         awaitMountPointNotPresent(slaveMountPointService);
 495     }
 496
 497     private void testCleanup() throws Exception {
 498         LOG.info("****** Testing cleanup");
 499
 500         slaveNetconfTopologyManager.close();
 501         verify(mockSlaveClusterSingletonServiceReg).close();
 502     }
 503
 504     private void testDOMRpcService(final DOMRpcService domRpcService)
 505             throws InterruptedException, ExecutionException, TimeoutException {
 506         testPutTopRpc(domRpcService, new DefaultDOMRpcResult((NormalizedNode<?, ?>)null));
 507         testPutTopRpc(domRpcService, null);
 508         testPutTopRpc(domRpcService, new DefaultDOMRpcResult(ImmutableList.of(
 509                 RpcResultBuilder.newError(ErrorType.APPLICATION, "tag1", "error1"),
 510                 RpcResultBuilder.newError(ErrorType.APPLICATION, "tag2", "error2"))));
 511
 512         testGetTopRpc(domRpcService, new DefaultDOMRpcResult(bindingToNormalized.toNormalizedNodeRpcData(
 513                 new GetTopOutputBuilder().setTopLevelList(oneTopLevelList()).build())));
 514
 515         testFailedRpc(domRpcService, getTopRpcSchemaPath, getTopInput);
 516     }
 517
 518     private void testPutTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
 519             throws InterruptedException, ExecutionException, TimeoutException {
 520         ContainerNode putTopInput = bindingToNormalized.toNormalizedNodeRpcData(
 521                 new PutTopInputBuilder().setTopLevelList(oneTopLevelList()).build());
 522         testRpc(domRpcService, putTopRpcSchemaPath, putTopInput, result);
 523     }
 524
 525     private static Map<TopLevelListKey, TopLevelList> oneTopLevelList() {
 526         final TopLevelListKey key = new TopLevelListKey("one");
 527         return ImmutableMap.of(key, new TopLevelListBuilder().withKey(key).build());
 528     }
 529
 530     private void testGetTopRpc(final DOMRpcService domRpcService, final DOMRpcResult result)
 531             throws InterruptedException, ExecutionException, TimeoutException {
 532         testRpc(domRpcService, getTopRpcSchemaPath, getTopInput, result);
 533     }
 534
 535     private void testRpc(final DOMRpcService domRpcService, final QName qname,
 536             final NormalizedNode<?, ?> input, final DOMRpcResult result) throws InterruptedException,
 537             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,
 565             final NormalizedNode<?, ?> input) 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,
 577             final NormalizedNode<?, ?> input, 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                 .setNodeId(NODE_ID)
 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).isPresent());
 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,
 736                 final NormalizedNode<?, ?> input) {
 737             rpcInvokedFuture.set(new SimpleEntry<>(rpc, input));
 738             return returnFuture;
 739         }
 740
 741         void init(final FluentFuture<DOMRpcResult> retFuture) {
 742             this.returnFuture = retFuture;
 743             rpcInvokedFuture = SettableFuture.create();
 744         }
 745
 746         void verify(final DOMRpcIdentifier expRpc, final NormalizedNode<?, ?> expInput)
 747                 throws InterruptedException, ExecutionException, TimeoutException {
 748             final Entry<DOMRpcIdentifier, NormalizedNode<?, ?>> actual = rpcInvokedFuture.get(5, TimeUnit.SECONDS);
 749             assertEquals(expRpc, actual.getKey());
 750             assertEquals(expInput, actual.getValue());
 751         }
 752     }
 753 }