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