Add --force flag to gh run cancel (cli#11513)

* feat: add --force flag to run cancel command

Signed-off-by: Andrey <andrekabatareika@gmail.com>

* docs: use less prescriptive docs for --force flag

Co-authored-by: Kynan Ware <47394200+BagToad@users.noreply.github.com>

* chore: remove short flag

Signed-off-by: Andrey <andrekabatareika@gmail.com>

---------

Signed-off-by: Andrey <andrekabatareika@gmail.com>
Co-authored-by: Kynan Ware <47394200+BagToad@users.noreply.github.com>

Author: ankddev

pkg/cmd/run/cancel/cancel.go

@@ -23,6 +23,7 @@ type CancelOptions struct {
 	Prompt bool
 
 	RunID string
+	Force bool
 }
 
 func NewCmdCancel(f *cmdutil.Factory, runF func(*CancelOptions) error) *cobra.Command {
@@ -56,6 +57,8 @@ func NewCmdCancel(f *cmdutil.Factory, runF func(*CancelOptions) error) *cobra.Co
 		},
 	}
 
+	cmd.Flags().BoolVar(&opts.Force, "force", false, "Force cancel a workflow run")
+
 	return cmd
 }
 
@@ -115,7 +118,9 @@ func runCancel(opts *CancelOptions) error {
 		}
 	}
 
-	err = cancelWorkflowRun(client, repo, fmt.Sprintf("%d", run.ID))
+	force := opts.Force
+
+	err = cancelWorkflowRun(client, repo, fmt.Sprintf("%d", run.ID), force)
 	if err != nil {
 		var httpErr api.HTTPError
 		if errors.As(err, &httpErr) {
@@ -127,13 +132,22 @@ func runCancel(opts *CancelOptions) error {
 		return err
 	}
 
-	fmt.Fprintf(opts.IO.Out, "%s Request to cancel workflow %s submitted.\n", cs.SuccessIcon(), runID)
+	if force {
+		fmt.Fprintf(opts.IO.Out, "%s Request to force cancel workflow %s submitted.\n", cs.SuccessIcon(), runID)
+	} else {
+		fmt.Fprintf(opts.IO.Out, "%s Request to cancel workflow %s submitted.\n", cs.SuccessIcon(), runID)
+	}
 
 	return nil
 }
 
-func cancelWorkflowRun(client *api.Client, repo ghrepo.Interface, runID string) error {
-	path := fmt.Sprintf("repos/%s/actions/runs/%s/cancel", ghrepo.FullName(repo), runID)
+func cancelWorkflowRun(client *api.Client, repo ghrepo.Interface, runID string, force bool) error {
+	var path string
+	if force {
+		path = fmt.Sprintf("repos/%s/actions/runs/%s/force-cancel", ghrepo.FullName(repo), runID)
+	} else {
+		path = fmt.Sprintf("repos/%s/actions/runs/%s/cancel", ghrepo.FullName(repo), runID)
+	}
 
 	err := client.REST(repo.RepoHost(), "POST", path, nil, nil)
 	if err != nil {

pkg/cmd/run/cancel/cancel_test.go

@@ -41,6 +41,15 @@ func TestNewCmdCancel(t *testing.T) {
 			cli:  "1234",
 			wants: CancelOptions{
 				RunID: "1234",
+				Force: false,
+			},
+		},
+		{
+			name: "with arg and force flag",
+			cli:  "1234 --force",
+			wants: CancelOptions{
+				RunID: "1234",
+				Force: true,
 			},
 		},
 	}
@@ -78,6 +87,7 @@ func TestNewCmdCancel(t *testing.T) {
 			assert.NoError(t, err)
 
 			assert.Equal(t, tt.wants.RunID, gotOpts.RunID)
+			assert.Equal(t, tt.wants.Force, gotOpts.Force)
 		})
 	}
 }
@@ -213,6 +223,47 @@ func TestRunCancel(t *testing.T) {
 			wantErr: true,
 			errMsg:  "invalid run-id \"12\\n34\"",
 		},
+		{
+			name: "force cancel run",
+			opts: &CancelOptions{
+				RunID: "1234",
+				Force: true,
+			},
+			wantErr: false,
+			httpStubs: func(reg *httpmock.Registry) {
+				reg.Register(
+					httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"),
+					httpmock.JSONResponse(inProgressRun))
+				reg.Register(
+					httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"),
+					httpmock.JSONResponse(shared.TestWorkflow))
+				reg.Register(
+					httpmock.REST("POST", "repos/OWNER/REPO/actions/runs/1234/force-cancel"),
+					httpmock.StatusStringResponse(202, "{}"))
+			},
+			wantOut: "✓ Request to force cancel workflow 1234 submitted.\n",
+		},
+		{
+			name: "force and completed",
+			opts: &CancelOptions{
+				RunID: "4567",
+				Force: true,
+			},
+			wantErr: true,
+			errMsg:  "Cannot cancel a workflow run that is completed",
+			httpStubs: func(reg *httpmock.Registry) {
+				reg.Register(
+					httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/4567"),
+					httpmock.JSONResponse(completedRun))
+				reg.Register(
+					httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"),
+					httpmock.JSONResponse(shared.TestWorkflow))
+				reg.Register(
+					httpmock.REST("POST", "repos/OWNER/REPO/actions/runs/4567/force-cancel"),
+					httpmock.StatusStringResponse(409, ""),
+				)
+			},
+		},
 	}
 
 	for _, tt := range tests {