gerrit.onap Code Review - so/adapters/so-cnf-adapter.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.cnfm.lcm.bpmn.flows;
  22
  23 import static org.camunda.bpm.engine.history.HistoricProcessInstance.STATE_ACTIVE;
  24 import static org.slf4j.LoggerFactory.getLogger;
  25 import java.io.IOException;
  26 import java.nio.file.Path;
  27 import java.time.LocalDateTime;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Optional;
  31 import java.util.UUID;
  32 import java.util.concurrent.TimeUnit;
  33 import org.camunda.bpm.engine.HistoryService;
  34 import org.camunda.bpm.engine.RuntimeService;
  35 import org.camunda.bpm.engine.history.HistoricProcessInstance;
  36 import org.camunda.bpm.engine.history.HistoricVariableInstance;
  37 import org.camunda.bpm.engine.runtime.ProcessInstance;
  38 import org.junit.runner.RunWith;
  39 import org.onap.so.cnfm.lcm.bpmn.flows.service.KubConfigProvider;
  40 import org.onap.so.cnfm.lcm.bpmn.flows.tasks.MockedHelmClientConfiguration;
  41 import org.onap.so.cnfm.lcm.bpmn.flows.tasks.MockedKubernetesClientProviderConfiguration;
  42 import org.onap.so.cnfm.lcm.database.beans.AsInst;
  43 import org.onap.so.cnfm.lcm.database.beans.Job;
  44 import org.onap.so.cnfm.lcm.database.beans.JobAction;
  45 import org.onap.so.cnfm.lcm.database.beans.JobStatusEnum;
  46 import org.onap.so.cnfm.lcm.database.service.DatabaseServiceProvider;
  47 import org.slf4j.Logger;
  48 import org.springframework.beans.factory.annotation.Autowired;
  49 import org.springframework.boot.test.context.SpringBootTest;
  50 import org.springframework.cloud.contract.wiremock.AutoConfigureWireMock;
  51 import org.springframework.context.annotation.Import;
  52 import org.springframework.mock.web.MockMultipartFile;
  53 import org.springframework.test.context.ActiveProfiles;
  54 import org.springframework.test.context.ContextConfiguration;
  55 import org.springframework.test.context.junit4.SpringRunner;
  56 import org.springframework.util.FileSystemUtils;
  57 import com.github.tomakehurst.wiremock.WireMockServer;
  58
  59 /**
  60  * @author Waqas Ikram (waqas.ikram@est.tech)
  61  *
  62  */
  63 @RunWith(SpringRunner.class)
  64 @SpringBootTest(classes = TestApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
  65 @ActiveProfiles("test")
  66 @ContextConfiguration
  67 @AutoConfigureWireMock(port = 0)
  68 @Import({MockedHelmClientConfiguration.class, MockedKubernetesClientProviderConfiguration.class})
  69 public abstract class BaseTest {
  70     protected static final String SERVICE_INSTANCE_ID = UUID.randomUUID().toString();
  71     protected static final String SERVICE_INSTANCE_NAME = "ServiceName";
  72     private static final String KUBE_CONFIG_EMPTY_FILE_NAME = "kube-config-empty-file";
  73     private static final String EMPTY = "";
  74
  75     protected static final String UUID_REGEX =
  76             "[0-9a-zA-Z]{8}\\-[0-9a-zA-Z]{4}\\-[0-9a-zA-Z]{4}\\-[0-9a-zA-Z]{4}\\-[0-9a-zA-Z]{12}";
  77     protected static final String RANDOM_JOB_ID = UUID.randomUUID().toString();
  78     protected static final Logger logger = getLogger(BaseTest.class);
  79
  80     private static final long TIME_OUT_IN_SECONDS = 120;
  81     private static final int SLEEP_TIME_IN_SECONDS = 5;
  82
  83     @Autowired
  84     private HistoryService historyService;
  85
  86     @Autowired
  87     private RuntimeService runtimeService;
  88
  89     @Autowired
  90     private KubConfigProvider kubConfigProvider;
  91
  92     @Autowired
  93     protected DatabaseServiceProvider databaseServiceProvider;
  94
  95     @Autowired
  96     protected WireMockServer wireMockServer;
  97
  98     public Job createNewJob(final String jobAction, final String nsdId, final String nsName) {
  99         final Job newJob = new Job().startTime(LocalDateTime.now()).jobType("AS").jobAction(JobAction.CREATE)
 100                 .status(JobStatusEnum.STARTING).resourceId(nsdId).resourceName(nsName);
 101         databaseServiceProvider.addJob(newJob);
 102         return newJob;
 103     }
 104
 105     public Optional<Job> getJob(final String jobId) {
 106         return databaseServiceProvider.getJob(jobId);
 107     }
 108
 109     public Optional<Job> getJobByResourceId(final String resourceId) {
 110         return databaseServiceProvider.getJobByResourceId(resourceId);
 111     }
 112
 113     public ProcessInstance executeWorkflow(final String processDefinitionKey, final String businessKey,
 114             final Map<String, Object> variables) {
 115         return runtimeService.startProcessInstanceByKey(processDefinitionKey, businessKey, variables);
 116     }
 117
 118     public HistoricProcessInstance getHistoricProcessInstance(final String processInstanceId) {
 119         return historyService.createHistoricProcessInstanceQuery().processInstanceId(processInstanceId).singleResult();
 120     }
 121
 122     public HistoricVariableInstance getVariable(final String processInstanceId, final String name) {
 123         return historyService.createHistoricVariableInstanceQuery().processInstanceId(processInstanceId)
 124                 .variableName(name).singleResult();
 125     }
 126
 127     public List<HistoricVariableInstance> getVariables(final String processInstanceId) {
 128         return historyService.createHistoricVariableInstanceQuery().processInstanceId(processInstanceId).list();
 129     }
 130
 131     public boolean waitForProcessInstanceToFinish(final String processInstanceId) throws InterruptedException {
 132         final long startTimeInMillis = System.currentTimeMillis();
 133         final long timeOutTime = startTimeInMillis + TimeUnit.SECONDS.toMillis(TIME_OUT_IN_SECONDS);
 134         while (timeOutTime > System.currentTimeMillis()) {
 135
 136             if (isProcessEndedByProcessInstanceId(processInstanceId)) {
 137                 logger.info("processInstanceId: {} is finished", processInstanceId);
 138                 return true;
 139             }
 140             logger.info("processInstanceId: {} is still running", processInstanceId);
 141             logger.info("Process instance {} not finished yet, will try again in {} seconds", processInstanceId,
 142                     SLEEP_TIME_IN_SECONDS);
 143             TimeUnit.SECONDS.sleep(SLEEP_TIME_IN_SECONDS);
 144         }
 145         logger.warn("Timeout {} process didn't finished ", processInstanceId);
 146         return false;
 147     }
 148
 149
 150     public boolean isProcessEndedByProcessInstanceId(final String processInstanceId) {
 151         return !isProcessInstanceActive(processInstanceId) && isProcessInstanceEnded(processInstanceId)
 152                 && isProcessInstanceCompleted(processInstanceId);
 153     }
 154
 155     private boolean isProcessInstanceActive(final String processInstanceId) {
 156         final HistoricProcessInstance processInstance = getHistoricProcessInstance(processInstanceId);
 157         return processInstance != null && STATE_ACTIVE.equalsIgnoreCase(processInstance.getState());
 158     }
 159
 160     private boolean isProcessInstanceEnded(final String processInstanceId) {
 161         return runtimeService.createProcessInstanceQuery().processInstanceId(processInstanceId).singleResult() == null;
 162     }
 163
 164     private boolean isProcessInstanceCompleted(final String processInstanceId) {
 165         final HistoricProcessInstance result =
 166                 historyService.createHistoricProcessInstanceQuery().processInstanceId(processInstanceId).singleResult();
 167         return result == null ? false : HistoricProcessInstance.STATE_COMPLETED.equalsIgnoreCase(result.getState());
 168     }
 169
 170     public void createKubeConfigFile(final AsInst asInst) throws IOException {
 171         final MockMultipartFile file = new MockMultipartFile(KUBE_CONFIG_EMPTY_FILE_NAME, EMPTY.getBytes());
 172         kubConfigProvider.addKubeConfigFile(file, asInst.getCloudOwner(), asInst.getCloudRegion(),
 173                 asInst.getTenantId());
 174     }
 175
 176     public void deleteFoldersAndFiles(final Path path) throws IOException {
 177         FileSystemUtils.deleteRecursively(path);
 178     }
 179
 180 }