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.Response;
26 import javax.ws.rs.core.UriInfo;
27 import org.eclipse.jdt.annotation.NonNull;
28 import org.eclipse.jdt.annotation.NonNullByDefault;
29 import org.junit.jupiter.api.BeforeEach;
30 import org.junit.jupiter.api.extension.ExtendWith;
31 import org.mockito.ArgumentCaptor;
32 import org.mockito.Mock;
33 import org.mockito.junit.jupiter.MockitoExtension;
34 import org.opendaylight.mdsal.dom.api.DOMActionService;
35 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
36 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
37 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
38 import org.opendaylight.mdsal.dom.api.DOMRpcService;
39 import org.opendaylight.mdsal.dom.spi.FixedDOMSchemaService;
40 import org.opendaylight.restconf.api.ApiPath;
41 import org.opendaylight.restconf.api.FormattableBody;
42 import org.opendaylight.restconf.api.query.PrettyPrintParam;
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.ErrorTagMapping;
47 import org.opendaylight.restconf.server.mdsal.MdsalDatabindProvider;
48 import org.opendaylight.restconf.server.mdsal.MdsalRestconfServer;
49 import org.opendaylight.restconf.server.spi.NormalizedFormattableBody;
50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
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(
76 new MdsalRestconfServer(new MdsalDatabindProvider(new FixedDOMSchemaService(modelContext())),
77 dataBroker, rpcService, actionService, mountPointService),
78 ErrorTagMapping.RFC8040, PrettyPrintParam.FALSE);
81 EffectiveModelContext modelContext() {
82 return JUKEBOX_SCHEMA;
85 static final void assertJson(final String expectedJson, final NormalizedFormattableBody<?> payload) {
86 final var baos = new ByteArrayOutputStream();
88 payload.formatToJSON(PrettyPrintParam.FALSE, baos);
89 } catch (IOException e) {
90 throw new AssertionError(e);
92 assertEquals(expectedJson, baos.toString(StandardCharsets.UTF_8));
95 static final void assertXml(final String expectedXml, final NormalizedFormattableBody<?> payload) {
96 final var baos = new ByteArrayOutputStream();
98 payload.formatToXML(PrettyPrintParam.FALSE, baos);
99 } catch (IOException e) {
100 throw new AssertionError(e);
102 assertEquals(expectedXml, baos.toString(StandardCharsets.UTF_8));
106 static final <N extends NormalizedNode> NormalizedFormattableBody<N> assertNormalizedBody(final int status,
107 final Consumer<AsyncResponse> invocation) {
108 return assertInstanceOf(NormalizedFormattableBody.class, assertFormattableBody(status, invocation));
111 static final FormattableBody assertFormattableBody(final int status, final Consumer<AsyncResponse> invocation) {
112 return assertEntity(JaxRsFormattableBody.class, status, invocation).body();
115 static final ContainerNode assertOperationOutput(final int status, final Consumer<AsyncResponse> invocation) {
116 return assertInstanceOf(ContainerNode.class, assertOperationOutputBody(status, invocation).data());
119 static final NormalizedFormattableBody<?> assertOperationOutputBody(final int status,
120 final Consumer<AsyncResponse> invocation) {
121 return assertInstanceOf(NormalizedFormattableBody.class, assertFormattableBody(status, invocation));
124 static final <T> T assertEntity(final Class<T> expectedType, final int expectedStatus,
125 final Consumer<AsyncResponse> invocation) {
126 return assertInstanceOf(expectedType, assertEntity(expectedStatus, invocation));
129 static final Object assertEntity(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
130 return assertResponse(expectedStatus, invocation).getEntity();
133 static final RestconfError assertError(final Consumer<AsyncResponse> invocation) {
134 final var errors = assertErrors(invocation);
135 assertEquals(1, errors.size());
136 final var error = errors.get(0);
137 assertNotNull(error);
141 static final List<RestconfError> assertErrors(final Consumer<AsyncResponse> invocation) {
142 final var ar = mock(AsyncResponse.class);
143 doReturn(true).when(ar).resume(any(RestconfDocumentedException.class));
145 invocation.accept(ar);
147 final var captor = ArgumentCaptor.forClass(RestconfDocumentedException.class);
148 verify(ar).resume(captor.capture());
149 return captor.getValue().getErrors();
152 static final Response assertResponse(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
153 final var ar = mock(AsyncResponse.class);
154 doReturn(true).when(ar).resume(any(Response.class));
156 invocation.accept(ar);
158 final var captor = ArgumentCaptor.forClass(Response.class);
159 verify(ar).resume(captor.capture());
160 final var response = captor.getValue();
161 assertEquals(expectedStatus, response.getStatus());
165 static final @NonNull ApiPath apiPath(final String str) {
167 return ApiPath.parse(str);
168 } catch (ParseException e) {
169 throw new AssertionError(e);