Skip to content

Commit

Permalink
Merge branch 'dev' into fix/js_engine
Browse files Browse the repository at this point in the history
  • Loading branch information
@caishunfeng
caishunfeng committed Mar 21, 2024
2 parents 735c452 + f7358c3 commit 7d13d65
Show file tree
Hide file tree
Showing 16 changed files with 484 additions and 303 deletions.
10 changes: 5 additions & 5 deletions docs/docs/en/guide/alert/script.md
View file
Expand Up @@ -7,11 +7,11 @@ The following shows the `Script` configuration example:

## Parameter Configuration

| **Parameter** | **Description** |
|---------------|--------------------------------------------------|
| User Params | User defined parameters will pass to the script. |
| Script Path | The file location path in the server. |
| Type | Support `Shell` script. |
| **Parameter** | **Description** |
|---------------|-------------------------------------------------------------|
| User Params | User defined parameters will pass to the script. |
| Script Path | The file location path in the server, only support .sh file |
| Type | Support `Shell` script. |

### Note

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/zh/guide/alert/script.md
View file
Expand Up @@ -12,7 +12,7 @@
* 脚本路径

> 脚本在服务器上的文件位置
> 脚本在服务器上的文件位置，只支持.sh后缀的文件
* 脚本类型

Expand Down
5 changes: 5 additions & 0 deletions ...rt-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSender.java
View file
Expand Up @@ -69,6 +69,11 @@ private AlertResult executeShellScript(String title, String content) {
alertResult.setMessage("shell script not support windows os");
return alertResult;
}
if (!scriptPath.endsWith(".sh")) {
alertResult.setMessage("shell script is invalid, only support .sh file");
return alertResult;
}

// validate script path in case of injections
File shellScriptFile = new File(scriptPath);
// validate existence
Expand Down
10 changes: 10 additions & 0 deletions ...cript/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java
View file
Expand Up @@ -79,6 +79,16 @@ public void testPathNPE() {
Assertions.assertEquals("false", alertResult.getStatus());
}

@Test
public void testPathError() {
scriptConfig.put(ScriptParamsConstants.NAME_SCRIPT_PATH, "/usr/sbin/abc");
ScriptSender scriptSender = new ScriptSender(scriptConfig);
AlertResult alertResult;
alertResult = scriptSender.sendScriptAlert("test path NPE", "test content");
Assertions.assertEquals("false", alertResult.getStatus());
Assertions.assertTrue(alertResult.getMessage().contains("shell script is invalid, only support .sh file"));
}

@Test
public void testTypeIsError() {
scriptConfig.put(ScriptParamsConstants.NAME_SCRIPT_TYPE, null);
Expand Down
148 changes: 74 additions & 74 deletions ...src/main/java/org/apache/dolphinscheduler/api/controller/ProcessDefinitionController.java
View file
Expand Up @@ -90,16 +90,16 @@ public class ProcessDefinitionController extends BaseController {
/**
* create process definition
*
* @param loginUser login user
* @param projectCode project code
* @param name process definition name
* @param description description
* @param globalParams globalParams
* @param locations locations for nodes
* @param timeout timeout
* @param taskRelationJson relation json for nodes
* @param loginUser login user
* @param projectCode project code
* @param name process definition name
* @param description description
* @param globalParams globalParams
* @param locations locations for nodes
* @param timeout timeout
* @param taskRelationJson relation json for nodes
* @param taskDefinitionJson taskDefinitionJson
* @param otherParamsJson otherParamsJson handle other params
* @param otherParamsJson otherParamsJson handle other params
* @return create result code
*/
@Operation(summary = "createProcessDefinition", description = "CREATE_PROCESS_DEFINITION_NOTES")
Expand Down Expand Up @@ -132,9 +132,9 @@ public Result createProcessDefinition(@Parameter(hidden = true) @RequestAttribut
/**
* copy process definition
*
* @param loginUser login user
* @param projectCode project code
* @param codes process definition codes
* @param loginUser login user
* @param projectCode project code
* @param codes process definition codes
* @param targetProjectCode target project code
* @return copy result code
*/
Expand All @@ -157,9 +157,9 @@ public Result copyProcessDefinition(@Parameter(hidden = true) @RequestAttribute(
/**
* move process definition
*
* @param loginUser login user
* @param projectCode project code
* @param codes process definition codes
* @param loginUser login user
* @param projectCode project code
* @param codes process definition codes
* @param targetProjectCode target project code
* @return move result code
*/
Expand All @@ -182,9 +182,9 @@ public Result moveProcessDefinition(@Parameter(hidden = true) @RequestAttribute(
/**
* verify process definition name unique
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @param name name
* @param name name
* @return true if process definition name not exists, otherwise false
*/
@Operation(summary = "verify-name", description = "VERIFY_PROCESS_DEFINITION_NAME_NOTES")
Expand All @@ -207,17 +207,17 @@ public Result verifyProcessDefinitionName(@Parameter(hidden = true) @RequestAttr
/**
* update process definition, with whole process definition object including task definition, task relation and location.
*
* @param loginUser login user
* @param projectCode project code
* @param name process definition name
* @param code process definition code
* @param description description
* @param globalParams globalParams
* @param locations locations for nodes
* @param timeout timeout
* @param taskRelationJson relation json for nodes
* @param loginUser login user
* @param projectCode project code
* @param name process definition name
* @param code process definition code
* @param description description
* @param globalParams globalParams
* @param locations locations for nodes
* @param timeout timeout
* @param taskRelationJson relation json for nodes
* @param taskDefinitionJson taskDefinitionJson
* @param otherParamsJson otherParamsJson handle other params
* @param otherParamsJson otherParamsJson handle other params
* @return update result code
*/
@Operation(summary = "update", description = "UPDATE_PROCESS_DEFINITION_NOTES")
Expand Down Expand Up @@ -263,11 +263,11 @@ public Result updateProcessDefinition(@Parameter(hidden = true) @RequestAttribut
/**
* query process definition version paging list info
*
* @param loginUser login user info
* @param loginUser login user info
* @param projectCode project code
* @param pageNo the process definition version list current page number
* @param pageSize the process definition version list page size
* @param code the process definition code
* @param pageNo the process definition version list current page number
* @param pageSize the process definition version list page size
* @param code the process definition code
* @return the process definition version list
*/
@Operation(summary = "queryVersions", description = "QUERY_PROCESS_DEFINITION_VERSIONS_NOTES")
Expand All @@ -293,10 +293,10 @@ public Result queryProcessDefinitionVersions(@Parameter(hidden = true) @RequestA
/**
* switch certain process definition version
*
* @param loginUser login user info
* @param loginUser login user info
* @param projectCode project code
* @param code the process definition code
* @param version the version user want to switch
* @param code the process definition code
* @param version the version user want to switch
* @return switch version result code
*/
@Operation(summary = "switchVersion", description = "SWITCH_PROCESS_DEFINITION_VERSION_NOTES")
Expand All @@ -319,10 +319,10 @@ public Result switchProcessDefinitionVersion(@Parameter(hidden = true) @RequestA
/**
* delete the certain process definition version by version and process definition code
*
* @param loginUser login user info
* @param loginUser login user info
* @param projectCode project code
* @param code the process definition code
* @param version the process definition version user want to delete
* @param code the process definition code
* @param version the process definition version user want to delete
* @return delete version result code
*/
@Operation(summary = "deleteVersion", description = "DELETE_PROCESS_DEFINITION_VERSION_NOTES")
Expand All @@ -333,13 +333,13 @@ public Result switchProcessDefinitionVersion(@Parameter(hidden = true) @RequestA
@DeleteMapping(value = "/{code}/versions/{version}")
@ResponseStatus(HttpStatus.OK)
@ApiException(DELETE_PROCESS_DEFINITION_VERSION_ERROR)
public Result deleteProcessDefinitionVersion(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
@Parameter(name = "projectCode", description = "PROJECT_CODE", required = true) @PathVariable long projectCode,
@PathVariable(value = "code") long code,
@PathVariable(value = "version") int version) {
Map<String, Object> result =
processDefinitionService.deleteProcessDefinitionVersion(loginUser, projectCode, code, version);
return returnDataList(result);
public Result<Void> deleteProcessDefinitionVersion(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
@Parameter(name = "projectCode", description = "PROJECT_CODE", required = true) @PathVariable long projectCode,
@PathVariable(value = "code") long workflowDefinitionCode,
@PathVariable(value = "version") int workflowDefinitionVersion) {
processDefinitionService.deleteProcessDefinitionVersion(loginUser, projectCode, workflowDefinitionCode,
workflowDefinitionVersion);
return Result.success();
}

@Operation(summary = "release", description = "RELEASE_PROCESS_DEFINITION_NOTES")
Expand Down Expand Up @@ -372,9 +372,9 @@ public Result<Boolean> releaseProcessDefinition(@Parameter(hidden = true) @Reque
/**
* query detail of process definition by code
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @param code process definition code
* @param code process definition code
* @return process definition detail
*/
@Operation(summary = "queryProcessDefinitionByCode", description = "QUERY_PROCESS_DEFINITION_BY_CODE_NOTES")
Expand All @@ -395,9 +395,9 @@ public Result queryProcessDefinitionByCode(@Parameter(hidden = true) @RequestAtt
/**
* query detail of process definition by name
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @param name process definition name
* @param name process definition name
* @return process definition detail
*/
@Operation(summary = "queryProcessDefinitionByName", description = "QUERY_PROCESS_DEFINITION_BY_NAME_NOTES")
Expand All @@ -418,7 +418,7 @@ public Result<ProcessDefinition> queryProcessDefinitionByName(@Parameter(hidden
/**
* query Process definition list
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @return process definition list
*/
Expand All @@ -435,7 +435,7 @@ public Result queryProcessDefinitionList(@Parameter(hidden = true) @RequestAttri
/**
* query Process definition simple list
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @return process definition list
*/
Expand All @@ -452,13 +452,13 @@ public Result queryProcessDefinitionSimpleList(@Parameter(hidden = true) @Reques
/**
* query process definition list paging
*
* @param loginUser login user
* @param projectCode project code
* @param searchVal search value
* @param loginUser login user
* @param projectCode project code
* @param searchVal search value
* @param otherParamsJson otherParamsJson handle other params
* @param pageNo page number
* @param pageSize page size
* @param userId user id
* @param pageNo page number
* @param pageSize page size
* @param userId user id
* @return process definition page
*/
@Operation(summary = "queryListPaging", description = "QUERY_PROCESS_DEFINITION_LIST_PAGING_NOTES")
Expand Down Expand Up @@ -493,10 +493,10 @@ public Result<PageInfo<ProcessDefinition>> queryProcessDefinitionListPaging(
/**
* encapsulation tree view structure
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @param code process definition code
* @param limit limit
* @param code process definition code
* @param limit limit
* @return tree view json data
*/
@Operation(summary = "viewTree", description = "VIEW_TREE_NOTES")
Expand All @@ -518,9 +518,9 @@ public Result viewTree(@Parameter(hidden = true) @RequestAttribute(value = Const
/**
* get tasks list by process definition code
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @param code process definition code
* @param code process definition code
* @return task list
*/
@Operation(summary = "getTasksByDefinitionCode", description = "GET_TASK_LIST_BY_DEFINITION_CODE_NOTES")
Expand All @@ -541,9 +541,9 @@ public Result getNodeListByDefinitionCode(@Parameter(hidden = true) @RequestAttr
/**
* get tasks list map by process definition multiple code
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @param codes process definition codes
* @param codes process definition codes
* @return node list data
*/
@Operation(summary = "getTaskListByDefinitionCodes", description = "GET_TASK_LIST_BY_DEFINITION_CODE_NOTES")
Expand All @@ -564,7 +564,7 @@ public Result getNodeListMapByDefinitionCodes(@Parameter(hidden = true) @Request
/**
* get process definition list map by project code
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @return process definition list data
*/
Expand All @@ -584,7 +584,7 @@ public Result getProcessListByProjectCode(@Parameter(hidden = true) @RequestAttr
/**
* get task definition list by process definition code
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @return process definition list data
*/
Expand Down Expand Up @@ -621,9 +621,9 @@ public Result deleteProcessDefinitionByCode(@Parameter(hidden = true) @RequestAt
/**
* batch delete process definition by codes
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @param codes process definition code list
* @param codes process definition code list
* @return delete result code
*/
@Operation(summary = "batchDeleteByCodes", description = "BATCH_DELETE_PROCESS_DEFINITION_BY_IDS_NOTES")
Expand All @@ -645,10 +645,10 @@ public Result batchDeleteProcessDefinitionByCodes(@Parameter(hidden = true) @Req
/**
* batch export process definition by codes
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @param codes process definition codes
* @param response response
* @param codes process definition codes
* @param response response
*/
@Operation(summary = "batchExportByCodes", description = "BATCH_EXPORT_PROCESS_DEFINITION_BY_CODES_NOTES")
@Parameters({
Expand All @@ -670,7 +670,7 @@ public void batchExportProcessDefinitionByCodes(@Parameter(hidden = true) @Reque
/**
* query all process definition by project code
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @return process definition list
*/
Expand All @@ -688,9 +688,9 @@ public Result queryAllProcessDefinitionByProjectCode(@Parameter(hidden = true) @
/**
* import process definition
*
* @param loginUser login user
* @param loginUser login user
* @param projectCode project code
* @param file resource file
* @param file resource file
* @return import result code
*/
@Operation(summary = "importProcessDefinition", description = "IMPORT_PROCESS_DEFINITION_NOTES")
Expand All @@ -715,7 +715,7 @@ public Result importProcessDefinition(@Parameter(hidden = true) @RequestAttribut
* query process definition global variables and local variables
*
* @param loginUser login user
* @param code process definition code
* @param code process definition code
* @return variables data
*/
@Operation(summary = "viewVariables", description = "QUERY_PROCESS_DEFINITION_GLOBAL_VARIABLES_AND_LOCAL_VARIABLES_NOTES")
Expand Down

0 comments on commit 7d13d65

Please sign in to comment.