plugins/netconf-client-mdsal/src/test/java/org/opendaylight/netconf/client/mdsal/spi/NetconfDeviceWriteOnlyTxTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. 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.client.mdsal.spi;
   9
  10 import static org.junit.jupiter.api.Assertions.assertEquals;
  11 import static org.junit.jupiter.api.Assertions.assertThrows;
  12 import static org.mockito.ArgumentMatchers.any;
  13 import static org.mockito.ArgumentMatchers.eq;
  14 import static org.mockito.Mockito.atMost;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.inOrder;
  17 import static org.mockito.Mockito.mock;
  18 import static org.mockito.Mockito.never;
  19 import static org.mockito.Mockito.verify;
  20 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.DISCARD_CHANGES_RPC_CONTENT;
  21 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_CANDIDATE_NODEID;
  22 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_RUNNING_NODEID;
  23
  24 import com.google.common.util.concurrent.Futures;
  25 import java.net.InetSocketAddress;
  26 import java.util.Set;
  27 import java.util.concurrent.ExecutionException;
  28 import org.junit.jupiter.api.Test;
  29 import org.junit.jupiter.api.extension.ExtendWith;
  30 import org.mockito.ArgumentCaptor;
  31 import org.mockito.Mock;
  32 import org.mockito.junit.jupiter.MockitoExtension;
  33 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  34 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  35 import org.opendaylight.netconf.api.CapabilityURN;
  36 import org.opendaylight.netconf.client.mdsal.AbstractBaseSchemasTest;
  37 import org.opendaylight.netconf.client.mdsal.api.NetconfSessionPreferences;
  38 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
  39 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceServices.Rpcs;
  40 import org.opendaylight.netconf.client.mdsal.impl.NetconfBaseOps;
  41 import org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Commit;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.DiscardChanges;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.EditConfig;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Lock;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Unlock;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.get.input.Filter;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  49 import org.opendaylight.yangtools.yang.common.ErrorTag;
  50 import org.opendaylight.yangtools.yang.common.ErrorType;
  51 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  54 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  55 import org.opendaylight.yangtools.yang.data.api.schema.MountPointContext;
  56 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
  57
  58 @ExtendWith(MockitoExtension.class)
  59 class NetconfDeviceWriteOnlyTxTest extends AbstractBaseSchemasTest {
  60     private static final RemoteDeviceId ID = new RemoteDeviceId("test-mount", new InetSocketAddress(99));
  61     private static final YangInstanceIdentifier STATE = YangInstanceIdentifier.of(NetconfState.QNAME);
  62
  63     @Mock
  64     private Rpcs.Normalized rpc;
  65
  66     private void mockFuture() {
  67         final var successFuture = Futures.immediateFuture(new DefaultDOMRpcResult((ContainerNode) null));
  68         doReturn(successFuture, Futures.immediateFailedFuture(new IllegalStateException("Failed tx")), successFuture)
  69             .when(rpc).invokeNetconf(any(), any());
  70     }
  71
  72     private static MountPointContext baseMountPointContext() {
  73         return BASE_SCHEMAS.baseSchemaForCapabilities(NetconfSessionPreferences.fromStrings(Set.of(
  74             "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring?module=ietf-netconf-monitoring&revision=2010-10-04")))
  75             .mountPointContext();
  76     }
  77
  78     @Test
  79     void testIgnoreNonVisibleData() {
  80         mockFuture();
  81         final var tx = new WriteCandidateTx(ID, new NetconfBaseOps(rpc, mock(MountPointContext.class)), false, true);
  82         tx.init();
  83
  84         final var emptyList = ImmutableNodes.newSystemMapBuilder()
  85             .withNodeIdentifier(new NodeIdentifier(Filter.QNAME))
  86             .build();
  87         tx.merge(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.of(Filter.QNAME), emptyList);
  88         tx.put(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.of(Filter.QNAME), emptyList);
  89
  90         verify(rpc, atMost(1)).invokeNetconf(any(), any());
  91     }
  92
  93     @Test
  94     void testDiscardChanges() {
  95         mockFuture();
  96         final var tx = new WriteCandidateTx(ID, new NetconfBaseOps(rpc, mock(MountPointContext.class)), false, true);
  97         tx.init();
  98         final var future = tx.commit();
  99         assertThrows(ExecutionException.class, () -> Futures.getDone(future));
 100
 101         // verify discard changes was sent
 102         final var inOrder = inOrder(rpc);
 103         inOrder.verify(rpc).invokeNetconf(Lock.QNAME, NetconfBaseOps.getLockContent(NETCONF_CANDIDATE_NODEID));
 104         inOrder.verify(rpc).invokeNetconf(Commit.QNAME, NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
 105         inOrder.verify(rpc).invokeNetconf(DiscardChanges.QNAME, DISCARD_CHANGES_RPC_CONTENT);
 106         inOrder.verify(rpc).invokeNetconf(Unlock.QNAME, NetconfBaseOps.getUnLockContent(NETCONF_CANDIDATE_NODEID));
 107     }
 108
 109     @Test
 110     void testFailedCommit() {
 111         doReturn(
 112             Futures.immediateFuture(new DefaultDOMRpcResult((ContainerNode) null)),
 113             Futures.immediateFuture(new DefaultDOMRpcResult(RpcResultBuilder.newError(ErrorType.APPLICATION,
 114                 new ErrorTag("a"), "m"))))
 115             .when(rpc).invokeNetconf(any(), any());
 116
 117         final var tx = new WriteCandidateTx(ID, new NetconfBaseOps(rpc, mock(MountPointContext.class)), false, true);
 118         tx.init();
 119
 120         final var future = tx.commit();
 121         assertThrows(ExecutionException.class, () -> Futures.getDone(future));
 122     }
 123
 124     @Test
 125     void testDiscardChangesNotSentWithoutCandidate() {
 126         doReturn(
 127             Futures.immediateFuture(new DefaultDOMRpcResult((ContainerNode) null)),
 128             Futures.immediateFailedFuture(new IllegalStateException("Failed tx")))
 129             .when(rpc).invokeNetconf(any(), any());
 130
 131         final var tx = new WriteRunningTx(ID, new NetconfBaseOps(rpc, BASE_SCHEMAS.baseSchemaForCapabilities(
 132             NetconfSessionPreferences.fromStrings(Set.of(CapabilityURN.NOTIFICATION,
 133                 "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring?module=ietf-netconf-monitoring"
 134                     + "&revision=2010-10-04"))).mountPointContext()), false, true);
 135         tx.init();
 136
 137         tx.delete(LogicalDatastoreType.CONFIGURATION, STATE);
 138         tx.commit();
 139         // verify discard changes was sent
 140         final var inOrder = inOrder(rpc);
 141         inOrder.verify(rpc).invokeNetconf(Lock.QNAME, NetconfBaseOps.getLockContent(NETCONF_RUNNING_NODEID));
 142         inOrder.verify(rpc).invokeNetconf(eq(EditConfig.QNAME), any());
 143         inOrder.verify(rpc).invokeNetconf(Unlock.QNAME, NetconfBaseOps.getUnLockContent(NETCONF_RUNNING_NODEID));
 144     }
 145
 146     @Test
 147     void testListenerSuccess() {
 148         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult((ContainerNode) null)))
 149             .when(rpc).invokeNetconf(any(), any());
 150         final var tx = new WriteCandidateTx(ID, new NetconfBaseOps(rpc, baseMountPointContext()), false, true);
 151         tx.init();
 152
 153         final var listener = mock(TxListener.class);
 154         tx.addListener(listener);
 155         tx.delete(LogicalDatastoreType.CONFIGURATION, STATE);
 156         tx.commit();
 157         verify(listener).onTransactionSubmitted(tx);
 158         verify(listener).onTransactionSuccessful(tx);
 159         verify(listener, never()).onTransactionFailed(eq(tx), any());
 160         verify(listener, never()).onTransactionCancelled(tx);
 161     }
 162
 163     @Test
 164     void testListenerCancellation() {
 165         mockFuture();
 166         final var tx = new WriteCandidateTx(ID, new NetconfBaseOps(rpc, baseMountPointContext()), false, true);
 167         tx.init();
 168
 169         final var listener = mock(TxListener.class);
 170         tx.addListener(listener);
 171         tx.delete(LogicalDatastoreType.CONFIGURATION, STATE);
 172         tx.cancel();
 173         verify(listener).onTransactionCancelled(tx);
 174         verify(listener, never()).onTransactionSubmitted(tx);
 175         verify(listener, never()).onTransactionSuccessful(tx);
 176         verify(listener, never()).onTransactionFailed(eq(tx), any());
 177     }
 178
 179     @Test
 180     void testListenerFailure() {
 181         final var cause = new IllegalStateException("Failed tx");
 182         doReturn(Futures.immediateFailedFuture(cause)).when(rpc).invokeNetconf(any(), any());
 183         final var tx = new WriteCandidateTx(ID, new NetconfBaseOps(rpc, baseMountPointContext()), false, true);
 184         tx.init();
 185
 186         final var listener = mock(TxListener.class);
 187         tx.addListener(listener);
 188         tx.delete(LogicalDatastoreType.CONFIGURATION, STATE);
 189         tx.commit();
 190         final var excCaptor = ArgumentCaptor.forClass(Exception.class);
 191         verify(listener).onTransactionSubmitted(tx);
 192         verify(listener).onTransactionFailed(eq(tx), excCaptor.capture());
 193         assertEquals(cause, excCaptor.getValue().getCause().getCause());
 194         verify(listener, never()).onTransactionSuccessful(tx);
 195         verify(listener, never()).onTransactionCancelled(tx);
 196     }
 197 }