Fix alacarte homing flows

This fix adds homingInstance
bean and stores homing info
in the database. It then
retreves that info when homing
ala carte and populates
homingSiteId and oofDirectives.
SO-1254

Issue-ID: SO-1258
Change-Id: I6f8d5d3aff9ebeb669064a02926c779886dc59dd
Signed-off-by: Marcus G K Williams <marcus.williams@intel.com>

5 files changed, 208 insertions, 36 deletions

diff --git a/bpmn/MSOCommonBPMN/src/main/groovy/org/onap/so/bpmn/common/scripts/OofHoming.groovy b/bpmn/MSOCommonBPMN/src/main/groovy/org/onap/so/bpmn/common/scripts/OofHoming.groovy
index c50ef3530e..df3399f1f0 100644
--- a/bpmn/MSOCommonBPMN/src/main/groovy/org/onap/so/bpmn/common/scripts/OofHoming.groovy
+++ b/bpmn/MSOCommonBPMN/src/main/groovy/org/onap/so/bpmn/common/scripts/OofHoming.groovy
@@ -33,6 +33,7 @@ import org.onap.so.bpmn.core.json.JsonUtils
 import org.onap.so.db.catalog.beans.AuthenticationType
 import org.onap.so.db.catalog.beans.CloudIdentity
 import org.onap.so.db.catalog.beans.CloudSite
+import org.onap.so.db.catalog.beans.HomingInstance
 import org.onap.so.db.catalog.beans.ServerType
 import org.onap.so.rest.APIResponse
 import org.onap.so.rest.RESTClient
@@ -293,8 +294,7 @@ class OofHoming extends AbstractServiceTaskProcessor {
                                     + " *****", "true")
 
                             // Set cloudsite in catalog DB here
-                            // TODO Get cloudsite and compare, set if not present
-                            oofUtils.createCloudSiteCatalogDb(cloudSite, execution)
+                            oofUtils.createCloudSite(cloudSite, execution)
 
                             if (oofDirectives != null && oofDirectives != "") {
                                 resource.getHomingSolution().setOofDirectives(oofDirectives)
@@ -303,6 +303,19 @@ class OofHoming extends AbstractServiceTaskProcessor {
                                         " *****", "true")
                             }
 
+                            // Set Homing Instance
+                            String serviceInstanceId = decomposition.getServiceInstance().getInstanceId()
+                            HomingInstance homingInstance = new HomingInstance()
+                            homingInstance.setServiceInstanceId(serviceInstanceId)
+                            homingInstance.setCloudOwner(cloudOwner)
+                            homingInstance.setCloudRegionId(cloudRegionId)
+                            if (oofDirectives != null && oofDirectives != "") {
+                                homingInstance.setOofDirectives(oofDirectives)}
+                            else {
+                                homingInstance.setOofDirectives("{}")
+                            }
+                            oofUtils.createHomingInstance(homingInstance, execution)
+
                             if (inventoryType.equalsIgnoreCase("service")) {
                                 resource.getHomingSolution().setRehome(assignmentMap.get("isRehome").toBoolean())
                                 VnfResource vnf = new VnfResource()
diff --git a/bpmn/MSOCommonBPMN/src/main/groovy/org/onap/so/bpmn/common/scripts/OofUtils.groovy b/bpmn/MSOCommonBPMN/src/main/groovy/org/onap/so/bpmn/common/scripts/OofUtils.groovy
index 19d19b8cea..f72fc47aa5 100644
--- a/bpmn/MSOCommonBPMN/src/main/groovy/org/onap/so/bpmn/common/scripts/OofUtils.groovy
+++ b/bpmn/MSOCommonBPMN/src/main/groovy/org/onap/so/bpmn/common/scripts/OofUtils.groovy
@@ -33,24 +33,16 @@ import org.onap.so.bpmn.core.domain.ServiceInstance
 import org.onap.so.bpmn.core.domain.Subscriber
 import org.onap.so.bpmn.core.domain.VnfResource
 import org.onap.so.bpmn.core.json.JsonUtils
-import org.onap.so.db.catalog.beans.CloudIdentity
 import org.onap.so.db.catalog.beans.CloudSite
-import org.onap.so.db.catalog.client.CatalogDbClient
-import org.onap.so.rest.APIResponse
-import org.onap.so.rest.RESTClient
-import org.onap.so.rest.RESTConfig
-import org.springframework.http.HttpEntity
-import org.springframework.http.HttpHeaders
-import org.springframework.web.util.UriComponentsBuilder
-
-import javax.ws.rs.core.MediaType
+import org.onap.so.db.catalog.beans.HomingInstance
 import javax.ws.rs.core.UriBuilder
-
+import org.onap.so.bpmn.common.util.OofInfraUtils
 import static org.onap.so.bpmn.common.scripts.GenericUtils.*
 
 class OofUtils {
     ExceptionUtil exceptionUtil = new ExceptionUtil()
     JsonUtils jsonUtil = new JsonUtils()
+    OofInfraUtils oofInfraUtils = new OofInfraUtils()
 
     private AbstractServiceTaskProcessor utils
 
@@ -491,6 +483,7 @@ class OofUtils {
         if (candidatesJson != "") {candidatesJson = candidatesJson.substring(0, candidatesJson.length() - 1)}
         return candidatesJson
     }
+
     /**
      * This method creates a cloudsite in catalog database.
      *
@@ -498,23 +491,19 @@ class OofUtils {
      *
      * @return void
      */
-    Void createCloudSiteCatalogDb(CloudSite cloudSite, DelegateExecution execution) {
-        def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
-        String endpoint = UrnPropertiesReader.getVariable("mso.catalog.db.spring.endpoint", execution)
-        String auth = UrnPropertiesReader.getVariable("mso.db.auth", execution)
-        CloudSite getCloudsite = null
+    Void createCloudSite(CloudSite cloudSite, DelegateExecution execution) {
+        oofInfraUtils.createCloudSite(cloudSite, execution)
+    }
 
-        CatalogDbClient catalogDbClient = new CatalogDbClient(endpoint, auth)
-        try {
-            getCloudsite = catalogDbClient.getCloudSite(cloudSite.getId().toString())
-        } catch (Exception e) {
-            e = null
-            utils.log("DEBUG", "Could not find cloudsite : " + cloudSite.getId(), isDebugEnabled)
-            utils.log("DEBUG", "Creating cloudSite: " + cloudSite.toString(), isDebugEnabled)
-        }
-        if (getCloudsite?.getId() != cloudSite.getId()) {
-            catalogDbClient.postCloudSite(cloudSite)
-        }
+    /**
+     * This method creates a HomingInstance in catalog database.
+     *
+     * @param HomingInstance homingInstance
+     *
+     * @return void
+     */
+    Void createHomingInstance(HomingInstance homingInstance, DelegateExecution execution) {
+        oofInfraUtils.createHomingInstance(homingInstance, execution)
     }
 
      String getMsbHost(DelegateExecution execution) {
diff --git a/bpmn/MSOCommonBPMN/src/main/java/org/onap/so/bpmn/common/util/OofInfraUtils.java b/bpmn/MSOCommonBPMN/src/main/java/org/onap/so/bpmn/common/util/OofInfraUtils.java
new file mode 100644
index 0000000000..b62d8be281
--- /dev/null
+++ b/bpmn/MSOCommonBPMN/src/main/java/org/onap/so/bpmn/common/util/OofInfraUtils.java
@@ -0,0 +1,103 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * Copyright (C) 2018. Intel Corp. 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.onap.so.bpmn.common.util;
+
+import org.camunda.bpm.engine.delegate.DelegateExecution;
+import org.onap.so.bpmn.core.UrnPropertiesReader;
+import org.onap.so.db.catalog.beans.CloudSite;
+import org.onap.so.db.catalog.beans.HomingInstance;
+import org.onap.so.db.catalog.client.CatalogDbClient;
+import org.onap.so.logger.MsoLogger;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+import java.util.Arrays;
+import java.util.Optional;
+
+public class OofInfraUtils {
+
+    private static final MsoLogger LOGGER = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL, OofInfraUtils.class);
+
+    /**
+     * This method creates a cloudsite in catalog database.
+     *
+     * @param cloudSite
+     *
+     * @return void
+     */
+    public void createCloudSite(CloudSite cloudSite, DelegateExecution execution) {
+        String endpoint = UrnPropertiesReader.getVariable("mso.catalog.db.spring.endpoint", execution);
+        String auth = UrnPropertiesReader.getVariable("mso.db.auth", execution);
+        Optional <CloudSite> optCloudsite = Optional.empty();
+
+        CatalogDbClient client = new CatalogDbClient(endpoint, auth);
+        try {
+            optCloudsite = Optional.ofNullable(client.getCloudSite(cloudSite.getId(), endpoint + "/cloudSite/"));
+        } catch (Exception e) {
+            LOGGER.debug("Could not find cloudsite : " + cloudSite.getId());
+            LOGGER.debug("Creating cloudSite: " + cloudSite.toString());
+        }
+        if (optCloudsite.isPresent() && (cloudSite.getId()) != optCloudsite.get().getId()) {
+            client.postCloudSite(cloudSite);
+        }
+    }
+
+    /**
+     * This method creates a HomingInstance in catalog database.
+     *
+     * @param homingInstance
+     *
+     * @return void
+     */
+    public void createHomingInstance(HomingInstance homingInstance, DelegateExecution execution) {
+        String endpoint = UrnPropertiesReader.getVariable("mso.catalog.db.spring.endpoint", execution);
+        String auth = UrnPropertiesReader.getVariable("mso.db.auth", execution);
+
+        CatalogDbClient client = new CatalogDbClient(endpoint, auth);
+        try {
+            client.postHomingInstance(homingInstance);
+        } catch (Exception exception) {
+            LOGGER.debug("Could not create HomingInstance : " + homingInstance.getServiceInstanceId());
+            LOGGER.debug("HomingInstance Creation Error: " + exception);
+        }
+
+    }
+
+    /**
+     * This method gets a HomingInstance in catalog database.
+     *
+     * @param serviceInstanceId
+     *
+     * @return HomingInstance
+     */
+    public HomingInstance getHomingInstance(String serviceInstanceId, DelegateExecution execution) {
+        String endpoint = UrnPropertiesReader.getVariable("mso.catalog.db.spring.endpoint", execution);
+        String auth = UrnPropertiesReader.getVariable("mso.db.auth", execution);
+
+        CatalogDbClient client = new CatalogDbClient(endpoint, auth);
+        try {
+            return client.getHomingInstance(serviceInstanceId, endpoint + "/homingInstance/");
+        } catch (Exception exception) {
+            LOGGER.debug("Could not get HomingInstance for serviceInstanceId : " + serviceInstanceId);
+            LOGGER.debug("Get HomingInstance Error: " + exception);
+        }
+        return null;
+    }
+}
diff --git a/bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/DoCreateVfModule.groovy b/bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/DoCreateVfModule.groovy
index 58b90a1bf2..74926ce5b7 100644
--- a/bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/DoCreateVfModule.groovy
+++ b/bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/DoCreateVfModule.groovy
@@ -20,6 +20,8 @@
 
 package org.onap.so.bpmn.infrastructure.scripts
 
+import org.onap.so.db.catalog.beans.HomingInstance
+
 import javax.xml.parsers.DocumentBuilder
 import javax.xml.parsers.DocumentBuilderFactory
 
@@ -35,6 +37,7 @@ import org.onap.so.bpmn.common.scripts.MsoUtils
 import org.onap.so.bpmn.common.scripts.NetworkUtils
 import org.onap.so.bpmn.common.scripts.SDNCAdapterUtils
 import org.onap.so.bpmn.common.scripts.VfModuleBase
+import org.onap.so.bpmn.common.util.OofInfraUtils
 import org.onap.so.bpmn.core.RollbackData
 import org.onap.so.bpmn.core.UrnPropertiesReader
 import org.onap.so.bpmn.core.WorkflowException
@@ -75,6 +78,7 @@ public class DoCreateVfModule extends VfModuleBase {
 	ExceptionUtil exceptionUtil = new ExceptionUtil()
 	JsonUtils jsonUtil = new JsonUtils()
 	SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils(this)
+	OofInfraUtils oofInfraUtils = new OofInfraUtils()
 	CatalogDbUtils catalog = new CatalogDbUtils()
 	DecomposeJsonUtil decomposeJsonUtils = new DecomposeJsonUtil()
 
@@ -232,12 +236,37 @@ public class DoCreateVfModule extends VfModuleBase {
 				String globalSubscriberId = execution.getVariable("globalSubscriberId")
 				execution.setVariable("DCVFM_globalSubscriberId", globalSubscriberId)
 				msoLogger.debug("globalSubsrciberId: " + globalSubscriberId)
-				//OofDirectives
-				String oofDirectives = execution.getVariable("oofDirectives")
+
+				// Set Homing Info
+				String oofDirectives = null
+				try {
+					HomingInstance homingInstance = oofInfraUtils.getHomingInstance(serviceInstanceId, execution)
+					if (homingInstance != null) {
+						execution.setVariable("DCVFM_cloudSiteId", homingInstance.getCloudRegionId())
+						rollbackData.put("VFMODULE", "aiccloudregion", homingInstance.getCloudRegionId())
+						msoLogger.debug("Overwriting cloudSiteId with homing cloudSiteId: " +
+								homingInstance.getCloudRegionId())
+						execution.setVariable("DCVFM_cloudOwner", homingInstance.getCloudOwner())
+						rollbackData.put("VFMODULE", "cloudOwner", homingInstance.getCloudOwner())
+						msoLogger.debug("Overwriting cloudOwner with homing cloudOwner: " +
+								homingInstance.getCloudOwner())
+						oofDirectives = homingInstance.getOofDirectives()
+						execution.setVariable("DCVFM_oofDirectives", oofDirectives)
+					}
+				} catch (Exception exception) {
+					msoLogger.debug("Could not find homing information for service instance: " + serviceInstanceId +
+							"... continuing")
+					msoLogger.debug("Could not find homing information for service instance error: " + exception)
+				}
+				//OofDirectives to Input Params
 				Map<String,String> vfModuleInputParams = execution.getVariable("vfModuleInputParams")
-				if (oofDirectives != null) {
-					vfModuleInputParams.put("oofDirectives", oofDirectives)
-					logDebug("OofDirectives are: " + oofDirectives, isDebugLogEnabled)
+				if (oofDirectives != null && vfModuleInputParams != null) {
+					vfModuleInputParams.put("oof_directives", oofDirectives)
+					vfModuleInputParams.put("sdnc_directives", "{}")
+					msoLogger.debug("OofDirectives are: " + oofDirectives)
+				} else if (vfModuleInputParams != null) {
+					vfModuleInputParams.put("oof_directives", "{}")
+					vfModuleInputParams.put("sdnc_directives", "{}")
 				}
 				if (vfModuleInputParams != null) {
 					execution.setVariable("DCVFM_vnfParamsMap", vfModuleInputParams)
@@ -464,11 +493,30 @@ public class DoCreateVfModule extends VfModuleBase {
 							}
 
 				//OofDirectives
-				String oofDirectives = execution.getVariable("oofDirectives")
+				String oofDirectives = null
+				try {
+					HomingInstance homingInstance = oofInfraUtils.getHomingInstance(serviceInstanceId, execution)
+					if (homingInstance != null) {
+						execution.setVariable("DCVFM_cloudSiteId", homingInstance.getCloudRegionId())
+						rollbackData.put("VFMODULE", "aiccloudregion", homingInstance.getCloudRegionId())
+						msoLogger.debug("Overwriting cloudSiteId with homing cloudSiteId: " +
+								homingInstance.getCloudRegionId())
+						execution.setVariable("DCVFM_cloudOwner", homingInstance.getCloudOwner())
+						rollbackData.put("VFMODULE", "cloudOwner", homingInstance.getCloudOwner())
+						msoLogger.debug("Overwriting cloudOwner with homing cloudOwner: " +
+								homingInstance.getCloudOwner())
+						oofDirectives = homingInstance.getOofDirectives()
+						execution.setVariable("DCVFM_oofDirectives", oofDirectives)
+					}
+				} catch (Exception exception) {
+					msoLogger.debug("Could not find homing information for service instance: " + serviceInstanceId +
+							"... continuing")
+					msoLogger.debug("Could not find homing information for service instance error: " + exception)
+				}
 				if (oofDirectives != null) {
 					Map<String, String> paramsMap = execution.getVariable("DCVFM_vnfParamsMap")
 					paramsMap.put("oofDirectives", oofDirectives)
-					logDebug("OofDirectives are: " + oofDirectives, isDebugLogEnabled)
+					msoLogger.debug("OofDirectives are: " + oofDirectives)
 					execution.setVariable("DCVFM_vnfParamsMap", paramsMap)
 				}
 			}
diff --git a/bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/DoCreateVnf.groovy b/bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/DoCreateVnf.groovy
index b35aab1176..deb0bffaf9 100644
--- a/bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/DoCreateVnf.groovy
+++ b/bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/DoCreateVnf.groovy
@@ -20,6 +20,8 @@
 
 package org.onap.so.bpmn.infrastructure.scripts
 
+import org.onap.so.db.catalog.beans.HomingInstance
+
 import static org.apache.commons.lang3.StringUtils.*
 
 import org.camunda.bpm.engine.delegate.BpmnError
@@ -31,6 +33,7 @@ import org.onap.so.bpmn.common.scripts.ExceptionUtil
 import org.onap.so.bpmn.common.scripts.MsoUtils
 import org.onap.so.bpmn.common.scripts.SDNCAdapterUtils
 import org.onap.so.bpmn.common.scripts.VidUtils
+import org.onap.so.bpmn.common.util.OofInfraUtils
 import org.onap.so.bpmn.core.RollbackData
 import org.onap.so.bpmn.core.UrnPropertiesReader
 import org.onap.so.bpmn.core.WorkflowException
@@ -61,6 +64,7 @@ class DoCreateVnf extends AbstractServiceTaskProcessor {
 	JsonUtils jsonUtil = new JsonUtils()
 	VidUtils vidUtils = new VidUtils(this)
 	SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils(this)
+	OofInfraUtils oofInfraUtils = new OofInfraUtils()
 
 	/**
 	 * This method gets and validates the incoming
@@ -238,6 +242,21 @@ class DoCreateVnf extends AbstractServiceTaskProcessor {
 			execution.setVariable("DoCVNF_nfFunction", nfFunction)
 			msoLogger.debug("NF Function is: " + nfFunction)
 
+			// Set Homing Info
+			try {
+				HomingInstance homingInstance = oofInfraUtils.getHomingInstance(serviceInstanceId, execution)
+				if (homingInstance != null) {
+					execution.setVariable("DoCVNF_cloudSiteId", homingInstance.getCloudRegionId())
+					rollbackData.put("VNF", "cloudSiteId", homingInstance.getCloudRegionId())
+					msoLogger.debug("Overwriting cloudSiteId with homing cloudSiteId: " +
+							homingInstance.getCloudRegionId())
+				}
+			} catch (Exception exception) {
+				msoLogger.debug("Could not find homing information for service instance: " + serviceInstanceId +
+						"... continuing")
+				msoLogger.debug("Could not find homing information for service instance error: " + exception)
+			}
+
 			rollbackData.put("VNF", "rollbackSDNCAssign", "false")
 			rollbackData.put("VNF", "rollbackSDNCActivate", "false")
 			rollbackData.put("VNF", "rollbackVnfCreate", "false")