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.Assert;
  17 import org.junit.Before;
  18 import org.junit.Test;
  19 import org.junit.runner.RunWith;
  20 import org.mockito.InOrder;
  21 import org.mockito.Matchers;
  22 import org.mockito.Mock;
  23 import org.mockito.Mockito;
  24 import org.mockito.runners.MockitoJUnitRunner;
  25 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  26 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  27 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  28 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  29 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  31 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  32 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  33 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  34 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  35 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  36 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  42 import org.opendaylight.yangtools.concepts.Registration;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  45
  46 /**
  47  * Created by mirehak on 4/5/15.
  48  */
  49 @RunWith(MockitoJUnitRunner.class)
  50 public class TransactionChainManagerTest {
  51
  52     @Mock
  53     private DataBroker dataBroker;
  54     @Mock
  55     private ConnectionContext connectionContext;
  56     @Mock
  57     private BindingTransactionChain txChain;
  58     @Mock
  59     private WriteTransaction writeTx;
  60     @Mock
  61     private TransactionChain<?, ?> transactionChain;
  62     @Mock
  63     HashedWheelTimer timer;
  64     @Mock
  65     Registration registration;
  66     @Mock
  67     private ReadyForNewTransactionChainHandler readyForNewTransactionChainHandler;
  68
  69     @Mock
  70     private KeyedInstanceIdentifier<Node, NodeKey> nodeKeyIdent;
  71
  72     private TransactionChainManager txChainManager;
  73     private InstanceIdentifier<Node> path;
  74     private NodeId nodeId;
  75
  76     @Before
  77     public void setUp() throws Exception {
  78         final ReadOnlyTransaction readOnlyTx = Mockito.mock(ReadOnlyTransaction.class);
  79         final CheckedFuture<Optional<Node>, ReadFailedException> noExistNodeFuture = Futures.immediateCheckedFuture(Optional.<Node>absent());
  80         Mockito.when(readOnlyTx.read(LogicalDatastoreType.OPERATIONAL, nodeKeyIdent)).thenReturn(noExistNodeFuture);
  81         Mockito.when(dataBroker.newReadOnlyTransaction()).thenReturn(readOnlyTx);
  82         Mockito.when(dataBroker.createTransactionChain(Matchers.any(TransactionChainListener.class)))
  83                 .thenReturn(txChain);
  84         nodeId = new NodeId("h2g2:42");
  85         nodeKeyIdent = DeviceStateUtil.createNodeInstanceIdentifier(nodeId);
  86         txChainManager = new TransactionChainManager(dataBroker, nodeKeyIdent, registration);
  87         Mockito.when(txChain.newWriteOnlyTransaction()).thenReturn(writeTx);
  88
  89         path = InstanceIdentifier.create(Nodes.class).child(Node.class, new NodeKey(nodeId));
  90         Mockito.when(writeTx.submit()).thenReturn(Futures.<Void, TransactionCommitFailedException>immediateCheckedFuture(null));
  91         Assert.assertEquals(TransactionChainManager.TransactionChainManagerStatus.WORKING, txChainManager.getTransactionChainManagerStatus());
  92     }
  93
  94     @After
  95     public void tearDown() throws Exception {
  96         Mockito.verifyNoMoreInteractions(txChain, writeTx);
  97     }
  98
  99     @Test
 100     public void testWriteToTransaction() throws Exception {
 101         final Node data = new NodeBuilder().setId(nodeId).build();
 102         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 103
 104         Mockito.verify(txChain).newWriteOnlyTransaction();
 105         Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data);
 106     }
 107
 108     @Test
 109     public void testSubmitTransaction() throws Exception {
 110         final Node data = new NodeBuilder().setId(nodeId).build();
 111         txChainManager.enableSubmit();
 112         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 113         txChainManager.submitWriteTransaction();
 114
 115         Mockito.verify(txChain).newWriteOnlyTransaction();
 116         Mockito.verify(writeTx).put(LogicalDatastoreType.CONFIGURATION, path, data);
 117         Mockito.verify(writeTx).submit();
 118     }
 119
 120     /**
 121      * test of {@link TransactionChainManager#enableSubmit()}: no submit - counter is not active
 122      *
 123      * @throws Exception
 124      */
 125     @Test
 126     public void testEnableCounter1() throws Exception {
 127         final Node data = new NodeBuilder().setId(nodeId).build();
 128         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 129         txChainManager.writeToTransaction(LogicalDatastoreType.CONFIGURATION, path, data);
 130
 131         Mockito.verify(txChain).newWriteOnlyTransaction();
 132         Mockito.verify(writeTx, Mockito.times(2)).put(LogicalDatastoreType.CONFIGURATION, path, data);
 133         Mockito.verify(writeTx, Mockito.never()).submit();
 134     }
 135
 136     @Test
 137     public void testOnTransactionChainFailed() throws Exception {
 138         txChainManager.onTransactionChainFailed(transactionChain, Mockito.mock(AsyncTransaction.class), Mockito.mock(Throwable.class));
 139
 140         Mockito.verify(txChain).close();
 141         Mockito.verify(dataBroker, Mockito.times(2)).createTransactionChain(txChainManager);
 142     }
 143
 144     @Test
 145     public void testOnTransactionChainSuccessful() throws Exception {
 146         txChainManager.onTransactionChainSuccessful(transactionChain);
 147         // NOOP
 148         Mockito.verifyZeroInteractions(transactionChain);
 149     }
 150
 151     @Test
 152     public void testAddDeleteOperationTotTxChain() throws Exception {
 153         txChainManager.addDeleteOperationTotTxChain(LogicalDatastoreType.CONFIGURATION, path);
 154
 155         Mockito.verify(txChain).newWriteOnlyTransaction();
 156         Mockito.verify(writeTx).delete(LogicalDatastoreType.CONFIGURATION, path);
 157     }
 158
 159     @Test
 160     public void testAttemptToRegisterHandler1() throws Exception {
 161         boolean attemptResult = txChainManager.attemptToRegisterHandler(readyForNewTransactionChainHandler);
 162         Assert.assertFalse(attemptResult);
 163     }
 164
 165     @Test
 166     public void testAttemptToRegisterHandler2() throws Exception {
 167         final InOrder inOrder = Mockito.inOrder(writeTx, txChain);
 168
 169         txChainManager.close();
 170         Assert.assertEquals(TransactionChainManager.TransactionChainManagerStatus.SHUTTING_DOWN, txChainManager.getTransactionChainManagerStatus());
 171
 172         boolean attemptResult = txChainManager.attemptToRegisterHandler(readyForNewTransactionChainHandler);
 173         Assert.assertTrue(attemptResult);
 174         //TODO: uncomment when txChainManager fixed (BUG-4328)
 175         //Assert.assertEquals(TransactionChainManager.TransactionChainManagerStatus.WORKING, txChainManager.getTransactionChainManagerStatus());
 176
 177         inOrder.verify(txChain).newWriteOnlyTransaction();
 178         inOrder.verify(writeTx).delete(LogicalDatastoreType.OPERATIONAL, path);
 179         inOrder.verify(writeTx).submit();
 180         inOrder.verify(txChain).close();
 181
 182         attemptResult = txChainManager.attemptToRegisterHandler(readyForNewTransactionChainHandler);
 183         Assert.assertFalse(attemptResult);
 184     }
 185 }