2 * Copyright (c) 2016 Cisco Systems, Inc. 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.rfc8040.jersey.providers.test;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertThrows;
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.when;
18 import java.util.List;
19 import java.util.Optional;
20 import javax.ws.rs.core.MediaType;
21 import javax.ws.rs.core.MultivaluedHashMap;
22 import javax.ws.rs.core.MultivaluedMap;
23 import javax.ws.rs.core.Request;
24 import javax.ws.rs.core.Response.Status;
25 import javax.ws.rs.core.UriInfo;
26 import org.junit.function.ThrowingRunnable;
27 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
28 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
29 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
30 import org.opendaylight.mdsal.dom.spi.FixedDOMSchemaService;
31 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
32 import org.opendaylight.restconf.common.errors.RestconfError;
33 import org.opendaylight.restconf.common.patch.PatchContext;
34 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
35 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindContext;
36 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindProvider;
37 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.spi.AbstractIdentifierAwareJaxRsProvider;
38 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
39 import org.opendaylight.yangtools.yang.common.ErrorTag;
40 import org.opendaylight.yangtools.yang.common.ErrorType;
41 import org.opendaylight.yangtools.yang.common.QName;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
43 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
45 public abstract class AbstractBodyReaderTest {
46 protected static final QName MAP_CONT_QNAME = QName.create("map:ns", "my-map").intern();
47 protected static final QName KEY_LEAF_QNAME = QName.create("map:ns", "key-leaf").intern();
48 protected static final QName DATA_LEAF_QNAME = QName.create("map:ns", "data-leaf").intern();
49 protected static final QName LEAF_SET_QNAME = QName.create("set:ns", "my-set").intern();
50 protected static final QName LIST_QNAME = QName.create("list:ns", "unkeyed-list").intern();
51 protected static final QName LIST_LEAF1_QNAME = QName.create("list:ns", "leaf1").intern();
52 protected static final QName LIST_LEAF2_QNAME = QName.create("list:ns", "leaf2").intern();
53 protected static final QName CHOICE_CONT_QNAME = QName.create("choice:ns", "case-cont1").intern();
54 protected static final QName CASE_LEAF1_QNAME = QName.create("choice:ns", "case-leaf1").intern();
55 protected static final QName LEAF_NAME_QNAME = QName.create("instance:identifier:patch:module",
56 "2015-11-21", "name").intern();
58 protected final MediaType mediaType;
59 protected final DatabindProvider databindProvider;
60 protected final DOMMountPointService mountPointService;
62 protected AbstractBodyReaderTest(final EffectiveModelContext schemaContext) throws NoSuchFieldException,
63 IllegalAccessException {
64 mediaType = getMediaType();
66 final var databindContext = DatabindContext.ofModel(schemaContext);
67 databindProvider = () -> databindContext;
69 mountPointService = mock(DOMMountPointService.class);
70 final var mountPoint = mock(DOMMountPoint.class);
71 doReturn(Optional.of(mountPoint)).when(mountPointService).getMountPoint(any(YangInstanceIdentifier.class));
72 doReturn(Optional.of(FixedDOMSchemaService.of(schemaContext))).when(mountPoint)
73 .getService(DOMSchemaService.class);
76 protected abstract MediaType getMediaType();
78 protected static EffectiveModelContext schemaContextLoader(final String yangPath,
79 final EffectiveModelContext schemaContext) {
80 return TestRestconfUtils.loadSchemaContext(yangPath, schemaContext);
83 protected static <T extends AbstractIdentifierAwareJaxRsProvider<?>> void mockBodyReader(
84 final String identifier, final T normalizedNodeProvider, final boolean isPost) {
85 final UriInfo uriInfoMock = mock(UriInfo.class);
86 final MultivaluedMap<String, String> pathParm = new MultivaluedHashMap<>(1);
88 if (!identifier.isEmpty()) {
89 pathParm.put("identifier", List.of(identifier));
92 when(uriInfoMock.getPathParameters()).thenReturn(pathParm);
93 when(uriInfoMock.getPathParameters(false)).thenReturn(pathParm);
94 when(uriInfoMock.getPathParameters(true)).thenReturn(pathParm);
95 normalizedNodeProvider.setUriInfo(uriInfoMock);
97 final Request request = mock(Request.class);
99 when(request.getMethod()).thenReturn("POST");
101 when(request.getMethod()).thenReturn("PUT");
104 normalizedNodeProvider.setRequest(request);
107 protected static void checkMountPointNormalizedNodePayload(final NormalizedNodePayload nnContext) {
108 checkNormalizedNodePayload(nnContext);
109 assertNotNull(nnContext.getInstanceIdentifierContext().getMountPoint());
112 protected static void checkNormalizedNodePayload(final NormalizedNodePayload nnContext) {
113 assertNotNull(nnContext.getData());
114 assertNotNull(nnContext.getInstanceIdentifierContext()
115 .getInstanceIdentifier());
116 assertNotNull(nnContext.getInstanceIdentifierContext()
117 .getSchemaContext());
118 assertNotNull(nnContext.getInstanceIdentifierContext().getSchemaNode());
121 protected static void checkPatchContext(final PatchContext patchContext) {
122 assertNotNull(patchContext.getData());
123 assertNotNull(patchContext.getInstanceIdentifierContext().getInstanceIdentifier());
124 assertNotNull(patchContext.getInstanceIdentifierContext().getSchemaContext());
125 assertNotNull(patchContext.getInstanceIdentifierContext().getSchemaNode());
128 protected static void checkPatchContextMountPoint(final PatchContext patchContext) {
129 checkPatchContext(patchContext);
130 assertNotNull(patchContext.getInstanceIdentifierContext().getMountPoint());
133 protected static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
134 return mountPoint.getService(DOMSchemaService.class)
135 .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
139 protected static void assertRangeViolation(final ThrowingRunnable runnable) {
140 final RestconfDocumentedException ex = assertThrows(RestconfDocumentedException.class, runnable);
141 assertEquals(Status.BAD_REQUEST, ex.getResponse().getStatusInfo());
143 final List<RestconfError> errors = ex.getErrors();
144 assertEquals(1, errors.size());
146 final RestconfError error = errors.get(0);
147 assertEquals(ErrorType.APPLICATION, error.getErrorType());
148 assertEquals(ErrorTag.INVALID_VALUE, error.getErrorTag());
149 assertEquals("bar error app tag", error.getErrorAppTag());
150 assertEquals("bar error message", error.getErrorMessage());