Unverified Commit 84409b57 authored by Yelli's avatar Yelli Committed by GitHub
Browse files

fix taskinstance.isSubprocess misjudgment (#2007) 

* add processInstanceService UT

* fix taskInstance.isSubProcess
add processInstanceService UT

* add taskInstance.isSubProcess UT

* modify taskInstance.isSubProcess UT

* add license

* remove author&date
parent f407adcb

dolphinscheduler-api/src/test/java/org/apache/dolphinscheduler/api/service/ProcessInstanceServiceTest.java

+333 −12
Original line number Diff line number Diff line
@@ -19,14 +19,11 @@ package org.apache.dolphinscheduler.api.service; 
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;

import org.apache.dolphinscheduler.api.ApiApplicationServer;

import org.apache.dolphinscheduler.api.enums.Status;

import org.apache.dolphinscheduler.api.utils.Result;

import org.apache.dolphinscheduler.common.Constants;

import org.apache.dolphinscheduler.common.enums.DependResult;

import org.apache.dolphinscheduler.common.enums.ExecutionStatus;

import org.apache.dolphinscheduler.common.enums.UserType;

import org.apache.dolphinscheduler.common.enums.*;

import org.apache.dolphinscheduler.common.utils.DateUtils;

import org.apache.dolphinscheduler.dao.entity.ProcessInstance;

import org.apache.dolphinscheduler.dao.entity.Project;

import org.apache.dolphinscheduler.dao.entity.User;

import org.apache.dolphinscheduler.dao.entity.*;

import org.apache.dolphinscheduler.dao.mapper.*;

import org.apache.dolphinscheduler.service.process.ProcessService;

import org.junit.Assert;
@@ -42,6 +39,7 @@ import org.springframework.boot.test.context.SpringBootTest; 


import java.io.IOException;

import java.text.MessageFormat;

import java.text.ParseException;

import java.util.*;



import static org.mockito.ArgumentMatchers.eq;
@@ -88,6 +86,13 @@ public class ProcessInstanceServiceTest { 
    @Mock

    UsersService usersService;



    private String shellJson = "{\"globalParams\":[],\"tasks\":[{\"type\":\"SHELL\",\"id\":\"tasks-9527\",\"name\":\"shell-1\"," +

            "\"params\":{\"resourceList\":[],\"localParams\":[],\"rawScript\":\"#!/bin/bash\\necho \\\"shell-1\\\"\"}," +

            "\"description\":\"\",\"runFlag\":\"NORMAL\",\"dependence\":{},\"maxRetryTimes\":\"0\",\"retryInterval\":\"1\"," +

            "\"timeout\":{\"strategy\":\"\",\"interval\":1,\"enable\":false},\"taskInstancePriority\":\"MEDIUM\"," +

            "\"workerGroupId\":-1,\"preTasks\":[]}],\"tenantId\":1,\"timeout\":0}";





    @Test

    public void testQueryProcessInstanceList() {

        String projectName = "project_test1";
@@ -144,7 +149,86 @@ public class ProcessInstanceServiceTest { 
    }



    @Test

    public void testDependResult(){

    public void testQueryProcessInstanceById() {

        String projectName = "project_test1";

        User loginUser = getAdminUser();

        Map<String, Object> result = new HashMap<>(5);

        putMsg(result, Status.PROJECT_NOT_FOUNT, projectName);



        //project auth fail

        when(projectMapper.queryByName(projectName)).thenReturn(null);

        when(projectService.checkProjectAndAuth(loginUser, null, projectName)).thenReturn(result);

        Map<String, Object> proejctAuthFailRes = processInstanceService.queryProcessInstanceById(loginUser, projectName, 1);

        Assert.assertEquals(Status.PROJECT_NOT_FOUNT, proejctAuthFailRes.get(Constants.STATUS));



        //project auth success

        ProcessInstance processInstance = getProcessInstance();

        processInstance.setWorkerGroupId(-1);

        processInstance.setReceivers("xxx@qq.com");

        processInstance.setReceiversCc("xxx@qq.com");

        processInstance.setProcessDefinitionId(46);

        putMsg(result, Status.SUCCESS, projectName);

        Project project = getProject(projectName);

        ProcessDefinition processDefinition = getProcessDefinition();

        when(projectMapper.queryByName(projectName)).thenReturn(project);

        when(projectService.checkProjectAndAuth(loginUser, project, projectName)).thenReturn(result);

        when(processService.findProcessInstanceDetailById(processInstance.getId())).thenReturn(processInstance);

        when(processService.findProcessDefineById(processInstance.getProcessDefinitionId())).thenReturn(processDefinition);

        Map<String, Object> successRes = processInstanceService.queryProcessInstanceById(loginUser, projectName, 1);

        Assert.assertEquals(Status.SUCCESS, successRes.get(Constants.STATUS));



        //worker group null

        processInstance.setWorkerGroupId(1);

        when(workerGroupMapper.selectById(processInstance.getWorkerGroupId())).thenReturn(null);

        Map<String, Object> workerNullRes = processInstanceService.queryProcessInstanceById(loginUser, projectName, 1);

        Assert.assertEquals(Status.SUCCESS, workerNullRes.get(Constants.STATUS));



        //worker group exist

        WorkerGroup workerGroup = getWorkGroup();

        when(workerGroupMapper.selectById(processInstance.getWorkerGroupId())).thenReturn(workerGroup);

        processInstance.setWorkerGroupId(1);

        when(workerGroupMapper.selectById(processInstance.getWorkerGroupId())).thenReturn(null);

        Map<String, Object> workerExistRes = processInstanceService.queryProcessInstanceById(loginUser, projectName, 1);

        Assert.assertEquals(Status.SUCCESS, workerExistRes.get(Constants.STATUS));

    }



    @Test

    public void testQueryTaskListByProcessId() throws IOException {

        String projectName = "project_test1";

        User loginUser = getAdminUser();

        Map<String, Object> result = new HashMap<>(5);

        putMsg(result, Status.PROJECT_NOT_FOUNT, projectName);



        //project auth fail

        when(projectMapper.queryByName(projectName)).thenReturn(null);

        when(projectService.checkProjectAndAuth(loginUser, null, projectName)).thenReturn(result);

        Map<String, Object> proejctAuthFailRes = processInstanceService.queryTaskListByProcessId(loginUser, projectName, 1);

        Assert.assertEquals(Status.PROJECT_NOT_FOUNT, proejctAuthFailRes.get(Constants.STATUS));



        //project auth success

        putMsg(result, Status.SUCCESS, projectName);

        Project project = getProject(projectName);

        ProcessInstance processInstance = getProcessInstance();

        processInstance.setState(ExecutionStatus.SUCCESS);

        TaskInstance taskInstance = new TaskInstance();

        taskInstance.setTaskType(TaskType.SHELL.getDescp());

        List<TaskInstance> taskInstanceList = new ArrayList<>();

        taskInstanceList.add(taskInstance);

        Result res = new Result();

        res.setCode(Status.SUCCESS.ordinal());

        res.setData("xxx");

        when(projectMapper.queryByName(projectName)).thenReturn(project);

        when(projectService.checkProjectAndAuth(loginUser, project, projectName)).thenReturn(result);

        when(processService.findProcessInstanceDetailById(processInstance.getId())).thenReturn(processInstance);

        when(processService.findValidTaskListByProcessId(processInstance.getId())).thenReturn(taskInstanceList);

        when(loggerService.queryLog(taskInstance.getId(), 0, 4098)).thenReturn(res);

        Map<String, Object> successRes = processInstanceService.queryTaskListByProcessId(loginUser, projectName, 1);

        Assert.assertEquals(Status.SUCCESS, successRes.get(Constants.STATUS));

    }





    @Test

    public void testParseLogForDependentResult() {

        String logString = "[INFO] 2019-03-19 17:11:08.475 org.apache.dolphinscheduler.server.worker.log.TaskLogger:[172] - [taskAppId=TASK_223_10739_452334] dependent item complete :|| 223-ALL-day-last1Day,SUCCESS\n" +

                "[INFO] 2019-03-19 17:11:08.476 org.apache.dolphinscheduler.server.worker.runner.TaskScheduleThread:[172] - task : 223_10739_452334 exit status code : 0\n" +

                "[root@node2 current]# ";
@@ -157,8 +241,201 @@ public class ProcessInstanceServiceTest { 
        }

    }



    @Test

    public void testQuerySubProcessInstanceByTaskId() {

        String projectName = "project_test1";

        User loginUser = getAdminUser();

        Map<String, Object> result = new HashMap<>(5);

        putMsg(result, Status.PROJECT_NOT_FOUNT, projectName);



        //project auth fail

        when(projectMapper.queryByName(projectName)).thenReturn(null);

        when(projectService.checkProjectAndAuth(loginUser, null, projectName)).thenReturn(result);

        Map<String, Object> proejctAuthFailRes = processInstanceService.querySubProcessInstanceByTaskId(loginUser, projectName, 1);

        Assert.assertEquals(Status.PROJECT_NOT_FOUNT, proejctAuthFailRes.get(Constants.STATUS));



        //task null

        Project project = getProject(projectName);

        putMsg(result, Status.SUCCESS, projectName);

        when(projectMapper.queryByName(projectName)).thenReturn(project);

        when(projectService.checkProjectAndAuth(loginUser, project, projectName)).thenReturn(result);

        when(processService.findTaskInstanceById(1)).thenReturn(null);

        Map<String, Object> taskNullRes = processInstanceService.querySubProcessInstanceByTaskId(loginUser, projectName, 1);

        Assert.assertEquals(Status.TASK_INSTANCE_NOT_EXISTS, taskNullRes.get(Constants.STATUS));



        //task not sub process

        TaskInstance taskInstance = getTaskInstance();

        taskInstance.setTaskType(TaskType.HTTP.getDescp());

        taskInstance.setProcessInstanceId(1);

        when(processService.findTaskInstanceById(1)).thenReturn(taskInstance);

        Map<String, Object> notSubprocessRes = processInstanceService.querySubProcessInstanceByTaskId(loginUser, projectName, 1);

        Assert.assertEquals(Status.TASK_INSTANCE_NOT_SUB_WORKFLOW_INSTANCE, notSubprocessRes.get(Constants.STATUS));



        //sub process not exist

        TaskInstance subTask = getTaskInstance();

        subTask.setTaskType(TaskType.SUB_PROCESS.getDescp());

        subTask.setProcessInstanceId(1);

        when(processService.findTaskInstanceById(subTask.getId())).thenReturn(subTask);

        when(processService.findSubProcessInstance(subTask.getProcessInstanceId(), subTask.getId())).thenReturn(null);

        Map<String, Object> subprocessNotExistRes = processInstanceService.querySubProcessInstanceByTaskId(loginUser, projectName, 1);

        Assert.assertEquals(Status.SUB_PROCESS_INSTANCE_NOT_EXIST, subprocessNotExistRes.get(Constants.STATUS));



        //sub process exist

        ProcessInstance processInstance = getProcessInstance();

        when(processService.findSubProcessInstance(taskInstance.getProcessInstanceId(), taskInstance.getId())).thenReturn(processInstance);

        Map<String, Object> subprocessExistRes = processInstanceService.querySubProcessInstanceByTaskId(loginUser, projectName, 1);

        Assert.assertEquals(Status.SUCCESS, subprocessExistRes.get(Constants.STATUS));

    }



    @Test

    public void testUpdateProcessInstance() throws ParseException {

        String projectName = "project_test1";

        User loginUser = getAdminUser();

        Map<String, Object> result = new HashMap<>(5);

        putMsg(result, Status.PROJECT_NOT_FOUNT, projectName);



        //project auth fail

        when(projectMapper.queryByName(projectName)).thenReturn(null);

        when(projectService.checkProjectAndAuth(loginUser, null, projectName)).thenReturn(result);

        Map<String, Object> proejctAuthFailRes = processInstanceService.updateProcessInstance(loginUser, projectName, 1,

                shellJson, "2020-02-21 00:00:00", true, Flag.YES, "", "");

        Assert.assertEquals(Status.PROJECT_NOT_FOUNT, proejctAuthFailRes.get(Constants.STATUS));



        //process instance null

        Project project = getProject(projectName);

        putMsg(result, Status.SUCCESS, projectName);

        ProcessInstance processInstance = getProcessInstance();

        when(projectMapper.queryByName(projectName)).thenReturn(project);

        when(projectService.checkProjectAndAuth(loginUser, project, projectName)).thenReturn(result);

        when(processService.findProcessInstanceDetailById(1)).thenReturn(null);

        Map<String, Object> processInstanceNullRes = processInstanceService.updateProcessInstance(loginUser, projectName, 1,

                shellJson, "2020-02-21 00:00:00", true, Flag.YES, "", "");

        Assert.assertEquals(Status.PROCESS_INSTANCE_NOT_EXIST, processInstanceNullRes.get(Constants.STATUS));



        //process instance not finish

        when(processService.findProcessInstanceDetailById(1)).thenReturn(processInstance);

        processInstance.setState(ExecutionStatus.RUNNING_EXEUTION);

        Map<String, Object> processInstanceNotFinishRes = processInstanceService.updateProcessInstance(loginUser, projectName, 1,

                shellJson, "2020-02-21 00:00:00", true, Flag.YES, "", "");

        Assert.assertEquals(Status.PROCESS_INSTANCE_STATE_OPERATION_ERROR, processInstanceNotFinishRes.get(Constants.STATUS));



        //process instance finish

        processInstance.setState(ExecutionStatus.SUCCESS);

        processInstance.setTimeout(3000);

        processInstance.setCommandType(CommandType.STOP);

        ProcessDefinition processDefinition = getProcessDefinition();

        processDefinition.setUserId(1);

        Tenant tenant = new Tenant();

        tenant.setId(1);

        tenant.setTenantCode("test_tenant");

        when(processService.findProcessDefineById(processInstance.getProcessDefinitionId())).thenReturn(processDefinition);

        when(processService.getTenantForProcess(Mockito.anyInt(), Mockito.anyInt())).thenReturn(tenant);

        when(processService.updateProcessInstance(processInstance)).thenReturn(1);

        when(processDefinitionService.checkProcessNodeList(Mockito.any(), eq(shellJson))).thenReturn(result);

        Map<String, Object> processInstanceFinishRes = processInstanceService.updateProcessInstance(loginUser, projectName, 1,

                shellJson, "2020-02-21 00:00:00", true, Flag.YES, "", "");

        Assert.assertEquals(Status.UPDATE_PROCESS_INSTANCE_ERROR, processInstanceFinishRes.get(Constants.STATUS));



        //success

        when(processDefineMapper.updateById(processDefinition)).thenReturn(1);

        Map<String, Object> successRes = processInstanceService.updateProcessInstance(loginUser, projectName, 1,

                shellJson, "2020-02-21 00:00:00", true, Flag.YES, "", "");

        Assert.assertEquals(Status.SUCCESS, successRes.get(Constants.STATUS));

    }



    @Test

    public void testQueryParentInstanceBySubId() {

        String projectName = "project_test1";

        User loginUser = getAdminUser();

        Map<String, Object> result = new HashMap<>(5);

        putMsg(result, Status.PROJECT_NOT_FOUNT, projectName);



        //project auth fail

        when(projectMapper.queryByName(projectName)).thenReturn(null);

        when(projectService.checkProjectAndAuth(loginUser, null, projectName)).thenReturn(result);

        Map<String, Object> proejctAuthFailRes = processInstanceService.queryParentInstanceBySubId(loginUser, projectName, 1);

        Assert.assertEquals(Status.PROJECT_NOT_FOUNT, proejctAuthFailRes.get(Constants.STATUS));



        //process instance null

        Project project = getProject(projectName);

        putMsg(result, Status.SUCCESS, projectName);

        when(projectMapper.queryByName(projectName)).thenReturn(project);

        when(projectService.checkProjectAndAuth(loginUser, project, projectName)).thenReturn(result);

        when(processService.findProcessInstanceDetailById(1)).thenReturn(null);

        Map<String, Object> processInstanceNullRes = processInstanceService.queryParentInstanceBySubId(loginUser, projectName, 1);

        Assert.assertEquals(Status.PROCESS_INSTANCE_NOT_EXIST, processInstanceNullRes.get(Constants.STATUS));



        //not sub process

        ProcessInstance processInstance = getProcessInstance();

        processInstance.setIsSubProcess(Flag.NO);

        when(processService.findProcessInstanceDetailById(1)).thenReturn(processInstance);

        Map<String, Object> notSubProcessRes = processInstanceService.queryParentInstanceBySubId(loginUser, projectName, 1);

        Assert.assertEquals(Status.PROCESS_INSTANCE_NOT_SUB_PROCESS_INSTANCE, notSubProcessRes.get(Constants.STATUS));



        //sub process

        processInstance.setIsSubProcess(Flag.YES);

        when(processService.findParentProcessInstance(1)).thenReturn(null);

        Map<String, Object> subProcessNullRes = processInstanceService.queryParentInstanceBySubId(loginUser, projectName, 1);

        Assert.assertEquals(Status.SUB_PROCESS_INSTANCE_NOT_EXIST, subProcessNullRes.get(Constants.STATUS));



        //success

        when(processService.findParentProcessInstance(1)).thenReturn(processInstance);

        Map<String, Object> successRes = processInstanceService.queryParentInstanceBySubId(loginUser, projectName, 1);

        Assert.assertEquals(Status.SUCCESS, successRes.get(Constants.STATUS));

    }



    @Test

    public void testDeleteProcessInstanceById() {

        String projectName = "project_test1";

        User loginUser = getAdminUser();

        Map<String, Object> result = new HashMap<>(5);

        putMsg(result, Status.PROJECT_NOT_FOUNT, projectName);



        //project auth fail

        when(projectMapper.queryByName(projectName)).thenReturn(null);

        when(projectService.checkProjectAndAuth(loginUser, null, projectName)).thenReturn(result);

        Map<String, Object> proejctAuthFailRes = processInstanceService.deleteProcessInstanceById(loginUser, projectName, 1, Mockito.any());

        Assert.assertEquals(Status.PROJECT_NOT_FOUNT, proejctAuthFailRes.get(Constants.STATUS));



        //process instance null

        Project project = getProject(projectName);

        putMsg(result, Status.SUCCESS, projectName);

        when(projectMapper.queryByName(projectName)).thenReturn(project);

        when(projectService.checkProjectAndAuth(loginUser, project, projectName)).thenReturn(result);

        when(processService.findProcessInstanceDetailById(1)).thenReturn(null);

        Map<String, Object> processInstanceNullRes = processInstanceService.deleteProcessInstanceById(loginUser, projectName, 1, Mockito.any());

        Assert.assertEquals(Status.PROCESS_INSTANCE_NOT_EXIST, processInstanceNullRes.get(Constants.STATUS));

    }



    @Test

    public void testViewVariables() throws Exception {

        //process instance not null

        ProcessInstance processInstance = getProcessInstance();

        processInstance.setCommandType(CommandType.SCHEDULER);

        processInstance.setScheduleTime(new Date());

        processInstance.setProcessInstanceJson(shellJson);

        processInstance.setGlobalParams("");

        when(processInstanceMapper.queryDetailById(1)).thenReturn(processInstance);

        Map<String, Object> successRes = processInstanceService.viewVariables(1);

        Assert.assertEquals(Status.SUCCESS, successRes.get(Constants.STATUS));

    }



    @Test

    public void testViewGantt() throws Exception {

        ProcessInstance processInstance = getProcessInstance();

        processInstance.setProcessInstanceJson(shellJson);

        TaskInstance taskInstance = getTaskInstance();

        taskInstance.setState(ExecutionStatus.RUNNING_EXEUTION);

        taskInstance.setStartTime(new Date());

        when(processInstanceMapper.queryDetailById(1)).thenReturn(processInstance);

        when(taskInstanceMapper.queryByInstanceIdAndName(Mockito.anyInt(), Mockito.any())).thenReturn(taskInstance);

        Map<String, Object> successRes = processInstanceService.viewGantt(1);

        Assert.assertEquals(Status.SUCCESS, successRes.get(Constants.STATUS));

    }



    /**

     * get Mock Admin User

     *

     * @return admin user

     */

    private User getAdminUser() {
@@ -171,6 +448,7 @@ public class ProcessInstanceServiceTest { 


    /**

     * get mock Project

     *

     * @param projectName projectName

     * @return Project

     */
@@ -184,6 +462,7 @@ public class ProcessInstanceServiceTest { 


    /**

     * get Mock process instance

     *

     * @return process instance

     */

    private ProcessInstance getProcessInstance() {
@@ -195,6 +474,48 @@ public class ProcessInstanceServiceTest { 
        return processInstance;

    }



    /**

     * get mock processDefinition

     *

     * @return ProcessDefinition

     */

    private ProcessDefinition getProcessDefinition() {

        ProcessDefinition processDefinition = new ProcessDefinition();

        processDefinition.setId(46);

        processDefinition.setName("test_pdf");

        processDefinition.setProjectId(2);

        processDefinition.setTenantId(1);

        processDefinition.setDescription("");

        return processDefinition;

    }



    /**

     * get Mock worker group

     *

     * @return worker group

     */

    private WorkerGroup getWorkGroup() {

        WorkerGroup workerGroup = new WorkerGroup();

        workerGroup.setId(1);

        workerGroup.setName("test_workergroup");

        return workerGroup;

    }



    /**

     * get Mock task instance

     *

     * @return task instance

     */

    private TaskInstance getTaskInstance() {

        TaskInstance taskInstance = new TaskInstance();

        taskInstance.setId(1);

        taskInstance.setName("test_task_instance");

        taskInstance.setStartTime(new Date());

        taskInstance.setEndTime(new Date());

        taskInstance.setExecutorId(-1);

        return taskInstance;

    }



    private void putMsg(Map<String, Object> result, Status status, Object... statusParams) {

        result.put(Constants.STATUS, status);

        if (statusParams != null && statusParams.length > 0) {

dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/TaskInstance.java

+1 −1
Original line number Diff line number Diff line
@@ -374,7 +374,7 @@ public class TaskInstance { 




    public Boolean isSubProcess(){

        return TaskType.SUB_PROCESS.toString().equals(this.taskType.toUpperCase());

        return TaskType.SUB_PROCESS.getDescp().equals(this.taskType);

    }



    public String getDependency(){

dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/entity/TaskInstanceTest.java

0 → 100644
+39 −0
Original line number Diff line number Diff line 
/*

 * Licensed to the 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.

 * The 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.dao.entity;



import org.junit.Assert;

import org.junit.Test;



public class TaskInstanceTest {



    /**

     * task instance sub process

     */

    @Test

    public void testTaskInstanceIsSubProcess() {

        TaskInstance taskInstance = new TaskInstance();



        //sub process

        taskInstance.setTaskType("sub process");

        Assert.assertTrue(taskInstance.isSubProcess());



        //not sub process

        taskInstance.setTaskType("http");

        Assert.assertFalse(taskInstance.isSubProcess());

    }

}

pom.xml

+1 −0
Original line number Diff line number Diff line
@@ -722,6 +722,7 @@ 
                        <include>**/dao/mapper/AlertGroupMapperTest.java</include>

                        <include>**/dao/mapper/AlertMapperTest.java</include>

                        <include>**/dao/mapper/CommandMapperTest.java</include>

                        <include>**/dao/entity/TaskInstanceTest.java</include>

                        <include>**/dao/cron/CronUtilsTest.java</include>

                        <include>**/dao/utils/DagHelperTest.java</include>

                        <include>**/alert/template/AlertTemplateFactoryTest.java</include>