restconf/restconf-nb/src/test/java/org/opendaylight/restconf/nb/jaxrs/AbstractRestconfTest.java

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. 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.jaxrs;
   9
  10 import static org.junit.jupiter.api.Assertions.assertEquals;
  11 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
  12 import static org.junit.jupiter.api.Assertions.assertNotNull;
  13 import static org.mockito.ArgumentMatchers.any;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.mock;
  16 import static org.mockito.Mockito.verify;
  17
  18 import java.io.ByteArrayOutputStream;
  19 import java.io.IOException;
  20 import java.nio.charset.StandardCharsets;
  21 import java.text.ParseException;
  22 import java.util.List;
  23 import java.util.function.Consumer;
  24 import javax.ws.rs.container.AsyncResponse;
  25 import javax.ws.rs.core.MediaType;
  26 import javax.ws.rs.core.Response;
  27 import javax.ws.rs.core.UriInfo;
  28 import javax.ws.rs.ext.MessageBodyWriter;
  29 import org.eclipse.jdt.annotation.NonNull;
  30 import org.junit.jupiter.api.BeforeEach;
  31 import org.junit.jupiter.api.extension.ExtendWith;
  32 import org.mockito.ArgumentCaptor;
  33 import org.mockito.Mock;
  34 import org.mockito.junit.jupiter.MockitoExtension;
  35 import org.opendaylight.mdsal.dom.api.DOMActionService;
  36 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  37 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  38 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  39 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  40 import org.opendaylight.mdsal.dom.spi.FixedDOMSchemaService;
  41 import org.opendaylight.restconf.api.ApiPath;
  42 import org.opendaylight.restconf.api.MediaTypes;
  43 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  44 import org.opendaylight.restconf.common.errors.RestconfError;
  45 import org.opendaylight.restconf.nb.rfc8040.AbstractJukeboxTest;
  46 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.JsonNormalizedNodeBodyWriter;
  47 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.XmlNormalizedNodeBodyWriter;
  48 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  49 import org.opendaylight.restconf.server.api.OperationOutputBody;
  50 import org.opendaylight.restconf.server.mdsal.MdsalDatabindProvider;
  51 import org.opendaylight.restconf.server.mdsal.MdsalRestconfServer;
  52 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  54 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  55
  56 @ExtendWith(MockitoExtension.class)
  57 abstract class AbstractRestconfTest extends AbstractJukeboxTest {
  58     static final ApiPath JUKEBOX_API_PATH = apiPath("example-jukebox:jukebox");
  59
  60     @Mock
  61     UriInfo uriInfo;
  62     @Mock
  63     DOMDataBroker dataBroker;
  64     @Mock
  65     DOMActionService actionService;
  66     @Mock
  67     DOMRpcService rpcService;
  68     @Mock
  69     DOMMountPointService mountPointService;
  70     @Mock
  71     DOMMountPoint mountPoint;
  72
  73     JaxRsRestconf restconf;
  74
  75     @BeforeEach
  76     final void setupRestconf() {
  77         restconf = new JaxRsRestconf(new MdsalRestconfServer(
  78             new MdsalDatabindProvider(new FixedDOMSchemaService(modelContext())), dataBroker, rpcService, actionService,
  79             mountPointService));
  80     }
  81
  82     EffectiveModelContext modelContext() {
  83         return JUKEBOX_SCHEMA;
  84     }
  85
  86     static final void assertJson(final String expectedJson, final NormalizedNodePayload payload) {
  87         assertPayload(expectedJson, payload, new JsonNormalizedNodeBodyWriter(),
  88             MediaTypes.APPLICATION_YANG_DATA_JSON);
  89     }
  90
  91     static final void assertJson(final String expectedJson, final OperationOutputBody payload) {
  92         final var baos = new ByteArrayOutputStream();
  93         try {
  94             payload.writeJSON(baos);
  95         } catch (IOException e) {
  96             throw new AssertionError(e);
  97         }
  98         assertEquals(expectedJson, baos.toString(StandardCharsets.UTF_8));
  99     }
 100
 101     static final void assertXml(final String expectedXml, final NormalizedNodePayload payload) {
 102         assertPayload(expectedXml, payload, new XmlNormalizedNodeBodyWriter(), MediaTypes.APPLICATION_YANG_DATA_XML);
 103     }
 104
 105     static final void assertXml(final String expectedXml, final OperationOutputBody payload) {
 106         final var baos = new ByteArrayOutputStream();
 107         try {
 108             payload.writeXML(baos);
 109         } catch (IOException e) {
 110             throw new AssertionError(e);
 111         }
 112         assertEquals(expectedXml, baos.toString(StandardCharsets.UTF_8));
 113     }
 114
 115     private static void assertPayload(final String expected, final NormalizedNodePayload payload,
 116             final MessageBodyWriter<NormalizedNodePayload> writer, final String mediaType) {
 117         final var baos = new ByteArrayOutputStream();
 118         try {
 119             writer.writeTo(payload, null, null, null, MediaType.valueOf(mediaType), null, baos);
 120         } catch (IOException e) {
 121             throw new AssertionError(e);
 122         }
 123         assertEquals(expected, baos.toString(StandardCharsets.UTF_8));
 124     }
 125
 126     static final ContainerNode assertOperationOutput(final int status, final Consumer<AsyncResponse> invocation) {
 127         return assertOperationOutputBody(status, invocation).output();
 128     }
 129
 130     static final OperationOutputBody assertOperationOutputBody(final int status,
 131             final Consumer<AsyncResponse> invocation) {
 132         return assertEntity(OperationOutputBody.class, status, invocation);
 133     }
 134
 135     static final NormalizedNode assertNormalizedNode(final int status, final Consumer<AsyncResponse> invocation) {
 136         return assertNormalizedNodePayload(status, invocation).data();
 137     }
 138
 139     static final NormalizedNodePayload assertNormalizedNodePayload(final int status,
 140             final Consumer<AsyncResponse> invocation) {
 141         return assertEntity(NormalizedNodePayload.class, status, invocation);
 142     }
 143
 144     static final <T> T assertEntity(final Class<T> expectedType, final int expectedStatus,
 145             final Consumer<AsyncResponse> invocation) {
 146         return assertInstanceOf(expectedType, assertEntity(expectedStatus, invocation));
 147     }
 148
 149     static final Object assertEntity(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
 150         return assertResponse(expectedStatus, invocation).getEntity();
 151     }
 152
 153     static final RestconfError assertError(final Consumer<AsyncResponse> invocation) {
 154         final var errors = assertErrors(invocation);
 155         assertEquals(1, errors.size());
 156         final var error = errors.get(0);
 157         assertNotNull(error);
 158         return error;
 159     }
 160
 161     static final List<RestconfError> assertErrors(final Consumer<AsyncResponse> invocation) {
 162         final var ar = mock(AsyncResponse.class);
 163         final var captor = ArgumentCaptor.forClass(RestconfDocumentedException.class);
 164         doReturn(true).when(ar).resume(captor.capture());
 165         invocation.accept(ar);
 166         verify(ar).resume(any(RestconfDocumentedException.class));
 167         return captor.getValue().getErrors();
 168     }
 169
 170     static final Response assertResponse(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
 171         final var ar = mock(AsyncResponse.class);
 172         final var captor = ArgumentCaptor.forClass(Response.class);
 173         doReturn(true).when(ar).resume(captor.capture());
 174         invocation.accept(ar);
 175         verify(ar).resume(any(Response.class));
 176         final var response = captor.getValue();
 177         assertEquals(expectedStatus, response.getStatus());
 178         return response;
 179     }
 180
 181     static final @NonNull ApiPath apiPath(final String str) {
 182         try {
 183             return ApiPath.parse(str);
 184         } catch (ParseException e) {
 185             throw new AssertionError(e);
 186         }
 187     }
 188 }