Merge "Based on Controller Actor calling CDS or APPC(Current Flow)"

2 files changed, 236 insertions, 0 deletions

diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/flowspecific/tasks/ControllerExecution.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/flowspecific/tasks/ControllerExecution.java
new file mode 100644
index 0000000000..86d56005f6
--- /dev/null
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/flowspecific/tasks/ControllerExecution.java
@@ -0,0 +1,109 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * Copyright (C) 2019  Tech Mahindra
+ * ================================================================================
+ * 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.flowspecific.tasks;
+
+import java.util.Optional;
+import org.onap.so.bpmn.common.BuildingBlockExecution;
+import org.onap.so.bpmn.servicedecomposition.bbobjects.GenericVnf;
+import org.onap.so.bpmn.servicedecomposition.entities.BuildingBlock;
+import org.onap.so.bpmn.servicedecomposition.entities.ExecuteBuildingBlock;
+import org.onap.so.bpmn.servicedecomposition.entities.ResourceKey;
+import org.onap.so.bpmn.servicedecomposition.tasks.ExtractPojosForBB;
+import org.onap.so.client.exception.ExceptionBuilder;
+import org.onap.so.db.catalog.beans.BBNameSelectionReference;
+import org.onap.so.db.catalog.beans.VnfResourceCustomization;
+import org.onap.so.db.catalog.client.CatalogDbClient;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+@Component
+public class ControllerExecution {
+    private static final Logger logger = LoggerFactory.getLogger(ControllerExecution.class);
+    private static final String CONTROLLER_ACTOR = "controllerActor";
+    private static final String BUILDING_BLOCK = "buildingBlock";
+    private static final String SCOPE = "scope";
+    private static final String ACTION = "action";
+    private static final String BBNAME = "bbName";
+    @Autowired
+    private ExceptionBuilder exceptionUtil;
+    @Autowired
+    private CatalogDbClient catalogDbClient;
+    @Autowired
+    private ExtractPojosForBB extractPojosForBB;
+
+    /**
+     * Setting Controller Actor, Scope and Action Variables in BuildingBlockExecution object
+     * 
+     * @param execution - BuildingBlockExecution object
+     */
+    public void setControllerActorScopeAction(BuildingBlockExecution execution) {
+        try {
+            GenericVnf genericVnf = extractPojosForBB.extractByKey(execution, ResourceKey.GENERIC_VNF_ID);
+            String modleUuid = genericVnf.getModelInfoGenericVnf().getModelCustomizationUuid();
+            VnfResourceCustomization vnfResourceCustomization =
+                    catalogDbClient.getVnfResourceCustomizationByModelCustomizationUUID(modleUuid);
+
+            // Fetching Controller Actor at VNF level if null then Controller Actor is set as "APPC"
+            String controllerActor = Optional.ofNullable(vnfResourceCustomization.getControllerActor()).orElse("APPC");
+            ExecuteBuildingBlock executeBuildingBlock = execution.getVariable(BUILDING_BLOCK);
+            BuildingBlock buildingBlock = executeBuildingBlock.getBuildingBlock();
+            String scope = Optional.ofNullable(buildingBlock.getBpmnScope()).orElseThrow(
+                    () -> new NullPointerException("BPMN Scope is NULL in the orchestration_flow_reference table "));
+            String action = Optional.ofNullable(buildingBlock.getBpmnAction()).orElseThrow(
+                    () -> new NullPointerException("BPMN Action is NULL in the orchestration_flow_reference table "));
+            execution.setVariable(SCOPE, scope);
+            execution.setVariable(ACTION, action);
+            execution.setVariable(CONTROLLER_ACTOR, controllerActor);
+            logger.debug("Executing Controller Execution for ControllerActor: {}, Scope: {} , Action: {}",
+                    controllerActor, scope, action);
+
+        } catch (Exception ex) {
+            logger.error("An exception occurred while fetching Controller Actor,Scope and Action ", ex);
+            exceptionUtil.buildAndThrowWorkflowException(execution, 7000, ex);
+        }
+    }
+
+    /**
+     * Selecting bbName from BBNameSelectionReference and setting the value in a variable of BuildingBlockExecution
+     * 
+     * @param execution - BuildingBlockExecution object
+     */
+    public void selectBB(BuildingBlockExecution execution) {
+        try {
+
+            String controllerActor = execution.getVariable(CONTROLLER_ACTOR);
+            String action = Optional.of((String) execution.getVariable(ACTION)).get();
+            String scope = Optional.of((String) execution.getVariable(SCOPE)).get();
+            BBNameSelectionReference bbNameSelectionReference =
+                    catalogDbClient.getBBNameSelectionReference(controllerActor, scope, action);
+            String bbName = bbNameSelectionReference.getBbName();
+            execution.setVariable(BBNAME, bbName);
+            logger.debug(" Executing {} BPMN", bbName);
+        } catch (Exception ex) {
+            logger.error("An exception occurred while getting bbname from catalogdb ", ex);
+            exceptionUtil.buildAndThrowWorkflowException(execution, 7000, ex);
+
+        }
+
+    }
+}
diff --git a/bpmn/so-bpmn-tasks/src/test/java/org/onap/so/bpmn/infrastructure/flowspecific/tasks/ControllerExecutionTest.java b/bpmn/so-bpmn-tasks/src/test/java/org/onap/so/bpmn/infrastructure/flowspecific/tasks/ControllerExecutionTest.java
new file mode 100644
index 0000000000..72a987c395
--- /dev/null
+++ b/bpmn/so-bpmn-tasks/src/test/java/org/onap/so/bpmn/infrastructure/flowspecific/tasks/ControllerExecutionTest.java
@@ -0,0 +1,127 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * Copyright (C) 2019  Tech Mahindra
+ * ================================================================================
+ * 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.flowspecific.tasks;
+
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.doThrow;
+import static org.mockito.Mockito.when;
+import java.util.UUID;
+import org.camunda.bpm.engine.delegate.BpmnError;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.ArgumentMatchers;
+import org.mockito.InjectMocks;
+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.bbobjects.ServiceInstance;
+import org.onap.so.bpmn.servicedecomposition.entities.BuildingBlock;
+import org.onap.so.bpmn.servicedecomposition.entities.ExecuteBuildingBlock;
+import org.onap.so.bpmn.servicedecomposition.entities.ResourceKey;
+import org.onap.so.bpmn.servicedecomposition.generalobjects.RequestContext;
+import org.onap.so.client.exception.BBObjectNotFoundException;
+import org.onap.so.db.catalog.beans.BBNameSelectionReference;
+import org.onap.so.db.catalog.beans.VnfResourceCustomization;
+
+
+public class ControllerExecutionTest extends BaseTaskTest {
+
+    @InjectMocks
+    private ControllerExecution controllerExecution = new ControllerExecution();
+
+    private static final String TEST_SCOPE = "vfModule";
+    private static final String TEST_BBNAME = "ConfigurationScaleOut";
+    private static final String TEST_ACTION = "configScaleOut";
+    private static final String TEST_CONTROLLER_ACTOR = "APPC";
+
+    private BuildingBlock buildingBlock = new BuildingBlock();
+    VnfResourceCustomization vnfResourceCustomization = new VnfResourceCustomization();
+    private ExecuteBuildingBlock executeBuildingBlock = new ExecuteBuildingBlock();
+    private GenericVnf genericVnf;
+    private ServiceInstance serviceInstance;
+    private RequestContext requestContext;
+    private String msoRequestId;
+
+
+    @Before
+    public void before() throws BBObjectNotFoundException {
+
+        genericVnf = setGenericVnf();
+        serviceInstance = setServiceInstance();
+        msoRequestId = UUID.randomUUID().toString();
+        requestContext = setRequestContext();
+        requestContext.setMsoRequestId(msoRequestId);
+        gBBInput.setRequestContext(requestContext);
+        buildingBlock.setBpmnAction(TEST_ACTION);
+        buildingBlock.setBpmnScope(TEST_SCOPE);
+        executeBuildingBlock.setBuildingBlock(buildingBlock);
+        execution.setVariable("buildingBlock", executeBuildingBlock);
+
+        doThrow(new BpmnError("BPMN Error")).when(exceptionUtil)
+                .buildAndThrowWorkflowException(any(BuildingBlockExecution.class), eq(7000), any(Exception.class));
+
+        when(extractPojosForBB.extractByKey(any(), ArgumentMatchers.eq(ResourceKey.GENERIC_VNF_ID)))
+                .thenReturn(genericVnf);
+        when(extractPojosForBB.extractByKey(any(), ArgumentMatchers.eq(ResourceKey.SERVICE_INSTANCE_ID)))
+                .thenReturn(serviceInstance);
+
+
+    }
+
+    @Test
+    public void testSetControllerActorScopeAction() throws Exception {
+
+
+        doReturn(vnfResourceCustomization).when(catalogDbClient).getVnfResourceCustomizationByModelCustomizationUUID(
+                genericVnf.getModelInfoGenericVnf().getModelCustomizationUuid());
+        controllerExecution.setControllerActorScopeAction(execution);
+        assertEquals(TEST_SCOPE, execution.getVariable("scope"));
+        assertEquals(TEST_ACTION, execution.getVariable("action"));
+        assertEquals(TEST_CONTROLLER_ACTOR, execution.getVariable("controllerActor"));
+
+    }
+
+
+    @Test
+    public void testSelectBB() throws Exception {
+        // given
+        BBNameSelectionReference bbNameSelectionReference = new BBNameSelectionReference();
+        bbNameSelectionReference.setBbName(TEST_BBNAME);
+        bbNameSelectionReference.setAction(TEST_ACTION);
+        bbNameSelectionReference.setControllerActor(TEST_CONTROLLER_ACTOR);
+        bbNameSelectionReference.setScope(TEST_SCOPE);
+        doReturn(bbNameSelectionReference).when(catalogDbClient).getBBNameSelectionReference(TEST_CONTROLLER_ACTOR,
+                TEST_SCOPE, TEST_ACTION);
+        execution.setVariable("controllerActor", TEST_CONTROLLER_ACTOR);
+        execution.setVariable("scope", TEST_SCOPE);
+        execution.setVariable("action", TEST_ACTION);
+
+        // when
+        controllerExecution.selectBB(execution);
+        // verify
+        assertEquals(TEST_BBNAME, execution.getVariable("bbName"));
+    }
+
+}