From 8020c1539c6788841d36c5b3de0df38eca3b0aa3 Mon Sep 17 00:00:00 2001 From: Eric Gao Date: Fri, 14 Jul 2023 11:07:41 +0800 Subject: [PATCH] [Improvement][API Test] Add api tests for process instance (#14514) * Add test cases for process instance apis --------- Co-authored-by: xiangzihao <460888207@qq.com> --- .github/workflows/api-test.yml | 2 + .../test/cases/ProcessInstanceAPITest.java | 186 ++++++++++++++++++ .../pages/workflow/ProcessInstancePage.java | 101 ++++++++++ 3 files changed, 289 insertions(+) create mode 100644 dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/cases/ProcessInstanceAPITest.java create mode 100644 dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/pages/workflow/ProcessInstancePage.java diff --git a/.github/workflows/api-test.yml b/.github/workflows/api-test.yml index 7462619a5e..3de6dcdc7d 100644 --- a/.github/workflows/api-test.yml +++ b/.github/workflows/api-test.yml @@ -100,6 +100,8 @@ jobs: class: org.apache.dolphinscheduler.api.test.cases.SchedulerAPITest - name: Executor class: org.apache.dolphinscheduler.api.test.cases.ExecutorAPITest + - name: ProcessInstance + class: org.apache.dolphinscheduler.api.test.cases.ProcessInstanceAPITest env: RECORDING_PATH: /tmp/recording-${{ matrix.case.name }} steps: diff --git a/dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/cases/ProcessInstanceAPITest.java b/dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/cases/ProcessInstanceAPITest.java new file mode 100644 index 0000000000..e49d1ea05e --- /dev/null +++ b/dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/cases/ProcessInstanceAPITest.java @@ -0,0 +1,186 @@ +/* + * Licensed to Apache Software Foundation (ASF) under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Apache Software Foundation (ASF) licenses this file to you 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.apache.dolphinscheduler.api.test.cases; + +import org.apache.dolphinscheduler.api.test.core.DolphinScheduler; +import org.apache.dolphinscheduler.api.test.entity.HttpResponse; +import org.apache.dolphinscheduler.api.test.entity.LoginResponseData; +import org.apache.dolphinscheduler.api.test.pages.LoginPage; +import org.apache.dolphinscheduler.api.test.pages.project.ProjectPage; +import org.apache.dolphinscheduler.api.test.pages.workflow.ExecutorPage; +import org.apache.dolphinscheduler.api.test.pages.workflow.ProcessDefinitionPage; +import org.apache.dolphinscheduler.api.test.pages.workflow.ProcessInstancePage; +import org.apache.dolphinscheduler.api.test.utils.JSONUtils; +import org.apache.dolphinscheduler.common.enums.FailureStrategy; +import org.apache.dolphinscheduler.common.enums.ReleaseState; +import org.apache.dolphinscheduler.common.enums.UserType; +import org.apache.dolphinscheduler.common.enums.WarningType; +import org.apache.dolphinscheduler.dao.entity.User; + +import org.apache.http.client.methods.CloseableHttpResponse; +import org.apache.http.util.EntityUtils; + +import java.io.File; +import java.text.SimpleDateFormat; +import java.util.Date; +import java.util.LinkedHashMap; +import java.util.List; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Test; + +import lombok.extern.slf4j.Slf4j; + +@DolphinScheduler(composeFiles = "docker/basic/docker-compose.yaml") +@Slf4j +public class ProcessInstanceAPITest { + + private static final String username = "admin"; + + private static final String password = "dolphinscheduler123"; + + private static String sessionId; + + private static User loginUser; + + private static ProcessInstancePage processInstancePage; + + private static ExecutorPage executorPage; + + private static ProcessDefinitionPage processDefinitionPage; + + private static ProjectPage projectPage; + + private static long projectCode; + + private static long processDefinitionCode; + + private static long triggerCode; + + private static int processInstanceId; + + @BeforeAll + public static void setup() { + LoginPage loginPage = new LoginPage(); + HttpResponse loginHttpResponse = loginPage.login(username, password); + sessionId = JSONUtils.convertValue(loginHttpResponse.getBody().getData(), LoginResponseData.class).getSessionId(); + processInstancePage = new ProcessInstancePage(sessionId); + executorPage = new ExecutorPage(sessionId); + processDefinitionPage = new ProcessDefinitionPage(sessionId); + projectPage = new ProjectPage(sessionId); + loginUser = new User(); + loginUser.setUserName("admin"); + loginUser.setId(1); + loginUser.setUserType(UserType.ADMIN_USER); + } + + @AfterAll + public static void cleanup() { + log.info("success cleanup"); + } + + @Test + @Order(1) + public void testQueryProcessInstancesByTriggerCode() { + try { + // create test project + HttpResponse createProjectResponse = projectPage.createProject(loginUser, "project-test"); + HttpResponse queryAllProjectListResponse = projectPage.queryAllProjectList(loginUser); + Assertions.assertTrue(queryAllProjectListResponse.getBody().getSuccess()); + projectCode = (long) ((LinkedHashMap) ((List) queryAllProjectListResponse.getBody().getData()).get(0)).get("code"); + + // upload test workflow definition json + ClassLoader classLoader = getClass().getClassLoader(); + File file = new File(classLoader.getResource("workflow-json/test.json").getFile()); + CloseableHttpResponse importProcessDefinitionResponse = processDefinitionPage + .importProcessDefinition(loginUser, projectCode, file); + String data = EntityUtils.toString(importProcessDefinitionResponse.getEntity()); + Assertions.assertTrue(data.contains("\"success\":true")); + + // get workflow definition code + HttpResponse queryAllProcessDefinitionByProjectCodeResponse = processDefinitionPage.queryAllProcessDefinitionByProjectCode(loginUser, projectCode); + Assertions.assertTrue(queryAllProcessDefinitionByProjectCodeResponse.getBody().getSuccess()); + Assertions.assertTrue(queryAllProcessDefinitionByProjectCodeResponse.getBody().getData().toString().contains("hello world")); + processDefinitionCode = (long) ((LinkedHashMap) ((LinkedHashMap) ((List) queryAllProcessDefinitionByProjectCodeResponse.getBody().getData()).get(0)).get("processDefinition")).get("code"); + + // release test workflow + HttpResponse releaseProcessDefinitionResponse = processDefinitionPage.releaseProcessDefinition(loginUser, projectCode, processDefinitionCode, ReleaseState.ONLINE); + Assertions.assertTrue(releaseProcessDefinitionResponse.getBody().getSuccess()); + + // trigger workflow instance + SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); + Date date = new Date(); + String scheduleTime = String.format("%s,%s", formatter.format(date), formatter.format(date)); + log.info("use current time {} as scheduleTime", scheduleTime); + HttpResponse startProcessInstanceResponse = executorPage.startProcessInstance(loginUser, projectCode, processDefinitionCode, scheduleTime, FailureStrategy.END, WarningType.NONE); + Assertions.assertTrue(startProcessInstanceResponse.getBody().getSuccess()); + // make sure process instance has completed and successfully persisted into db + Thread.sleep(5000); + + // query workflow instance by trigger code + triggerCode = (long) startProcessInstanceResponse.getBody().getData(); + HttpResponse queryProcessInstancesByTriggerCodeResponse = processInstancePage.queryProcessInstancesByTriggerCode(loginUser, projectCode, triggerCode); + Assertions.assertTrue(queryProcessInstancesByTriggerCodeResponse.getBody().getSuccess()); + processInstanceId = (int) ((LinkedHashMap) ((List) queryProcessInstancesByTriggerCodeResponse.getBody().getData()).get(0)).get("id"); + } catch (Exception e) { + log.error("failed", e); + Assertions.fail(); + } + } + + @Test + @Order(2) + public void testQueryProcessInstanceList() { + HttpResponse queryProcessInstanceListResponse = processInstancePage.queryProcessInstanceList(loginUser, projectCode, 1, 10); + Assertions.assertTrue(queryProcessInstanceListResponse.getBody().getSuccess()); + Assertions.assertTrue(queryProcessInstanceListResponse.getBody().getData().toString().contains("test_import")); + } + + @Test + @Order(3) + public void testQueryTaskListByProcessId() { + HttpResponse queryTaskListByProcessIdResponse = processInstancePage.queryTaskListByProcessId(loginUser, projectCode, processInstanceId); + Assertions.assertTrue(queryTaskListByProcessIdResponse.getBody().getSuccess()); + Assertions.assertTrue(queryTaskListByProcessIdResponse.getBody().getData().toString().contains("test_import")); + } + + @Test + @Order(4) + public void testQueryProcessInstanceById() { + HttpResponse queryProcessInstanceByIdResponse = processInstancePage.queryProcessInstanceById(loginUser, projectCode, processInstanceId); + Assertions.assertTrue(queryProcessInstanceByIdResponse.getBody().getSuccess()); + Assertions.assertTrue(queryProcessInstanceByIdResponse.getBody().getData().toString().contains("test_import")); + } + + @Test + @Order(5) + public void testDeleteProcessInstanceById() { + HttpResponse deleteProcessInstanceByIdResponse = processInstancePage.deleteProcessInstanceById(loginUser, projectCode, processInstanceId); + Assertions.assertTrue(deleteProcessInstanceByIdResponse.getBody().getSuccess()); + + HttpResponse queryProcessInstanceListResponse = processInstancePage.queryProcessInstanceList(loginUser, projectCode, 1, 10); + Assertions.assertTrue(queryProcessInstanceListResponse.getBody().getSuccess()); + Assertions.assertFalse(queryProcessInstanceListResponse.getBody().getData().toString().contains("test_import")); + } + +} diff --git a/dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/pages/workflow/ProcessInstancePage.java b/dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/pages/workflow/ProcessInstancePage.java new file mode 100644 index 0000000000..e07e1166b1 --- /dev/null +++ b/dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/pages/workflow/ProcessInstancePage.java @@ -0,0 +1,101 @@ +/* + * Licensed to Apache Software Foundation (ASF) under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Apache Software Foundation (ASF) licenses this file to you 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.apache.dolphinscheduler.api.test.pages.workflow; + +import org.apache.dolphinscheduler.api.enums.ExecuteType; +import org.apache.dolphinscheduler.api.test.core.Constants; +import org.apache.dolphinscheduler.api.test.entity.HttpResponse; +import org.apache.dolphinscheduler.api.test.utils.RequestClient; +import org.apache.dolphinscheduler.common.enums.FailureStrategy; +import org.apache.dolphinscheduler.common.enums.TaskDependType; +import org.apache.dolphinscheduler.common.enums.WarningType; +import org.apache.dolphinscheduler.dao.entity.User; + +import java.util.HashMap; +import java.util.Map; + +import lombok.AllArgsConstructor; +import lombok.extern.slf4j.Slf4j; + + +@Slf4j +@AllArgsConstructor +public class ProcessInstancePage { + + private String sessionId; + + public HttpResponse queryProcessInstancesByTriggerCode(User loginUser, long projectCode, long triggerCode) { + Map params = new HashMap<>(); + params.put("loginUser", loginUser); + params.put("triggerCode", triggerCode); + Map headers = new HashMap<>(); + headers.put(Constants.SESSION_ID_KEY, sessionId); + + RequestClient requestClient = new RequestClient(); + String url = String.format("/projects/%s/process-instances/trigger", projectCode); + return requestClient.get(url, headers, params); + } + + public HttpResponse queryProcessInstanceList(User loginUser, long projectCode, int pageNo, int pageSize) { + Map params = new HashMap<>(); + params.put("loginUser", loginUser); + params.put("pageNo", pageNo); + params.put("pageSize", pageSize); + Map headers = new HashMap<>(); + headers.put(Constants.SESSION_ID_KEY, sessionId); + + RequestClient requestClient = new RequestClient(); + String url = String.format("/projects/%s/process-instances", projectCode); + return requestClient.get(url, headers, params); + } + + public HttpResponse queryTaskListByProcessId(User loginUser, long projectCode, long processInstanceId) { + Map params = new HashMap<>(); + params.put("loginUser", loginUser); + Map headers = new HashMap<>(); + headers.put(Constants.SESSION_ID_KEY, sessionId); + RequestClient requestClient = new RequestClient(); + String url = String.format("/projects/%s/process-instances/%s/tasks", projectCode, processInstanceId); + return requestClient.get(url, headers, params); + } + + public HttpResponse queryProcessInstanceById(User loginUser, long projectCode, long processInstanceId) { + Map params = new HashMap<>(); + params.put("loginUser", loginUser); + Map headers = new HashMap<>(); + headers.put(Constants.SESSION_ID_KEY, sessionId); + + RequestClient requestClient = new RequestClient(); + String url = String.format("/projects/%s/process-instances/%s", projectCode, processInstanceId); + return requestClient.get(url, headers, params); + } + + public HttpResponse deleteProcessInstanceById(User loginUser, long projectCode, long processInstanceId) { + Map params = new HashMap<>(); + params.put("loginUser", loginUser); + Map headers = new HashMap<>(); + headers.put(Constants.SESSION_ID_KEY, sessionId); + + RequestClient requestClient = new RequestClient(); + String url = String.format("/projects/%s/process-instances/%s", projectCode, processInstanceId); + return requestClient.delete(url, headers, params); + } + +}