Skip to content

Commit 0af15ad

Browse files
gsmetbitwiseman
gsmet
and
bitwiseman
authored
Allow to list workflow runs by head sha and created date (#1789)
* Allow to list workflow runs by head sha and created date * Update src/test/java/org/kohsuke/github/GHWorkflowRunTest.java --------- Co-authored-by: Liam Newman <bitwiseman@gmail.com>
1 parent 51b3a06 commit 0af15ad

22 files changed

+6181
-0
lines changed

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,34 @@ public GHWorkflowRunQueryBuilder conclusion(Conclusion conclusion) {
110110
return this;
111111
}
112112

113+
/**
114+
* Created workflow run query builder.
115+
*
116+
* @param created
117+
* a range following the Query for dates syntax
118+
*
119+
* @return the gh workflow run query builder
120+
* @see <a href=
121+
* "https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates">Query
122+
* for dates</a>
123+
*/
124+
public GHWorkflowRunQueryBuilder created(String created) {
125+
req.with("created", created);
126+
return this;
127+
}
128+
129+
/**
130+
* Head sha workflow run query builder.
131+
*
132+
* @param headSha
133+
* the head sha
134+
* @return the gh workflow run query builder
135+
*/
136+
public GHWorkflowRunQueryBuilder headSha(String headSha) {
137+
req.with("head_sha", headSha);
138+
return this;
139+
}
140+
113141
/**
114142
* List.
115143
*

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

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111

1212
import java.io.IOException;
1313
import java.time.Duration;
14+
import java.time.Instant;
1415
import java.util.ArrayList;
16+
import java.util.Date;
1517
import java.util.List;
1618
import java.util.Optional;
1719
import java.util.Scanner;
@@ -232,6 +234,75 @@ public void testSearchOnBranch() throws IOException {
232234
assertThat(workflowRun.getConclusion(), equalTo(Conclusion.SUCCESS));
233235
}
234236

237+
/**
238+
* Test search on created and head sha.
239+
*
240+
* @throws IOException
241+
* Signals that an I/O exception has occurred.
242+
*/
243+
@Test
244+
public void testSearchOnCreatedAndHeadSha() throws IOException {
245+
GHWorkflow workflow = repo.getWorkflow(FAST_WORKFLOW_PATH);
246+
247+
long latestPreexistingWorkflowRunId = getLatestPreexistingWorkflowRunId();
248+
249+
Instant before = Instant.parse("2024-02-09T10:19:00.00Z");
250+
251+
String mainBranchHeadSha = repo.getBranch(MAIN_BRANCH).getSHA1();
252+
String secondBranchHeadSha = repo.getBranch(SECOND_BRANCH).getSHA1();
253+
254+
workflow.dispatch(MAIN_BRANCH);
255+
workflow.dispatch(SECOND_BRANCH);
256+
257+
await((nonRecordingRepo) -> getWorkflowRun(nonRecordingRepo,
258+
FAST_WORKFLOW_NAME,
259+
MAIN_BRANCH,
260+
Status.COMPLETED,
261+
latestPreexistingWorkflowRunId).isPresent());
262+
await((nonRecordingRepo) -> getWorkflowRun(nonRecordingRepo,
263+
FAST_WORKFLOW_NAME,
264+
SECOND_BRANCH,
265+
Status.COMPLETED,
266+
latestPreexistingWorkflowRunId).isPresent());
267+
268+
List<GHWorkflowRun> mainBranchHeadShaWorkflowRuns = repo.queryWorkflowRuns()
269+
.headSha(mainBranchHeadSha)
270+
.created(">=" + before.toString())
271+
.list()
272+
.toList();
273+
List<GHWorkflowRun> secondBranchHeadShaWorkflowRuns = repo.queryWorkflowRuns()
274+
.headSha(secondBranchHeadSha)
275+
.created(">=" + before.toString())
276+
.list()
277+
.toList();
278+
279+
assertThat(mainBranchHeadShaWorkflowRuns, hasSize(greaterThanOrEqualTo(1)));
280+
assertThat(mainBranchHeadShaWorkflowRuns, everyItem(hasProperty("headSha", equalTo(mainBranchHeadSha))));
281+
// Ideally, we would use everyItem() but the bridge method is in the way
282+
for (GHWorkflowRun workflowRun : mainBranchHeadShaWorkflowRuns) {
283+
assertThat(workflowRun.getCreatedAt(), greaterThanOrEqualTo(Date.from(before)));
284+
}
285+
286+
assertThat(secondBranchHeadShaWorkflowRuns, hasSize(greaterThanOrEqualTo(1)));
287+
assertThat(secondBranchHeadShaWorkflowRuns, everyItem(hasProperty("headSha", equalTo(secondBranchHeadSha))));
288+
// Ideally, we would use everyItem() but the bridge method is in the way
289+
for (GHWorkflowRun workflowRun : secondBranchHeadShaWorkflowRuns) {
290+
assertThat(workflowRun.getCreatedAt(), greaterThanOrEqualTo(Date.from(before)));
291+
}
292+
293+
List<GHWorkflowRun> mainBranchHeadShaWorkflowRunsBefore = repo.queryWorkflowRuns()
294+
.headSha(repo.getBranch(MAIN_BRANCH).getSHA1())
295+
.created("<" + before.toString())
296+
.list()
297+
.toList();
298+
// Ideally, we would use that but the bridge method is causing issues
299+
// assertThat(mainBranchHeadShaWorkflowRunsBefore, everyItem(hasProperty("createdAt",
300+
// lessThan(Date.from(before)))));
301+
for (GHWorkflowRun workflowRun : mainBranchHeadShaWorkflowRunsBefore) {
302+
assertThat(workflowRun.getCreatedAt(), lessThan(Date.from(before)));
303+
}
304+
}
305+
235306
/**
236307
* Test logs.
237308
*

‎src/test/resources/org/kohsuke/github/GHWorkflowRunTest/wiremock/testSearchOnCreatedAndHeadSha/__files/1-r_h_ghworkflowruntest.json‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
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": "2023-11-08T21:14:03Z",
69+
"pushed_at": "2023-11-08T21:53:11Z",
70+
"git_url": "git://github.com/hub4j-test-org/GHWorkflowRunTest.git",
71+
"ssh_url": "git@github.com: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": 12,
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+
"has_discussions": false,
85+
"forks_count": 1,
86+
"mirror_url": null,
87+
"archived": false,
88+
"disabled": false,
89+
"open_issues_count": 7,
90+
"license": null,
91+
"allow_forking": true,
92+
"is_template": false,
93+
"web_commit_signoff_required": false,
94+
"topics": [],
95+
"visibility": "public",
96+
"forks": 1,
97+
"open_issues": 7,
98+
"watchers": 0,
99+
"default_branch": "main",
100+
"permissions": {
101+
"admin": true,
102+
"maintain": true,
103+
"push": true,
104+
"triage": true,
105+
"pull": true
106+
},
107+
"temp_clone_token": "",
108+
"allow_squash_merge": true,
109+
"allow_merge_commit": true,
110+
"allow_rebase_merge": true,
111+
"allow_auto_merge": false,
112+
"delete_branch_on_merge": false,
113+
"allow_update_branch": false,
114+
"use_squash_pr_title_as_default": false,
115+
"squash_merge_commit_message": "COMMIT_MESSAGES",
116+
"squash_merge_commit_title": "COMMIT_OR_PR_TITLE",
117+
"merge_commit_message": "PR_TITLE",
118+
"merge_commit_title": "MERGE_MESSAGE",
119+
"custom_properties": {},
120+
"organization": {
121+
"login": "hub4j-test-org",
122+
"id": 7544739,
123+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
124+
"avatar_url": "https://avatars.githubusercontent.com/u/7544739?v=4",
125+
"gravatar_id": "",
126+
"url": "https://api.github.com/users/hub4j-test-org",
127+
"html_url": "https://github.com/hub4j-test-org",
128+
"followers_url": "https://api.github.com/users/hub4j-test-org/followers",
129+
"following_url": "https://api.github.com/users/hub4j-test-org/following{/other_user}",
130+
"gists_url": "https://api.github.com/users/hub4j-test-org/gists{/gist_id}",
131+
"starred_url": "https://api.github.com/users/hub4j-test-org/starred{/owner}{/repo}",
132+
"subscriptions_url": "https://api.github.com/users/hub4j-test-org/subscriptions",
133+
"organizations_url": "https://api.github.com/users/hub4j-test-org/orgs",
134+
"repos_url": "https://api.github.com/users/hub4j-test-org/repos",
135+
"events_url": "https://api.github.com/users/hub4j-test-org/events{/privacy}",
136+
"received_events_url": "https://api.github.com/users/hub4j-test-org/received_events",
137+
"type": "Organization",
138+
"site_admin": false
139+
},
140+
"security_and_analysis": {
141+
"secret_scanning": {
142+
"status": "disabled"
143+
},
144+
"secret_scanning_push_protection": {
145+
"status": "disabled"
146+
},
147+
"dependabot_security_updates": {
148+
"status": "disabled"
149+
},
150+
"secret_scanning_validity_checks": {
151+
"status": "disabled"
152+
}
153+
},
154+
"network_count": 1,
155+
"subscribers_count": 10
156+
}

‎src/test/resources/org/kohsuke/github/GHWorkflowRunTest/wiremock/testSearchOnCreatedAndHeadSha/__files/10-r_h_g_branches_main.json‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
{
2+
"name": "main",
3+
"commit": {
4+
"sha": "e8b2761bda453495d1ae25941b5b380b07deae52",
5+
"node_id": "C_kwDOFMhYrNoAKGU4YjI3NjFiZGE0NTM0OTVkMWFlMjU5NDFiNWIzODBiMDdkZWFlNTI",
6+
"commit": {
7+
"author": {
8+
"name": "Yasin Herken",
9+
"email": "57527891+yasin-herken@users.noreply.github.com",
10+
"date": "2023-11-08T21:53:11Z"
11+
},
12+
"committer": {
13+
"name": "GitHub",
14+
"email": "noreply@github.com",
15+
"date": "2023-11-08T21:53:11Z"
16+
},
17+
"message": "Update startup-failure-workflow.yml\n\nChanging workflow to get startup-failure",
18+
"tree": {
19+
"sha": "e67e0a5e6ffd0894c412d2aad46196c849c0803b",
20+
"url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/git/trees/e67e0a5e6ffd0894c412d2aad46196c849c0803b"
21+
},
22+
"url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/git/commits/e8b2761bda453495d1ae25941b5b380b07deae52",
23+
"comment_count": 0,
24+
"verification": {
25+
"verified": true,
26+
"reason": "valid",
27+
"signature": "-----BEGIN PGP SIGNATURE-----\n\nwsBcBAABCAAQBQJlTANHCRBK7hj4Ov3rIwAAk3sIAES3J69Uym48L0fZi1MFaErd\nUsFLU+OHvSzY7KQMreUiK9N5zvcj3NsnMEDxCJtMP5s4siyvqPHO8uIGcy/wqgYT\nBMiA/Uf8hNFNvCNtHleTkbZyAqcVdFn4LQ2ffHAWugc7xJwUnEmawXCaSJG+D+CA\nXjBEhi4xbq5YJKIt40cK7FnApn+YItauDzqJgyIxR+WwCM/KryvpUDWhpjzrT6Bs\npNXXmGTXjjkv5VEDyRUja8DjuXW/PNO16tWE0XMMy2lgnZjYCnwceTvmrujzM4bo\nFj3QDoYMQwp+ZXc87zNl2Hdj2rvAkqU1uXN6Hck1uCMvt4ObC5AIZ1bn15pGqKw=\n=Hokl\n-----END PGP SIGNATURE-----\n",
28+
"payload": "tree e67e0a5e6ffd0894c412d2aad46196c849c0803b\nparent 3c712d0b18d9313f69c0d96b9d0a6fd9421203d2\nauthor Yasin Herken <57527891+yasin-herken@users.noreply.github.com> 1699480391 +0300\ncommitter GitHub <noreply@github.com> 1699480391 +0300\n\nUpdate startup-failure-workflow.yml\n\nChanging workflow to get startup-failure"
29+
}
30+
},
31+
"url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/commits/e8b2761bda453495d1ae25941b5b380b07deae52",
32+
"html_url": "https://github.com/hub4j-test-org/GHWorkflowRunTest/commit/e8b2761bda453495d1ae25941b5b380b07deae52",
33+
"comments_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/commits/e8b2761bda453495d1ae25941b5b380b07deae52/comments",
34+
"author": {
35+
"login": "yasin-herken",
36+
"id": 57527891,
37+
"node_id": "MDQ6VXNlcjU3NTI3ODkx",
38+
"avatar_url": "https://avatars.githubusercontent.com/u/57527891?v=4",
39+
"gravatar_id": "",
40+
"url": "https://api.github.com/users/yasin-herken",
41+
"html_url": "https://github.com/yasin-herken",
42+
"followers_url": "https://api.github.com/users/yasin-herken/followers",
43+
"following_url": "https://api.github.com/users/yasin-herken/following{/other_user}",
44+
"gists_url": "https://api.github.com/users/yasin-herken/gists{/gist_id}",
45+
"starred_url": "https://api.github.com/users/yasin-herken/starred{/owner}{/repo}",
46+
"subscriptions_url": "https://api.github.com/users/yasin-herken/subscriptions",
47+
"organizations_url": "https://api.github.com/users/yasin-herken/orgs",
48+
"repos_url": "https://api.github.com/users/yasin-herken/repos",
49+
"events_url": "https://api.github.com/users/yasin-herken/events{/privacy}",
50+
"received_events_url": "https://api.github.com/users/yasin-herken/received_events",
51+
"type": "User",
52+
"site_admin": false
53+
},
54+
"committer": {
55+
"login": "web-flow",
56+
"id": 19864447,
57+
"node_id": "MDQ6VXNlcjE5ODY0NDQ3",
58+
"avatar_url": "https://avatars.githubusercontent.com/u/19864447?v=4",
59+
"gravatar_id": "",
60+
"url": "https://api.github.com/users/web-flow",
61+
"html_url": "https://github.com/web-flow",
62+
"followers_url": "https://api.github.com/users/web-flow/followers",
63+
"following_url": "https://api.github.com/users/web-flow/following{/other_user}",
64+
"gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}",
65+
"starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}",
66+
"subscriptions_url": "https://api.github.com/users/web-flow/subscriptions",
67+
"organizations_url": "https://api.github.com/users/web-flow/orgs",
68+
"repos_url": "https://api.github.com/users/web-flow/repos",
69+
"events_url": "https://api.github.com/users/web-flow/events{/privacy}",
70+
"received_events_url": "https://api.github.com/users/web-flow/received_events",
71+
"type": "User",
72+
"site_admin": false
73+
},
74+
"parents": [
75+
{
76+
"sha": "3c712d0b18d9313f69c0d96b9d0a6fd9421203d2",
77+
"url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/commits/3c712d0b18d9313f69c0d96b9d0a6fd9421203d2",
78+
"html_url": "https://github.com/hub4j-test-org/GHWorkflowRunTest/commit/3c712d0b18d9313f69c0d96b9d0a6fd9421203d2"
79+
}
80+
]
81+
},
82+
"_links": {
83+
"self": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/branches/main",
84+
"html": "https://github.com/hub4j-test-org/GHWorkflowRunTest/tree/main"
85+
},
86+
"protected": false,
87+
"protection": {
88+
"enabled": false,
89+
"required_status_checks": {
90+
"enforcement_level": "off",
91+
"contexts": [],
92+
"checks": []
93+
}
94+
},
95+
"protection_url": "https://api.github.com/repos/hub4j-test-org/GHWorkflowRunTest/branches/main/protection"
96+
}

0 commit comments

Comments
 (0)