Workflow Designer Activities Implementation

Logging changes and error message fixes for runAppcCommand()
added unit test and removed catch blocks
Workflow Designer Activities Implementation

Change-Id: I22d3d95541708ddc9e2617a92085b0d4c16caad9
Issue-ID: SO-829
Signed-off-by: Elena Kuleshov <EK1439@att.com>

3 files changed, 310 insertions, 0 deletions

diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/appc/tasks/AppcRunTasks.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/appc/tasks/AppcRunTasks.java
new file mode 100644
index 0000000000..798837fa7d
--- /dev/null
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/appc/tasks/AppcRunTasks.java
@@ -0,0 +1,171 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * 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.onap.so.bpmn.infrastructure.appc.tasks;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Optional;
+
+import org.camunda.bpm.engine.delegate.BpmnError;
+import org.onap.so.bpmn.servicedecomposition.bbobjects.GenericVnf;
+import org.onap.so.bpmn.servicedecomposition.bbobjects.VfModule;
+import org.onap.so.bpmn.servicedecomposition.entities.GeneralBuildingBlock;
+import org.onap.so.bpmn.servicedecomposition.entities.ResourceKey;
+import org.onap.so.bpmn.servicedecomposition.generalobjects.RequestParameters;
+import org.onap.so.bpmn.servicedecomposition.tasks.ExtractPojosForBB;
+import org.onap.so.db.catalog.client.CatalogDbClient;
+import org.onap.so.db.catalog.beans.ControllerSelectionReference;
+import org.onap.so.client.exception.BBObjectNotFoundException;
+import org.onap.so.client.exception.ExceptionBuilder;
+import org.onap.appc.client.lcm.model.Action;
+import org.onap.so.bpmn.common.BuildingBlockExecution;
+import org.onap.so.client.appc.ApplicationControllerAction;
+import org.onap.so.logger.MessageEnum;
+import org.onap.so.logger.MsoLogger;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+@Component
+public class AppcRunTasks {
+	private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL, AppcRunTasks.class);
+	@Autowired
+	private ExceptionBuilder exceptionUtil;
+	@Autowired
+	private ExtractPojosForBB extractPojosForBB;
+	@Autowired
+	private CatalogDbClient catalogDbClient;
+	@Autowired
+	private ApplicationControllerAction appCClient;
+	
+	public void preProcessActivity(BuildingBlockExecution execution) {
+		execution.setVariable("actionSnapshot", Action.Snapshot);
+		execution.setVariable("actionLock", Action.Lock);
+		execution.setVariable("actionUnlock", Action.Unlock);
+		execution.setVariable("actionUpgradePreCheck", Action.UpgradePreCheck);
+		execution.setVariable("actionUpgradePostCheck", Action.UpgradePostCheck);
+		execution.setVariable("actionQuiesceTraffic", Action.QuiesceTraffic);
+		execution.setVariable("actionUpgradeBackup", Action.UpgradeBackup);
+		execution.setVariable("actionUpgradeSoftware", Action.UpgradeSoftware);
+		execution.setVariable("actionResumeTraffic", Action.ResumeTraffic);		
+		execution.setVariable("actionStop", Action.Stop);
+		execution.setVariable("actionStart", Action.Start);
+		execution.setVariable("rollbackVnfStop", false);
+		execution.setVariable("rollbackVnfLock", false);
+		execution.setVariable("rollbackQuiesceTraffic", false);
+	}
+	
+	public void runAppcCommand(BuildingBlockExecution execution, Action action) {
+		msoLogger.trace("Start runAppcCommand ");
+		String appcCode = "1002";
+		String appcMessage = "";
+		try {
+			GeneralBuildingBlock gBBInput = execution.getGeneralBuildingBlock();
+			GenericVnf vnf = null;
+			try {
+				vnf = extractPojosForBB.extractByKey(execution, ResourceKey.GENERIC_VNF_ID, execution.getLookupMap().get(ResourceKey.GENERIC_VNF_ID));
+			} catch (BBObjectNotFoundException e) {
+				exceptionUtil.buildAndThrowWorkflowException(execution, 7000, "No valid VNF exists");
+			}
+			String vnfId = vnf.getVnfId();
+			String msoRequestId = gBBInput.getRequestContext().getMsoRequestId();
+			String vnfName = vnf.getVnfName();
+			String vnfType = vnf.getVnfType();
+			
+			String aicIdentity = execution.getVariable("aicIdentity");
+			String vnfHostIpAddress =  vnf.getIpv4OamAddress();
+			String vmIdList = execution.getVariable("vmIdList");
+			String vserverIdList = execution.getVariable("vserverIdList");
+			String identityUrl =  execution.getVariable("identityUrl");
+			
+			ControllerSelectionReference controllerSelectionReference = catalogDbClient.getControllerSelectionReferenceByVnfTypeAndActionCategory(vnfType, action.toString());
+			String controllerType = controllerSelectionReference.getControllerName();
+			
+			String vfModuleId = null;
+			VfModule vfModule = null;
+			try {
+				vfModule = extractPojosForBB.extractByKey(execution, ResourceKey.VF_MODULE_ID, execution.getLookupMap().get(ResourceKey.VF_MODULE_ID));
+			} catch (BBObjectNotFoundException e) {
+			}
+			if (vfModule != null) {
+				vfModuleId = vfModule.getVfModuleId();
+			}
+			
+			HashMap<String, String> payloadInfo = buildPayloadInfo(vnfName, aicIdentity, vnfHostIpAddress, vmIdList, vserverIdList,
+					identityUrl, vfModuleId);
+			Optional<String> payload = null;
+			RequestParameters requestParameters = gBBInput.getRequestContext().getRequestParameters();
+			if(requestParameters != null){
+				String pay = requestParameters.getPayload();
+				if (pay != null) {
+					payload =  Optional.of(pay);
+				}
+			}			
+			msoLogger.debug("Running APP-C action: " + action.toString());
+			msoLogger.debug("VNFID: " + vnfId);	
+			appCClient.runAppCCommand(action, msoRequestId, vnfId, payload, payloadInfo, controllerType);
+			appcCode = appCClient.getErrorCode();
+			appcMessage = appCClient.getErrorMessage();
+			mapRollbackVariables(execution, action, appcCode);
+		}
+		catch (Exception e) {
+			msoLogger.error(MessageEnum.BPMN_GENERAL_EXCEPTION, "Caught exception in runAppcCommand", "BPMN", MsoLogger.getServiceName(), MsoLogger.ErrorCode.UnknownError, "APPC Error", e);
+			appcMessage = e.getMessage();
+		}		
+		
+		msoLogger.error("Error Message: " + appcMessage);
+		msoLogger.error("ERROR CODE: " + appcCode);
+		msoLogger.trace("End of runAppCommand ");
+		if (appcCode != null && !appcCode.equals("0")) {
+			exceptionUtil.buildAndThrowWorkflowException(execution, Integer.parseInt(appcCode), appcMessage);
+		}
+	}
+	
+	protected void mapRollbackVariables(BuildingBlockExecution execution, Action action, String appcCode) {
+		if (appcCode.equals("0") && action != null) {
+			if (action.equals(Action.Lock)) {
+				execution.setVariable("rollbackVnfLock", true);
+			} else if (action.equals(Action.Unlock)) {
+				execution.setVariable("rollbackVnfLock", false);
+			} else if (action.equals(Action.Start)) {
+				execution.setVariable("rollbackVnfStop", false);
+			} else if (action.equals(Action.Stop)) {
+				execution.setVariable("rollbackVnfStop", true);
+			} else if (action.equals(Action.QuiesceTraffic)) {
+				execution.setVariable("rollbackQuiesceTraffic", true);
+			} else if (action.equals(Action.ResumeTraffic)) {
+				execution.setVariable("rollbackQuiesceTraffic", false);
+			}
+		}
+	}
+	
+	private HashMap<String,String> buildPayloadInfo(String vnfName, String aicIdentity, String vnfHostIpAddress, 
+			String vmIdList, String vserverIdList, String identityUrl, String vfModuleId) {
+		HashMap<String, String> payloadInfo = new HashMap<String, String>();
+		payloadInfo.put("vnfName", vnfName);
+		payloadInfo.put("aicIdentity", aicIdentity);
+		payloadInfo.put("vnfHostIpAddress", vnfHostIpAddress);
+		payloadInfo.put("vmIdList", vmIdList);
+		payloadInfo.put("vserverIdList", vserverIdList);
+		payloadInfo.put("identityUrl", identityUrl);
+		payloadInfo.put("vfModuleId",vfModuleId);
+		return payloadInfo;
+	}
+}
diff --git a/bpmn/so-bpmn-tasks/src/test/java/org/onap/so/bpmn/infrastructure/appc/tasks/AppcRunTasksITTest.java b/bpmn/so-bpmn-tasks/src/test/java/org/onap/so/bpmn/infrastructure/appc/tasks/AppcRunTasksITTest.java
new file mode 100644
index 0000000000..9e1dac69e0
--- /dev/null
+++ b/bpmn/so-bpmn-tasks/src/test/java/org/onap/so/bpmn/infrastructure/appc/tasks/AppcRunTasksITTest.java
@@ -0,0 +1,103 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * 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.onap.so.bpmn.infrastructure.appc.tasks;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+import java.util.HashMap;
+import java.util.Optional;
+import java.util.UUID;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mockito;
+import org.onap.appc.client.lcm.model.Action;
+import org.onap.so.bpmn.BaseTaskTest;
+import org.onap.so.bpmn.common.BuildingBlockExecution;
+import org.onap.so.bpmn.servicedecomposition.bbobjects.GenericVnf;
+import org.onap.so.bpmn.servicedecomposition.generalobjects.RequestContext;
+import org.onap.so.bpmn.servicedecomposition.generalobjects.RequestParameters;
+import org.onap.so.db.catalog.beans.ControllerSelectionReference;
+import org.springframework.beans.factory.annotation.Autowired;
+
+public class AppcRunTasksITTest extends BaseTaskTest {
+	
+	@Autowired
+	private AppcRunTasks appcRunTasks;
+	
+	private GenericVnf genericVnf;
+	private RequestContext requestContext;
+	private String msoRequestId;
+
+	@Before
+	public void before() {
+		genericVnf = setGenericVnf();
+		msoRequestId = UUID.randomUUID().toString();
+		requestContext = setRequestContext();
+		requestContext.setMsoRequestId(msoRequestId);
+		gBBInput.setRequestContext(requestContext);
+	}
+	
+	@Test 
+	public void preProcessActivityTest() throws Exception {
+		appcRunTasks.preProcessActivity(execution);
+		assertEquals(execution.getVariable("actionQuiesceTraffic"), Action.QuiesceTraffic);
+		assertEquals(execution.getVariable("rollbackQuiesceTraffic"), false);		
+	}
+	
+	@Test
+	public void runAppcCommandTest() throws Exception {
+		Action action = Action.QuiesceTraffic;
+		ControllerSelectionReference controllerSelectionReference = new ControllerSelectionReference();
+		controllerSelectionReference.setControllerName("testName");
+		controllerSelectionReference.setActionCategory(action.toString());
+		controllerSelectionReference.setVnfType("testVnfType");
+		
+		doReturn(controllerSelectionReference).when(catalogDbClient).getControllerSelectionReferenceByVnfTypeAndActionCategory(genericVnf.getVnfType(), Action.QuiesceTraffic.toString());
+		
+		execution.setVariable("aicIdentity", "testAicIdentity");		
+		
+		String vnfId = genericVnf.getVnfId();
+		genericVnf.setIpv4OamAddress("testOamIpAddress");
+		String payload = "{\"testName\":\"testValue\",}";
+		RequestParameters requestParameters = new RequestParameters();
+		requestParameters.setPayload(payload);
+		gBBInput.getRequestContext().setRequestParameters(requestParameters);
+		
+		String controllerType = "testName";
+		HashMap<String, String> payloadInfo = new HashMap<String, String>();
+		payloadInfo.put("vnfName", "testVnfName1");		
+		payloadInfo.put("aicIdentity", "testAicIdentity");
+		payloadInfo.put("vnfHostIpAddress", "testOamIpAddress");
+		payloadInfo.put("vserverIdList", null);
+		payloadInfo.put("vfModuleId", null);
+		payloadInfo.put("identityUrl", null);
+		payloadInfo.put("vmIdList", null);
+		
+		doNothing().when(appCClient).runAppCCommand(action, msoRequestId, vnfId, Optional.of(payload), payloadInfo, controllerType);
+		
+		appcRunTasks.runAppcCommand(execution, action);
+		verify(appCClient, times(1)).runAppCCommand(action, msoRequestId, vnfId, Optional.of(payload), payloadInfo, controllerType);
+	}
+}
diff --git a/bpmn/so-bpmn-tasks/src/test/java/org/onap/so/bpmn/infrastructure/appc/tasks/AppcRunTasksTest.java b/bpmn/so-bpmn-tasks/src/test/java/org/onap/so/bpmn/infrastructure/appc/tasks/AppcRunTasksTest.java
new file mode 100644
index 0000000000..7cade7703a
--- /dev/null
+++ b/bpmn/so-bpmn-tasks/src/test/java/org/onap/so/bpmn/infrastructure/appc/tasks/AppcRunTasksTest.java
@@ -0,0 +1,36 @@
+package org.onap.so.bpmn.infrastructure.appc.tasks;
+
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.mock;
+
+import org.junit.Test;
+import org.onap.appc.client.lcm.model.Action;
+import org.onap.so.bpmn.common.BuildingBlockExecution;
+
+public class AppcRunTasksTest {
+
+	
+	private AppcRunTasks appcRunTasks = new AppcRunTasks();
+	@Test
+	public void mapRollbackVariablesTest() {
+		
+		BuildingBlockExecution mock = mock(BuildingBlockExecution.class);
+		
+		appcRunTasks.mapRollbackVariables(mock, Action.Lock, "1");
+		verify(mock, times(0)).setVariable(any(String.class), any());
+		appcRunTasks.mapRollbackVariables(mock, Action.Lock, "0");
+		verify(mock, times(1)).setVariable("rollbackVnfLock", true);
+		appcRunTasks.mapRollbackVariables(mock, Action.Unlock, "0");
+		verify(mock, times(1)).setVariable("rollbackVnfLock", false);
+		appcRunTasks.mapRollbackVariables(mock, Action.Start, "0");
+		verify(mock, times(1)).setVariable("rollbackVnfStop", false);
+		appcRunTasks.mapRollbackVariables(mock, Action.Stop, "0");
+		verify(mock, times(1)).setVariable("rollbackVnfStop", true);
+		appcRunTasks.mapRollbackVariables(mock, Action.QuiesceTraffic, "0");
+		verify(mock, times(1)).setVariable("rollbackQuiesceTraffic", true);
+		appcRunTasks.mapRollbackVariables(mock, Action.ResumeTraffic, "0");
+		verify(mock, times(1)).setVariable("rollbackQuiesceTraffic", false);
+	}
+}