restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfInvokeOperationsServiceImplTest.java

   1 /*
   2  * Copyright (c) 2016 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 package org.opendaylight.restconf.nb.rfc8040.rests.services.impl;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertNull;
  13 import static org.junit.Assert.assertThrows;
  14 import static org.junit.Assert.assertTrue;
  15 import static org.mockito.Mockito.doCallRealMethod;
  16 import static org.mockito.Mockito.doReturn;
  17 import static org.mockito.Mockito.mock;
  18 import static org.mockito.Mockito.when;
  19 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
  20 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
  21
  22 import java.util.Collection;
  23 import java.util.List;
  24 import java.util.Optional;
  25 import javax.ws.rs.WebApplicationException;
  26 import javax.ws.rs.core.Response;
  27 import javax.ws.rs.core.UriInfo;
  28 import org.junit.Before;
  29 import org.junit.Test;
  30 import org.junit.runner.RunWith;
  31 import org.mockito.Mock;
  32 import org.mockito.junit.MockitoJUnitRunner;
  33 import org.opendaylight.mdsal.common.api.CommitInfo;
  34 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  35 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  36 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  37 import org.opendaylight.mdsal.dom.api.DOMRpcException;
  38 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
  39 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  40 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  41 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  42 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  43 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  44 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  45 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  46 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
  47 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  48 import org.opendaylight.yangtools.yang.common.QName;
  49 import org.opendaylight.yangtools.yang.common.RpcError;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  51 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  56 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  57 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  58 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  59
  60 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  61 public class RestconfInvokeOperationsServiceImplTest {
  62     private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/invoke-rpc";
  63
  64     private static final QName RPC = QName.create("ns", "2015-02-28", "test-rpc");
  65     private static final ContainerNode INPUT = Builders.containerBuilder()
  66         .withNodeIdentifier(new NodeIdentifier(QName.create(RPC, "input")))
  67         .withChild(ImmutableNodes.leafNode(QName.create(RPC, "content"), "test"))
  68         .build();
  69     private static final ContainerNode OUTPUT = Builders.containerBuilder()
  70         .withNodeIdentifier(new NodeIdentifier(QName.create(RPC, "output")))
  71         .withChild(ImmutableNodes.leafNode(QName.create(RPC, "content"), "operation result"))
  72         .build();
  73
  74     @Mock
  75     private DOMRpcService rpcService;
  76     @Mock
  77     private DOMMountPoint mountPoint;
  78     private RestconfInvokeOperationsServiceImpl invokeOperationsService;
  79
  80     @Before
  81     public void setup() throws Exception {
  82         final EffectiveModelContext contextRef =
  83                 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
  84         final DOMDataBroker dataBroker = mock(DOMDataBroker.class);
  85         final DOMDataTreeWriteTransaction wTx = mock(DOMDataTreeWriteTransaction.class);
  86         when(dataBroker.newWriteOnlyTransaction()).thenReturn(wTx);
  87         doReturn(CommitInfo.emptyFluentFuture()).when(wTx).commit();
  88         final SchemaContextHandler schemaContextHandler = new SchemaContextHandler(dataBroker,
  89             mock(DOMSchemaService.class));
  90         schemaContextHandler.onModelContextUpdated(contextRef);
  91         this.invokeOperationsService =
  92                 new RestconfInvokeOperationsServiceImpl(this.rpcService, schemaContextHandler);
  93     }
  94
  95     @Test
  96     public void testInvokeRpcWithNonEmptyOutput() {
  97         final String identifier = "invoke-rpc-module:rpcTest";
  98         final ContainerNode result = mock(ContainerNode.class);
  99         final LeafNode<?> outputChild = mock(LeafNode.class);
 100         doCallRealMethod().when(result).isEmpty();
 101         doReturn(List.of(outputChild)).when(result).body();
 102
 103         final NormalizedNodeContext payload = prepNNC(result);
 104         final UriInfo uriInfo = mock(UriInfo.class);
 105
 106         final NormalizedNodeContext rpc = this.invokeOperationsService.invokeRpc(identifier, payload, uriInfo);
 107         assertEquals(result, rpc.getData());
 108     }
 109
 110     @Test
 111     public void testInvokeRpcWithEmptyOutput() {
 112         final String identifier = "invoke-rpc-module:rpcTest";
 113         final ContainerNode result = mock(ContainerNode.class);
 114         doReturn(true).when(result).isEmpty();
 115
 116         final NormalizedNodeContext payload = prepNNC(result);
 117         final UriInfo uriInfo = mock(UriInfo.class);
 118
 119         WebApplicationException exceptionToBeThrown = null;
 120         try {
 121             this.invokeOperationsService.invokeRpc(identifier, payload, uriInfo);
 122         } catch (final WebApplicationException exception) {
 123             exceptionToBeThrown = exception;
 124
 125         }
 126         assertNotNull("WebApplicationException with status code 204 is expected.", exceptionToBeThrown);
 127         assertEquals(Response.Status.NO_CONTENT.getStatusCode(), exceptionToBeThrown.getResponse().getStatus());
 128     }
 129
 130     @Test
 131     public void invokeRpcTest() {
 132         final DOMRpcResult mockResult = new DefaultDOMRpcResult(OUTPUT, List.of());
 133         doReturn(immediateFluentFuture(mockResult)).when(rpcService).invokeRpc(RPC, INPUT);
 134         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, rpcService);
 135         assertTrue(rpcResult.getErrors().isEmpty());
 136         assertEquals(OUTPUT, rpcResult.getResult());
 137     }
 138
 139     @Test
 140     public void invokeRpcErrorsAndCheckTestTest() {
 141         final QName errorRpc = QName.create(RPC, "error-rpc");
 142         final DOMRpcException exception = new DOMRpcImplementationNotAvailableException(
 143                 "No implementation of RPC " + errorRpc + " available.");
 144         doReturn(immediateFailedFluentFuture(exception)).when(rpcService).invokeRpc(errorRpc, INPUT);
 145         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, errorRpc, rpcService);
 146         assertNull(rpcResult.getResult());
 147         final Collection<? extends RpcError> errorList = rpcResult.getErrors();
 148         assertEquals(1, errorList.size());
 149         final RpcError actual = errorList.iterator().next();
 150         assertEquals("No implementation of RPC " + errorRpc + " available.", actual.getMessage());
 151         assertEquals("operation-failed", actual.getTag());
 152         assertEquals(RpcError.ErrorType.RPC, actual.getErrorType());
 153
 154         assertThrows(RestconfDocumentedException.class,
 155             () -> RestconfInvokeOperationsServiceImpl.checkResponse(rpcResult));
 156     }
 157
 158     @Test
 159     public void invokeRpcViaMountPointTest() {
 160         doReturn(Optional.ofNullable(rpcService)).when(mountPoint).getService(DOMRpcService.class);
 161         final DOMRpcResult mockResult = new DefaultDOMRpcResult(OUTPUT, List.of());
 162         doReturn(immediateFluentFuture(mockResult)).when(rpcService).invokeRpc(RPC, INPUT);
 163         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, mountPoint);
 164         assertTrue(rpcResult.getErrors().isEmpty());
 165         assertEquals(OUTPUT, rpcResult.getResult());
 166     }
 167
 168     @Test
 169     public void invokeRpcMissingMountPointServiceTest() {
 170         doReturn(Optional.empty()).when(mountPoint).getService(DOMRpcService.class);
 171         assertThrows(RestconfDocumentedException.class,
 172             () -> RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, mountPoint));
 173     }
 174
 175     @Test
 176     public void checkResponseTest() {
 177         final DOMRpcResult mockResult = new DefaultDOMRpcResult(OUTPUT, List.of());
 178         doReturn(immediateFluentFuture(mockResult)).when(rpcService).invokeRpc(RPC, INPUT);
 179         final DOMRpcResult rpcResult = RestconfInvokeOperationsServiceImpl.invokeRpc(INPUT, RPC, rpcService);
 180         assertTrue(rpcResult.getErrors().isEmpty());
 181         assertEquals(OUTPUT, rpcResult.getResult());
 182         assertNotNull(RestconfInvokeOperationsServiceImpl.checkResponse(rpcResult));
 183     }
 184
 185     private NormalizedNodeContext prepNNC(final NormalizedNode result) {
 186         final InstanceIdentifierContext<?> context = mock(InstanceIdentifierContext.class);
 187         final RpcDefinition schemaNode = mock(RpcDefinition.class);
 188         final QName qname = QName.create("invoke:rpc:module", "2013-12-03", "rpcTest");
 189         when(schemaNode.getQName()).thenReturn(qname);
 190         doReturn(schemaNode).when(context).getSchemaNode();
 191         final NormalizedNode data = mock(NormalizedNode.class);
 192         final DOMRpcResult domRpcResult = mock(DOMRpcResult.class);
 193         doReturn(immediateFluentFuture(domRpcResult)).when(rpcService).invokeRpc(qname, data);
 194         doReturn(result).when(domRpcResult).getResult();
 195         return new NormalizedNodeContext(context, data);
 196     }
 197 }