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