2 * Copyright (c) 2016 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
9 package org.opendaylight.netconf.topology.singleton.impl.tx;
11 import static junit.framework.TestCase.assertNull;
12 import static org.junit.Assert.assertEquals;
13 import static org.junit.Assert.assertTrue;
14 import static org.mockito.Matchers.any;
15 import static org.mockito.Mockito.doNothing;
16 import static org.mockito.Mockito.doReturn;
17 import static org.mockito.Mockito.mock;
18 import static org.mockito.Mockito.times;
19 import static org.mockito.Mockito.verify;
20 import static org.mockito.MockitoAnnotations.initMocks;
21 import static org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils.DEFAULT_SCHEMA_REPOSITORY;
23 import akka.actor.ActorRef;
24 import akka.actor.ActorSystem;
25 import akka.actor.Props;
26 import akka.pattern.Patterns;
27 import akka.testkit.JavaTestKit;
28 import akka.testkit.TestActorRef;
29 import akka.util.Timeout;
30 import com.google.common.collect.Lists;
31 import com.google.common.util.concurrent.CheckedFuture;
32 import com.google.common.util.concurrent.Futures;
33 import java.net.InetAddress;
34 import java.net.InetSocketAddress;
35 import java.net.UnknownHostException;
36 import java.util.List;
37 import java.util.concurrent.TimeUnit;
38 import org.junit.After;
39 import org.junit.Before;
40 import org.junit.Rule;
41 import org.junit.Test;
42 import org.junit.rules.ExpectedException;
43 import org.mockito.Mock;
44 import org.mockito.Mockito;
45 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
46 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
47 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
48 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
49 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
50 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
51 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
52 import org.opendaylight.netconf.topology.singleton.api.NetconfDOMTransaction;
53 import org.opendaylight.netconf.topology.singleton.impl.NetconfDOMDataBroker;
54 import org.opendaylight.netconf.topology.singleton.impl.actors.NetconfNodeActor;
55 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
56 import org.opendaylight.netconf.topology.singleton.messages.CreateInitialMasterActorData;
57 import org.opendaylight.netconf.topology.singleton.messages.MasterActorDataInitialized;
58 import org.opendaylight.yangtools.yang.common.QName;
59 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
60 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
61 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
62 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
63 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
64 import scala.concurrent.Await;
65 import scala.concurrent.Future;
66 import scala.concurrent.duration.Duration;
68 public class WriteOnlyTransactionTest {
69 private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
70 private static final int TIMEOUT_SEC = 5;
71 private static ActorSystem system;
74 public final ExpectedException exception = ExpectedException.none();
76 private ActorRef masterRef;
77 private NetconfDOMDataBroker slaveDataBroker;
78 private DOMDataBroker masterDataBroker;
79 private List<SourceIdentifier> sourceIdentifiers;
82 private DOMDataWriteTransaction writeTx;
85 private DOMRpcService domRpcService;
88 public void setup() throws UnknownHostException {
91 system = ActorSystem.create();
93 final RemoteDeviceId remoteDeviceId = new RemoteDeviceId("netconf-topology",
94 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
96 final NetconfTopologySetup setup = mock(NetconfTopologySetup.class);
97 final Props props = NetconfNodeActor.props(setup, remoteDeviceId, DEFAULT_SCHEMA_REPOSITORY,
98 DEFAULT_SCHEMA_REPOSITORY);
100 masterRef = TestActorRef.create(system, props, "master_read");
102 sourceIdentifiers = Lists.newArrayList();
104 // Create master data broker
106 final DOMDataBroker delegateDataBroker = mock(DOMDataBroker.class);
107 writeTx = mock(DOMDataWriteTransaction.class);
108 final DOMDataReadOnlyTransaction readTx = mock(DOMDataReadOnlyTransaction.class);
110 doReturn(writeTx).when(delegateDataBroker).newWriteOnlyTransaction();
111 doReturn(readTx).when(delegateDataBroker).newReadOnlyTransaction();
113 final NetconfDOMTransaction masterDOMTransactions =
114 new NetconfMasterDOMTransaction(remoteDeviceId, delegateDataBroker);
117 new NetconfDOMDataBroker(system, remoteDeviceId, masterDOMTransactions);
119 // Create slave data broker for testing proxy
121 final NetconfDOMTransaction proxyDOMTransactions =
122 new NetconfProxyDOMTransaction(remoteDeviceId, system, masterRef);
124 slaveDataBroker = new NetconfDOMDataBroker(system, remoteDeviceId, proxyDOMTransactions);
130 public void teardown() {
131 JavaTestKit.shutdownActorSystem(system);
136 public void testPutMergeDeleteCalls() throws Exception {
138 /* Initialize data on master */
140 initializeDataTest();
142 final YangInstanceIdentifier instanceIdentifier = YangInstanceIdentifier.EMPTY;
143 final LogicalDatastoreType storeType = LogicalDatastoreType.CONFIGURATION;
144 final NormalizedNode<?, ?> testNode = ImmutableContainerNodeBuilder.create()
145 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create("TestQname")))
146 .withChild(ImmutableNodes.leafNode(QName.create("NodeQname"), "foo")).build();
148 // Test of invoking put on master through slave proxy
150 doNothing().when(writeTx).put(storeType, instanceIdentifier, testNode);
152 DOMDataWriteTransaction wTx = slaveDataBroker.newWriteOnlyTransaction();
153 wTx.put(storeType, instanceIdentifier, testNode);
155 verify(writeTx, times(1)).put(storeType, instanceIdentifier, testNode);
158 // Test of invoking merge on master through slave proxy
160 doNothing().when(writeTx).merge(storeType, instanceIdentifier, testNode);
161 wTx = slaveDataBroker.newWriteOnlyTransaction();
162 wTx.merge(storeType, instanceIdentifier, testNode);
164 verify(writeTx, times(1)).merge(storeType, instanceIdentifier, testNode);
167 // Test of invoking delete on master through slave proxy
169 doNothing().when(writeTx).delete(storeType, instanceIdentifier);
170 wTx = slaveDataBroker.newWriteOnlyTransaction();
171 wTx.delete(storeType, instanceIdentifier);
174 verify(writeTx, times(1)).delete(storeType, instanceIdentifier);
179 public void testSubmit() throws Exception {
181 /* Initialize data on master */
183 initializeDataTest();
187 DOMDataWriteTransaction wTx = slaveDataBroker.newWriteOnlyTransaction();
188 final CheckedFuture<Void,TransactionCommitFailedException> resultSubmit = Futures.immediateCheckedFuture(null);
189 doReturn(resultSubmit).when(writeTx).submit();
191 final CheckedFuture<Void, TransactionCommitFailedException> resultSubmitResponse = wTx.submit();
193 final Object result = resultSubmitResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
198 wTx = slaveDataBroker.newWriteOnlyTransaction();
199 doNothing().when(writeTx).delete(any(), any());
200 wTx.delete(LogicalDatastoreType.CONFIGURATION,
201 YangInstanceIdentifier.EMPTY);
203 final CheckedFuture<Void,TransactionCommitFailedException> resultSubmitTx = Futures.immediateCheckedFuture(null);
204 doReturn(resultSubmitTx).when(writeTx).submit();
206 final CheckedFuture<Void, TransactionCommitFailedException> resultSubmitTxResponse = wTx.submit();
208 final Object resultTx = resultSubmitTxResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
210 assertNull(resultTx);
212 wTx = slaveDataBroker.newWriteOnlyTransaction();
213 wTx.delete(LogicalDatastoreType.CONFIGURATION,
214 YangInstanceIdentifier.EMPTY);
216 final TransactionCommitFailedException throwable = new TransactionCommitFailedException("Fail", null);
217 final CheckedFuture<Void,TransactionCommitFailedException> resultThrowable =
218 Futures.immediateFailedCheckedFuture(throwable);
220 doReturn(resultThrowable).when(writeTx).submit();
222 final CheckedFuture<Void, TransactionCommitFailedException> resultThrowableResponse =
225 exception.expect(TransactionCommitFailedException.class);
226 resultThrowableResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
230 public void testCancel() throws Exception {
232 /* Initialize data on master */
234 initializeDataTest();
238 DOMDataWriteTransaction wTx = slaveDataBroker.newWriteOnlyTransaction();
239 final Boolean resultFalseNoTx = wTx.cancel();
240 assertEquals(false, resultFalseNoTx);
242 // With Tx, readWriteTx test
244 wTx = slaveDataBroker.newWriteOnlyTransaction();
245 doNothing().when(writeTx).delete(any(), any());
246 wTx.delete(LogicalDatastoreType.CONFIGURATION,
247 YangInstanceIdentifier.EMPTY);
249 doReturn(true).when(writeTx).cancel();
250 final Boolean resultTrue = wTx.cancel();
251 assertEquals(true, resultTrue);
253 doReturn(false).when(writeTx).cancel();
255 final Boolean resultFalse = wTx.cancel();
256 assertEquals(false, resultFalse);
260 private void initializeDataTest() throws Exception {
261 final Future<Object> initialDataToActor =
262 Patterns.ask(masterRef, new CreateInitialMasterActorData(masterDataBroker, sourceIdentifiers,
263 domRpcService), TIMEOUT);
265 final Object success = Await.result(initialDataToActor, TIMEOUT.duration());
267 assertTrue(success instanceof MasterActorDataInitialized);