2 * Copyright (c) 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
9 package org.opendaylight.openflowplugin.impl.device;
11 import com.google.common.base.Optional;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import com.google.common.util.concurrent.Futures;
14 import org.junit.After;
15 import org.junit.Before;
16 import org.junit.Test;
17 import org.junit.runner.RunWith;
18 import org.mockito.Matchers;
19 import org.mockito.Mock;
20 import org.mockito.Mockito;
21 import org.mockito.runners.MockitoJUnitRunner;
22 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
23 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
24 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
25 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
26 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
28 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
29 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
30 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
31 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
32 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
33 import org.opendaylight.openflowplugin.common.txchain.TransactionChainManager;
34 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
41 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
43 @RunWith(MockitoJUnitRunner.class)
44 public class TransactionChainManagerTest {
47 private DataBroker dataBroker;
49 private BindingTransactionChain txChain;
51 private ReadWriteTransaction writeTx;
53 private TransactionChain<?, ?> transactionChain;
55 DeviceInfo deviceInfo;
58 private KeyedInstanceIdentifier<Node, NodeKey> nodeKeyIdent;
60 private TransactionChainManager txChainManager;
61 private InstanceIdentifier<Node> path;
62 private NodeId nodeId;
65 public void setUp() throws Exception {
66 final ReadOnlyTransaction readOnlyTx = Mockito.mock(ReadOnlyTransaction.class);
67 final CheckedFuture<Optional<Node>, ReadFailedException> noExistNodeFuture =
68 Futures.immediateCheckedFuture(Optional.<Node>absent());
69 Mockito.when(readOnlyTx.read(LogicalDatastoreType.OPERATIONAL, nodeKeyIdent)).thenReturn(noExistNodeFuture);
70 Mockito.when(dataBroker.newReadOnlyTransaction()).thenReturn(readOnlyTx);
71 Mockito.when(dataBroker.createTransactionChain(Matchers.any(TransactionChainListener.class)))
73 nodeId = new NodeId("h2g2:42");
74 nodeKeyIdent = DeviceStateUtil.createNodeInstanceIdentifier(nodeId);
75 Mockito.when(deviceInfo.getNodeInstanceIdentifier()).thenReturn(nodeKeyIdent);
76 Mockito.when(deviceInfo.getNodeId()).thenReturn(nodeId);
77 txChainManager = new TransactionChainManager(dataBroker, nodeId.getValue());
78 Mockito.when(txChain.newReadWriteTransaction()).thenReturn(writeTx);
80 path = InstanceIdentifier.create(Nodes.class).child(Node.class, new NodeKey(nodeId));
81 Mockito.when(writeTx.submit())
82 .thenReturn(Futures.<Void, TransactionCommitFailedException>immediateCheckedFuture(null));
83 txChainManager.activateTransactionManager();
87 public void tearDown() throws Exception {
88 Mockito.verifyNoMoreInteractions(txChain, writeTx);
92 public void testWriteToTransaction() throws Exception {
93 final Node data = new NodeBuilder().setId(nodeId).build();
94 txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data, false);
96 Mockito.verify(txChain).newReadWriteTransaction();
97 Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data, false);
101 * test of {@link TransactionChainManager#submitTransaction()}
105 public void testSubmitTransaction() throws Exception {
106 final Node data = new NodeBuilder().setId(nodeId).build();
107 txChainManager.initialSubmitWriteTransaction();
108 txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data, false);
109 txChainManager.submitTransaction();
111 Mockito.verify(txChain).newReadWriteTransaction();
112 Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data, false);
113 Mockito.verify(writeTx).submit();
117 * test of {@link TransactionChainManager#submitTransaction()}: no submit, never enabled
121 public void testSubmitTransaction1() throws Exception {
122 final Node data = new NodeBuilder().setId(nodeId).build();
123 txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data, false);
124 txChainManager.submitTransaction();
126 Mockito.verify(txChain).newReadWriteTransaction();
127 Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data, false);
128 Mockito.verify(writeTx, Mockito.never()).submit();
132 public void testSubmitTransactionFailed() throws Exception {
133 Mockito.when(writeTx.submit()).thenReturn(Futures.<Void, TransactionCommitFailedException>immediateFailedCheckedFuture(new TransactionCommitFailedException("mock")));
134 final Node data = new NodeBuilder().setId(nodeId).build();
135 txChainManager.initialSubmitWriteTransaction();
136 txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data, false);
137 txChainManager.submitTransaction();
139 Mockito.verify(txChain).newReadWriteTransaction();
140 Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data, false);
141 Mockito.verify(writeTx).submit();
145 * Test of {@link TransactionChainManager#enableSubmit()}: no submit - counter is not active.
148 public void testEnableCounter1() throws Exception {
149 final Node data = new NodeBuilder().setId(nodeId).build();
150 txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data, false);
151 txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data, false);
153 Mockito.verify(txChain).newReadWriteTransaction();
154 Mockito.verify(writeTx, Mockito.times(2)).put(LogicalDatastoreType.CONFIGURATION, path, data, false);
155 Mockito.verify(writeTx, Mockito.never()).submit();
159 public void testOnTransactionChainFailed() throws Exception {
160 txChainManager.onTransactionChainFailed(txChain, Mockito.mock(AsyncTransaction.class), Mockito.mock(Throwable.class));
161 Mockito.verify(txChain).close();
162 Mockito.verify(dataBroker, Mockito.times(2)).createTransactionChain(txChainManager);
166 public void testOnTransactionChainSuccessful() throws Exception {
167 txChainManager.onTransactionChainSuccessful(transactionChain);
169 Mockito.verifyZeroInteractions(transactionChain);
173 public void testAddDeleteOperationTotTxChain() throws Exception {
174 txChainManager.addDeleteOperationTotTxChain(LogicalDatastoreType.CONFIGURATION, path);
176 Mockito.verify(txChain).newReadWriteTransaction();
177 Mockito.verify(writeTx).delete(LogicalDatastoreType.CONFIGURATION, path);
181 public void testDeactivateTransactionChainManager() throws Exception {
182 txChainManager.deactivateTransactionManager();
184 Mockito.verify(txChain).close();
188 public void testDeactivateTransactionChainManagerFailed() throws Exception {
189 Mockito.when(writeTx.submit())
190 .thenReturn(Futures.<Void, TransactionCommitFailedException>immediateFailedCheckedFuture(
191 new TransactionCommitFailedException("mock")));
192 final Node data = new NodeBuilder().setId(nodeId).build();
193 txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data, false);
195 txChainManager.deactivateTransactionManager();
197 Mockito.verify(txChain).newReadWriteTransaction();
198 Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data, false);
199 Mockito.verify(writeTx, Mockito.never()).submit();
200 Mockito.verify(writeTx).cancel();
201 Mockito.verify(txChain).close();
205 public void testShuttingDown() throws Exception {
206 final Node data = new NodeBuilder().setId(nodeId).build();
207 txChainManager.initialSubmitWriteTransaction();
208 txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data, false);
209 txChainManager.shuttingDown();
211 Mockito.verify(txChain).newReadWriteTransaction();
212 Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data, false);
213 Mockito.verify(writeTx).submit();
217 public void testClose() {
218 txChainManager.shuttingDown();
219 txChainManager.close();
220 Mockito.verify(txChain).close();