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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.so.cnfm.lcm.bpmn.flows;
23 import static org.camunda.bpm.engine.history.HistoricProcessInstance.STATE_ACTIVE;
24 import static org.slf4j.LoggerFactory.getLogger;
26 import com.github.tomakehurst.wiremock.WireMockServer;
27 import java.io.IOException;
28 import java.nio.file.Path;
29 import java.time.LocalDateTime;
30 import java.util.List;
32 import java.util.Optional;
33 import java.util.UUID;
34 import java.util.concurrent.TimeUnit;
35 import org.camunda.bpm.engine.HistoryService;
36 import org.camunda.bpm.engine.RuntimeService;
37 import org.camunda.bpm.engine.history.HistoricProcessInstance;
38 import org.camunda.bpm.engine.history.HistoricVariableInstance;
39 import org.camunda.bpm.engine.runtime.ProcessInstance;
40 import org.junit.runner.RunWith;
41 //import org.onap.so.cnfm.lcm.bpmn.flows.service.KubConfigProvider;
42 //import org.onap.so.cnfm.lcm.bpmn.flows.tasks.MockedHelmClientConfiguration;
43 //import org.onap.so.cnfm.lcm.bpmn.flows.tasks.MockedKubernetesClientProviderConfiguration;
44 import org.onap.so.cnfm.lcm.database.beans.AsInst;
45 import org.onap.so.cnfm.lcm.database.beans.Job;
46 import org.onap.so.cnfm.lcm.database.beans.JobAction;
47 import org.onap.so.cnfm.lcm.database.beans.JobStatusEnum;
48 import org.onap.so.cnfm.lcm.database.service.DatabaseServiceProvider;
49 import org.slf4j.Logger;
50 import org.springframework.beans.factory.annotation.Autowired;
51 import org.springframework.boot.test.context.SpringBootTest;
52 import org.springframework.cloud.contract.wiremock.AutoConfigureWireMock;
53 //import org.springframework.context.annotation.Import;
54 //import org.springframework.mock.web.MockMultipartFile;
55 import org.springframework.test.context.ActiveProfiles;
56 import org.springframework.test.context.ContextConfiguration;
57 import org.springframework.test.context.junit4.SpringRunner;
58 import org.springframework.util.FileSystemUtils;
61 * @author Waqas Ikram (waqas.ikram@est.tech)
64 @RunWith(SpringRunner.class)
65 @SpringBootTest(classes = TestApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
66 @ActiveProfiles("test")
68 @AutoConfigureWireMock(port = 0)
69 //@Import({MockedHelmClientConfiguration.class, MockedKubernetesClientProviderConfiguration.class})
70 public abstract class BaseTest {
71 protected static final String SERVICE_INSTANCE_ID = UUID.randomUUID().toString();
72 protected static final String SERVICE_INSTANCE_NAME = "ServiceName";
73 // private static final String KUBE_CONFIG_EMPTY_FILE_NAME = "kube-config-empty-file";
74 // private static final String EMPTY = "";
76 protected static final String UUID_REGEX =
77 "[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}";
78 protected static final String RANDOM_JOB_ID = UUID.randomUUID().toString();
79 protected static final Logger logger = getLogger(BaseTest.class);
81 private static final long TIME_OUT_IN_SECONDS = 120;
82 private static final int SLEEP_TIME_IN_SECONDS = 5;
85 private HistoryService historyService;
88 private RuntimeService runtimeService;
91 // private KubConfigProvider kubConfigProvider;
94 protected DatabaseServiceProvider databaseServiceProvider;
97 protected WireMockServer wireMockServer;
99 public Job createNewJob(final String jobAction, final String nsdId, final String nsName) {
100 final Job newJob = new Job().startTime(LocalDateTime.now()).jobType("AS").jobAction(JobAction.CREATE)
101 .status(JobStatusEnum.STARTING).resourceId(nsdId).resourceName(nsName);
102 databaseServiceProvider.addJob(newJob);
106 public Optional<Job> getJob(final String jobId) {
107 return databaseServiceProvider.getJob(jobId);
110 public Optional<Job> getJobByResourceId(final String resourceId) {
111 return databaseServiceProvider.getJobByResourceId(resourceId);
114 public ProcessInstance executeWorkflow(final String processDefinitionKey, final String businessKey,
115 final Map<String, Object> variables) {
116 return runtimeService.startProcessInstanceByKey(processDefinitionKey, businessKey, variables);
119 public HistoricProcessInstance getHistoricProcessInstance(final String processInstanceId) {
120 return historyService.createHistoricProcessInstanceQuery().processInstanceId(processInstanceId).singleResult();
123 public HistoricVariableInstance getVariable(final String processInstanceId, final String name) {
124 return historyService.createHistoricVariableInstanceQuery().processInstanceId(processInstanceId)
125 .variableName(name).singleResult();
128 public List<HistoricVariableInstance> getVariables(final String processInstanceId) {
129 return historyService.createHistoricVariableInstanceQuery().processInstanceId(processInstanceId).list();
132 public boolean waitForProcessInstanceToFinish(final String processInstanceId) throws InterruptedException {
133 final long startTimeInMillis = System.currentTimeMillis();
134 final long timeOutTime = startTimeInMillis + TimeUnit.SECONDS.toMillis(TIME_OUT_IN_SECONDS);
135 while (timeOutTime > System.currentTimeMillis()) {
137 if (isProcessEndedByProcessInstanceId(processInstanceId)) {
138 logger.info("processInstanceId: {} is finished", processInstanceId);
141 logger.info("processInstanceId: {} is still running", processInstanceId);
142 logger.info("Process instance {} not finished yet, will try again in {} seconds", processInstanceId,
143 SLEEP_TIME_IN_SECONDS);
144 TimeUnit.SECONDS.sleep(SLEEP_TIME_IN_SECONDS);
146 logger.warn("Timeout {} process didn't finished ", processInstanceId);
151 public boolean isProcessEndedByProcessInstanceId(final String processInstanceId) {
152 return !isProcessInstanceActive(processInstanceId) && isProcessInstanceEnded(processInstanceId)
153 && isProcessInstanceCompleted(processInstanceId);
156 private boolean isProcessInstanceActive(final String processInstanceId) {
157 final HistoricProcessInstance processInstance = getHistoricProcessInstance(processInstanceId);
158 return processInstance != null && STATE_ACTIVE.equalsIgnoreCase(processInstance.getState());
161 private boolean isProcessInstanceEnded(final String processInstanceId) {
162 return runtimeService.createProcessInstanceQuery().processInstanceId(processInstanceId).singleResult() == null;
165 private boolean isProcessInstanceCompleted(final String processInstanceId) {
166 final HistoricProcessInstance result =
167 historyService.createHistoricProcessInstanceQuery().processInstanceId(processInstanceId).singleResult();
168 return result == null ? false : HistoricProcessInstance.STATE_COMPLETED.equalsIgnoreCase(result.getState());
171 public void createKubeConfigFile(final AsInst asInst) throws IOException {
172 // final MockMultipartFile file = new MockMultipartFile(KUBE_CONFIG_EMPTY_FILE_NAME, EMPTY.getBytes());
173 // kubConfigProvider.addKubeConfigFile(file, asInst.getCloudOwner(), asInst.getCloudRegion(),
174 // asInst.getTenantId());
177 public void deleteFoldersAndFiles(final Path path) throws IOException {
178 FileSystemUtils.deleteRecursively(path);