2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.openecomp.sdc.be.servlets;
23 import com.google.gson.Gson;
24 import com.google.gson.GsonBuilder;
25 import fj.data.Either;
26 import org.apache.commons.codec.binary.Base64;
27 import org.apache.commons.lang3.tuple.ImmutablePair;
28 import org.glassfish.hk2.utilities.binding.AbstractBinder;
29 import org.glassfish.jersey.server.ResourceConfig;
30 import org.glassfish.jersey.test.JerseyTest;
31 import org.glassfish.jersey.test.TestProperties;
32 import org.junit.Before;
33 import org.junit.BeforeClass;
34 import org.junit.Test;
35 import org.mockito.Mockito;
36 import org.mockito.invocation.InvocationOnMock;
37 import org.mockito.stubbing.Answer;
38 import org.openecomp.sdc.be.components.impl.ResourceImportManager;
39 import org.openecomp.sdc.be.config.SpringConfig;
40 import org.openecomp.sdc.be.dao.api.ActionStatus;
41 import org.openecomp.sdc.be.impl.ComponentsUtils;
42 import org.openecomp.sdc.be.impl.ServletUtils;
43 import org.openecomp.sdc.be.impl.WebAppContextWrapper;
44 import org.openecomp.sdc.be.model.Resource;
45 import org.openecomp.sdc.be.model.UploadResourceInfo;
46 import org.openecomp.sdc.be.model.User;
47 import org.openecomp.sdc.be.user.Role;
48 import org.openecomp.sdc.be.user.UserBusinessLogic;
49 import org.openecomp.sdc.common.api.Constants;
50 import org.openecomp.sdc.common.impl.ExternalConfiguration;
51 import org.openecomp.sdc.common.util.GeneralUtility;
52 import org.openecomp.sdc.exception.ResponseFormat;
53 import org.springframework.context.ApplicationContext;
54 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
55 import org.springframework.http.HttpStatus;
56 import org.springframework.web.context.WebApplicationContext;
58 import javax.servlet.ServletContext;
59 import javax.servlet.http.HttpServletRequest;
60 import javax.servlet.http.HttpSession;
61 import javax.ws.rs.client.Entity;
62 import javax.ws.rs.core.Application;
63 import javax.ws.rs.core.MediaType;
64 import javax.ws.rs.core.Response;
65 import java.util.Arrays;
67 import static org.junit.Assert.assertEquals;
68 import static org.junit.Assert.assertTrue;
69 import static org.mockito.Mockito.when;
71 public class ResourceServletTest extends JerseyTest {
72 public static final HttpServletRequest request = Mockito.mock(HttpServletRequest.class);
73 public static final ResourceImportManager resourceImportManager = Mockito.mock(ResourceImportManager.class);
74 final static HttpSession session = Mockito.mock(HttpSession.class);
75 final static ServletContext servletContext = Mockito.mock(ServletContext.class);
76 final static WebAppContextWrapper webAppContextWrapper = Mockito.mock(WebAppContextWrapper.class);
77 final static WebApplicationContext webApplicationContext = Mockito.mock(WebApplicationContext.class);
78 public static final ServletUtils servletUtils = Mockito.mock(ServletUtils.class);
79 public static final ComponentsUtils componentUtils = Mockito.mock(ComponentsUtils.class);
80 public static final UserBusinessLogic userAdmin = Mockito.mock(UserBusinessLogic.class);
81 Gson gson = new GsonBuilder().setPrettyPrinting().create();
84 public static void setup() {
85 ExternalConfiguration.setAppName("catalog-be");
86 when(request.getSession()).thenReturn(session);
87 when(session.getServletContext()).thenReturn(servletContext);
88 when(servletContext.getAttribute(Constants.WEB_APPLICATION_CONTEXT_WRAPPER_ATTR)).thenReturn(webAppContextWrapper);
89 when(webAppContextWrapper.getWebAppContext(servletContext)).thenReturn(webApplicationContext);
90 when(webApplicationContext.getBean(ResourceImportManager.class)).thenReturn(resourceImportManager);
91 when(webApplicationContext.getBean(ServletUtils.class)).thenReturn(servletUtils);
92 when(servletUtils.getComponentsUtils()).thenReturn(componentUtils);
93 when(servletUtils.getUserAdmin()).thenReturn(userAdmin);
94 String userId = "jh0003";
95 User user = new User();
96 user.setUserId(userId);
97 user.setRole(Role.ADMIN.name());
98 Either<User, ActionStatus> eitherUser = Either.left(user);
99 when(userAdmin.getUser(userId, false)).thenReturn(eitherUser);
100 when(request.getHeader(Constants.USER_ID_HEADER)).thenReturn(userId);
102 ImmutablePair<Resource, ActionStatus> pair = new ImmutablePair<>(new Resource(), ActionStatus.OK);
103 Either<ImmutablePair<Resource, ActionStatus>, ResponseFormat> ret = Either.left(pair);
104 when(resourceImportManager.importUserDefinedResource(Mockito.anyString(), Mockito.any(UploadResourceInfo.class), Mockito.any(User.class), Mockito.anyBoolean())).thenReturn(ret);
109 public void beforeTest() {
110 Mockito.reset(componentUtils);
112 Mockito.doAnswer(new Answer<ResponseFormat>() {
113 public ResponseFormat answer(InvocationOnMock invocation) {
114 Object[] args = invocation.getArguments();
115 ActionStatus action = (ActionStatus) args[0];
116 return (action == ActionStatus.OK) ? new ResponseFormat(HttpStatus.CREATED.value()) : new ResponseFormat(HttpStatus.INTERNAL_SERVER_ERROR.value());
118 }).when(componentUtils).getResponseFormat(Mockito.any(ActionStatus.class));
123 public void testHappyScenarioTest() {
124 UploadResourceInfo validJson = buildValidJson();
125 setMD5OnRequest(true, validJson);
126 Response response = target().path("/v1/catalog/resources").request(MediaType.APPLICATION_JSON).post(Entity.json(gson.toJson(validJson)), Response.class);
127 Mockito.verify(componentUtils, Mockito.times(1)).getResponseFormat(Mockito.any(ActionStatus.class));
128 Mockito.verify(componentUtils, Mockito.times(1)).getResponseFormat(ActionStatus.OK);
129 assertEquals(response.getStatus(), HttpStatus.CREATED.value());
134 public void testNonValidMd5Fail() {
135 UploadResourceInfo validJson = buildValidJson();
137 setMD5OnRequest(false, validJson);
139 Response response = target().path("/v1/catalog/resources").request(MediaType.APPLICATION_JSON).post(Entity.json(gson.toJson(validJson)), Response.class);
140 Mockito.verify(componentUtils, Mockito.times(1)).getResponseFormat(Mockito.any(ActionStatus.class));
141 Mockito.verify(componentUtils, Mockito.times(1)).getResponseFormat(ActionStatus.INVALID_RESOURCE_CHECKSUM);
142 assertEquals(response.getStatus(), HttpStatus.INTERNAL_SERVER_ERROR.value());
147 public void testNonValidPayloadNameFail() {
148 UploadResourceInfo mdJson = buildValidJson();
149 mdJson.setPayloadName("myCompute.xml");
151 runAndVerifyActionStatusError(mdJson, ActionStatus.INVALID_TOSCA_FILE_EXTENSION);
156 public void testNullPayloadFail() {
157 UploadResourceInfo mdJson = buildValidJson();
158 mdJson.setPayloadData(null);
159 runAndVerifyActionStatusError(mdJson, ActionStatus.INVALID_RESOURCE_PAYLOAD);
164 public void testNonYmlPayloadFail() {
165 UploadResourceInfo mdJson = buildValidJson();
166 String payload = "{ json : { isNot : yaml } ";
167 encodeAndSetPayload(mdJson, payload);
168 runAndVerifyActionStatusError(mdJson, ActionStatus.INVALID_YAML_FILE);
173 public void testNonToscaPayloadFail() {
174 UploadResourceInfo mdJson = buildValidJson();
176 String payload = "node_types: \r\n" + " org.openecomp.resource.importResource4test:\r\n" + " derived_from: tosca.nodes.Root\r\n" + " description: update update";
177 encodeAndSetPayload(mdJson, payload);
178 runAndVerifyActionStatusError(mdJson, ActionStatus.INVALID_TOSCA_TEMPLATE);
183 public void testServiceToscaPayloadFail() {
184 UploadResourceInfo mdJson = buildValidJson();
186 String payload = "tosca_definitions_version: tosca_simple_yaml_1_0_0\r\n" + "node_types: \r\n" + " org.openecomp.resource.importResource4test:\r\n" + " derived_from: tosca.nodes.Root\r\n" + " topology_template: thisIsService\r\n"
187 + " description: update update";
189 encodeAndSetPayload(mdJson, payload);
190 runAndVerifyActionStatusError(mdJson, ActionStatus.NOT_RESOURCE_TOSCA_TEMPLATE);
195 public void testMultipleResourcesInPayloadFail() {
196 UploadResourceInfo mdJson = buildValidJson();
198 String payload = "tosca_definitions_version: tosca_simple_yaml_1_0_0\r\n" + "node_types: \r\n" + " org.openecomp.resource.importResource4test2:\r\n" + " derived_from: tosca.nodes.Root\r\n" + " org.openecomp.resource.importResource4test:\r\n"
199 + " derived_from: tosca.nodes.Root\r\n" + " description: update update";
201 encodeAndSetPayload(mdJson, payload);
202 runAndVerifyActionStatusError(mdJson, ActionStatus.NOT_SINGLE_RESOURCE);
207 public void testNonValidNameSpaceInPayloadFail() {
208 UploadResourceInfo mdJson = buildValidJson();
210 String payload = "tosca_definitions_version: tosca_simple_yaml_1_0_0\r\n" + "node_types: \r\n" + " org.openecomp.resourceX.importResource4test:\r\n" + " derived_from: tosca.nodes.Root\r\n" + " description: update update";
212 encodeAndSetPayload(mdJson, payload);
213 runAndVerifyActionStatusError(mdJson, ActionStatus.INVALID_RESOURCE_NAMESPACE);
217 private void encodeAndSetPayload(UploadResourceInfo mdJson, String payload) {
218 byte[] encodedBase64Payload = Base64.encodeBase64(payload.getBytes());
219 mdJson.setPayloadData(new String(encodedBase64Payload));
222 private void runAndVerifyActionStatusError(UploadResourceInfo mdJson, ActionStatus invalidResourcePayload) {
223 setMD5OnRequest(true, mdJson);
224 Response response = target().path("/v1/catalog/resources").request(MediaType.APPLICATION_JSON).post(Entity.json(gson.toJson(mdJson)), Response.class);
225 Mockito.verify(componentUtils, Mockito.times(1)).getResponseFormat(Mockito.any(ActionStatus.class));
226 Mockito.verify(componentUtils, Mockito.times(1)).getResponseFormat(invalidResourcePayload);
227 assertEquals(response.getStatus(), HttpStatus.INTERNAL_SERVER_ERROR.value());
230 private void setMD5OnRequest(boolean isValid, UploadResourceInfo json) {
231 String md5 = (isValid) ? GeneralUtility.calculateMD5Base64EncodedByString(gson.toJson(json)) : "stam=";
232 when(request.getHeader(Constants.MD5_HEADER)).thenReturn(md5);
236 private UploadResourceInfo buildValidJson() {
237 UploadResourceInfo ret = new UploadResourceInfo();
238 ret.setName("ciMyCompute");
239 ret.setPayloadName("ciMyCompute.yml");
240 ret.addSubCategory("Application Layer 4+", "Application Servers");
241 ret.setDescription("ResourceDescription");
242 ret.setVendorName("VendorName");
243 ret.setVendorRelease("VendorRelease");
244 ret.setContactId("AT1234");
245 ret.setIcon("router");
246 ret.setTags(Arrays.asList(new String[] { "ciMyCompute" }));
248 "dG9zY2FfZGVmaW5pdGlvbnNfdmVyc2lvbjogdG9zY2Ffc2ltcGxlX3lhbWxfMV8wXzANCm5vZGVfdHlwZXM6IA0KICBvcmcub3BlbmVjb21wLnJlc291cmNlLk15Q29tcHV0ZToNCiAgICBkZXJpdmVkX2Zyb206IHRvc2NhLm5vZGVzLlJvb3QNCiAgICBhdHRyaWJ1dGVzOg0KICAgICAgcHJpdmF0ZV9hZGRyZXNzOg0KICAgICAgICB0eXBlOiBzdHJpbmcNCiAgICAgIHB1YmxpY19hZGRyZXNzOg0KICAgICAgICB0eXBlOiBzdHJpbmcNCiAgICAgIG5ldHdvcmtzOg0KICAgICAgICB0eXBlOiBtYXANCiAgICAgICAgZW50cnlfc2NoZW1hOg0KICAgICAgICAgIHR5cGU6IHRvc2NhLmRhdGF0eXBlcy5uZXR3b3JrLk5ldHdvcmtJbmZvDQogICAgICBwb3J0czoNCiAgICAgICAgdHlwZTogbWFwDQogICAgICAgIGVudHJ5X3NjaGVtYToNCiAgICAgICAgICB0eXBlOiB0b3NjYS5kYXRhdHlwZXMubmV0d29yay5Qb3J0SW5mbw0KICAgIHJlcXVpcmVtZW50czoNCiAgICAgIC0gbG9jYWxfc3RvcmFnZTogDQogICAgICAgICAgY2FwYWJpbGl0eTogdG9zY2EuY2FwYWJpbGl0aWVzLkF0dGFjaG1lbnQNCiAgICAgICAgICBub2RlOiB0b3NjYS5ub2Rlcy5CbG9ja1N0b3JhZ2UNCiAgICAgICAgICByZWxhdGlvbnNoaXA6IHRvc2NhLnJlbGF0aW9uc2hpcHMuQXR0YWNoZXNUbw0KICAgICAgICAgIG9jY3VycmVuY2VzOiBbMCwgVU5CT1VOREVEXSAgDQogICAgY2FwYWJpbGl0aWVzOg0KICAgICAgaG9zdDogDQogICAgICAgIHR5cGU6IHRvc2NhLmNhcGFiaWxpdGllcy5Db250YWluZXINCiAgICAgICAgdmFsaWRfc291cmNlX3R5cGVzOiBbdG9zY2Eubm9kZXMuU29mdHdhcmVDb21wb25lbnRdIA0KICAgICAgZW5kcG9pbnQgOg0KICAgICAgICB0eXBlOiB0b3NjYS5jYXBhYmlsaXRpZXMuRW5kcG9pbnQuQWRtaW4gDQogICAgICBvczogDQogICAgICAgIHR5cGU6IHRvc2NhLmNhcGFiaWxpdGllcy5PcGVyYXRpbmdTeXN0ZW0NCiAgICAgIHNjYWxhYmxlOg0KICAgICAgICB0eXBlOiB0b3NjYS5jYXBhYmlsaXRpZXMuU2NhbGFibGUNCiAgICAgIGJpbmRpbmc6DQogICAgICAgIHR5cGU6IHRvc2NhLmNhcGFiaWxpdGllcy5uZXR3b3JrLkJpbmRhYmxl");
253 protected Application configure() {
254 ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
255 forceSet(TestProperties.CONTAINER_PORT, "0");
256 return new ResourceConfig(ResourcesServlet.class)
257 .register(new AbstractBinder() {
259 protected void configure() {
260 bind(request).to(HttpServletRequest.class);
263 .property("contextConfig", context);