opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/BrokerFacadeTest.java

   1 /*
   2  * Copyright (c) ${year} Brocade Communications 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.controller.sal.restconf.impl.test;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertSame;
  14 import static org.mockito.Matchers.any;
  15 import static org.mockito.Matchers.eq;
  16 import static org.mockito.Mockito.inOrder;
  17 import static org.mockito.Mockito.mock;
  18 import static org.mockito.Mockito.verify;
  19 import static org.mockito.Mockito.verifyNoMoreInteractions;
  20 import static org.mockito.Mockito.when;
  21
  22 import com.google.common.base.Optional;
  23 import com.google.common.util.concurrent.CheckedFuture;
  24 import com.google.common.util.concurrent.Futures;
  25 import java.util.concurrent.Future;
  26 import org.junit.Before;
  27 import org.junit.Ignore;
  28 import org.junit.Test;
  29 import org.mockito.InOrder;
  30 import org.mockito.Mock;
  31 import org.mockito.MockitoAnnotations;
  32 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  33 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  34 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  35 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  36 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  37 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
  38 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  39 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  40 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  41 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  42 import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
  43 import org.opendaylight.controller.sal.restconf.impl.BrokerFacade;
  44 import org.opendaylight.controller.sal.restconf.impl.ControllerContext;
  45 import org.opendaylight.controller.sal.restconf.impl.RestconfDocumentedException;
  46 import org.opendaylight.controller.sal.restconf.impl.RestconfError;
  47 import org.opendaylight.controller.sal.streams.listeners.ListenerAdapter;
  48 import org.opendaylight.controller.sal.streams.listeners.Notificator;
  49 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  50 import org.opendaylight.yangtools.yang.common.QName;
  51 import org.opendaylight.yangtools.yang.common.RpcResult;
  52 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  55 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  57
  58 /**
  59  * Unit tests for BrokerFacade.
  60  *
  61  * @author Thomas Pantelis
  62  */
  63 public class BrokerFacadeTest {
  64
  65     @Mock
  66     DOMDataBroker domDataBroker;
  67
  68     @Mock
  69     ConsumerSession mockConsumerSession;
  70
  71     @Mock
  72     DOMMountPoint mockMountInstance;
  73
  74     BrokerFacade brokerFacade = BrokerFacade.getInstance();
  75
  76     CompositeNode dataNode;
  77
  78     NormalizedNode<?, ?> dummyNode = createDummyNode("test:module", "2014-01-09", "interfaces");
  79     CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> dummyNodeInFuture = wrapDummyNode(dummyNode);
  80
  81     QName qname = TestUtils.buildQName("interfaces","test:module", "2014-01-09");
  82
  83     YangInstanceIdentifier instanceID = YangInstanceIdentifier.builder().node(qname).toInstance();
  84
  85     @Mock
  86     DOMDataReadOnlyTransaction rTransaction;
  87
  88     @Mock
  89     DOMDataWriteTransaction wTransaction;
  90
  91     @Mock
  92     DOMDataReadWriteTransaction rwTransaction;
  93
  94     @Before
  95     public void setUp() throws Exception {
  96         MockitoAnnotations.initMocks(this);
  97         // TODO it is started before every test method
  98         brokerFacade.setDomDataBroker(domDataBroker);
  99         brokerFacade.setContext(mockConsumerSession);
 100         when(domDataBroker.newReadOnlyTransaction()).thenReturn(rTransaction);
 101         when(domDataBroker.newWriteOnlyTransaction()).thenReturn(wTransaction);
 102         when(domDataBroker.newReadWriteTransaction()).thenReturn(rwTransaction);
 103
 104         dataNode = TestUtils.prepareCompositeNodeWithIetfInterfacesInterfacesData();
 105
 106         ControllerContext.getInstance().setSchemas(TestUtils.loadSchemaContext("/full-versions/test-module"));
 107
 108     }
 109
 110     private CheckedFuture<Optional<NormalizedNode<?, ?>>,ReadFailedException> wrapDummyNode(final NormalizedNode<?, ?> dummyNode) {
 111         return  Futures.immediateCheckedFuture(Optional.<NormalizedNode<?, ?>> of(dummyNode));
 112     }
 113
 114     /**
 115      * Value of this node shouldn't be important for testing purposes
 116      */
 117     private NormalizedNode<?, ?> createDummyNode(final String namespace, final String date, final String localName) {
 118         return Builders.containerBuilder()
 119                 .withNodeIdentifier(new NodeIdentifier(QName.create(namespace, date, localName))).build();
 120     }
 121
 122     @Test
 123     public void testReadConfigurationData() {
 124         when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
 125                 dummyNodeInFuture);
 126
 127         NormalizedNode<?, ?> actualNode = brokerFacade.readConfigurationData(instanceID);
 128
 129         assertSame("readConfigurationData", dummyNode, actualNode);
 130     }
 131
 132     @Test
 133     public void testReadOperationalData() {
 134         when(rTransaction.read(any(LogicalDatastoreType.class), any(YangInstanceIdentifier.class))).thenReturn(
 135                 dummyNodeInFuture);
 136
 137         NormalizedNode<?, ?> actualNode = brokerFacade.readOperationalData(instanceID);
 138
 139         assertSame("readOperationalData", dummyNode, actualNode);
 140     }
 141
 142     @Test(expected = RestconfDocumentedException.class)
 143     public void testReadOperationalDataWithNoDataBroker() {
 144         brokerFacade.setDomDataBroker(null);
 145
 146         brokerFacade.readOperationalData(instanceID);
 147     }
 148
 149     @SuppressWarnings("unchecked")
 150     @Test
 151     public void testInvokeRpc() throws Exception {
 152         RpcResult<CompositeNode> expResult = mock(RpcResult.class);
 153         Future<RpcResult<CompositeNode>> future = Futures.immediateFuture(expResult);
 154         when(mockConsumerSession.rpc(qname, dataNode)).thenReturn(future);
 155
 156         Future<RpcResult<CompositeNode>> actualFuture = brokerFacade.invokeRpc(qname, dataNode);
 157         assertNotNull("Future is null", actualFuture);
 158         RpcResult<CompositeNode> actualResult = actualFuture.get();
 159
 160         assertSame("invokeRpc", expResult, actualResult);
 161     }
 162
 163     @Test(expected = RestconfDocumentedException.class)
 164     public void testInvokeRpcWithNoConsumerSession() {
 165         brokerFacade.setContext(null);
 166
 167         brokerFacade.invokeRpc(qname, dataNode);
 168     }
 169
 170     @Ignore
 171     @Test
 172     public void testCommitConfigurationDataPut() {
 173         CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
 174
 175         when(wTransaction.submit()).thenReturn(expFuture);
 176
 177         Future<Void> actualFuture = brokerFacade.commitConfigurationDataPut(instanceID, dummyNode);
 178
 179         assertSame("commitConfigurationDataPut", expFuture, actualFuture);
 180
 181         InOrder inOrder = inOrder(domDataBroker, wTransaction);
 182         inOrder.verify(domDataBroker).newWriteOnlyTransaction();
 183         inOrder.verify(wTransaction).put(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
 184         inOrder.verify(wTransaction).submit();
 185     }
 186
 187     @Test
 188     public void testCommitConfigurationDataPost() {
 189         CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
 190
 191         NormalizedNode<?, ?> dummyNode2 = createDummyNode("dummy:namespace2", "2014-07-01", "dummy local name2");
 192         when(rwTransaction.read(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
 193                 wrapDummyNode(dummyNode2));
 194         when(rwTransaction.submit()).thenReturn(expFuture);
 195
 196         CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade.commitConfigurationDataPost(
 197                 instanceID, dummyNode);
 198
 199         assertSame("commitConfigurationDataPost", expFuture, actualFuture);
 200
 201         InOrder inOrder = inOrder(domDataBroker, rwTransaction);
 202         inOrder.verify(domDataBroker).newReadWriteTransaction();
 203         inOrder.verify(rwTransaction).merge(LogicalDatastoreType.CONFIGURATION, instanceID, dummyNode);
 204         inOrder.verify(rwTransaction).submit();
 205     }
 206
 207     @Test(expected = RestconfDocumentedException.class)
 208     public void testCommitConfigurationDataPostAlreadyExists() {
 209         when(rwTransaction.read(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class))).thenReturn(
 210                 dummyNodeInFuture);
 211         try {
 212             brokerFacade.commitConfigurationDataPost(instanceID, dummyNode);
 213         } catch (RestconfDocumentedException e) {
 214             assertEquals("getErrorTag", RestconfError.ErrorTag.DATA_EXISTS, e.getErrors().get(0).getErrorTag());
 215             throw e;
 216         }
 217     }
 218
 219     @Test
 220     public void testCommitConfigurationDataDelete() {
 221         CheckedFuture<Void, TransactionCommitFailedException> expFuture = mock(CheckedFuture.class);
 222
 223         when(wTransaction.submit()).thenReturn(expFuture);
 224
 225         CheckedFuture<Void, TransactionCommitFailedException> actualFuture = brokerFacade
 226                 .commitConfigurationDataDelete(instanceID);
 227
 228         assertSame("commitConfigurationDataDelete", expFuture, actualFuture);
 229
 230         InOrder inOrder = inOrder(domDataBroker, wTransaction);
 231         inOrder.verify(domDataBroker).newWriteOnlyTransaction();
 232         inOrder.verify(wTransaction).delete(eq(LogicalDatastoreType.CONFIGURATION), any(YangInstanceIdentifier.class));
 233         inOrder.verify(wTransaction).submit();
 234     }
 235
 236     @SuppressWarnings("unchecked")
 237     @Test
 238     public void testRegisterToListenDataChanges() {
 239         ListenerAdapter listener = Notificator.createListener(instanceID, "stream");
 240
 241         ListenerRegistration<DOMDataChangeListener> mockRegistration = mock(ListenerRegistration.class);
 242
 243         when(
 244                 domDataBroker.registerDataChangeListener(any(LogicalDatastoreType.class), eq(instanceID), eq(listener),
 245                         eq(DataChangeScope.BASE))).thenReturn(mockRegistration);
 246
 247         brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
 248
 249         verify(domDataBroker).registerDataChangeListener(LogicalDatastoreType.CONFIGURATION, instanceID, listener,
 250                 DataChangeScope.BASE);
 251
 252         assertEquals("isListening", true, listener.isListening());
 253
 254         brokerFacade.registerToListenDataChanges(LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE, listener);
 255         verifyNoMoreInteractions(domDataBroker);
 256
 257     }
 258 }