RestconfServer is strictly asynchronous
[netconf.git] / 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.util.List;
19 import java.util.function.Consumer;
20 import javax.ws.rs.container.AsyncResponse;
21 import javax.ws.rs.core.Response;
22 import javax.ws.rs.core.UriInfo;
23 import org.junit.jupiter.api.BeforeEach;
24 import org.junit.jupiter.api.extension.ExtendWith;
25 import org.mockito.ArgumentCaptor;
26 import org.mockito.Mock;
27 import org.mockito.junit.jupiter.MockitoExtension;
28 import org.opendaylight.mdsal.dom.api.DOMActionService;
29 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
30 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
31 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
32 import org.opendaylight.mdsal.dom.api.DOMRpcService;
33 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
34 import org.opendaylight.restconf.common.errors.RestconfError;
35 import org.opendaylight.restconf.nb.rfc8040.AbstractJukeboxTest;
36 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindContext;
37 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
38 import org.opendaylight.restconf.server.mdsal.MdsalRestconfServer;
39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
40 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
41
42 @ExtendWith(MockitoExtension.class)
43 abstract class AbstractRestconfTest extends AbstractJukeboxTest {
44     @Mock
45     UriInfo uriInfo;
46     @Mock
47     DOMDataBroker dataBroker;
48     @Mock
49     DOMActionService actionService;
50     @Mock
51     DOMRpcService rpcService;
52     @Mock
53     DOMMountPointService mountPointService;
54     @Mock
55     DOMMountPoint mountPoint;
56
57     JaxRsRestconf restconf;
58
59     @BeforeEach
60     final void setupRestconf() {
61         restconf = new JaxRsRestconf(new MdsalRestconfServer(() -> DatabindContext.ofModel(modelContext()), dataBroker,
62             rpcService, actionService, mountPointService));
63     }
64
65     EffectiveModelContext modelContext() {
66         return JUKEBOX_SCHEMA;
67     }
68
69     static final NormalizedNode assertNormalizedNode(final int status, final Consumer<AsyncResponse> invocation) {
70         return assertEntity(NormalizedNodePayload.class, status, invocation).data();
71     }
72
73     static final <T> T assertEntity(final Class<T> expectedType, final int expectedStatus,
74             final Consumer<AsyncResponse> invocation) {
75         return assertInstanceOf(expectedType, assertEntity(expectedStatus, invocation));
76     }
77
78     static final Object assertEntity(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
79         return assertResponse(expectedStatus, invocation).getEntity();
80     }
81
82     static final RestconfError assertError(final Consumer<AsyncResponse> invocation) {
83         final var errors = assertErrors(invocation);
84         assertEquals(1, errors.size());
85         final var error = errors.get(0);
86         assertNotNull(error);
87         return error;
88     }
89
90     static final List<RestconfError> assertErrors(final Consumer<AsyncResponse> invocation) {
91         final var ar = mock(AsyncResponse.class);
92         final var captor = ArgumentCaptor.forClass(RestconfDocumentedException.class);
93         doReturn(true).when(ar).resume(captor.capture());
94         invocation.accept(ar);
95         verify(ar).resume(any(RestconfDocumentedException.class));
96         return captor.getValue().getErrors();
97     }
98
99     static final Response assertResponse(final int expectedStatus, final Consumer<AsyncResponse> invocation) {
100         final var ar = mock(AsyncResponse.class);
101         final var captor = ArgumentCaptor.forClass(Response.class);
102         doReturn(true).when(ar).resume(captor.capture());
103         invocation.accept(ar);
104         verify(ar).resume(any(Response.class));
105         final var response = captor.getValue();
106         assertEquals(expectedStatus, response.getStatus());
107         return response;
108     }
109 }