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