aboutsummaryrefslogtreecommitdiffstats
path: root/catalog-be/src/main/java/org/openecomp/sdc/be/components/lifecycle/CertificationRequestTransition.java
blob: 4a7f44673978dafa7e6da10bca5d24503a521a7b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.sdc.be.components.lifecycle;

import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.Set;

import org.openecomp.sdc.be.components.distribution.engine.ServiceDistributionArtifactsBuilder;
import org.openecomp.sdc.be.components.impl.ComponentBusinessLogic;
import org.openecomp.sdc.be.components.impl.ServiceBusinessLogic;
import org.openecomp.sdc.be.config.BeEcompErrorManager;
import org.openecomp.sdc.be.dao.api.ActionStatus;
import org.openecomp.sdc.be.dao.jsongraph.TitanDao;
import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
import org.openecomp.sdc.be.datatypes.enums.NodeTypeEnum;
import org.openecomp.sdc.be.datatypes.enums.OriginTypeEnum;
import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
import org.openecomp.sdc.be.impl.ComponentsUtils;
import org.openecomp.sdc.be.model.ArtifactDefinition;
import org.openecomp.sdc.be.model.Component;
import org.openecomp.sdc.be.model.ComponentInstance;
import org.openecomp.sdc.be.model.LifeCycleTransitionEnum;
import org.openecomp.sdc.be.model.LifecycleStateEnum;
import org.openecomp.sdc.be.model.Operation;
import org.openecomp.sdc.be.model.Resource;
import org.openecomp.sdc.be.model.Service;
import org.openecomp.sdc.be.model.User;
import org.openecomp.sdc.be.model.jsontitan.datamodel.ToscaElement;
import org.openecomp.sdc.be.model.jsontitan.datamodel.ToscaElementTypeEnum;
import org.openecomp.sdc.be.model.jsontitan.operations.ToscaElementLifecycleOperation;
import org.openecomp.sdc.be.model.jsontitan.operations.ToscaOperationFacade;
import org.openecomp.sdc.be.model.jsontitan.utils.ModelConverter;
import org.openecomp.sdc.be.model.operations.api.StorageOperationStatus;
import org.openecomp.sdc.be.model.operations.impl.CapabilityOperation;
import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
import org.openecomp.sdc.be.tosca.ToscaExportHandler;
import org.openecomp.sdc.be.user.Role;
import org.openecomp.sdc.common.util.ValidationUtils;
import org.openecomp.sdc.exception.ResponseFormat;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import fj.data.Either;

public class CertificationRequestTransition extends LifeCycleTransition {

	private static Logger log = LoggerFactory.getLogger(CertificationRequestTransition.class.getName());

	private CapabilityOperation capabilityOperation;
	private ServiceBusinessLogic serviceBusinessLogic;
	public CertificationRequestTransition(ComponentsUtils componentUtils, ToscaElementLifecycleOperation lifecycleOperation, ServiceDistributionArtifactsBuilder serviceDistributionArtifactsBuilder, ServiceBusinessLogic serviceBusinessLogic,
			CapabilityOperation capabilityOperation, ToscaExportHandler toscaExportUtils, ToscaOperationFacade toscaOperationFacade, TitanDao titanDao) {
		super(componentUtils, lifecycleOperation, toscaOperationFacade, titanDao);

		// authorized roles
		Role[] resourceServiceCheckoutRoles = { Role.ADMIN, Role.DESIGNER };
		// Role[] productCheckoutRoles = {Role.ADMIN, Role.PRODUCT_MANAGER,
		// Role.PRODUCT_STRATEGIST};
		addAuthorizedRoles(ComponentTypeEnum.RESOURCE, Arrays.asList(resourceServiceCheckoutRoles));
		addAuthorizedRoles(ComponentTypeEnum.SERVICE, Arrays.asList(resourceServiceCheckoutRoles));
		// TODO to be later defined for product
		// addAuthorizedRoles(ComponentTypeEnum.PRODUCT,
		// Arrays.asList(productCheckoutRoles));
		
		//additional authorized roles for resource type
		Role[] resourceRoles = { Role.TESTER};
		addResouceAuthorizedRoles(ResourceTypeEnum.VFCMT, Arrays.asList(resourceRoles));

		this.serviceBusinessLogic = serviceBusinessLogic;
		this.capabilityOperation = capabilityOperation;
	}

	@Override
	public LifeCycleTransitionEnum getName() {
		return LifeCycleTransitionEnum.CERTIFICATION_REQUEST;
	}

	@Override
	public AuditingActionEnum getAuditingAction() {
		return AuditingActionEnum.CERTIFICATION_REQUEST_RESOURCE;
	}

	protected Either<Boolean, ResponseFormat> validateAllResourceInstanceCertified(Component component) {
		Either<Boolean, ResponseFormat> eitherResult = Either.left(true);

		List<ComponentInstance> resourceInstance = component.getComponentInstances();
		if (resourceInstance != null) {
			Optional<ComponentInstance> nonCertifiedRIOptional = resourceInstance.stream().filter(p -> !ValidationUtils.validateCertifiedVersion(p.getComponentVersion())).findAny();
			// Uncertified Resource Found
			if (nonCertifiedRIOptional.isPresent()) {
				ComponentInstance nonCertifiedRI = nonCertifiedRIOptional.get();
				ResponseFormat resFormat = getRelevantResponseFormatUncertifiedRI(nonCertifiedRI, component.getComponentType());
				eitherResult = Either.right(resFormat);
			}
		}
		return eitherResult;
	}

	private ResponseFormat getRelevantResponseFormatUncertifiedRI(ComponentInstance nonCertifiedRI, ComponentTypeEnum componentType) {

		ResponseFormat responseFormat;
		Either<Resource, StorageOperationStatus> eitherResource = toscaOperationFacade.getToscaElement(nonCertifiedRI.getComponentUid());
		if (eitherResource.isRight()) {

			responseFormat = componentUtils.getResponseFormat(ActionStatus.GENERAL_ERROR);

		} else {
			ActionStatus actionStatus;
			Resource resource = eitherResource.left().value();
			Either<Resource, StorageOperationStatus> status = toscaOperationFacade.findLastCertifiedToscaElementByUUID(resource);

			if (ValidationUtils.validateMinorVersion(nonCertifiedRI.getComponentVersion())) {
				if (status.isRight() || status.left().value() == null) {
					actionStatus = ActionStatus.VALIDATED_RESOURCE_NOT_FOUND;
				} else {
					actionStatus = ActionStatus.FOUND_ALREADY_VALIDATED_RESOURCE;
				}
			} else {
				if (status.isRight() || status.left().value() == null)
					actionStatus = ActionStatus.FOUND_LIST_VALIDATED_RESOURCES;
				else {
					actionStatus = ActionStatus.FOUND_ALREADY_VALIDATED_RESOURCE;
				}

			}
			String compType = (componentType == ComponentTypeEnum.RESOURCE) ? "VF" : "service";
			responseFormat = componentUtils.getResponseFormat(actionStatus, compType, resource.getName());
		}
		return responseFormat;
	}

	private Either<ActionStatus, Map<String, ArtifactDefinition>> validateMandatoryArtifactsSupplied(Map<String, ArtifactDefinition> artifacts) {

		if (artifacts == null || artifacts.isEmpty()) {
			return Either.left(ActionStatus.OK);
		}

		Map<String, ArtifactDefinition> invalidArtifacts = new HashMap<>();
		for (Entry<String, ArtifactDefinition> artifact : artifacts.entrySet()) {

			ArtifactDefinition artifactDefinition = artifact.getValue();
			if (artifactDefinition.getMandatory()) {
				String artifactEsId = artifactDefinition.getEsId();
				if (artifactEsId == null || artifactEsId.isEmpty()) {
					invalidArtifacts.put(artifact.getKey(), artifactDefinition);
				}
			}
		}

		if (invalidArtifacts.isEmpty()) {
			return Either.left(ActionStatus.OK);
		} else {
			return Either.right(invalidArtifacts);
		}
	}

	@Override
	public Either<? extends Component, ResponseFormat> changeState(ComponentTypeEnum componentType, Component component, ComponentBusinessLogic componentBl, User modifier, User owner, boolean shouldLock, boolean inTransaction) {

		log.debug("start performing certification request for resource {}", component.getUniqueId());

		ActionStatus actionStatus;
		ResponseFormat responseFormat;
		Either<? extends Component, ResponseFormat> result = null;
		try{
			if (component.getToscaType().equals(ToscaElementTypeEnum.TopologyTemplate.getValue())) {
	
				Either<Boolean, ResponseFormat> statusCert = validateAllResourceInstanceCertified(component);
				if (statusCert.isRight()) {
					return Either.right(statusCert.right().value());
				}
	
				statusCert = validateConfiguredAtomicReqCapSatisfied(component);
				if (statusCert.isRight()) {
					return Either.right(statusCert.right().value());
				}
			}
			if (componentType == ComponentTypeEnum.SERVICE) {
			
				Either<Service, ResponseFormat> generateHeatEnvResult = serviceBusinessLogic.generateHeatEnvArtifacts((Service) component, modifier, shouldLock);
						
				if (generateHeatEnvResult.isRight()) {
						return Either.right(generateHeatEnvResult.right().value());
					}
				Either<Service, ResponseFormat> generateVfModuleResult = serviceBusinessLogic.generateVfModuleArtifacts((Service) component, modifier, shouldLock);
				if (generateVfModuleResult.isRight()) {
						return Either.right(generateVfModuleResult.right().value());
				}
			}
	
			Either<Either<ArtifactDefinition, Operation>, ResponseFormat> eitherPopulated = componentBl.populateToscaArtifacts(component, modifier, true, inTransaction, shouldLock);
			if (eitherPopulated != null && eitherPopulated.isRight()) {
				return Either.right(eitherPopulated.right().value());
			}
	
			NodeTypeEnum nodeType = componentType.equals(ComponentTypeEnum.SERVICE) ? NodeTypeEnum.Service : NodeTypeEnum.Resource;
			
			
			Either<ToscaElement, StorageOperationStatus> certificationRequestResult = lifeCycleOperation.requestCertificationToscaElement(component.getUniqueId(), modifier.getUserId(), owner.getUserId());
			if (certificationRequestResult.isRight()) {
				log.debug("checkout failed on graph");
				StorageOperationStatus response = certificationRequestResult.right().value();
				actionStatus = componentUtils.convertFromStorageResponse(response);
	
				if (response.equals(StorageOperationStatus.ENTITY_ALREADY_EXISTS)) {
					actionStatus = ActionStatus.COMPONENT_VERSION_ALREADY_EXIST;
				}
				responseFormat = componentUtils.getResponseFormatByComponent(actionStatus, component, componentType);
				result =  Either.right(responseFormat);
			}
			else {
				result =  Either.left(ModelConverter.convertFromToscaElement(certificationRequestResult.left().value()));
			}
	} finally {
		if (result == null || result.isRight()) {
			BeEcompErrorManager.getInstance().logBeDaoSystemError("Change LifecycleState");
			if (!inTransaction) {
				log.debug("operation failed. do rollback");
				titanDao.rollback();
			}
		} else {
			if (!inTransaction) {
				log.debug("operation success. do commit");
				titanDao.commit();
			}
		}
	}
		return result;
	}

	private Either<Boolean, ResponseFormat> validateConfiguredAtomicReqCapSatisfied(Component component) {
		log.debug("Submit for testing validation - Start validating configured req/cap satisfied for inner atomic instances, component id:{}", component.getUniqueId());
		List<ComponentInstance> componentInstances = component.getComponentInstances();
		if (componentInstances != null) {
			// Prepare relationships data structures
			// Better make it list than set in case we need to count req/cap
			// occurrences in the future
			Map<String, List<String>> reqName2Ids = new HashMap<>();
			Map<String, List<String>> capName2Ids = new HashMap<>();
//			Either<Boolean, ResponseFormat>  parseRelationsForReqCapVerificationRes = parseRelationsForReqCapVerification(component, reqName2Ids, capName2Ids);
//			if(parseRelationsForReqCapVerificationRes.isRight()){
//				return parseRelationsForReqCapVerificationRes;
//			}
			Map<String, Set<String>> requirementsToFulfillBeforeCert = configurationManager.getConfiguration().getRequirementsToFulfillBeforeCert();
			Map<String, Set<String>> capabilitiesToConsumeBeforeCert = configurationManager.getConfiguration().getCapabilitiesToConsumeBeforeCert();
			for (ComponentInstance compInst : componentInstances) {
				String compInstId = compInst.getUniqueId();
				OriginTypeEnum originType = compInst.getOriginType();
				if (originType == null) {
					log.error("Origin type is not set for component instance {} - it shouldn't happen. Skipping this component instance...", compInst.getUniqueId());
					continue;
				}
				String compInstType = originType.getValue();
				// Validating configured requirements fulfilled
				if (null != requirementsToFulfillBeforeCert) {
					Set<String> reqToFulfillForType = requirementsToFulfillBeforeCert.get(compInstType);
					if (reqToFulfillForType != null) {
						for (String reqNameToFulfill : reqToFulfillForType) {
							List<String> reqNameList = reqName2Ids.get(reqNameToFulfill);
							if (reqNameList == null || !reqNameList.contains(compInstId)) {
								log.debug("Requirement {} wasn't fulfilled for component instance {} of type {}", reqNameToFulfill, compInstId, compInstType);
								ComponentTypeEnum componentType = component.getComponentType();
								String compParam = (componentType == ComponentTypeEnum.RESOURCE) ? "VF" : componentType.getValue().toLowerCase();
								ResponseFormat responseFormat = componentUtils.getResponseFormat(ActionStatus.REQ_CAP_NOT_SATISFIED_BEFORE_CERTIFICATION, component.getName(), compParam, originType.getDisplayValue(), compInst.getName(), "requirement",
										reqNameToFulfill, "fulfilled");
								return Either.right(responseFormat);
							}
						}
					}
				}
				// Validating configured capabilities consumed
				if (null != capabilitiesToConsumeBeforeCert) {
					Set<String> capToConsumeForType = capabilitiesToConsumeBeforeCert.get(compInstType);
					if (capToConsumeForType != null) {
						for (String capNameToConsume : capToConsumeForType) {
							List<String> capNameList = capName2Ids.get(capNameToConsume);
							if (capNameList == null || !capNameList.contains(compInstId)) {
								log.debug("Capability {} wasn't consumed for component instance {} of type {}", capNameToConsume, compInstId, compInstType);
								ComponentTypeEnum componentType = component.getComponentType();
								String compParam = (componentType == ComponentTypeEnum.RESOURCE) ? "VF" : componentType.getValue().toLowerCase();
								ResponseFormat responseFormat = componentUtils.getResponseFormat(ActionStatus.REQ_CAP_NOT_SATISFIED_BEFORE_CERTIFICATION, component.getName(), compParam, originType.getDisplayValue(), compInst.getName(), "capability",
										capNameToConsume, "consumed");
								return Either.right(responseFormat);
							}
						}
					}
				}
			}
		}
		log.debug("Submit for testing validation - validating configured req/cap satisfied for inner atomic instances finished successfully, component id:{}", component.getUniqueId());
		return Either.left(true);
	}

	@Override
	public Either<Boolean, ResponseFormat> validateBeforeTransition(Component component, ComponentTypeEnum componentType, User modifier, User owner, LifecycleStateEnum oldState, LifecycleChangeInfoWithAction lifecycleChangeInfo) {
		String componentName = component.getComponentMetadataDefinition().getMetadataDataDefinition().getName();
		log.debug("validate before certification request. resource name={}, oldState={}, owner userId={}", componentName, oldState, owner.getUserId());

		// validate user
		Either<Boolean, ResponseFormat> userValidationResponse = userRoleValidation(modifier,component, componentType, lifecycleChangeInfo);
		if (userValidationResponse.isRight()) {
			return userValidationResponse;
		}

		// case of "atomic" checkin and certification request - modifier must be
		// the owner
		if (oldState.equals(LifecycleStateEnum.NOT_CERTIFIED_CHECKOUT) && !modifier.equals(owner) && !modifier.getRole().equals(Role.ADMIN.name())) {
			ResponseFormat error = componentUtils.getResponseFormat(ActionStatus.COMPONENT_CHECKOUT_BY_ANOTHER_USER, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
			return Either.right(error);
		}

		// other states
		if (oldState.equals(LifecycleStateEnum.CERTIFIED)) {
			ResponseFormat error = componentUtils.getResponseFormat(ActionStatus.COMPONENT_ALREADY_CERTIFIED, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
			return Either.right(error);
		}
		if (oldState.equals(LifecycleStateEnum.CERTIFICATION_IN_PROGRESS)) {
			ResponseFormat error = componentUtils.getResponseFormat(ActionStatus.COMPONENT_IN_CERT_IN_PROGRESS_STATE, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
			return Either.right(error);
		}
		if (oldState.equals(LifecycleStateEnum.READY_FOR_CERTIFICATION)) {
			ResponseFormat error = componentUtils.getResponseFormat(ActionStatus.COMPONENT_SENT_FOR_CERTIFICATION, componentName, componentType.name().toLowerCase(), owner.getFirstName(), owner.getLastName(), owner.getUserId());
			return Either.right(error);
		}

		return Either.left(true);
	}
}