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