1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/*
* SonarQube
* Copyright (C) 2009-2025 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.alm.client;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import java.util.List;
import java.util.Optional;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.kohsuke.github.GHRateLimit;
import org.mockito.ArgumentCaptor;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;
import org.slf4j.event.Level;
import org.sonar.api.testfixtures.log.LogTester;
import org.sonar.auth.github.security.AccessToken;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.assertj.core.api.Assertions.assertThatNoException;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyLong;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.sonar.alm.client.ApplicationHttpClient.GetResponse;
@RunWith(MockitoJUnitRunner.class)
public class GenericPaginatedHttpClientImplTest {
private static final String APP_URL = "https://github.com/";
private static final String ENDPOINT = "/test-endpoint";
private static final TypeToken<List<String>> STRING_LIST_TYPE = new TypeToken<>() {
};
private Gson gson = new Gson();
@Rule
public LogTester logTester = new LogTester();
@Mock
private AccessToken accessToken;
@Mock
RatioBasedRateLimitChecker rateLimitChecker;
@Mock
ApplicationHttpClient appHttpClient;
@InjectMocks
private TestPaginatedHttpClient underTest;
private static class TestPaginatedHttpClient extends GenericPaginatedHttpClient {
protected TestPaginatedHttpClient(ApplicationHttpClient appHttpClient, RatioBasedRateLimitChecker rateLimitChecker) {
super(appHttpClient, rateLimitChecker);
}
}
@Test
public void get_whenNoPagination_ReturnsCorrectResponse() throws IOException {
GetResponse response = mockResponseWithoutPagination("[\"result1\", \"result2\"]");
when(appHttpClient.get(APP_URL, accessToken, ENDPOINT + "?per_page=100")).thenReturn(response);
List<String> results = underTest.get(APP_URL, accessToken, ENDPOINT, result -> gson.fromJson(result, STRING_LIST_TYPE));
assertThat(results)
.containsExactly("result1", "result2");
}
@Test
public void get_whenEndpointAlreadyContainsPathParameter_shouldAddANewParameter() throws IOException {
ArgumentCaptor<String> urlCaptor = ArgumentCaptor.forClass(String.class);
GetResponse response = mockResponseWithoutPagination("[\"result1\", \"result2\"]");
when(appHttpClient.get(eq(APP_URL), eq(accessToken), urlCaptor.capture())).thenReturn(response);
underTest.get(APP_URL, accessToken, ENDPOINT + "?alreadyExistingArg=2", result -> gson.fromJson(result, STRING_LIST_TYPE));
assertThat(urlCaptor.getValue()).isEqualTo(ENDPOINT + "?alreadyExistingArg=2&per_page=100");
}
private static GetResponse mockResponseWithoutPagination(String content) {
GetResponse response = mock(GetResponse.class);
when(response.getCode()).thenReturn(200);
when(response.getContent()).thenReturn(Optional.of(content));
return response;
}
@Test
public void get_whenPaginationAndRateLimiting_returnsResponseFromAllPages() throws IOException, InterruptedException {
GetResponse response1 = mockResponseWithPaginationAndRateLimit("[\"result1\", \"result2\"]", "/next-endpoint");
GetResponse response2 = mockResponseWithoutPagination("[\"result3\"]");
when(appHttpClient.get(APP_URL, accessToken, ENDPOINT + "?per_page=100")).thenReturn(response1);
when(appHttpClient.get(APP_URL, accessToken, "/next-endpoint")).thenReturn(response2);
List<String> results = underTest.get(APP_URL, accessToken, ENDPOINT, result -> gson.fromJson(result, STRING_LIST_TYPE));
assertThat(results)
.containsExactly("result1", "result2", "result3");
ArgumentCaptor<GHRateLimit.Record> rateLimitRecordCaptor = ArgumentCaptor.forClass(GHRateLimit.Record.class);
verify(rateLimitChecker).checkRateLimit(rateLimitRecordCaptor.capture(), anyLong());
GHRateLimit.Record rateLimitRecord = rateLimitRecordCaptor.getValue();
assertThat(rateLimitRecord.getLimit()).isEqualTo(10);
assertThat(rateLimitRecord.getRemaining()).isEqualTo(1);
assertThat(rateLimitRecord.getResetEpochSeconds()).isZero();
}
private static GetResponse mockResponseWithPaginationAndRateLimit(String content, String nextEndpoint) {
GetResponse response = mockResponseWithoutPagination(content);
when(response.getCode()).thenReturn(200);
when(response.getNextEndPoint()).thenReturn(Optional.of(nextEndpoint));
when(response.getRateLimit()).thenReturn(new ApplicationHttpClient.RateLimit(1, 10, 0L));
return response;
}
@Test
public void get_whenGitHubReturnsNonSuccessCode_shouldThrow() throws IOException {
GetResponse response1 = mockResponseWithPaginationAndRateLimit("[\"result1\", \"result2\"]", "/next-endpoint");
GetResponse response2 = mockFailedResponse("failed");
when(appHttpClient.get(APP_URL, accessToken, ENDPOINT + "?per_page=100")).thenReturn(response1);
when(appHttpClient.get(APP_URL, accessToken, "/next-endpoint")).thenReturn(response2);
assertThatIllegalStateException()
.isThrownBy(() -> underTest.get(APP_URL, accessToken, ENDPOINT, result -> gson.fromJson(result, STRING_LIST_TYPE)))
.withMessage("SonarQube was not able to retrieve resources from external system. Error while executing a paginated call to https://github.com/, endpoint:/next-endpoint. "
+ "Error while executing a call to https://github.com/. Return code 400. Error message: failed.");
}
private static GetResponse mockFailedResponse(String content) {
GetResponse response = mock(GetResponse.class);
when(response.getCode()).thenReturn(400);
when(response.getContent()).thenReturn(Optional.of(content));
return response;
}
@Test
public void getRepositoryTeams_whenRateLimitCheckerThrowsInterruptedException_shouldSucceed() throws IOException, InterruptedException {
GetResponse response1 = mockResponseWithPaginationAndRateLimit("[\"result1\", \"result2\"]", "/next-endpoint");
GetResponse response2 = mockResponseWithoutPagination("[\"result3\"]");
when(appHttpClient.get(APP_URL, accessToken, ENDPOINT + "?per_page=100")).thenReturn(response1);
when(appHttpClient.get(APP_URL, accessToken, "/next-endpoint")).thenReturn(response2);
doThrow(new InterruptedException("interrupted")).when(rateLimitChecker).checkRateLimit(any(GHRateLimit.Record.class), anyLong());
assertThatNoException()
.isThrownBy(() -> underTest.get(APP_URL, accessToken, ENDPOINT, result -> gson.fromJson(result, STRING_LIST_TYPE)));
assertThat(logTester.logs()).hasSize(1);
assertThat(logTester.logs(Level.WARN))
.containsExactly("Thread interrupted: interrupted");
}
@Test
public void getRepositoryCollaborators_whenDevOpsPlatformCallThrowsIOException_shouldLogAndReThrow() throws IOException {
AccessToken accessToken = mock();
when(appHttpClient.get(APP_URL, accessToken, "query?per_page=100")).thenThrow(new IOException("error"));
assertThatIllegalStateException()
.isThrownBy(() -> underTest.get(APP_URL, accessToken, "query", mock()))
.isInstanceOf(IllegalStateException.class)
.withMessage("SonarQube was not able to retrieve resources from external system. Error while executing a paginated call to https://github.com/, "
+ "endpoint:query?per_page=100. error");
assertThat(logTester.logs()).hasSize(1);
assertThat(logTester.logs(Level.WARN))
.containsExactly("SonarQube was not able to retrieve resources from external system. "
+ "Error while executing a paginated call to https://github.com/, endpoint:query?per_page=100.");
}
}
|
