Unverified Commit ca66cfec authored by zixi0825's avatar zixi0825 Committed by GitHub
Browse files

solve code spell problem (#2419) 



* solve code spell problem

* remove controller test

* add controller test

* sovle spell problem and sovle conflict

* sovle spell problem and sovle conflict

* sovle spell problem and add test

Co-authored-by: default avatarsunchaohe <sunzhaohe@linklogis.com>
parent c4f44a62

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/ProcessDefinitionController.java

+32 −34
Original line number Diff line number Diff line
@@ -102,19 +102,19 @@ public class ProcessDefinitionController extends BaseController { 
     * @param name        name

     * @return true if process definition name not exists, otherwise false

     */

    @ApiOperation(value = "verify-name", notes = "VERIFY_PROCCESS_DEFINITION_NAME_NOTES")

    @ApiOperation(value = "verify-name", notes = "VERIFY_PROCESS_DEFINITION_NAME_NOTES")

    @ApiImplicitParams({

            @ApiImplicitParam(name = "name", value = "PROCESS_DEFINITION_NAME", required = true, type = "String")

    })

    @GetMapping(value = "/verify-name")

    @ResponseStatus(HttpStatus.OK)

    @ApiException(VERIFY_PROCESS_DEFINITION_NAME_UNIQUE_ERROR)

    public Result verifyProccessDefinitionName(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

    public Result verifyProcessDefinitionName(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

                                               @ApiParam(name = "projectName", value = "PROJECT_NAME", required = true) @PathVariable String projectName,

                                               @RequestParam(value = "name", required = true) String name) {

        logger.info("verify process definition name unique, user:{}, project name:{}, process definition name:{}",

                loginUser.getUserName(), projectName, name);

        Map<String, Object> result = processDefinitionService.verifyProccessDefinitionName(loginUser, projectName, name);

        Map<String, Object> result = processDefinitionService.verifyProcessDefinitionName(loginUser, projectName, name);

        return returnDataList(result);

    }
@@ -131,7 +131,8 @@ public class ProcessDefinitionController extends BaseController { 
     * @param connects              connects for nodes

     * @return update result code

     */

    @ApiOperation(value = "updateProccessDefinition", notes = "UPDATE_PROCCESS_DEFINITION_NOTES")



    @ApiOperation(value = "updateProcessDefinition", notes= "UPDATE_PROCESS_DEFINITION_NOTES")

    @ApiImplicitParams({

            @ApiImplicitParam(name = "name", value = "PROCESS_DEFINITION_NAME", required = true, type = "String"),

            @ApiImplicitParam(name = "id", value = "PROCESS_DEFINITION_ID", required = true, dataType = "Int", example = "100"),
@@ -143,7 +144,7 @@ public class ProcessDefinitionController extends BaseController { 
    @PostMapping(value = "/update")

    @ResponseStatus(HttpStatus.OK)

    @ApiException(UPDATE_PROCESS_DEFINITION_ERROR)

    public Result updateProccessDefinition(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

    public Result updateProcessDefinition(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

                                           @ApiParam(name = "projectName", value = "PROJECT_NAME", required = true) @PathVariable String projectName,

                                           @RequestParam(value = "name", required = true) String name,

                                           @RequestParam(value = "id", required = true) int id,
@@ -169,7 +170,8 @@ public class ProcessDefinitionController extends BaseController { 
     * @param releaseState release state

     * @return release result code

     */

    @ApiOperation(value = "releaseProccessDefinition", notes = "RELEASE_PROCCESS_DEFINITION_NOTES")



    @ApiOperation(value = "releaseProcessDefinition", notes= "RELEASE_PROCESS_DEFINITION_NOTES")

    @ApiImplicitParams({

            @ApiImplicitParam(name = "name", value = "PROCESS_DEFINITION_NAME", required = true, type = "String"),

            @ApiImplicitParam(name = "processId", value = "PROCESS_DEFINITION_ID", required = true, dataType = "Int", example = "100"),
@@ -178,7 +180,7 @@ public class ProcessDefinitionController extends BaseController { 
    @PostMapping(value = "/release")

    @ResponseStatus(HttpStatus.OK)

    @ApiException(RELEASE_PROCESS_DEFINITION_ERROR)

    public Result releaseProccessDefinition(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

    public Result releaseProcessDefinition(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

                                            @ApiParam(name = "projectName", value = "PROJECT_NAME", required = true) @PathVariable String projectName,

                                            @RequestParam(value = "processId", required = true) int processId,

                                            @RequestParam(value = "releaseState", required = true) int releaseState) {
@@ -189,7 +191,6 @@ public class ProcessDefinitionController extends BaseController { 
        return returnDataList(result);

    }





    /**

     * query datail of process definition

     *
@@ -198,46 +199,45 @@ public class ProcessDefinitionController extends BaseController { 
     * @param processId   process definition id

     * @return process definition detail

     */

    @ApiOperation(value = "queryProccessDefinitionById", notes = "QUERY_PROCCESS_DEFINITION_BY_ID_NOTES")

    @ApiOperation(value = "queryProcessDefinitionById", notes= "QUERY_PROCESS_DEFINITION_BY_ID_NOTES")

    @ApiImplicitParams({

            @ApiImplicitParam(name = "processId", value = "PROCESS_DEFINITION_ID", required = true, dataType = "Int", example = "100")

    })

    @GetMapping(value = "/select-by-id")

    @ResponseStatus(HttpStatus.OK)

    @ApiException(QUERY_DATAIL_OF_PROCESS_DEFINITION_ERROR)

    public Result queryProccessDefinitionById(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

    public Result queryProcessDefinitionById(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

                                              @ApiParam(name = "projectName", value = "PROJECT_NAME", required = true) @PathVariable String projectName,

                                              @RequestParam("processId") Integer processId

    ) {

        logger.info("query datail of process definition, login user:{}, project name:{}, process definition id:{}",

        logger.info("query detail of process definition, login user:{}, project name:{}, process definition id:{}",

                loginUser.getUserName(), projectName, processId);

        Map<String, Object> result = processDefinitionService.queryProccessDefinitionById(loginUser, projectName, processId);

        Map<String, Object> result = processDefinitionService.queryProcessDefinitionById(loginUser, projectName, processId);

        return returnDataList(result);

    }





    /**

     * query proccess definition list

     * query Process definition list

     *

     * @param loginUser   login user

     * @param projectName project name

     * @return process definition list

     */

    @ApiOperation(value = "queryProccessDefinitionList", notes = "QUERY_PROCCESS_DEFINITION_LIST_NOTES")

    @ApiOperation(value = "queryProcessDefinitionList", notes = "QUERY_PROCESS_DEFINITION_LIST_NOTES")

    @GetMapping(value = "/list")

    @ResponseStatus(HttpStatus.OK)

    @ApiException(QUERY_PROCCESS_DEFINITION_LIST)

    public Result queryProccessDefinitionList(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

    @ApiException(QUERY_PROCESS_DEFINITION_LIST)

    public Result queryProcessDefinitionList(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

                                              @ApiParam(name = "projectName", value = "PROJECT_NAME", required = true) @PathVariable String projectName

    ) {

        logger.info("query proccess definition list, login user:{}, project name:{}",

        logger.info("query process definition list, login user:{}, project name:{}",

                loginUser.getUserName(), projectName);

        Map<String, Object> result = processDefinitionService.queryProccessDefinitionList(loginUser, projectName);

        Map<String, Object> result = processDefinitionService.queryProcessDefinitionList(loginUser, projectName);

        return returnDataList(result);

    }



    /**

     * query proccess definition list paging

     * query process definition list paging

     *

     * @param loginUser   login user

     * @param projectName project name
@@ -247,7 +247,7 @@ public class ProcessDefinitionController extends BaseController { 
     * @param userId      user id

     * @return process definition page

     */

    @ApiOperation(value = "queryProcessDefinitionListPaging", notes = "QUERY_PROCCESS_DEFINITION_LIST_PAGING_NOTES")

    @ApiOperation(value = "queryProcessDefinitionListPaging", notes= "QUERY_PROCESS_DEFINITION_LIST_PAGING_NOTES")

    @ApiImplicitParams({

            @ApiImplicitParam(name = "pageNo", value = "PAGE_NO", required = true, dataType = "Int", example = "100"),

            @ApiImplicitParam(name = "searchVal", value = "SEARCH_VAL", required = false, type = "String"),
@@ -256,14 +256,14 @@ public class ProcessDefinitionController extends BaseController { 
    })

    @GetMapping(value = "/list-paging")

    @ResponseStatus(HttpStatus.OK)

    @ApiException(QUERY_PROCCESS_DEFINITION_LIST_PAGING_ERROR)

    @ApiException(QUERY_PROCESS_DEFINITION_LIST_PAGING_ERROR)

    public Result queryProcessDefinitionListPaging(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

                                                   @ApiParam(name = "projectName", value = "PROJECT_NAME", required = true) @PathVariable String projectName,

                                                   @RequestParam("pageNo") Integer pageNo,

                                                   @RequestParam(value = "searchVal", required = false) String searchVal,

                                                   @RequestParam(value = "userId", required = false, defaultValue = "0") Integer userId,

                                                   @RequestParam("pageSize") Integer pageSize) {

        logger.info("query proccess definition list paging, login user:{}, project name:{}", loginUser.getUserName(), projectName);

        logger.info("query process definition list paging, login user:{}, project name:{}", loginUser.getUserName(), projectName);

        Map<String, Object> result = checkPageParams(pageNo, pageSize);

        if (result.get(Constants.STATUS) != Status.SUCCESS) {

            return returnDataListPaging(result);
@@ -273,7 +273,6 @@ public class ProcessDefinitionController extends BaseController { 
        return returnDataListPaging(result);

    }





    /**

     * encapsulation treeview structure

     *
@@ -299,7 +298,6 @@ public class ProcessDefinitionController extends BaseController { 
        return returnDataList(result);

    }





    /**

     * get tasks list by process definition id

     *
@@ -434,7 +432,8 @@ public class ProcessDefinitionController extends BaseController { 
     * @param processDefinitionId process definition id

     * @param response            response

     */

    @ApiOperation(value = "exportProcessDefinitionById", notes = "EXPORT_PROCCESS_DEFINITION_BY_ID_NOTES")



    @ApiOperation(value = "exportProcessDefinitionById", notes= "EXPORT_PROCESS_DEFINITION_BY_ID_NOTES")

    @ApiImplicitParams({

            @ApiImplicitParam(name = "processDefinitionId", value = "PROCESS_DEFINITION_ID", required = true, dataType = "Int", example = "100")

    })
@@ -453,23 +452,22 @@ public class ProcessDefinitionController extends BaseController { 
        }

    }





    /**

     * query proccess definition all by project id

     * query process definition all by project id

     *

     * @param loginUser login user

     * @param projectId project id

     * @return process definition list

     */

    @ApiOperation(value = "queryProccessDefinitionAllByProjectId", notes = "QUERY_PROCCESS_DEFINITION_All_BY_PROJECT_ID_NOTES")

    @GetMapping(value = "/queryProccessDefinitionAllByProjectId")

    @ApiOperation(value = "queryProcessDefinitionAllByProjectId", notes = "QUERY_PROCESS_DEFINITION_All_BY_PROJECT_ID_NOTES")

    @GetMapping(value = "/queryProcessDefinitionAllByProjectId")

    @ResponseStatus(HttpStatus.OK)

    @ApiException(QUERY_PROCCESS_DEFINITION_LIST)

    public Result queryProccessDefinitionAllByProjectId(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

    @ApiException(QUERY_PROCESS_DEFINITION_LIST)

    public Result queryProcessDefinitionAllByProjectId(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

                                                        @RequestParam("projectId") Integer projectId) {

        logger.info("query proccess definition list, login user:{}, project id:{}",

        logger.info("query process definition list, login user:{}, project id:{}",

                loginUser.getUserName(), projectId);

        Map<String, Object> result = processDefinitionService.queryProccessDefinitionAllByProjectId(projectId);

        Map<String, Object> result = processDefinitionService.queryProcessDefinitionAllByProjectId(projectId);

        return returnDataList(result);

    }

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/ProjectController.java

+2 −1
Original line number Diff line number Diff line
@@ -234,7 +234,8 @@ public class ProjectController extends BaseController { 
     * @param projectName project name

     * @return import result code

     */

    @ApiOperation(value = "importProcessDefinition", notes = "EXPORT_PROCCESS_DEFINITION_NOTES")



    @ApiOperation(value = "importProcessDefinition", notes= "EXPORT_PROCESS_DEFINITION_NOTES")

    @ApiImplicitParams({

            @ApiImplicitParam(name = "file", value = "RESOURCE_FILE", required = true, dataType = "MultipartFile")

    })

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/enums/Status.java

+2 −2
Original line number Diff line number Diff line
@@ -136,7 +136,7 @@ public enum Status { 
    UPDATE_PROCESS_DEFINITION_ERROR(10107,"update process definition error", "更新工作流定义错误"),

    RELEASE_PROCESS_DEFINITION_ERROR(10108,"release process definition error", "上线工作流错误"),

    QUERY_DATAIL_OF_PROCESS_DEFINITION_ERROR(10109,"query datail of process definition error", "查询工作流详细信息错误"),

    QUERY_PROCCESS_DEFINITION_LIST(10110,"query proccess definition list", "查询工作流列表错误"),

    QUERY_PROCESS_DEFINITION_LIST(10110,"query process definition list", "查询工作流列表错误"),

    ENCAPSULATION_TREEVIEW_STRUCTURE_ERROR(10111,"encapsulation treeview structure error", "查询工作流树形图数据错误"),

    GET_TASKS_LIST_BY_PROCESS_DEFINITION_ID_ERROR(10112,"get tasks list by process definition id error", "查询工作流定义节点信息错误"),

    QUERY_PROCESS_INSTANCE_LIST_PAGING_ERROR(10113,"query process instance list paging error", "分页查询工作流实例列表错误"),
@@ -148,7 +148,7 @@ public enum Status { 
    QUERY_PARENT_PROCESS_INSTANCE_DETAIL_INFO_BY_SUB_PROCESS_INSTANCE_ID_ERROR(10119,"query parent process instance detail info by sub process instance id error", "查询子流程该工作流实例错误"),

    QUERY_PROCESS_INSTANCE_ALL_VARIABLES_ERROR(10120,"query process instance all variables error", "查询工作流自定义变量信息错误"),

    ENCAPSULATION_PROCESS_INSTANCE_GANTT_STRUCTURE_ERROR(10121,"encapsulation process instance gantt structure error", "查询工作流实例甘特图数据错误"),

    QUERY_PROCCESS_DEFINITION_LIST_PAGING_ERROR(10122,"query proccess definition list paging error", "分页查询工作流定义列表错误"),

    QUERY_PROCESS_DEFINITION_LIST_PAGING_ERROR(10122,"query process definition list paging error", "分页查询工作流定义列表错误"),

    SIGN_OUT_ERROR(10123,"sign out error", "退出错误"),

    TENANT_CODE_HAS_ALREADY_EXISTS(10124,"tenant code has already exists", "租户编码已存在"),

    IP_IS_EMPTY(10125,"ip is empty", "IP地址不能为空"),

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/service/ProcessDefinitionService.java

+7 −7
Original line number Diff line number Diff line
@@ -191,13 +191,13 @@ public class ProcessDefinitionService extends BaseDAGService { 




    /**

     * query proccess definition list

     * query process definition list

     *

     * @param loginUser login user

     * @param projectName project name

     * @return definition list

     */

    public Map<String, Object> queryProccessDefinitionList(User loginUser, String projectName) {

    public Map<String, Object> queryProcessDefinitionList(User loginUser, String projectName) {



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

        Project project = projectMapper.queryByName(projectName);
@@ -217,7 +217,7 @@ public class ProcessDefinitionService extends BaseDAGService { 




    /**

     * query proccess definition list paging

     * query process definition list paging

     *

     * @param loginUser login user

     * @param projectName project name
@@ -259,7 +259,7 @@ public class ProcessDefinitionService extends BaseDAGService { 
     * @param processId process definition id

     * @return process definition detail

     */

    public Map<String, Object> queryProccessDefinitionById(User loginUser, String projectName, Integer processId) {

    public Map<String, Object> queryProcessDefinitionById(User loginUser, String projectName, Integer processId) {





        Map<String, Object> result = new HashMap<>(5);
@@ -365,7 +365,7 @@ public class ProcessDefinitionService extends BaseDAGService { 
     * @param name name

     * @return true if process definition name not exists, otherwise false

     */

    public Map<String, Object> verifyProccessDefinitionName(User loginUser, String projectName, String name) {

    public Map<String, Object> verifyProcessDefinitionName(User loginUser, String projectName, String name) {



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

            Project project = projectMapper.queryByName(projectName);
@@ -1038,12 +1038,12 @@ public class ProcessDefinitionService extends BaseDAGService { 




    /**

     * query proccess definition all by project id

     * query process definition all by project id

     *

     * @param projectId project id

     * @return process definitions in the project

     */

    public Map<String, Object> queryProccessDefinitionAllByProjectId(Integer projectId) {

    public Map<String, Object> queryProcessDefinitionAllByProjectId(Integer projectId) {



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

dolphinscheduler-api/src/main/resources/i18n/messages.properties

+7 −7
Original line number Diff line number Diff line
@@ -166,15 +166,15 @@ SIGNOUT_NOTES=logout 
USER_PASSWORD=user password

UPDATE_PROCESS_INSTANCE_NOTES=update process instance

QUERY_PROCESS_INSTANCE_LIST_NOTES=query process instance list

VERIFY_PROCCESS_DEFINITION_NAME_NOTES=verify proccess definition name

VERIFY_PROCESS_DEFINITION_NAME_NOTES=verify process definition name

LOGIN_NOTES=user login

UPDATE_PROCCESS_DEFINITION_NOTES=update proccess definition

UPDATE_PROCESS_DEFINITION_NOTES=update process definition

PROCESS_DEFINITION_ID=process definition id

PROCESS_DEFINITION_IDS=process definition ids

RELEASE_PROCCESS_DEFINITION_NOTES=release proccess definition

QUERY_PROCCESS_DEFINITION_BY_ID_NOTES=query proccess definition by id

QUERY_PROCCESS_DEFINITION_LIST_NOTES=query proccess definition list

QUERY_PROCCESS_DEFINITION_LIST_PAGING_NOTES=query proccess definition list paging

RELEASE_PROCESS_DEFINITION_NOTES=release process definition

QUERY_PROCESS_DEFINITION_BY_ID_NOTES=query process definition by id

QUERY_PROCESS_DEFINITION_LIST_NOTES=query process definition list

QUERY_PROCESS_DEFINITION_LIST_PAGING_NOTES=query process definition list paging

QUERY_ALL_DEFINITION_LIST_NOTES=query all definition list

PAGE_NO=page no

PROCESS_INSTANCE_ID=process instance id
@@ -190,7 +190,7 @@ LIMIT=limit 
VIEW_TREE_NOTES=view tree

GET_NODE_LIST_BY_DEFINITION_ID_NOTES=get task node list by process definition id

PROCESS_DEFINITION_ID_LIST=process definition id list

QUERY_PROCCESS_DEFINITION_All_BY_PROJECT_ID_NOTES=query proccess definition all by project id

QUERY_PROCESS_DEFINITION_All_BY_PROJECT_ID_NOTES=query process definition all by project id

DELETE_PROCESS_DEFINITION_BY_ID_NOTES=delete process definition by process definition id

BATCH_DELETE_PROCESS_DEFINITION_BY_IDS_NOTES=batch delete process definition by process definition ids

QUERY_PROCESS_INSTANCE_BY_ID_NOTES=query process instance by process instance id