2 * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.restconf.nb.jaxrs;
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;
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.mdsal.MdsalDatabindProvider;
50 import org.opendaylight.restconf.server.mdsal.MdsalRestconfServer;
51 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
52 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
54 @ExtendWith(MockitoExtension.class)
55 abstract class AbstractRestconfTest extends AbstractJukeboxTest {
56 static final ApiPath JUKEBOX_API_PATH = apiPath("example-jukebox:jukebox");
61 DOMDataBroker dataBroker;
63 DOMActionService actionService;
65 DOMRpcService rpcService;
67 DOMMountPointService mountPointService;
69 DOMMountPoint mountPoint;
71 JaxRsRestconf restconf;
74 final void setupRestconf() {
75 restconf = new JaxRsRestconf(new MdsalRestconfServer(
76 new MdsalDatabindProvider(new FixedDOMSchemaService(modelContext())), dataBroker, rpcService, actionService,
80 EffectiveModelContext modelContext() {
81 return JUKEBOX_SCHEMA;
84 static final void assertJson(final String expectedJson, final NormalizedNodePayload payload) {
85 assertPayload(expectedJson, payload, new JsonNormalizedNodeBodyWriter(),
86 MediaTypes.APPLICATION_YANG_DATA_JSON);
89 static final void assertXml(final String expectedXml, final NormalizedNodePayload payload) {
90 assertPayload(expectedXml, payload, new XmlNormalizedNodeBodyWriter(), MediaTypes.APPLICATION_YANG_DATA_XML);
93 private static void assertPayload(final String expected, final NormalizedNodePayload payload,
94 final MessageBodyWriter<NormalizedNodePayload> writer, final String mediaType) {
95 final var baos = new ByteArrayOutputStream();
97 writer.writeTo(payload, null, null, null, MediaType.valueOf(mediaType), null, baos);
98 } catch (IOException e) {
99 throw new AssertionError(e);
101 assertEquals(expected, baos.toString(StandardCharsets.UTF_8));
104 static final NormalizedNode assertNormalizedNode(final int status, final Consumer<AsyncResponse> invocation) {
105 return assertNormalizedNodePayload(status, invocation).data();
108 static final NormalizedNodePayload assertNormalizedNodePayload(final int status,
109 final Consumer<AsyncResponse> invocation) {
110 return assertEntity(NormalizedNodePayload.class, status, invocation);
113 static final <T> T assertEntity(final Class<T> expectedType, final int expectedStatus,
114 final Consumer<AsyncResponse> invocation) {
115 return assertInstanceOf(expectedType, assertEntity(expectedStatus, invocation));
118 static final Object assertEntity(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
119 return assertResponse(expectedStatus, invocation).getEntity();
122 static final RestconfError assertError(final Consumer<AsyncResponse> invocation) {
123 final var errors = assertErrors(invocation);
124 assertEquals(1, errors.size());
125 final var error = errors.get(0);
126 assertNotNull(error);
130 static final List<RestconfError> assertErrors(final Consumer<AsyncResponse> invocation) {
131 final var ar = mock(AsyncResponse.class);
132 final var captor = ArgumentCaptor.forClass(RestconfDocumentedException.class);
133 doReturn(true).when(ar).resume(captor.capture());
134 invocation.accept(ar);
135 verify(ar).resume(any(RestconfDocumentedException.class));
136 return captor.getValue().getErrors();
139 static final Response assertResponse(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
140 final var ar = mock(AsyncResponse.class);
141 final var captor = ArgumentCaptor.forClass(Response.class);
142 doReturn(true).when(ar).resume(captor.capture());
143 invocation.accept(ar);
144 verify(ar).resume(any(Response.class));
145 final var response = captor.getValue();
146 assertEquals(expectedStatus, response.getStatus());
150 static final @NonNull ApiPath apiPath(final String str) {
152 return ApiPath.parse(str);
153 } catch (ParseException e) {
154 throw new AssertionError(e);