apih resume request handling more generic

getInstanceName throws exception if requestScope doesn't match modelType
Updated to combine separate return statements
Replaced if statements for modelType and added tests
Replace if statements for modelType in ResumeOrchestrationRequest and
added tests
Added coverage for setId in ModelType
Updated to use ModelType setters/getters
model type can now get and set generically
Added modelInfo to RequestBody for resume request
Added getModelType call and unit tests
Moved getModelType from ServiceInstances
Moved getModelType and added unit tests
Added tests for getIsBaseVfModule
Added more tests for isBaseVfModule
Began adding tests for getIsBaseVfModule
Updated currentActiveRequest creation and isBaseVfModule
Updated recipe lookup and setting of aLaCarte to be more general
Updated concurrency control to include other resources

Change-Id: I12ad011d0a021c3ee066e16b4c8a4526d040cbe3
Issue-ID: SO-1963
Signed-off-by: Benjamin, Max (mb388a) <mb388a@us.att.com>

3 files changed, 159 insertions, 101 deletions

diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/RequestHandlerUtils.java b/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/RequestHandlerUtils.java
index 2a0718aeba..4e910e5382 100644
--- a/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/RequestHandlerUtils.java
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/RequestHandlerUtils.java
@@ -59,7 +59,9 @@ import org.onap.so.apihandlerinfra.exceptions.ContactCamundaException;
 import org.onap.so.apihandlerinfra.exceptions.DuplicateRequestException;
 import org.onap.so.apihandlerinfra.exceptions.RequestDbFailureException;
 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
+import org.onap.so.apihandlerinfra.exceptions.VfModuleNotFoundException;
 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
+import org.onap.so.db.catalog.beans.VfModule;
 import org.onap.so.db.catalog.client.CatalogDbClient;
 import org.onap.so.db.request.beans.InfraActiveRequests;
 import org.onap.so.db.request.client.RequestsDbClient;
@@ -67,6 +69,7 @@ import org.onap.so.exceptions.ValidationException;
 import org.onap.so.logger.ErrorCode;
 import org.onap.so.logger.LogConstants;
 import org.onap.so.logger.MessageEnum;
+import org.onap.so.serviceinstancebeans.ModelInfo;
 import org.onap.so.serviceinstancebeans.ModelType;
 import org.onap.so.serviceinstancebeans.RelatedInstance;
 import org.onap.so.serviceinstancebeans.RelatedInstanceList;
@@ -638,11 +641,70 @@ public class RequestHandlerUtils {
             request.setRequestBody(infraActiveRequest.getRequestBody());
             request.setAicCloudRegion(infraActiveRequest.getAicCloudRegion());
             request.setRequestScope(infraActiveRequest.getRequestScope());
-            request.setServiceInstanceId(infraActiveRequest.getServiceInstanceId());
-            request.setServiceInstanceName(infraActiveRequest.getServiceInstanceName());
             request.setRequestAction(infraActiveRequest.getRequestAction());
+            setInstanceIdAndName(infraActiveRequest, request);
         }
         return request;
     }
 
+    protected void setInstanceIdAndName(InfraActiveRequests infraActiveRequest,
+            InfraActiveRequests currentActiveRequest) {
+        String requestScope = infraActiveRequest.getRequestScope();
+        try {
+            ModelType type = ModelType.valueOf(requestScope);
+            type.setName(currentActiveRequest, type.getName(infraActiveRequest));
+            type.setId(currentActiveRequest, type.getId(infraActiveRequest));
+        } catch (IllegalArgumentException e) {
+            logger.error(
+                    "requestScope \"{}\" does not match a ModelType enum. Unable to set instanceId and instanceName from the original request.",
+                    requestScope);
+        }
+    }
+
+    protected Boolean getIsBaseVfModule(ModelInfo modelInfo, Actions action, String vnfType,
+            String sdcServiceModelVersion, InfraActiveRequests currentActiveReq) throws ApiException {
+        // Get VF Module-specific base module indicator
+        VfModule vfm = null;
+        String modelVersionId = modelInfo.getModelVersionId();
+        Boolean isBaseVfModule = false;
+
+        if (modelVersionId != null) {
+            vfm = catalogDbClient.getVfModuleByModelUUID(modelVersionId);
+        } else if (modelInfo.getModelInvariantId() != null && modelInfo.getModelVersion() != null) {
+            vfm = catalogDbClient.getVfModuleByModelInvariantUUIDAndModelVersion(modelInfo.getModelInvariantId(),
+                    modelInfo.getModelVersion());
+        }
+
+        if (vfm != null) {
+            if (vfm.getIsBase()) {
+                isBaseVfModule = true;
+            }
+        } else if (action == Action.createInstance || action == Action.updateInstance) {
+            String serviceVersionText = "";
+            if (sdcServiceModelVersion != null && !sdcServiceModelVersion.isEmpty()) {
+                serviceVersionText = " with version " + sdcServiceModelVersion;
+            }
+            String errorMessage = "VnfType " + vnfType + " and VF Module Model Name " + modelInfo.getModelName()
+                    + serviceVersionText + " not found in MSO Catalog DB";
+            ErrorLoggerInfo errorLoggerInfo =
+                    new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
+                            .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
+            VfModuleNotFoundException vfModuleException = new VfModuleNotFoundException.Builder(errorMessage,
+                    HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
+            updateStatus(currentActiveReq, Status.FAILED, vfModuleException.getMessage());
+            throw vfModuleException;
+        }
+        return isBaseVfModule;
+    }
+
+    protected ModelType getModelType(Actions action, ModelInfo modelInfo) {
+        if (action == Action.applyUpdatedConfig || action == Action.inPlaceSoftwareUpdate) {
+            return ModelType.vnf;
+        } else if (action == Action.addMembers || action == Action.removeMembers) {
+            return ModelType.instanceGroup;
+        } else {
+            return modelInfo.getModelType();
+        }
+    }
+
 }
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/ResumeOrchestrationRequest.java b/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/ResumeOrchestrationRequest.java
index abf3729215..32d2c50978 100644
--- a/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/ResumeOrchestrationRequest.java
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/ResumeOrchestrationRequest.java
@@ -47,6 +47,8 @@ import org.onap.so.logger.HttpHeadersConstants;
 import org.onap.so.logger.LogConstants;
 import org.onap.so.logger.MdcConstants;
 import org.onap.so.logger.MessageEnum;
+import org.onap.so.serviceinstancebeans.ModelInfo;
+import org.onap.so.serviceinstancebeans.ModelType;
 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -74,6 +76,8 @@ public class ResumeOrchestrationRequest {
     @Autowired
     private RequestsDbClient requestsDbClient;
 
+    @Autowired
+    private MsoRequest msoRequest;
 
     @POST
     @Path("/{version:[vV][7]}/requests/{requestId}/resume")
@@ -128,24 +132,26 @@ public class ResumeOrchestrationRequest {
         String requestBody = infraActiveRequest.getRequestBody();
         Action action = Action.valueOf(infraActiveRequest.getRequestAction());
         String requestId = currentActiveRequest.getRequestId();
-        String serviceInstanceName = infraActiveRequest.getServiceInstanceName();
         String requestScope = infraActiveRequest.getRequestScope();
-        String serviceInstanceId = infraActiveRequest.getServiceInstanceId();
+        String instanceName = getInstanceName(infraActiveRequest, requestScope, currentActiveRequest);
+        HashMap<String, String> instanceIdMap = setInstanceIdMap(infraActiveRequest, requestScope);
 
-        checkForInProgressRequest(currentActiveRequest, serviceInstanceId, requestScope, serviceInstanceName, action);
+        checkForInProgressRequest(currentActiveRequest, instanceIdMap, requestScope, instanceName, action);
 
         ServiceInstancesRequest sir = null;
         sir = requestHandlerUtils.convertJsonToServiceInstanceRequest(requestBody, action, requestId, requestUri);
         Boolean aLaCarte = sir.getRequestDetails().getRequestParameters().getALaCarte();
-        if (aLaCarte == null) {
-            aLaCarte = false;
-        }
 
         String pnfCorrelationId = serviceInstances.getPnfCorrelationId(sir);
-        RecipeLookupResult recipeLookupResult = serviceRecipeLookup(currentActiveRequest, sir, action, aLaCarte);
+        RecipeLookupResult recipeLookupResult = serviceInstances.getServiceInstanceOrchestrationURI(sir, action,
+                msoRequest.getAlacarteFlag(sir), currentActiveRequest);
 
         requestDbSave(currentActiveRequest);
 
+        if (aLaCarte == null) {
+            aLaCarte = setALaCarteFlagIfNull(requestScope, action);
+        }
+
         RequestClientParameter requestClientParameter = setRequestClientParameter(recipeLookupResult, version,
                 infraActiveRequest, currentActiveRequest, pnfCorrelationId, aLaCarte, sir);
 
@@ -153,40 +159,60 @@ public class ResumeOrchestrationRequest {
                 recipeLookupResult.getOrchestrationURI(), requestScope);
     }
 
-    protected void checkForInProgressRequest(InfraActiveRequests currentActiveRequest, String serviceInstanceId,
-            String requestScope, String serviceInstanceName, Action action) throws ApiException {
-        boolean inProgress = false;
-        HashMap<String, String> instanceIdMap = new HashMap<>();
-        instanceIdMap.put("serviceInstanceId", serviceInstanceId);
-        InfraActiveRequests requestInProgress = requestHandlerUtils.duplicateCheck(action, instanceIdMap,
-                serviceInstanceName, requestScope, currentActiveRequest);
-        if (requestInProgress != null) {
-            inProgress = requestHandlerUtils.camundaHistoryCheck(requestInProgress, currentActiveRequest);
+    protected Boolean setALaCarteFlagIfNull(String requestScope, Action action) {
+        Boolean aLaCarteFlag;
+        if (!requestScope.equalsIgnoreCase(ModelType.service.name()) && action != Action.recreateInstance) {
+            aLaCarteFlag = true;
+        } else {
+            aLaCarteFlag = false;
         }
-        if (inProgress) {
-            requestHandlerUtils.buildErrorOnDuplicateRecord(currentActiveRequest, action, instanceIdMap,
-                    serviceInstanceName, requestScope, requestInProgress);
+        return aLaCarteFlag;
+    }
+
+    protected HashMap<String, String> setInstanceIdMap(InfraActiveRequests infraActiveRequest, String requestScope) {
+        HashMap<String, String> instanceIdMap = new HashMap<>();
+        ModelType type;
+        try {
+            type = ModelType.valueOf(requestScope);
+            instanceIdMap.put(type.name() + "InstanceId", type.getId(infraActiveRequest));
+        } catch (IllegalArgumentException e) {
+            logger.error("requestScope \"{}\" does not match a ModelType enum.", requestScope);
         }
+        return instanceIdMap;
     }
 
-    protected RecipeLookupResult serviceRecipeLookup(InfraActiveRequests currentActiveRequest,
-            ServiceInstancesRequest sir, Action action, Boolean aLaCarte)
-            throws ValidateException, RequestDbFailureException {
-        RecipeLookupResult recipeLookupResult = null;
+    protected String getInstanceName(InfraActiveRequests infraActiveRequest, String requestScope,
+            InfraActiveRequests currentActiveRequest) throws ValidateException, RequestDbFailureException {
+        ModelType type;
+        String instanceName = "";
         try {
-            recipeLookupResult = serviceInstances.getServiceURI(sir, action, aLaCarte);
-        } catch (IOException e) {
-            logger.error("IOException while performing service recipe lookup", e);
-            ErrorLoggerInfo errorLoggerInfo =
-                    new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
-                            .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
-            ValidateException validateException =
-                    new ValidateException.Builder(e.getMessage(), HttpStatus.SC_BAD_REQUEST,
-                            ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
+            type = ModelType.valueOf(requestScope);
+            instanceName = type.getName(infraActiveRequest);
+        } catch (IllegalArgumentException e) {
+            logger.error("requestScope \"{}\" does not match a ModelType enum.", requestScope);
+            ValidateException validateException = new ValidateException.Builder(
+                    "requestScope: \"" + requestScope + "\" from request: " + infraActiveRequest.getRequestId()
+                            + " does not match a ModelType enum.",
+                    HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e).build();
             requestHandlerUtils.updateStatus(currentActiveRequest, Status.FAILED, validateException.getMessage());
             throw validateException;
         }
-        return recipeLookupResult;
+        return instanceName;
+    }
+
+    protected void checkForInProgressRequest(InfraActiveRequests currentActiveRequest,
+            HashMap<String, String> instanceIdMap, String requestScope, String instanceName, Action action)
+            throws ApiException {
+        boolean inProgress = false;
+        InfraActiveRequests requestInProgress = requestHandlerUtils.duplicateCheck(action, instanceIdMap, instanceName,
+                requestScope, currentActiveRequest);
+        if (requestInProgress != null) {
+            inProgress = requestHandlerUtils.camundaHistoryCheck(requestInProgress, currentActiveRequest);
+        }
+        if (inProgress) {
+            requestHandlerUtils.buildErrorOnDuplicateRecord(currentActiveRequest, action, instanceIdMap, instanceName,
+                    requestScope, requestInProgress);
+        }
     }
 
     protected void requestDbSave(InfraActiveRequests currentActiveRequest) throws RequestDbFailureException {
@@ -204,23 +230,37 @@ public class ResumeOrchestrationRequest {
 
     protected RequestClientParameter setRequestClientParameter(RecipeLookupResult recipeLookupResult, String version,
             InfraActiveRequests infraActiveRequest, InfraActiveRequests currentActiveRequest, String pnfCorrelationId,
-            Boolean aLaCarte, ServiceInstancesRequest sir) throws ValidateException {
+            Boolean aLaCarte, ServiceInstancesRequest sir) throws ApiException {
         RequestClientParameter requestClientParameter = null;
+        Action action = Action.valueOf(infraActiveRequest.getRequestAction());
+        ModelInfo modelInfo = sir.getRequestDetails().getModelInfo();
+
+        Boolean isBaseVfModule = false;
+        if (requestHandlerUtils.getModelType(action, modelInfo).equals(ModelType.vfModule)) {
+            isBaseVfModule = requestHandlerUtils.getIsBaseVfModule(modelInfo, action, infraActiveRequest.getVnfType(),
+                    msoRequest.getSDCServiceModelVersion(sir), currentActiveRequest);
+        }
+
         try {
-            requestClientParameter = new RequestClientParameter.Builder()
-                    .setRequestId(currentActiveRequest.getRequestId())
-                    .setRecipeTimeout(recipeLookupResult.getRecipeTimeout())
-                    .setRequestAction(infraActiveRequest.getRequestAction())
-                    .setServiceInstanceId(infraActiveRequest.getServiceInstanceId())
-                    .setPnfCorrelationId(pnfCorrelationId).setVnfId(infraActiveRequest.getVnfId())
-                    .setVfModuleId(infraActiveRequest.getVfModuleId())
-                    .setVolumeGroupId(infraActiveRequest.getVolumeGroupId())
-                    .setNetworkId(infraActiveRequest.getNetworkId()).setServiceType(infraActiveRequest.getServiceType())
-                    .setVnfType(infraActiveRequest.getVnfType()).setNetworkType(infraActiveRequest.getNetworkType())
-                    .setRequestDetails(requestHandlerUtils.mapJSONtoMSOStyle(infraActiveRequest.getRequestBody(), sir,
-                            aLaCarte, Action.valueOf(infraActiveRequest.getRequestAction())))
-                    .setApiVersion(version).setALaCarte(aLaCarte).setRequestUri(currentActiveRequest.getRequestUrl())
-                    .setInstanceGroupId(infraActiveRequest.getInstanceGroupId()).build();
+            requestClientParameter =
+                    new RequestClientParameter.Builder().setRequestId(currentActiveRequest.getRequestId())
+                            .setBaseVfModule(isBaseVfModule).setRecipeTimeout(recipeLookupResult.getRecipeTimeout())
+                            .setRequestAction(infraActiveRequest.getRequestAction())
+                            .setServiceInstanceId(infraActiveRequest.getServiceInstanceId())
+                            .setPnfCorrelationId(pnfCorrelationId).setVnfId(infraActiveRequest.getVnfId())
+                            .setVfModuleId(infraActiveRequest.getVfModuleId())
+                            .setVolumeGroupId(infraActiveRequest.getVolumeGroupId())
+                            .setNetworkId(infraActiveRequest.getNetworkId())
+                            .setServiceType(infraActiveRequest.getServiceType())
+                            .setVnfType(infraActiveRequest.getVnfType())
+                            .setVfModuleType(msoRequest.getVfModuleType(sir, infraActiveRequest.getRequestScope(),
+                                    action, Integer.parseInt(version)))
+                            .setNetworkType(infraActiveRequest.getNetworkType())
+                            .setRequestDetails(requestHandlerUtils
+                                    .mapJSONtoMSOStyle(infraActiveRequest.getRequestBody(), sir, aLaCarte, action))
+                            .setApiVersion(version).setALaCarte(aLaCarte)
+                            .setRequestUri(currentActiveRequest.getRequestUrl())
+                            .setInstanceGroupId(infraActiveRequest.getInstanceGroupId()).build();
         } catch (IOException e) {
             logger.error("IOException while generating requestClientParameter to send to BPMN", e);
             ErrorLoggerInfo errorLoggerInfo =
diff --git a/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/ServiceInstances.java b/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/ServiceInstances.java
index 45319de5e8..68fa6e4f56 100644
--- a/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/ServiceInstances.java
+++ b/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/ServiceInstances.java
@@ -814,64 +814,20 @@ public class ServiceInstances {
         referencesResponse.setRequestId(requestId);
 
         serviceResponse.setRequestReferences(referencesResponse);
-        Boolean isBaseVfModule = false;
-
         RecipeLookupResult recipeLookupResult =
                 getServiceInstanceOrchestrationURI(sir, action, alaCarteFlag, currentActiveReq);
         String serviceInstanceType = requestHandlerUtils.getServiceType(requestScope, sir, alaCarteFlag);
-        ModelType modelType;
-        ModelInfo modelInfo = sir.getRequestDetails().getModelInfo();
-        if (action == Action.applyUpdatedConfig || action == Action.inPlaceSoftwareUpdate) {
-            modelType = ModelType.vnf;
-        } else if (action == Action.addMembers || action == Action.removeMembers) {
-            modelType = ModelType.instanceGroup;
-        } else {
-            modelType = modelInfo.getModelType();
-        }
-
-        if (modelType.equals(ModelType.vfModule)) {
-
-
-            // Get VF Module-specific base module indicator
-            VfModule vfm = null;
-
-            String modelVersionId = modelInfo.getModelVersionId();
 
-            if (modelVersionId != null) {
-                vfm = catalogDbClient.getVfModuleByModelUUID(modelVersionId);
-            } else if (modelInfo.getModelInvariantId() != null && modelInfo.getModelVersion() != null) {
-                vfm = catalogDbClient.getVfModuleByModelInvariantUUIDAndModelVersion(modelInfo.getModelInvariantId(),
-                        modelInfo.getModelVersion());
-            }
-
-            if (vfm != null) {
-                if (vfm.getIsBase()) {
-                    isBaseVfModule = true;
-                }
-            } else if (action == Action.createInstance || action == Action.updateInstance) {
-                // There is no entry for this vfModuleType with this version, if specified, in VF_MODULE table in
-                // Catalog DB.
-                // This request cannot proceed
-
-                String serviceVersionText = "";
-                if (sdcServiceModelVersion != null && !sdcServiceModelVersion.isEmpty()) {
-                    serviceVersionText = " with version " + sdcServiceModelVersion;
-                }
+        ModelInfo modelInfo = sir.getRequestDetails().getModelInfo();
+        ModelType modelType = requestHandlerUtils.getModelType(action, modelInfo);
 
-                String errorMessage = "VnfType " + vnfType + " and VF Module Model Name " + modelInfo.getModelName()
-                        + serviceVersionText + " not found in MSO Catalog DB";
-                ErrorLoggerInfo errorLoggerInfo =
-                        new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
-                                .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
-                VfModuleNotFoundException vfModuleException = new VfModuleNotFoundException.Builder(errorMessage,
-                        HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
-                requestHandlerUtils.updateStatus(currentActiveReq, Status.FAILED, vfModuleException.getMessage());
+        Boolean isBaseVfModule = false;
 
-                throw vfModuleException;
-            }
+        if (modelType.equals(ModelType.vfModule)) {
+            isBaseVfModule = requestHandlerUtils.getIsBaseVfModule(modelInfo, action, vnfType, sdcServiceModelVersion,
+                    currentActiveReq);
         }
 
-
         serviceInstanceId = requestHandlerUtils.setServiceInstanceId(requestScope, sir);
         String vnfId = "";
         String vfModuleId = "";
@@ -1030,7 +986,7 @@ public class ServiceInstances {
                 .orElse("");
     }
 
-    private RecipeLookupResult getServiceInstanceOrchestrationURI(ServiceInstancesRequest sir, Actions action,
+    protected RecipeLookupResult getServiceInstanceOrchestrationURI(ServiceInstancesRequest sir, Actions action,
             boolean alaCarteFlag, InfraActiveRequests currentActiveReq) throws ApiException {
         RecipeLookupResult recipeLookupResult = null;
         // if the aLaCarte flag is set to TRUE, the API-H should choose the VID_DEFAULT recipe for the requested action