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.FormattableBody;
  43 import org.opendaylight.restconf.api.MediaTypes;
  44 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  45 import org.opendaylight.restconf.common.errors.RestconfError;
  46 import org.opendaylight.restconf.nb.rfc8040.AbstractJukeboxTest;
  47 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.JsonNormalizedNodeBodyWriter;
  48 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.XmlNormalizedNodeBodyWriter;
  49 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  50 import org.opendaylight.restconf.server.mdsal.MdsalDatabindProvider;
  51 import org.opendaylight.restconf.server.mdsal.MdsalRestconfServer;
  52 import org.opendaylight.restconf.server.spi.OperationOutputBody;
  53 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  54 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  55 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  56
  57 @ExtendWith(MockitoExtension.class)
  58 abstract class AbstractRestconfTest extends AbstractJukeboxTest {
  59     static final ApiPath JUKEBOX_API_PATH = apiPath("example-jukebox:jukebox");
  60
  61     @Mock
  62     UriInfo uriInfo;
  63     @Mock
  64     DOMDataBroker dataBroker;
  65     @Mock
  66     DOMActionService actionService;
  67     @Mock
  68     DOMRpcService rpcService;
  69     @Mock
  70     DOMMountPointService mountPointService;
  71     @Mock
  72     DOMMountPoint mountPoint;
  73
  74     JaxRsRestconf restconf;
  75
  76     @BeforeEach
  77     final void setupRestconf() {
  78         restconf = new JaxRsRestconf(new MdsalRestconfServer(
  79             new MdsalDatabindProvider(new FixedDOMSchemaService(modelContext())), dataBroker, rpcService, actionService,
  80             mountPointService));
  81     }
  82
  83     EffectiveModelContext modelContext() {
  84         return JUKEBOX_SCHEMA;
  85     }
  86
  87     static final void assertJson(final String expectedJson, final NormalizedNodePayload payload) {
  88         assertPayload(expectedJson, payload, new JsonNormalizedNodeBodyWriter(),
  89             MediaTypes.APPLICATION_YANG_DATA_JSON);
  90     }
  91
  92     static final void assertJson(final String expectedJson, final OperationOutputBody payload) {
  93         final var baos = new ByteArrayOutputStream();
  94         try {
  95             payload.formatToJSON(baos);
  96         } catch (IOException e) {
  97             throw new AssertionError(e);
  98         }
  99         assertEquals(expectedJson, baos.toString(StandardCharsets.UTF_8));
 100     }
 101
 102     static final void assertXml(final String expectedXml, final NormalizedNodePayload payload) {
 103         assertPayload(expectedXml, payload, new XmlNormalizedNodeBodyWriter(), MediaTypes.APPLICATION_YANG_DATA_XML);
 104     }
 105
 106     static final void assertXml(final String expectedXml, final OperationOutputBody payload) {
 107         final var baos = new ByteArrayOutputStream();
 108         try {
 109             payload.formatToXML(baos);
 110         } catch (IOException e) {
 111             throw new AssertionError(e);
 112         }
 113         assertEquals(expectedXml, baos.toString(StandardCharsets.UTF_8));
 114     }
 115
 116     private static void assertPayload(final String expected, final NormalizedNodePayload payload,
 117             final MessageBodyWriter<NormalizedNodePayload> writer, final String mediaType) {
 118         final var baos = new ByteArrayOutputStream();
 119         try {
 120             writer.writeTo(payload, null, null, null, MediaType.valueOf(mediaType), null, baos);
 121         } catch (IOException e) {
 122             throw new AssertionError(e);
 123         }
 124         assertEquals(expected, baos.toString(StandardCharsets.UTF_8));
 125     }
 126
 127     static final FormattableBody assertFormatableBody(final int status, final Consumer<AsyncResponse> invocation) {
 128         return assertEntity(FormattableBody.class, status, invocation);
 129     }
 130
 131     static final ContainerNode assertOperationOutput(final int status, final Consumer<AsyncResponse> invocation) {
 132         return assertOperationOutputBody(status, invocation).output();
 133     }
 134
 135     static final OperationOutputBody assertOperationOutputBody(final int status,
 136             final Consumer<AsyncResponse> invocation) {
 137         return assertEntity(OperationOutputBody.class, status, invocation);
 138     }
 139
 140     static final NormalizedNode assertNormalizedNode(final int status, final Consumer<AsyncResponse> invocation) {
 141         return assertNormalizedNodePayload(status, invocation).data();
 142     }
 143
 144     static final NormalizedNodePayload assertNormalizedNodePayload(final int status,
 145             final Consumer<AsyncResponse> invocation) {
 146         return assertEntity(NormalizedNodePayload.class, status, invocation);
 147     }
 148
 149     static final <T> T assertEntity(final Class<T> expectedType, final int expectedStatus,
 150             final Consumer<AsyncResponse> invocation) {
 151         return assertInstanceOf(expectedType, assertEntity(expectedStatus, invocation));
 152     }
 153
 154     static final Object assertEntity(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
 155         return assertResponse(expectedStatus, invocation).getEntity();
 156     }
 157
 158     static final RestconfError assertError(final Consumer<AsyncResponse> invocation) {
 159         final var errors = assertErrors(invocation);
 160         assertEquals(1, errors.size());
 161         final var error = errors.get(0);
 162         assertNotNull(error);
 163         return error;
 164     }
 165
 166     static final List<RestconfError> assertErrors(final Consumer<AsyncResponse> invocation) {
 167         final var ar = mock(AsyncResponse.class);
 168         doReturn(true).when(ar).resume(any(RestconfDocumentedException.class));
 169
 170         invocation.accept(ar);
 171
 172         final var captor = ArgumentCaptor.forClass(RestconfDocumentedException.class);
 173         verify(ar).resume(captor.capture());
 174         return captor.getValue().getErrors();
 175     }
 176
 177     static final Response assertResponse(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
 178         final var ar = mock(AsyncResponse.class);
 179         doReturn(true).when(ar).resume(any(Response.class));
 180
 181         invocation.accept(ar);
 182
 183         final var captor = ArgumentCaptor.forClass(Response.class);
 184         verify(ar).resume(captor.capture());
 185         final var response = captor.getValue();
 186         assertEquals(expectedStatus, response.getStatus());
 187         return response;
 188     }
 189
 190     static final @NonNull ApiPath apiPath(final String str) {
 191         try {
 192             return ApiPath.parse(str);
 193         } catch (ParseException e) {
 194             throw new AssertionError(e);
 195         }
 196     }
 197 }