Skip to content

Commit b1de32d

Browse files
cyrilicocyrilico
authored
feat: add force-cancel workflow run (#2143)
* add force-cancel workflow run * mvn spotless:apply * remove forceCancelUrl logic this property is not part of workflow_run payloads * modify snapshot
1 parent 3745013 commit b1de32d

16 files changed

+1135
-1
lines changed

‎src/main/java/org/kohsuke/github/GHWorkflowRun.java‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,8 @@ public String toString() {
211211
private String artifactsUrl;
212212
private String cancelUrl;
213213
private String checkSuiteUrl;
214-
215214
private String conclusion;
215+
216216
private String displayTitle;
217217
private String event;
218218

@@ -308,6 +308,16 @@ public <T> T downloadLogs(InputStreamFunction<T> streamFunction) throws IOExcept
308308
return root().createRequest().method("GET").withUrlPath(getApiRoute(), "logs").fetchStream(streamFunction);
309309
}
310310

311+
/**
312+
* Force-cancel the workflow run.
313+
*
314+
* @throws IOException
315+
* the io exception
316+
*/
317+
public void forceCancel() throws IOException {
318+
root().createRequest().method("POST").withUrlPath(getApiRoute(), "force-cancel").send();
319+
}
320+
311321
/**
312322
* The actor which triggered the initial run.
313323
*

‎src/test/java/org/kohsuke/github/GHWorkflowRunTest.java‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -458,6 +458,46 @@ public void testDelete() throws IOException {
458458
}
459459
}
460460

461+
/**
462+
* Test force cancel a run.
463+
*
464+
* @throws IOException
465+
* Signals that an I/O exception has occurred.
466+
*/
467+
@Test
468+
public void testForceCancel() throws IOException {
469+
GHWorkflow workflow = repo.getWorkflow(SLOW_WORKFLOW_PATH);
470+
471+
long latestPreexistingWorkflowRunId = getLatestPreexistingWorkflowRunId();
472+
473+
workflow.dispatch(MAIN_BRANCH);
474+
475+
// now that we have triggered the workflow run, we will wait until it's in progress and then force cancel it
476+
await((nonRecordingRepo) -> getWorkflowRun(nonRecordingRepo,
477+
SLOW_WORKFLOW_NAME,
478+
MAIN_BRANCH,
479+
Status.IN_PROGRESS,
480+
latestPreexistingWorkflowRunId).isPresent());
481+
482+
GHWorkflowRun workflowRun = getWorkflowRun(SLOW_WORKFLOW_NAME,
483+
MAIN_BRANCH,
484+
Status.IN_PROGRESS,
485+
latestPreexistingWorkflowRunId)
486+
.orElseThrow(() -> new IllegalStateException("We must have a valid workflow run starting from here"));
487+
488+
assertThat(workflowRun.getId(), notNullValue());
489+
490+
workflowRun.forceCancel();
491+
long cancelledWorkflowRunId = workflowRun.getId();
492+
493+
// let's wait until it's completed
494+
await((nonRecordingRepo) -> getWorkflowRunStatus(nonRecordingRepo, cancelledWorkflowRunId) == Status.COMPLETED);
495+
496+
// let's check that it has been properly cancelled
497+
workflowRun = repo.getWorkflowRun(cancelledWorkflowRunId);
498+
assertThat(workflowRun.getConclusion(), equalTo(Conclusion.CANCELLED));
499+
}
500+
461501
/**
462502
* Test jobs.
463503
*

‎src/test/resources/org/kohsuke/github/GHWorkflowRunTest/wiremock/testForceCancel/__files/1-user.json‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"login": "gsmet",
3+
"id": 1279749,
4+
"node_id": "MDQ6VXNlcjEyNzk3NDk=",
5+
"avatar_url": "https://avatars.githubusercontent.com/u/1279749?v=4",
6+
"gravatar_id": "",
7+
"url": "https://api.github.com/users/gsmet",
8+
"html_url": "https://github.com/gsmet",
9+
"followers_url": "https://api.github.com/users/gsmet/followers",
10+
"following_url": "https://api.github.com/users/gsmet/following{/other_user}",
11+
"gists_url": "https://api.github.com/users/gsmet/gists{/gist_id}",
12+
"starred_url": "https://api.github.com/users/gsmet/starred{/owner}{/repo}",
13+
"subscriptions_url": "https://api.github.com/users/gsmet/subscriptions",
14+
"organizations_url": "https://api.github.com/users/gsmet/orgs",
15+
"repos_url": "https://api.github.com/users/gsmet/repos",
16+
"events_url": "https://api.github.com/users/gsmet/events{/privacy}",
17+
"received_events_url": "https://api.github.com/users/gsmet/received_events",
18+
"type": "User",
19+
"site_admin": false,
20+
"name": "Guillaume Smet",
21+
"company": "Red Hat",
22+
"blog": "https://www.redhat.com/",
23+
"location": "Lyon, France",
24+
"email": "[email protected]",
25+
"hireable": null,
26+
"bio": "Happy camper at Red Hat, working on Quarkus and the Hibernate portfolio.",
27+
"twitter_username": "gsmet_",
28+
"public_repos": 102,
29+
"public_gists": 14,
30+
"followers": 127,
31+
"following": 3,
32+
"created_at": "2011-12-22T11:03:22Z",
33+
"updated_at": "2021-03-23T17:35:45Z",
34+
"private_gists": 14,
35+
"total_private_repos": 4,
36+
"owned_private_repos": 1,
37+
"disk_usage": 68258,
38+
"collaborators": 1,
39+
"two_factor_authentication": true,
40+
"plan": {
41+
"name": "free",
42+
"space": 976562499,
43+
"collaborators": 0,
44+
"private_repos": 10000
45+
}
46+
}

‎src/test/resources/org/kohsuke/github/GHWorkflowRunTest/wiremock/testForceCancel/__files/2-r_h_ghworkflowruntest.json‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
{
2+
"id": 348674220,
3+
"node_id": "MDEwOlJlcG9zaXRvcnkzNDg2NzQyMjA=",
4+
"name": "GHWorkflowRunTest",
5+
"full_name": "hub4j-test-org/GHWorkflowRunTest",
6+
"private": false,
7+
"owner": {
8+
"login": "hub4j-test-org",
9+
"id": 7544739,
10+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
11+
"avatar_url": "https://avatars.githubusercontent.com/u/7544739?v=4",
12+
"gravatar_id": "",
13+
"url": "https://api.github.com/users/hub4j-test-org",
14+
"html_url": "https://github.com/hub4j-test-org",
15+
"followers_url": "https://api.github.com/users/hub4j-test-org/followers",
16+
"following_url": "https://api.github.com/users/hub4j-test-org/following{/other_user}",
17+
"gists_url": "https://api.github.com/users/hub4j-test-org/gists{/gist_id}",
18+
"starred_url": "https://api.github.com/users/hub4j-test-org/starred{/owner}{/repo}",
19+
"subscriptions_url": "https://api.github.com/users/hub4j-test-org/subscriptions",
20+
"organizations_url": "https://api.github.com/users/hub4j-test-org/orgs",
21+
"repos_url": "https://api.github.com/users/hub4j-test-org/repos",
22+
"events_url": "https://api.github.com/users/hub4j-test-org/events{/privacy}",
23+
"received_events_url": "https://api.github.com/users/hub4j-test-org/received_events",
24+
"type": "Organization",
25+
"site_admin": false
26+
},
27+
"html_url": "https://github.com/hub4j-test-org/GHWorkflowRunTest",
28+
"description": "Repository used by GHWorkflowRunTest",
29+
"fork": false,
30+
"url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest",
31+
"forks_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/forks",
32+
"keys_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/keys{/key_id}",
33+
"collaborators_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/collaborators{/collaborator}",
34+
"teams_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/teams",
35+
"hooks_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/hooks",
36+
"issue_events_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/issues/events{/number}",
37+
"events_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/events",
38+
"assignees_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/assignees{/user}",
39+
"branches_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/branches{/branch}",
40+
"tags_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/tags",
41+
"blobs_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/git/blobs{/sha}",
42+
"git_tags_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/git/tags{/sha}",
43+
"git_refs_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/git/refs{/sha}",
44+
"trees_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/git/trees{/sha}",
45+
"statuses_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/statuses/{sha}",
46+
"languages_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/languages",
47+
"stargazers_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/stargazers",
48+
"contributors_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/contributors",
49+
"subscribers_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/subscribers",
50+
"subscription_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/subscription",
51+
"commits_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/commits{/sha}",
52+
"git_commits_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/git/commits{/sha}",
53+
"comments_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/comments{/number}",
54+
"issue_comment_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/issues/comments{/number}",
55+
"contents_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/contents/{+path}",
56+
"compare_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/compare/{base}...{head}",
57+
"merges_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/merges",
58+
"archive_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/{archive_format}{/ref}",
59+
"downloads_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/downloads",
60+
"issues_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/issues{/number}",
61+
"pulls_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/pulls{/number}",
62+
"milestones_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/milestones{/number}",
63+
"notifications_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/notifications{?since,all,participating}",
64+
"labels_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/labels{/name}",
65+
"releases_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/releases{/id}",
66+
"deployments_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/deployments",
67+
"created_at": "2021-03-17T10:50:49Z",
68+
"updated_at": "2021-03-17T10:56:17Z",
69+
"pushed_at": "2021-03-22T17:53:57Z",
70+
"git_url": "git://github.com/hub4j-test-org/GHWorkflowRunTest.git",
71+
"ssh_url": "[email protected]:hub4j-test-org/GHWorkflowRunTest.git",
72+
"clone_url": "https://github.com/hub4j-test-org/GHWorkflowRunTest.git",
73+
"svn_url": "https://github.com/hub4j-test-org/GHWorkflowRunTest",
74+
"homepage": null,
75+
"size": 3,
76+
"stargazers_count": 0,
77+
"watchers_count": 0,
78+
"language": null,
79+
"has_issues": true,
80+
"has_projects": true,
81+
"has_downloads": true,
82+
"has_wiki": true,
83+
"has_pages": false,
84+
"forks_count": 0,
85+
"mirror_url": null,
86+
"archived": false,
87+
"disabled": false,
88+
"open_issues_count": 7,
89+
"license": null,
90+
"forks": 0,
91+
"open_issues": 7,
92+
"watchers": 0,
93+
"default_branch": "main",
94+
"permissions": {
95+
"admin": true,
96+
"push": true,
97+
"pull": true
98+
},
99+
"temp_clone_token": "",
100+
"allow_squash_merge": true,
101+
"allow_merge_commit": true,
102+
"allow_rebase_merge": true,
103+
"delete_branch_on_merge": false,
104+
"organization": {
105+
"login": "hub4j-test-org",
106+
"id": 7544739,
107+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
108+
"avatar_url": "https://avatars.githubusercontent.com/u/7544739?v=4",
109+
"gravatar_id": "",
110+
"url": "https://api.github.com/users/hub4j-test-org",
111+
"html_url": "https://github.com/hub4j-test-org",
112+
"followers_url": "https://api.github.com/users/hub4j-test-org/followers",
113+
"following_url": "https://api.github.com/users/hub4j-test-org/following{/other_user}",
114+
"gists_url": "https://api.github.com/users/hub4j-test-org/gists{/gist_id}",
115+
"starred_url": "https://api.github.com/users/hub4j-test-org/starred{/owner}{/repo}",
116+
"subscriptions_url": "https://api.github.com/users/hub4j-test-org/subscriptions",
117+
"organizations_url": "https://api.github.com/users/hub4j-test-org/orgs",
118+
"repos_url": "https://api.github.com/users/hub4j-test-org/repos",
119+
"events_url": "https://api.github.com/users/hub4j-test-org/events{/privacy}",
120+
"received_events_url": "https://api.github.com/users/hub4j-test-org/received_events",
121+
"type": "Organization",
122+
"site_admin": false
123+
},
124+
"network_count": 0,
125+
"subscribers_count": 9
126+
}

‎src/test/resources/org/kohsuke/github/GHWorkflowRunTest/wiremock/testForceCancel/__files/3-r_h_g_actions_workflows_slow-workflowyml.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"id": 6820849,
3+
"node_id": "MDg6V29ya2Zsb3c2ODIwODQ5",
4+
"name": "Slow workflow",
5+
"path": ".github/workflows/slow-workflow.yml",
6+
"state": "active",
7+
"created_at": "2021-03-17T11:55:06.000+01:00",
8+
"updated_at": "2021-03-17T11:55:06.000+01:00",
9+
"url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/actions/workflows/6820849",
10+
"html_url": "https://github.com/hub4j-test-org/GHWorkflowRunTest/blob/main/.github/workflows/slow-workflow.yml",
11+
"badge_url": "https://github.com/hub4j-test-org/GHWorkflowRunTest/workflows/Slow%20workflow/badge.svg"
12+
}

0 commit comments

Comments
 (0)