Skip to content

Commit 8d6964d

Browse files
jeetchoudharyjeetchoudhary
committed
Added unit tests
1 parent 86cb8f8 commit 8d6964d

File tree

6 files changed

+389
-0
lines changed

6 files changed

+389
-0
lines changed

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

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,4 +307,72 @@ public void onError(IOException e, HttpURLConnection uc) throws IOException {
307307
assertThat(mockGitHub.getRequestCount(), equalTo(4));
308308
}
309309

310+
/**
311+
* Tests the behavior of the GitHub API client when the abuse limit handler is set to WAIT then the handler waits
312+
* appropriately when secondary rate limits are encountered.
313+
*
314+
* @throws Exception
315+
* if any error occurs during the test execution.
316+
*/
317+
@Test
318+
public void testHandler_Wait_Secondary_Limits() throws Exception {
319+
// Customized response that templates the date to keep things working
320+
snapshotNotAllowed();
321+
final HttpURLConnection[] savedConnection = new HttpURLConnection[1];
322+
gitHub = getGitHubBuilder().withEndpoint(mockGitHub.apiServer().baseUrl())
323+
.withAbuseLimitHandler(new AbuseLimitHandler() {
324+
/**
325+
* Overriding method because the actual method will wait for one minute causing slowness in unit
326+
* tests
327+
*/
328+
@Override
329+
public void onError(IOException e, HttpURLConnection uc) throws IOException {
330+
savedConnection[0] = uc;
331+
// Verify
332+
assertThat(uc.getDate(), Matchers.greaterThanOrEqualTo(new Date().getTime() - 10000));
333+
assertThat(uc.getExpiration(), equalTo(0L));
334+
assertThat(uc.getIfModifiedSince(), equalTo(0L));
335+
assertThat(uc.getLastModified(), equalTo(1581014017000L));
336+
assertThat(uc.getRequestMethod(), equalTo("GET"));
337+
assertThat(uc.getResponseCode(), equalTo(403));
338+
assertThat(uc.getResponseMessage(), containsString("Forbidden"));
339+
assertThat(uc.getURL().toString(),
340+
endsWith("/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits"));
341+
assertThat(uc.getHeaderFieldInt("X-RateLimit-Limit", 10), equalTo(5000));
342+
assertThat(uc.getHeaderFieldInt("X-RateLimit-Remaining", 10), equalTo(4000));
343+
assertThat(uc.getHeaderFieldInt("X-Foo", 20), equalTo(20));
344+
assertThat(uc.getHeaderFieldLong("X-RateLimit-Limit", 15L), equalTo(5000L));
345+
assertThat(uc.getHeaderFieldLong("X-RateLimit-Remaining", 15L), equalTo(4000L));
346+
assertThat(uc.getHeaderFieldLong("X-Foo", 20L), equalTo(20L));
347+
assertThat(uc.getHeaderField("gh-limited-by"), equalTo("search-elapsed-time-shared-grouped"));
348+
assertThat(uc.getContentEncoding(), nullValue());
349+
assertThat(uc.getContentType(), equalTo("application/json; charset=utf-8"));
350+
assertThat(uc.getContentLength(), equalTo(-1));
351+
assertThat(uc.getHeaderFields(), instanceOf(Map.class));
352+
assertThat(uc.getHeaderFields().size(), Matchers.greaterThan(25));
353+
assertThat(uc.getHeaderField("Status"), equalTo("403 Forbidden"));
354+
355+
try (InputStream errorStream = uc.getErrorStream()) {
356+
assertThat(errorStream, notNullValue());
357+
String errorString = IOUtils.toString(errorStream, StandardCharsets.UTF_8);
358+
assertThat(errorString,
359+
containsString(
360+
"You have exceeded a secondary rate limit. Please wait a few minutes before you try again"));
361+
}
362+
AbuseLimitHandler.FAIL.onError(e, uc);
363+
}
364+
})
365+
.build();
366+
367+
gitHub.getMyself();
368+
assertThat(mockGitHub.getRequestCount(), equalTo(1));
369+
try {
370+
getTempRepository();
371+
fail();
372+
} catch (Exception e) {
373+
assertThat(e, instanceOf(HttpException.class));
374+
assertThat(e.getMessage(), equalTo("Abuse limit reached"));
375+
}
376+
assertThat(mockGitHub.getRequestCount(), equalTo(2));
377+
}
310378
}

‎src/test/resources/org/kohsuke/github/AbuseLimitHandlerTest/wiremock/testHandler_Wait_Secondary_Limits/__files/1-user.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"login": "bitwiseman",
3+
"id": 1958953,
4+
"node_id": "MDQ6VXNlcjE5NTg5NTM=",
5+
"avatar_url": "https://avatars3.githubusercontent.com/u/1958953?v=4",
6+
"gravatar_id": "",
7+
"url": "https://api.github.com/users/bitwiseman",
8+
"html_url": "https://github.com/bitwiseman",
9+
"followers_url": "https://api.github.com/users/bitwiseman/followers",
10+
"following_url": "https://api.github.com/users/bitwiseman/following{/other_user}",
11+
"gists_url": "https://api.github.com/users/bitwiseman/gists{/gist_id}",
12+
"starred_url": "https://api.github.com/users/bitwiseman/starred{/owner}{/repo}",
13+
"subscriptions_url": "https://api.github.com/users/bitwiseman/subscriptions",
14+
"organizations_url": "https://api.github.com/users/bitwiseman/orgs",
15+
"repos_url": "https://api.github.com/users/bitwiseman/repos",
16+
"events_url": "https://api.github.com/users/bitwiseman/events{/privacy}",
17+
"received_events_url": "https://api.github.com/users/bitwiseman/received_events",
18+
"type": "User",
19+
"site_admin": false,
20+
"name": "Liam Newman",
21+
"company": "Cloudbees, Inc.",
22+
"blog": "",
23+
"location": "Seattle, WA, USA",
24+
"email": "bitwiseman@gmail.com",
25+
"hireable": null,
26+
"bio": "https://twitter.com/bitwiseman",
27+
"public_repos": 181,
28+
"public_gists": 7,
29+
"followers": 146,
30+
"following": 9,
31+
"created_at": "2012-07-11T20:38:33Z",
32+
"updated_at": "2020-02-06T17:29:39Z",
33+
"private_gists": 8,
34+
"total_private_repos": 10,
35+
"owned_private_repos": 0,
36+
"disk_usage": 33697,
37+
"collaborators": 0,
38+
"two_factor_authentication": true,
39+
"plan": {
40+
"name": "free",
41+
"space": 976562499,
42+
"collaborators": 0,
43+
"private_repos": 10000
44+
}
45+
}

‎src/test/resources/org/kohsuke/github/AbuseLimitHandlerTest/wiremock/testHandler_Wait_Secondary_Limits/__files/3-r_h_t_fail.json

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
{
2+
"id": 238757196,
3+
"node_id": "MDEwOlJlcG9zaXRvcnkyMzg3NTcxOTY=",
4+
"name": "temp-testHandler_Wait_Secondary_Limits",
5+
"full_name": "hub4j-test-org/temp-testHandler_Wait_Secondary_Limits",
6+
"private": false,
7+
"owner": {
8+
"login": "hub4j-test-org",
9+
"id": 7544739,
10+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
11+
"avatar_url": "https://avatars3.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/temp-testHandler_Wait_Secondary_Limits",
28+
"description": "A test repository for testing the github-api project: temp-testHandler_Wait_Secondary_Limits",
29+
"fork": false,
30+
"url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits",
31+
"forks_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/forks",
32+
"keys_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/keys{/key_id}",
33+
"collaborators_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/collaborators{/collaborator}",
34+
"teams_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/teams",
35+
"hooks_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/hooks",
36+
"issue_events_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/issues/events{/number}",
37+
"events_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/events",
38+
"assignees_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/assignees{/user}",
39+
"branches_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/branches{/branch}",
40+
"tags_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/tags",
41+
"blobs_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/git/blobs{/sha}",
42+
"git_tags_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/git/tags{/sha}",
43+
"git_refs_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/git/refs{/sha}",
44+
"trees_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/git/trees{/sha}",
45+
"statuses_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/statuses/{sha}",
46+
"languages_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/languages",
47+
"stargazers_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/stargazers",
48+
"contributors_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/contributors",
49+
"subscribers_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/subscribers",
50+
"subscription_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/subscription",
51+
"commits_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/commits{/sha}",
52+
"git_commits_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/git/commits{/sha}",
53+
"comments_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/comments{/number}",
54+
"issue_comment_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/issues/comments{/number}",
55+
"contents_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/contents/{+path}",
56+
"compare_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/compare/{base}...{head}",
57+
"merges_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/merges",
58+
"archive_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/{archive_format}{/ref}",
59+
"downloads_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/downloads",
60+
"issues_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/issues{/number}",
61+
"pulls_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/pulls{/number}",
62+
"milestones_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/milestones{/number}",
63+
"notifications_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/notifications{?since,all,participating}",
64+
"labels_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/labels{/name}",
65+
"releases_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/releases{/id}",
66+
"deployments_url": "https://api.github.com/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits/deployments",
67+
"created_at": "2020-02-06T18:33:39Z",
68+
"updated_at": "2020-02-06T18:33:43Z",
69+
"pushed_at": "2020-02-06T18:33:41Z",
70+
"git_url": "git://github.com/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits.git",
71+
"ssh_url": "git@github.com:hub4j-test-org/temp-testHandler_Wait_Secondary_Limits.git",
72+
"clone_url": "https://github.com/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits.git",
73+
"svn_url": "https://github.com/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits",
74+
"homepage": "http://github-api.kohsuke.org/",
75+
"size": 0,
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": 0,
89+
"license": null,
90+
"forks": 0,
91+
"open_issues": 0,
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://avatars3.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": 6
126+
}

‎src/test/resources/org/kohsuke/github/AbuseLimitHandlerTest/wiremock/testHandler_Wait_Secondary_Limits/mappings/1-user.json

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"id": "a60baf84-5b5c-4f86-af3d-cab0d609c7b2",
3+
"name": "user",
4+
"request": {
5+
"url": "/user",
6+
"method": "GET",
7+
"headers": {
8+
"Accept": {
9+
"equalTo": "application/vnd.github.v3+json"
10+
}
11+
}
12+
},
13+
"response": {
14+
"status": 200,
15+
"bodyFileName": "1-user.json",
16+
"headers": {
17+
"Date": "{{now timezone='GMT' format='EEE, dd MMM yyyy HH:mm:ss z'}}",
18+
"Content-Type": "application/json; charset=utf-8",
19+
"Server": "GitHub.com",
20+
"Status": "200 OK",
21+
"X-RateLimit-Limit": "5000",
22+
"X-RateLimit-Remaining": "4930",
23+
"X-RateLimit-Reset": "{{now offset='3 seconds' format='unix'}}",
24+
"Cache-Control": "private, max-age=60, s-maxage=60",
25+
"Vary": [
26+
"Accept, Authorization, Cookie, X-GitHub-OTP",
27+
"Accept-Encoding"
28+
],
29+
"ETag": "W/\"1cb30f031c67c499473b3aad01c7f7a5\"",
30+
"Last-Modified": "Thu, 06 Feb 2020 17:29:39 GMT",
31+
"X-OAuth-Scopes": "admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete_repo, gist, notifications, repo, user, write:discussion",
32+
"X-Accepted-OAuth-Scopes": "",
33+
"X-GitHub-Media-Type": "unknown, github.v3",
34+
"Access-Control-Expose-Headers": "ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type",
35+
"Access-Control-Allow-Origin": "*",
36+
"Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
37+
"X-Frame-Options": "deny",
38+
"X-Content-Type-Options": "nosniff",
39+
"X-XSS-Protection": "1; mode=block",
40+
"Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin",
41+
"Content-Security-Policy": "default-src 'none'",
42+
"X-GitHub-Request-Id": "CC37:2605:3F884:4E941:5E3C5BFC"
43+
}
44+
},
45+
"uuid": "a60baf84-5b5c-4f86-af3d-cab0d609c7b2",
46+
"persistent": true,
47+
"insertionIndex": 1
48+
}

‎src/test/resources/org/kohsuke/github/AbuseLimitHandlerTest/wiremock/testHandler_Wait_Secondary_Limits/mappings/2-r_h_t_fail.json

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{
2+
"id": "79fb1092-8bf3-4274-bc8e-ca126c9d9261",
3+
"name": "repos_hub4j-test-org_temp-testHandler_Wait_Secondary_Limits",
4+
"request": {
5+
"url": "/repos/hub4j-test-org/temp-testHandler_Wait_Secondary_Limits",
6+
"method": "GET",
7+
"headers": {
8+
"Accept": {
9+
"equalTo": "application/vnd.github.v3+json"
10+
}
11+
}
12+
},
13+
"response": {
14+
"status": 403,
15+
"body": "{\"message\":\"You have exceeded a secondary rate limit. Please wait a few minutes before you try again\"}",
16+
"headers": {
17+
"Date": "{{now timezone='GMT' format='EEE, dd MMM yyyy HH:mm:ss z'}}",
18+
"Content-Type": "application/json; charset=utf-8",
19+
"Server": "GitHub.com",
20+
"Status": "403 Forbidden",
21+
"gh-limited-by": "search-elapsed-time-shared-grouped",
22+
"X-RateLimit-Limit": "5000",
23+
"X-RateLimit-Remaining": "4000",
24+
"X-RateLimit-Reset": "{{testStartDate offset='3 seconds' format='unix'}}",
25+
"Cache-Control": "private, max-age=60, s-maxage=60",
26+
"Vary": [
27+
"Accept, Authorization, Cookie, X-GitHub-OTP",
28+
"Accept-Encoding"
29+
],
30+
"ETag": "W/\"7ff3c96399f7ddf6129622d675ca9935\"",
31+
"Last-Modified": "Thu, 06 Feb 2020 18:33:37 GMT",
32+
"X-OAuth-Scopes": "admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete_repo, gist, notifications, repo, user, write:discussion",
33+
"X-Accepted-OAuth-Scopes": "repo",
34+
"X-GitHub-Media-Type": "unknown, github.v3",
35+
"Access-Control-Expose-Headers": "ETag, Link, Location, gh-limited-by, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type",
36+
"Access-Control-Allow-Origin": "*",
37+
"Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
38+
"X-Frame-Options": "deny",
39+
"X-Content-Type-Options": "nosniff",
40+
"X-XSS-Protection": "1; mode=block",
41+
"Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin",
42+
"Content-Security-Policy": "default-src 'none'",
43+
"X-GitHub-Request-Id": "CC37:2605:3F982:4E949:5E3C5BFC"
44+
}
45+
},
46+
"uuid": "79fb1092-8bf3-4274-bc8e-ca126c9d9261",
47+
"persistent": true,
48+
"scenarioName": "scenario-1-repos-hub4j-test-org-temp-testHandler_Wait_Secondary_Limits",
49+
"requiredScenarioState": "Started",
50+
"newScenarioState": "scenario-1-repos-hub4j-test-org-temp-testHandler_Wait_Secondary_Limits-2",
51+
"insertionIndex": 2
52+
}

0 commit comments

Comments
 (0)