Make homingBB optinal and fix homing process

Properly defined whether or not to call homing at AssignVnfBB where by
default homing doesn't get called, but if a homing solution is provided,
then we resolve the solutions.
The goal is to change the BPMN definition to use serviceTask rather
than a scriptTask, allowing to use the Srping component to inject
logic.
Also we create a new HomingV2 component that is agnostic of the homing
implementation, which goal is to route the homing request to the proper
bbackend implementation; e.g. oof vs homing.
Finally, we remove the un-needed variables set in the execution context.

Change-Id: Ic9fb2a599c6375617c92a6d3462b62921ee47a6f
Issue-ID: SO-1168
Signed-off-by: Alexis de Talhouët <adetalhouet89@gmail.com>

2 files changed, 76 insertions, 15 deletions

diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/buildingblock/HomingV2.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/buildingblock/HomingV2.java
new file mode 100644
index 0000000000..612051f903
--- /dev/null
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/buildingblock/HomingV2.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2018 Bell Canada.
+ *
+ * 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.
+ */
+package org.onap.so.bpmn.buildingblock;
+
+import java.util.Map;
+import org.onap.so.bpmn.common.BuildingBlockExecution;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+@Component
+public class HomingV2 {
+
+    @Autowired
+    private OofHomingV2 oofHomingV2;
+    @Autowired
+    private SniroHomingV2 sniroHomingV2;
+
+    private static final String HOMINGSOLUTION = "Homing_Solution";
+
+    public void callHoming(BuildingBlockExecution execution) {
+        if (isOof(execution)) {
+            oofHomingV2.callOof(execution);
+        } else {
+            sniroHomingV2.callSniro(execution);
+        }
+    }
+
+    public void processSolution(BuildingBlockExecution execution, String asyncResponse) {
+        if (isOof(execution)) {
+            oofHomingV2.processSolution(execution, asyncResponse);
+        } else {
+            sniroHomingV2.processSolution(execution, asyncResponse);
+        }
+    }
+
+    // Default solution is SNIRO. OOF gets called only if specified.
+    private boolean isOof(BuildingBlockExecution execution) {
+        for (Map<String, Object> params : execution.getGeneralBuildingBlock().getRequestContext().getRequestParameters()
+            .getUserParams()) {
+            if (params.containsKey(HOMINGSOLUTION) && params.get(HOMINGSOLUTION).equals("oof")) {
+                return true;
+            }
+        }
+        return false;
+    }
+}
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/workflow/tasks/WorkflowAction.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/workflow/tasks/WorkflowAction.java
index d8a6fc2e1d..e9dcdade9f 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/workflow/tasks/WorkflowAction.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/workflow/tasks/WorkflowAction.java
@@ -163,19 +163,6 @@ public class WorkflowAction {
 			execution.setVariable("resourceId", resourceId);
 			execution.setVariable("resourceType", resourceType);
 
-			if (sIRequest.getRequestDetails().getRequestParameters().getUserParams() != null) {
-				List<Map<String, Object>> userParams = sIRequest.getRequestDetails().getRequestParameters()
-						.getUserParams();
-				for (Map<String, Object> params : userParams) {
-					if (params.containsKey(HOMINGSOLUTION)) {
-						execution.setVariable("homing", true);
-						execution.setVariable("callHoming", true);
-						execution.setVariable("homingSolution", params.get(HOMINGSOLUTION));
-						execution.setVariable("homingService", params.get(HOMINGSOLUTION));
-					}
-				}
-			}
-
 			if (aLaCarte) {
 				if (orchFlows == null || orchFlows.isEmpty()) {
 					orchFlows = queryNorthBoundRequestCatalogDb(execution, requestAction, resourceType, aLaCarte);
@@ -270,9 +257,10 @@ public class WorkflowAction {
 					logger.info("Sorting for Vlan Tagging");
 					flowsToExecute = sortExecutionPathByObjectForVlanTagging(flowsToExecute, requestAction);
 				}
+				// By default, enable homing at VNF level for CREATEINSTANCE and ASSIGNINSTANCE
 				if (resourceType == WorkflowType.SERVICE
-						&& (requestAction.equals(CREATEINSTANCE) || requestAction.equals(ASSIGNINSTANCE))
-						&& !resourceCounter.stream().filter(x -> WorkflowType.VNF.equals(x.getResourceType())).collect(Collectors.toList()).isEmpty()) {
+					&& (requestAction.equals(CREATEINSTANCE) || requestAction.equals(ASSIGNINSTANCE))
+					&& !resourceCounter.stream().filter(x -> WorkflowType.VNF.equals(x.getResourceType())).collect(Collectors.toList()).isEmpty()) {
 					execution.setVariable("homing", true);
 					execution.setVariable("calledHoming", false);
 				}
@@ -283,6 +271,20 @@ public class WorkflowAction {
 				}
 			}
 
+			// If the user set "Homing_Solution" to "none", disable homing, else if "Homing_Solution" is specified, enable it.
+			if (sIRequest.getRequestDetails().getRequestParameters().getUserParams() != null) {
+				List<Map<String, Object>> userParams = sIRequest.getRequestDetails().getRequestParameters().getUserParams();
+				for (Map<String, Object> params : userParams) {
+					if (params.containsKey(HOMINGSOLUTION)) {
+						if (params.get(HOMINGSOLUTION).equals("none")) {
+							execution.setVariable("homing", false);
+						} else {
+							execution.setVariable("homing", true);
+						}
+					}
+				}
+			}
+
 			if (flowsToExecute.isEmpty()) {
 				throw new IllegalStateException("Macro did not come up with a valid execution path.");
 			}