2 * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.sal.connect.netconf.sal.tx;
10 import static org.junit.Assert.fail;
11 import static org.mockito.ArgumentMatchers.any;
12 import static org.mockito.ArgumentMatchers.eq;
13 import static org.mockito.ArgumentMatchers.isNull;
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.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_CANDIDATE_QNAME;
21 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_FILTER_QNAME;
22 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME;
23 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath;
25 import com.google.common.util.concurrent.FluentFuture;
26 import java.net.InetSocketAddress;
27 import java.util.concurrent.ExecutionException;
28 import org.junit.Assert;
29 import org.junit.Before;
30 import org.junit.Test;
31 import org.mockito.ArgumentCaptor;
32 import org.mockito.InOrder;
33 import org.mockito.Mock;
34 import org.mockito.MockitoAnnotations;
35 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
36 import org.opendaylight.mdsal.dom.api.DOMRpcService;
37 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
38 import org.opendaylight.netconf.sal.connect.netconf.schema.mapping.BaseSchema;
39 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
40 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
41 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
43 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
44 import org.opendaylight.yangtools.yang.common.RpcError;
45 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
47 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
48 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
49 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
50 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
51 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
52 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
54 public class NetconfDeviceWriteOnlyTxTest {
56 private final RemoteDeviceId id = new RemoteDeviceId("test-mount", new InetSocketAddress(99));
59 private DOMRpcService rpc;
60 private YangInstanceIdentifier yangIId;
63 public void setUp() throws Exception {
64 MockitoAnnotations.initMocks(this);
66 final FluentFuture<DefaultDOMRpcResult> successFuture =
67 FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode<?, ?>) null));
69 doReturn(successFuture)
70 .doReturn(FluentFutures.immediateFailedFluentFuture(new IllegalStateException("Failed tx")))
71 .doReturn(successFuture)
72 .when(rpc).invokeRpc(any(SchemaPath.class), any(ContainerNode.class));
74 yangIId = YangInstanceIdentifier.builder().node(NetconfState.QNAME).build();
78 public void testIgnoreNonVisibleData() {
79 final WriteCandidateTx tx = new WriteCandidateTx(id, new NetconfBaseOps(rpc, mock(EffectiveModelContext.class)),
81 final MapNode emptyList = ImmutableNodes.mapNodeBuilder(NETCONF_FILTER_QNAME).build();
82 tx.merge(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier
83 .create(new YangInstanceIdentifier.NodeIdentifier(NETCONF_FILTER_QNAME)), emptyList);
84 tx.put(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier
85 .create(new YangInstanceIdentifier.NodeIdentifier(NETCONF_FILTER_QNAME)), emptyList);
87 verify(rpc, atMost(1)).invokeRpc(any(SchemaPath.class), any(ContainerNode.class));
91 public void testDiscardChanges() throws InterruptedException {
92 doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode<?, ?>) null)))
93 .when(rpc).invokeRpc(any(SchemaPath.class), isNull());
95 final WriteCandidateTx tx = new WriteCandidateTx(id, new NetconfBaseOps(rpc, mock(EffectiveModelContext.class)),
99 } catch (final ExecutionException e) {
100 // verify discard changes was sent
101 final InOrder inOrder = inOrder(rpc);
102 inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_LOCK_QNAME),
103 NetconfBaseOps.getLockContent(NETCONF_CANDIDATE_QNAME));
104 inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME),
105 NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
106 inOrder.verify(rpc).invokeRpc(eq(toPath(NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME)),
108 inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_UNLOCK_QNAME),
109 NetconfBaseOps.getUnLockContent(NETCONF_CANDIDATE_QNAME));
113 fail("Submit should fail");
117 public void testFailedCommit() throws Exception {
118 final FluentFuture<DefaultDOMRpcResult> rpcErrorFuture = FluentFutures.immediateFluentFuture(
119 new DefaultDOMRpcResult(RpcResultBuilder.newError(RpcError.ErrorType.APPLICATION, "a", "m")));
121 doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode<?, ?>) null)))
122 .doReturn(rpcErrorFuture).when(rpc).invokeRpc(any(SchemaPath.class), any(ContainerNode.class));
124 final WriteCandidateTx tx = new WriteCandidateTx(id, new NetconfBaseOps(rpc, mock(EffectiveModelContext.class)),
129 fail("Submit should fail");
130 } catch (final ExecutionException e) {
136 public void testDiscardChangesNotSentWithoutCandidate() {
137 doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode<?, ?>) null)))
138 .doReturn(FluentFutures.immediateFailedFluentFuture(new IllegalStateException("Failed tx")))
139 .when(rpc).invokeRpc(any(SchemaPath.class), any(ContainerNode.class));
141 final WriteRunningTx tx = new WriteRunningTx(id,
142 new NetconfBaseOps(rpc, BaseSchema.BASE_NETCONF_CTX_WITH_NOTIFICATIONS.getEffectiveModelContext()), false);
144 tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
146 // verify discard changes was sent
147 final InOrder inOrder = inOrder(rpc);
148 inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_LOCK_QNAME),
149 NetconfBaseOps.getLockContent(NETCONF_RUNNING_QNAME));
150 inOrder.verify(rpc).invokeRpc(eq(toPath(NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME)),
151 any(ContainerNode.class));
152 inOrder.verify(rpc).invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_UNLOCK_QNAME),
153 NetconfBaseOps.getUnLockContent(NETCONF_RUNNING_QNAME));
157 public void testListenerSuccess() throws Exception {
158 doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode<?, ?>) null)))
159 .when(rpc).invokeRpc(any(SchemaPath.class), any(ContainerNode.class));
160 final WriteCandidateTx tx = new WriteCandidateTx(
161 id, new NetconfBaseOps(rpc, BaseSchema.BASE_NETCONF_CTX.getEffectiveModelContext()), false);
162 final TxListener listener = mock(TxListener.class);
163 tx.addListener(listener);
164 tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
166 verify(listener).onTransactionSubmitted(tx);
167 verify(listener).onTransactionSuccessful(tx);
168 verify(listener, never()).onTransactionFailed(eq(tx), any());
169 verify(listener, never()).onTransactionCancelled(tx);
173 public void testListenerCancellation() throws Exception {
174 doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult((NormalizedNode<?, ?>) null)))
175 .when(rpc).invokeRpc(any(SchemaPath.class), isNull());
176 final WriteCandidateTx tx = new WriteCandidateTx(
177 id, new NetconfBaseOps(rpc, BaseSchema.BASE_NETCONF_CTX.getEffectiveModelContext()), false);
178 final TxListener listener = mock(TxListener.class);
179 tx.addListener(listener);
180 tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
182 verify(listener).onTransactionCancelled(tx);
183 verify(listener, never()).onTransactionSubmitted(tx);
184 verify(listener, never()).onTransactionSuccessful(tx);
185 verify(listener, never()).onTransactionFailed(eq(tx), any());
189 public void testListenerFailure() throws Exception {
190 final IllegalStateException cause = new IllegalStateException("Failed tx");
191 doReturn(FluentFutures.immediateFailedFluentFuture(cause))
192 .when(rpc).invokeRpc(any(SchemaPath.class), any(ContainerNode.class));
193 final WriteCandidateTx tx = new WriteCandidateTx(
194 id, new NetconfBaseOps(rpc, BaseSchema.BASE_NETCONF_CTX.getEffectiveModelContext()), false);
195 final TxListener listener = mock(TxListener.class);
196 tx.addListener(listener);
197 tx.delete(LogicalDatastoreType.CONFIGURATION, yangIId);
199 final ArgumentCaptor<Exception> excCaptor = ArgumentCaptor.forClass(Exception.class);
200 verify(listener).onTransactionSubmitted(tx);
201 verify(listener).onTransactionFailed(eq(tx), excCaptor.capture());
202 Assert.assertEquals(cause, excCaptor.getValue().getCause().getCause());
203 verify(listener, never()).onTransactionSuccessful(tx);
204 verify(listener, never()).onTransactionCancelled(tx);