2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2020 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.components.impl;
23 import static org.junit.jupiter.api.Assertions.assertEquals;
24 import static org.mockito.ArgumentMatchers.anyString;
25 import static org.mockito.ArgumentMatchers.eq;
26 import static org.mockito.Mockito.when;
28 import fj.data.Either;
29 import java.util.ArrayList;
30 import java.util.Arrays;
31 import java.util.Collections;
32 import java.util.List;
33 import javax.servlet.ServletContext;
34 import org.junit.jupiter.api.BeforeEach;
35 import org.mockito.Mockito;
36 import org.openecomp.sdc.ElementOperationMock;
37 import org.openecomp.sdc.be.auditing.impl.AuditingManager;
38 import org.openecomp.sdc.be.components.distribution.engine.DistributionEngine;
39 import org.openecomp.sdc.be.components.impl.exceptions.ComponentException;
40 import org.openecomp.sdc.be.components.impl.generic.GenericTypeBusinessLogic;
41 import org.openecomp.sdc.be.components.path.ForwardingPathValidator;
42 import org.openecomp.sdc.be.components.validation.ServiceDistributionValidation;
43 import org.openecomp.sdc.be.components.validation.UserValidations;
44 import org.openecomp.sdc.be.components.validation.component.ComponentContactIdValidator;
45 import org.openecomp.sdc.be.components.validation.component.ComponentDescriptionValidator;
46 import org.openecomp.sdc.be.components.validation.component.ComponentFieldValidator;
47 import org.openecomp.sdc.be.components.validation.component.ComponentIconValidator;
48 import org.openecomp.sdc.be.components.validation.component.ComponentNameValidator;
49 import org.openecomp.sdc.be.components.validation.component.ComponentProjectCodeValidator;
50 import org.openecomp.sdc.be.components.validation.component.ComponentTagsValidator;
51 import org.openecomp.sdc.be.components.validation.component.ComponentValidator;
52 import org.openecomp.sdc.be.components.validation.service.ServiceCategoryValidator;
53 import org.openecomp.sdc.be.components.validation.service.ServiceEnvironmentContextValidator;
54 import org.openecomp.sdc.be.components.validation.service.ServiceFieldValidator;
55 import org.openecomp.sdc.be.components.validation.service.ServiceFunctionValidator;
56 import org.openecomp.sdc.be.components.validation.service.ServiceInstantiationTypeValidator;
57 import org.openecomp.sdc.be.components.validation.service.ServiceNamingPolicyValidator;
58 import org.openecomp.sdc.be.components.validation.service.ServiceRoleValidator;
59 import org.openecomp.sdc.be.components.validation.service.ServiceTypeValidator;
60 import org.openecomp.sdc.be.components.validation.service.ServiceValidator;
61 import org.openecomp.sdc.be.dao.api.ActionStatus;
62 import org.openecomp.sdc.be.dao.cassandra.AuditCassandraDao;
63 import org.openecomp.sdc.be.dao.janusgraph.JanusGraphDao;
64 import org.openecomp.sdc.be.datamodel.utils.UiComponentDataConverter;
65 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
66 import org.openecomp.sdc.be.datatypes.enums.JsonPresentationFields;
67 import org.openecomp.sdc.be.datatypes.enums.NodeTypeEnum;
68 import org.openecomp.sdc.be.facade.operations.CatalogOperation;
69 import org.openecomp.sdc.be.impl.ComponentsUtils;
70 import org.openecomp.sdc.be.impl.WebAppContextWrapper;
71 import org.openecomp.sdc.be.model.ArtifactDefinition;
72 import org.openecomp.sdc.be.model.Component;
73 import org.openecomp.sdc.be.model.Resource;
74 import org.openecomp.sdc.be.model.Service;
75 import org.openecomp.sdc.be.model.User;
76 import org.openecomp.sdc.be.model.category.CategoryDefinition;
77 import org.openecomp.sdc.be.model.jsonjanusgraph.operations.ToscaOperationFacade;
78 import org.openecomp.sdc.be.model.operations.api.IElementOperation;
79 import org.openecomp.sdc.be.model.operations.api.StorageOperationStatus;
80 import org.openecomp.sdc.be.model.operations.impl.GraphLockOperation;
81 import org.openecomp.sdc.be.resources.data.auditing.DistributionDeployEvent;
82 import org.openecomp.sdc.be.resources.data.auditing.DistributionNotificationEvent;
83 import org.openecomp.sdc.be.resources.data.auditing.ResourceAdminEvent;
84 import org.openecomp.sdc.be.user.Role;
85 import org.openecomp.sdc.be.user.UserBusinessLogic;
86 import org.openecomp.sdc.common.api.ArtifactGroupTypeEnum;
87 import org.openecomp.sdc.common.api.Constants;
88 import org.openecomp.sdc.exception.ResponseFormat;
89 import org.springframework.web.context.WebApplicationContext;
91 class ServiceBusinessLogicBaseTestSetup extends BaseBusinessLogicMock {
93 protected ServiceBusinessLogic bl;
94 protected static final String SERVICE_CATEGORY = "Mobility";
95 protected static final String INSTANTIATION_TYPE = "A-la-carte";
96 protected final ServletContext servletContext = Mockito.mock(ServletContext.class);
97 protected UserBusinessLogic mockUserAdmin = Mockito.mock(UserBusinessLogic.class);
98 protected WebAppContextWrapper webAppContextWrapper = Mockito.mock(WebAppContextWrapper.class);
99 protected WebApplicationContext webAppContext = Mockito.mock(WebApplicationContext.class);
100 protected ResponseFormatManager responseManager = null;
101 protected ComponentsUtils componentsUtils = new ComponentsUtils(Mockito.mock(AuditingManager.class));
102 protected AuditCassandraDao auditingDao = Mockito.mock(AuditCassandraDao.class);
103 protected ArtifactsBusinessLogic artifactBl = Mockito.mock(ArtifactsBusinessLogic.class);
104 protected GraphLockOperation graphLockOperation = Mockito.mock(GraphLockOperation.class);
105 protected JanusGraphDao mockJanusGraphDao = Mockito.mock(JanusGraphDao.class);
106 protected ToscaOperationFacade toscaOperationFacade = Mockito.mock(ToscaOperationFacade.class);
107 protected GenericTypeBusinessLogic genericTypeBusinessLogic = Mockito.mock(GenericTypeBusinessLogic.class);
108 protected UserValidations userValidations = Mockito.mock(UserValidations.class);
109 protected ResourceAdminEvent auditArchive1 = Mockito.mock(ResourceAdminEvent.class);
110 protected CatalogOperation catalogOperation = Mockito.mock(CatalogOperation.class);
111 protected ResourceAdminEvent auditArchive2 = Mockito.mock(ResourceAdminEvent.class);
112 protected ResourceAdminEvent auditRestore = Mockito.mock(ResourceAdminEvent.class);
113 IElementOperation mockElementDao = new ElementOperationMock();
114 DistributionEngine distributionEngine = Mockito.mock(DistributionEngine.class);
115 ServiceDistributionValidation serviceDistributionValidation = Mockito.mock(ServiceDistributionValidation.class);
116 ComponentInstanceBusinessLogic componentInstanceBusinessLogic = Mockito.mock(ComponentInstanceBusinessLogic.class);
117 ForwardingPathValidator forwardingPathValidator = Mockito.mock(ForwardingPathValidator.class);
118 UiComponentDataConverter uiComponentDataConverter = Mockito.mock(UiComponentDataConverter.class);
119 protected ServiceTypeValidator serviceTypeValidator = new ServiceTypeValidator(componentsUtils);
120 protected ServiceCategoryValidator serviceCategoryValidator = new ServiceCategoryValidator(componentsUtils, mockElementDao);
121 protected ServiceRoleValidator serviceRoleValidator = new ServiceRoleValidator(componentsUtils);
122 protected ServiceFunctionValidator serviceFunctionValidator = new ServiceFunctionValidator(componentsUtils);
123 protected ServiceInstantiationTypeValidator serviceInstantiationTypeValidator = new ServiceInstantiationTypeValidator(componentsUtils);
124 protected ComponentDescriptionValidator componentDescriptionValidator = new ComponentDescriptionValidator(componentsUtils);
125 protected ComponentProjectCodeValidator componentProjectCodeValidator = new ComponentProjectCodeValidator(componentsUtils);
126 protected ComponentIconValidator componentIconValidator = new ComponentIconValidator(componentsUtils);
127 protected ComponentContactIdValidator componentContactIdValidator = new ComponentContactIdValidator(componentsUtils);
128 protected ComponentTagsValidator componentTagsValidator = new ComponentTagsValidator(componentsUtils);
129 protected ComponentNameValidator componentNameValidator = new ComponentNameValidator(componentsUtils, toscaOperationFacade);
130 protected final ComponentValidator componentValidator = Mockito.mock(ComponentValidator.class);
131 protected ServiceValidator serviceValidator = createServiceValidator();
133 protected User user = null;
134 protected Resource genericService = null;
136 protected static final String CERTIFIED_VERSION = "1.0";
137 protected static final String UNCERTIFIED_VERSION = "0.2";
138 protected static final String COMPONNET_ID = "myUniqueId";
139 protected static final String GENERIC_SERVICE_NAME = "org.openecomp.resource.abstract.nodes.service";
141 protected static final String SERVICE_ROLE = JsonPresentationFields.SERVICE_ROLE.getPresentation();
142 protected static final String SERVICE_TYPE = JsonPresentationFields.SERVICE_TYPE.getPresentation();
143 protected static final String SERVICE_FUNCTION = JsonPresentationFields.SERVICE_FUNCTION.getPresentation();
145 public ServiceBusinessLogicBaseTestSetup() {
149 protected ServiceValidator createServiceValidator() {
150 List<ComponentFieldValidator> componentFieldValidators = Arrays.asList(componentContactIdValidator,
151 componentDescriptionValidator,
152 componentIconValidator, componentNameValidator,
153 new ComponentProjectCodeValidator(componentsUtils),
154 componentTagsValidator);
156 List<ServiceFieldValidator> serviceFieldValidators = Arrays.asList(serviceCategoryValidator, new ServiceEnvironmentContextValidator(),
157 serviceInstantiationTypeValidator, new ServiceNamingPolicyValidator(componentsUtils),
158 serviceRoleValidator, serviceTypeValidator);
159 return new ServiceValidator(componentsUtils, componentFieldValidators, serviceFieldValidators);
165 public void setup() {
168 IElementOperation mockElementDao = new ElementOperationMock();
170 // User data and management
172 user.setUserId("jh0003");
173 user.setFirstName("Jimmi");
174 user.setLastName("Hendrix");
175 user.setRole(Role.ADMIN.name());
177 when(mockUserAdmin.getUser("jh0003", false)).thenReturn(user);
178 when(userValidations.validateUserExists(eq("jh0003"))).thenReturn(user);
179 when(userValidations.validateUserNotEmpty(eq(user), anyString())).thenReturn(user);
180 when(servletContext.getAttribute(Constants.CONFIGURATION_MANAGER_ATTR)).thenReturn(configurationManager);
181 when(servletContext.getAttribute(Constants.WEB_APPLICATION_CONTEXT_WRAPPER_ATTR)).thenReturn(webAppContextWrapper);
182 when(webAppContextWrapper.getWebAppContext(servletContext)).thenReturn(webAppContext);
183 when(webAppContext.getBean(IElementOperation.class)).thenReturn(mockElementDao);
184 when(graphLockOperation.lockComponent(Mockito.anyString(), Mockito.eq(NodeTypeEnum.Service))).thenReturn(StorageOperationStatus.OK);
185 when(graphLockOperation.lockComponentByName(Mockito.anyString(), Mockito.eq(NodeTypeEnum.Service))).thenReturn(StorageOperationStatus.OK);
186 when(catalogOperation.updateCatalog(Mockito.any(), Mockito.any())).thenReturn(ActionStatus.OK);
187 // artifact bussinesslogic
188 ArtifactDefinition artifactDef = new ArtifactDefinition();
189 when(artifactBl.createArtifactPlaceHolderInfo(Mockito.any(), Mockito.anyString(), Mockito.anyMap(), Mockito.any(User.class), Mockito.any(ArtifactGroupTypeEnum.class))).thenReturn(artifactDef);
192 Service serviceResponse = createServiceObject(true);
193 Either<Component, StorageOperationStatus> eitherCreate = Either.left(serviceResponse);
194 when(toscaOperationFacade.createToscaComponent(Mockito.any(Component.class))).thenReturn(eitherCreate);
195 Either<Boolean, StorageOperationStatus> eitherCount = Either.left(false);
196 when(toscaOperationFacade.validateComponentNameExists("Service", null, ComponentTypeEnum.SERVICE)).thenReturn(eitherCount);
197 Either<Boolean, StorageOperationStatus> eitherCountExist = Either.left(true);
198 when(toscaOperationFacade.validateComponentNameExists("alreadyExist", null, ComponentTypeEnum.SERVICE)).thenReturn(eitherCountExist);
199 when(userValidations.validateUserExists(user)).thenReturn(user);
201 genericService = setupGenericServiceMock();
202 Either<Resource, StorageOperationStatus> findLatestGeneric = Either.left(genericService);
203 when(toscaOperationFacade.getLatestCertifiedNodeTypeByToscaResourceName(GENERIC_SERVICE_NAME)).thenReturn(findLatestGeneric);
206 bl = new ServiceBusinessLogic(elementDao, groupOperation, groupInstanceOperation,
207 groupTypeOperation, groupBusinessLogic, interfaceOperation, interfaceLifecycleTypeOperation,
208 artifactBl, distributionEngine, componentInstanceBusinessLogic,
209 serviceDistributionValidation, forwardingPathValidator, uiComponentDataConverter,
210 artifactToscaOperation, componentContactIdValidator,
211 componentNameValidator, componentTagsValidator, componentValidator,
212 componentIconValidator, componentProjectCodeValidator, componentDescriptionValidator);
213 bl.setComponentContactIdValidator(componentContactIdValidator);
214 bl.setComponentIconValidator(componentIconValidator);
215 bl.setComponentTagsValidator(componentTagsValidator);
216 bl.setComponentNameValidator(componentNameValidator);
217 bl.setComponentDescriptionValidator(componentDescriptionValidator);
218 bl.setComponentProjectCodeValidator(componentProjectCodeValidator);
219 bl.setServiceCategoryValidator(serviceCategoryValidator);
220 bl.setServiceTypeValidator(serviceTypeValidator);
221 bl.setServiceFunctionValidator(serviceFunctionValidator);
222 bl.setElementDao(mockElementDao);
223 bl.setUserAdmin(mockUserAdmin);
224 bl.setArtifactBl(artifactBl);
225 bl.setServiceValidator(createServiceValidator());
226 bl.setGraphLockOperation(graphLockOperation);
227 bl.setJanusGraphDao(mockJanusGraphDao);
228 bl.setToscaOperationFacade(toscaOperationFacade);
229 bl.setGenericTypeBusinessLogic(genericTypeBusinessLogic);
230 bl.setComponentsUtils(componentsUtils);
231 bl.setCassandraAuditingDao(auditingDao);
232 bl.setUserValidations(userValidations);
233 bl.setCatalogOperations(catalogOperation);
235 mockAuditingDaoLogic();
237 responseManager = ResponseFormatManager.getInstance();
242 protected Resource setupGenericServiceMock(){
243 Resource genericService = new Resource();
244 genericService.setVersion("1.0");
245 genericService.setToscaResourceName(GENERIC_SERVICE_NAME);
246 return genericService;
249 protected Service createServiceObject(boolean afterCreate) {
250 Service service = new Service();
251 service.setUniqueId("sid");
252 service.setName("Service");
253 CategoryDefinition category = new CategoryDefinition();
254 category.setName(SERVICE_CATEGORY);
255 category.setIcons(Collections.singletonList("defaulticon"));
256 List<CategoryDefinition> categories = new ArrayList<>();
257 categories.add(category);
258 service.setCategories(categories);
259 service.setInstantiationType(INSTANTIATION_TYPE);
261 service.setDescription("description");
262 List<String> tgs = new ArrayList<>();
263 tgs.add(service.getName());
264 service.setTags(tgs);
265 service.setIcon("defaulticon");
266 service.setContactId("aa1234");
267 service.setProjectCode("12345");
268 service.setEcompGeneratedNaming(true);
271 service.setVersion("0.1");
272 service.setUniqueId(service.getName() + ":" + service.getVersion());
273 service.setCreatorUserId(user.getUserId());
274 service.setCreatorFullName(user.getFirstName() + " " + user.getLastName());
279 private void mockAuditingDaoLogic() {
280 final ResourceAdminEvent createResourceAudit = new ResourceAdminEvent();
281 createResourceAudit.setModifier("Carlos Santana(cs0008)");
282 createResourceAudit.setCurrState("NOT_CERTIFIED_CHECKOUT");
283 createResourceAudit.setCurrVersion("0.1");
284 createResourceAudit.setServiceInstanceId("82eddd99-0bd9-4742-ab0a-1bdb5e262a05");
285 createResourceAudit.setRequestId("3e65cea1-7403-4bc7-b461-e2544d83799f");
286 createResourceAudit.setDesc("OK");
287 createResourceAudit.setResourceType("Resource");
288 createResourceAudit.setStatus("201");
289 createResourceAudit.setPrevVersion("");
290 createResourceAudit.setAction("Create");
291 createResourceAudit.setPrevState("");
292 createResourceAudit.setResourceName("MyTestResource");
294 final ResourceAdminEvent checkInResourceAudit = new ResourceAdminEvent();
295 checkInResourceAudit.setModifier("Carlos Santana(cs0008)");
296 checkInResourceAudit.setCurrState("NOT_CERTIFIED_CHECKIN");
297 checkInResourceAudit.setCurrVersion("0.1");
298 checkInResourceAudit.setServiceInstanceId("82eddd99-0bd9-4742-ab0a-1bdb5e262a05");
299 checkInResourceAudit.setRequestId("ffacbf5d-eeb1-43c6-a310-37fe7e1cc091");
300 checkInResourceAudit.setDesc("OK");
301 checkInResourceAudit.setComment("Stam");
302 checkInResourceAudit.setResourceType("Resource");
303 checkInResourceAudit.setStatus("200");
304 checkInResourceAudit.setPrevVersion("0.1");
305 checkInResourceAudit.setAction("Checkin");
306 checkInResourceAudit.setPrevState("NOT_CERTIFIED_CHECKOUT");
307 checkInResourceAudit.setResourceName("MyTestResource");
309 final ResourceAdminEvent checkOutResourceAudit = new ResourceAdminEvent();
310 checkOutResourceAudit.setModifier("Carlos Santana(cs0008)");
311 checkOutResourceAudit.setCurrState("NOT_CERTIFIED_CHECKOUT");
312 checkOutResourceAudit.setCurrVersion("0.2");
313 checkOutResourceAudit.setServiceInstanceId("82eddd99-0bd9-4742-ab0a-1bdb5e262a05");
314 checkOutResourceAudit.setRequestId("7add5078-4c16-4d74-9691-cc150e3c96b8");
315 checkOutResourceAudit.setDesc("OK");
316 checkOutResourceAudit.setComment("");
317 checkOutResourceAudit.setResourceType("Resource");
318 checkOutResourceAudit.setStatus("200");
319 checkOutResourceAudit.setPrevVersion("0.1");
320 checkOutResourceAudit.setAction("Checkout");
321 checkOutResourceAudit.setPrevState("NOT_CERTIFIED_CHECKIN");
322 checkOutResourceAudit.setResourceName("MyTestResource");
323 List<ResourceAdminEvent> list = new ArrayList<>() {
325 add(createResourceAudit);
326 add(checkInResourceAudit);
327 add(checkOutResourceAudit);
330 Either<List<ResourceAdminEvent>, ActionStatus> result = Either.left(list);
331 Mockito.when(auditingDao.getByServiceInstanceId(Mockito.anyString())).thenReturn(result);
333 List<ResourceAdminEvent> listPrev = new ArrayList<>();
334 Either<List<ResourceAdminEvent>, ActionStatus> resultPrev = Either.left(listPrev);
335 Mockito.when(auditingDao.getAuditByServiceIdAndPrevVersion(Mockito.anyString(), Mockito.anyString())).thenReturn(resultPrev);
337 List<ResourceAdminEvent> listCurr = new ArrayList<>() {
339 add(checkOutResourceAudit);
342 Either<List<ResourceAdminEvent>, ActionStatus> resultCurr = Either.left(listCurr);
343 Mockito.when(auditingDao.getAuditByServiceIdAndCurrVersion(Mockito.anyString(), Mockito.anyString())).thenReturn(resultCurr);
345 Either<List<ResourceAdminEvent>, ActionStatus> archiveAuditList = Either.left(Arrays.asList(auditArchive1, auditArchive2));
346 when(auditingDao.getArchiveAuditByServiceInstanceId(anyString())).thenReturn(archiveAuditList);
348 Either<List<ResourceAdminEvent>, ActionStatus> restoreAuditList = Either.left(Collections.singletonList(auditRestore));
349 when(auditingDao.getRestoreAuditByServiceInstanceId(anyString())).thenReturn(restoreAuditList);
353 protected void setupBeforeDeploy(String notifyAction, String requestAction, String did) {
355 DistributionNotificationEvent notifyEvent = new DistributionNotificationEvent();
356 notifyEvent.setAction(notifyAction);
357 notifyEvent.setDid(did);
358 notifyEvent.setStatus("200");
360 ResourceAdminEvent requestEvent = new ResourceAdminEvent();
361 requestEvent.setAction(requestAction);
362 requestEvent.setDid(did);
363 requestEvent.setStatus("200");
365 List<DistributionNotificationEvent> notifyResults = Collections.singletonList(notifyEvent);
366 Either<List<DistributionNotificationEvent>, ActionStatus> eitherNotify = Either.left(notifyResults);
368 Mockito.when(auditingDao.getDistributionNotify(Mockito.anyString(), Mockito.eq(notifyAction))).thenReturn(eitherNotify);
370 List<ResourceAdminEvent> requestResults = Collections.singletonList(requestEvent);
371 Either<List<ResourceAdminEvent>, ActionStatus> eitherRequest = Either.left(requestResults);
372 Mockito.when(auditingDao.getDistributionRequest(Mockito.anyString(), Mockito.eq(requestAction))).thenReturn(eitherRequest);
374 Either<Component, StorageOperationStatus> eitherService = Either.left(createServiceObject(true));
375 Mockito.when(toscaOperationFacade.getToscaElement(Mockito.anyString())).thenReturn(eitherService);
377 Either<List<DistributionDeployEvent>, ActionStatus> emptyEventList = Either.left(Collections.emptyList());
378 Mockito.when(auditingDao.getDistributionDeployByStatus(Mockito.anyString(), Mockito.eq("DResult"), Mockito.anyString())).thenReturn(emptyEventList);
381 private void assertResponse(Either<Service, ResponseFormat> createResponse, ActionStatus expectedStatus, String... variables) {
382 assertResponse(createResponse.right().value(), expectedStatus, variables);
385 protected void assertComponentException(ComponentException e, ActionStatus expectedStatus, String... variables) {
386 ResponseFormat actualResponse = e.getResponseFormat() != null ?
387 e.getResponseFormat() : componentsUtils.getResponseFormat(e.getActionStatus(), e.getParams());
388 assertResponse(actualResponse, expectedStatus, variables);
391 protected void assertResponse(ResponseFormat actualResponse, ActionStatus expectedStatus, String... variables) {
392 ResponseFormat expectedResponse = responseManager.getResponseFormat(expectedStatus, variables);
393 assertEquals(expectedResponse.getStatus(), actualResponse.getStatus());
394 assertEquals(expectedResponse.getFormattedMessage(), actualResponse.getFormattedMessage(), "assert error description");