openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/device/TransactionChainManagerTest.java

   1 /*
   2  * Copyright (c) 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
   9 package org.opendaylight.openflowplugin.impl.device;
  10
  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 io.netty.util.HashedWheelTimer;
  15 import org.junit.After;
  16 import org.junit.Before;
  17 import org.junit.Ignore;
  18 import org.junit.Test;
  19 import org.junit.runner.RunWith;
  20 import org.mockito.Matchers;
  21 import org.mockito.Mock;
  22 import org.mockito.Mockito;
  23 import org.mockito.runners.MockitoJUnitRunner;
  24 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  25 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  26 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  27 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  28 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  29 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  30 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  31 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  32 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  33 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  34 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  35 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  36 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
  37 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  43 import org.opendaylight.yangtools.concepts.Registration;
  44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  45 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  46
  47 /**
  48  * Created by mirehak on 4/5/15.
  49  */
  50 @RunWith(MockitoJUnitRunner.class)
  51 public class TransactionChainManagerTest {
  52
  53     @Mock
  54     private DataBroker dataBroker;
  55     @Mock
  56     private ConnectionContext connectionContext;
  57     @Mock
  58     private BindingTransactionChain txChain;
  59     @Mock
  60     private WriteTransaction writeTx;
  61     @Mock
  62     private TransactionChain<?, ?> transactionChain;
  63     @Mock
  64     HashedWheelTimer timer;
  65     @Mock
  66     Registration registration;
  67     @Mock
  68     DeviceState deviceState;
  69     @Mock
  70     LifecycleConductor conductor;
  71
  72     @Mock
  73     private KeyedInstanceIdentifier<Node, NodeKey> nodeKeyIdent;
  74
  75     private TransactionChainManager txChainManager;
  76     private InstanceIdentifier<Node> path;
  77     private NodeId nodeId;
  78
  79     @Before
  80     public void setUp() throws Exception {
  81         final ReadOnlyTransaction readOnlyTx = Mockito.mock(ReadOnlyTransaction.class);
  82         final CheckedFuture<Optional<Node>, ReadFailedException> noExistNodeFuture = Futures.immediateCheckedFuture(Optional.<Node>absent());
  83         Mockito.when(readOnlyTx.read(LogicalDatastoreType.OPERATIONAL, nodeKeyIdent)).thenReturn(noExistNodeFuture);
  84         Mockito.when(dataBroker.newReadOnlyTransaction()).thenReturn(readOnlyTx);
  85         Mockito.when(dataBroker.createTransactionChain(Matchers.any(TransactionChainListener.class)))
  86                 .thenReturn(txChain);
  87         nodeId = new NodeId("h2g2:42");
  88         nodeKeyIdent = DeviceStateUtil.createNodeInstanceIdentifier(nodeId);
  89         Mockito.when(deviceState.getNodeInstanceIdentifier()).thenReturn(nodeKeyIdent);
  90         Mockito.when(deviceState.getNodeId()).thenReturn(nodeId);
  91         txChainManager = new TransactionChainManager(dataBroker, deviceState, conductor);
  92         Mockito.when(txChain.newWriteOnlyTransaction()).thenReturn(writeTx);
  93
  94         path = InstanceIdentifier.create(Nodes.class).child(Node.class, new NodeKey(nodeId));
  95         Mockito.when(writeTx.submit()).thenReturn(Futures.<Void, TransactionCommitFailedException>immediateCheckedFuture(null));
  96         txChainManager.activateTransactionManager();
  97     }
  98
  99     @After
 100     public void tearDown() throws Exception {
 101         Mockito.verifyNoMoreInteractions(txChain, writeTx);
 102     }
 103
 104     @Test
 105     public void testWriteToTransaction() throws Exception {
 106         final Node data = new NodeBuilder().setId(nodeId).build();
 107         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 108
 109         Mockito.verify(txChain).newWriteOnlyTransaction();
 110         Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data);
 111     }
 112
 113     /**
 114      * test of {@link TransactionChainManager#submitWriteTransaction()}
 115      * @throws Exception
 116      */
 117     @Test
 118     public void testSubmitTransaction() throws Exception {
 119         final Node data = new NodeBuilder().setId(nodeId).build();
 120         txChainManager.initialSubmitWriteTransaction();
 121         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 122         txChainManager.submitWriteTransaction();
 123
 124         Mockito.verify(txChain).newWriteOnlyTransaction();
 125         Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data);
 126         Mockito.verify(writeTx).submit();
 127     }
 128
 129     /**
 130      * test of {@link TransactionChainManager#submitWriteTransaction()}: no submit, never enabled
 131      * @throws Exception
 132      */
 133     @Test
 134     public void testSubmitTransaction1() throws Exception {
 135         final Node data = new NodeBuilder().setId(nodeId).build();
 136         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 137         txChainManager.submitWriteTransaction();
 138
 139         Mockito.verify(txChain).newWriteOnlyTransaction();
 140         Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data);
 141         Mockito.verify(writeTx, Mockito.never()).submit();
 142     }
 143
 144     /**
 145      * @throws Exception
 146      */
 147     @Test
 148     public void testSubmitTransactionFailed() throws Exception {
 149         Mockito.when(writeTx.submit()).thenReturn(Futures.<Void, TransactionCommitFailedException>immediateFailedCheckedFuture(new TransactionCommitFailedException("mock")));
 150         final Node data = new NodeBuilder().setId(nodeId).build();
 151         txChainManager.initialSubmitWriteTransaction();
 152         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 153         txChainManager.submitWriteTransaction();
 154
 155         Mockito.verify(txChain).newWriteOnlyTransaction();
 156         Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data);
 157         Mockito.verify(writeTx).submit();
 158     }
 159
 160     /**
 161      * test of {@link TransactionChainManager#enableSubmit()}: no submit - counter is not active
 162      *
 163      * @throws Exception
 164      */
 165     @Test
 166     public void testEnableCounter1() throws Exception {
 167         final Node data = new NodeBuilder().setId(nodeId).build();
 168         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 169         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 170
 171         Mockito.verify(txChain).newWriteOnlyTransaction();
 172         Mockito.verify(writeTx, Mockito.times(2)).put(LogicalDatastoreType.CONFIGURATION, path, data);
 173         Mockito.verify(writeTx, Mockito.never()).submit();
 174     }
 175
 176     /**
 177      * @throws Exception
 178      */
 179     @Test
 180     public void testOnTransactionChainFailed() throws Exception {
 181         txChainManager.onTransactionChainFailed(transactionChain, Mockito.mock(AsyncTransaction.class), Mockito.mock(Throwable.class));
 182         Mockito.verify(txChain).close();
 183         Mockito.verify(dataBroker, Mockito.times(2)).createTransactionChain(txChainManager);
 184     }
 185
 186     @Test
 187     public void testOnTransactionChainSuccessful() throws Exception {
 188         txChainManager.onTransactionChainSuccessful(transactionChain);
 189         // NOOP
 190         Mockito.verifyZeroInteractions(transactionChain);
 191     }
 192
 193     @Test
 194     public void testAddDeleteOperationTotTxChain() throws Exception {
 195         txChainManager.addDeleteOperationTotTxChain(LogicalDatastoreType.CONFIGURATION, path);
 196
 197         Mockito.verify(txChain).newWriteOnlyTransaction();
 198         Mockito.verify(writeTx).delete(LogicalDatastoreType.CONFIGURATION, path);
 199     }
 200
 201     @Test
 202     public void testDeactivateTransactionChainManager() throws Exception {
 203         txChainManager.deactivateTransactionManager();
 204
 205         Mockito.verify(txChain).close();
 206     }
 207
 208     /**
 209      * @throws Exception
 210      */
 211     @Test
 212     public void testDeactivateTransactionChainManagerFailed() throws Exception {
 213         Mockito.when(writeTx.submit()).thenReturn(Futures.<Void, TransactionCommitFailedException>immediateFailedCheckedFuture(new TransactionCommitFailedException("mock")));
 214         final Node data = new NodeBuilder().setId(nodeId).build();
 215         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 216
 217         txChainManager.deactivateTransactionManager();
 218
 219         Mockito.verify(txChain).newWriteOnlyTransaction();
 220         Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data);
 221         Mockito.verify(writeTx).submit();
 222         Mockito.verify(txChain).close();
 223     }
 224
 225     @Test
 226     public void testShuttingDown() throws Exception{
 227         final Node data = new NodeBuilder().setId(nodeId).build();
 228         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 229
 230         txChainManager.shuttingDown();
 231
 232         Mockito.verify(txChain).newWriteOnlyTransaction();
 233         Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data);
 234         Mockito.verify(writeTx).submit();
 235     }
 236
 237     @Test
 238     public void testClose() {
 239         txChainManager.shuttingDown();
 240         txChainManager.close();
 241         Mockito.verify(txChain).close();
 242     }
 243 }