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

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