feat(cli): add delete workflow run command (#6273)

Author: sguiheux

cli/cdsctl/workflow.go

@@ -20,6 +20,7 @@ func workflow() *cobra.Command {
 	return cli.NewCommand(workflowCmd, nil, []*cobra.Command{
 		cli.NewCommand(workflowInitCmd, workflowInitRun, nil),
 		cli.NewCommand(templateApplyCmd("applyTemplate"), templateApplyRun, nil, withAllCommandModifiers()...),
+		cli.NewDeleteCommand(workflowRunDeleteCmd, workflowRunDelete, nil, withAllCommandModifiers()...),
 		cli.NewListCommand(workflowListCmd, workflowListRun, nil, withAllCommandModifiers()...),
 		cli.NewListCommand(workflowHistoryCmd, workflowHistoryRun, nil, withAllCommandModifiers()...),
 		cli.NewGetCommand(workflowShowCmd, workflowShowRun, nil, withAllCommandModifiers()...),

cli/cdsctl/workflow_run.go

@@ -213,3 +213,35 @@ func workflowRunManualRun(v cli.Values) error {
 
 	return workflowRunInteractive(v, w, configUser.URLUI)
 }
+
+var workflowRunDeleteCmd = cli.Command{
+	Name:    "run-delete",
+	Short:   "Delete a workflow run",
+	Aliases: []string{"remove", "rm"},
+	Ctx: []cli.Arg{
+		{Name: _ProjectKey},
+		{Name: _WorkflowName},
+	},
+	VariadicArgs: cli.Arg{
+		Name: "run-number",
+		IsValid: func(s string) bool {
+			match, _ := regexp.MatchString(`[0-9]?`, s)
+			return match
+		},
+	},
+}
+
+func workflowRunDelete(v cli.Values) error {
+	runNumbers := v.GetStringSlice("run-number")
+	for _, runNumber := range runNumbers {
+		num, err := strconv.Atoi(runNumber)
+		if err != nil {
+			return err
+		}
+		fmt.Printf("Deleting run %d\n", num)
+		if err := client.WorkflowRunDelete(v.GetString(_ProjectKey), v.GetString(_WorkflowName), int64(num)); err != nil {
+			return err
+		}
+	}
+	return nil
+}

sdk/cdsclient/client_workflow.go

@@ -122,6 +122,14 @@ func (c *client) WorkflowRunSearch(projectKey string, offset, limit int64, filte
 	return runs, nil
 }
 
+func (c *client) WorkflowRunDelete(projectKey string, workflowName string, runNumber int64) error {
+	url := fmt.Sprintf("/project/%s/workflows/%s/runs/%d", projectKey, workflowName, runNumber)
+	if _, err := c.DeleteJSON(context.Background(), url, nil); err != nil {
+		return err
+	}
+	return nil
+}
+
 func (c *client) WorkflowRunList(projectKey string, workflowName string, offset, limit int64) ([]sdk.WorkflowRun, error) {
 	if offset < 0 {
 		offset = 0

sdk/cdsclient/interface.go

@@ -348,6 +348,7 @@ type WorkflowClient interface {
 	WorkflowRunsDeleteByBranch(projectKey string, workflowName string, branch string) error
 	WorkflowRunSearch(projectKey string, offset, limit int64, filter ...Filter) ([]sdk.WorkflowRun, error)
 	WorkflowRunList(projectKey string, workflowName string, offset, limit int64) ([]sdk.WorkflowRun, error)
+	WorkflowRunDelete(projectKey string, workflowName string, runNumber int64) error
 	WorkflowRunArtifactsLinks(projectKey string, name string, number int64) (sdk.CDNItemLinks, error)
 	WorkflowRunResultsList(ctx context.Context, projectKey string, name string, number int64) ([]sdk.WorkflowRunResult, error)
 	WorkflowRunFromHook(projectKey string, workflowName string, hook sdk.WorkflowNodeRunHookEvent) (*sdk.WorkflowRun, error)