Skip to content

Commit e0c2a7e

Browse files
vinokurigvinokurig
committed
Rework the Bitbucket Server getUser request
1 parent f74ac9f commit e0c2a7e

File tree

5 files changed

+198
-46
lines changed

5 files changed

+198
-46
lines changed

‎wsmaster/che-core-api-factory-bitbucket-server/src/main/java/org/eclipse/che/api/factory/server/bitbucket/HttpBitbucketServerApiClient.java

+42-35
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2012-2024 Red Hat, Inc.
2+
* Copyright (c) 2012-2025 Red Hat, Inc.
33
* This program and the accompanying materials are made
44
* available under the terms of the Eclipse Public License 2.0
55
* which is available at https://www.eclipse.org/legal/epl-2.0/
@@ -48,6 +48,7 @@
4848
import org.eclipse.che.api.core.NotFoundException;
4949
import org.eclipse.che.api.core.ServerException;
5050
import org.eclipse.che.api.core.UnauthorizedException;
51+
import org.eclipse.che.api.factory.server.bitbucket.server.BitbucketApplicationProperties;
5152
import org.eclipse.che.api.factory.server.bitbucket.server.BitbucketPersonalAccessToken;
5253
import org.eclipse.che.api.factory.server.bitbucket.server.BitbucketServerApiClient;
5354
import org.eclipse.che.api.factory.server.bitbucket.server.BitbucketUser;
@@ -77,6 +78,8 @@ public class HttpBitbucketServerApiClient implements BitbucketServerApiClient {
7778

7879
private static final Logger LOG = LoggerFactory.getLogger(HttpBitbucketServerApiClient.class);
7980
private static final Duration DEFAULT_HTTP_TIMEOUT = ofSeconds(10);
81+
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
82+
public static final String USERNAME_HEADER = "x-ausername";
8083
private final URI serverUri;
8184
private final OAuthAuthenticator authenticator;
8285
private final OAuthAPI oAuthAPI;
@@ -166,10 +169,10 @@ public void deletePersonalAccessTokens(String tokenId)
166169
executeRequest(
167170
httpClient,
168171
request,
169-
inputStream -> {
172+
response -> {
170173
try {
171174
String result =
172-
CharStreams.toString(new InputStreamReader(inputStream, Charsets.UTF_8));
175+
CharStreams.toString(new InputStreamReader(response.body(), Charsets.UTF_8));
173176
return OM.readValue(result, String.class);
174177
} catch (IOException e) {
175178
throw new UncheckedIOException(e);
@@ -210,10 +213,10 @@ public BitbucketPersonalAccessToken createPersonalAccessTokens(
210213
return executeRequest(
211214
httpClient,
212215
request,
213-
inputStream -> {
216+
response -> {
214217
try {
215218
String result =
216-
CharStreams.toString(new InputStreamReader(inputStream, Charsets.UTF_8));
219+
CharStreams.toString(new InputStreamReader(response.body(), Charsets.UTF_8));
217220
return OM.readValue(result, BitbucketPersonalAccessToken.class);
218221
} catch (IOException e) {
219222
throw new UncheckedIOException(e);
@@ -262,10 +265,10 @@ public BitbucketPersonalAccessToken getPersonalAccessToken(String tokenId, Strin
262265
return executeRequest(
263266
httpClient,
264267
request,
265-
inputStream -> {
268+
response -> {
266269
try {
267270
String result =
268-
CharStreams.toString(new InputStreamReader(inputStream, Charsets.UTF_8));
271+
CharStreams.toString(new InputStreamReader(response.body(), Charsets.UTF_8));
269272
return OM.readValue(result, BitbucketPersonalAccessToken.class);
270273
} catch (IOException e) {
271274
throw new UncheckedIOException(e);
@@ -283,13 +286,7 @@ private String getUserSlug(Optional<String> token)
283286

284287
private BitbucketUser getUser(Optional<String> token)
285288
throws ScmCommunicationException, ScmUnauthorizedException, ScmItemNotFoundException {
286-
URI uri;
287-
try {
288-
uri = serverUri.resolve("./plugins/servlet/applinks/whoami");
289-
} catch (IllegalArgumentException e) {
290-
// if the slug contains invalid characters (space for example) then the URI will be invalid
291-
throw new ScmCommunicationException(e.getMessage(), e);
292-
}
289+
URI uri = serverUri.resolve("/rest/api/1.0/application-properties");
293290

294291
HttpRequest request =
295292
HttpRequest.newBuilder(uri)
@@ -301,29 +298,15 @@ private BitbucketUser getUser(Optional<String> token)
301298
.timeout(DEFAULT_HTTP_TIMEOUT)
302299
.build();
303300

304-
String username;
301+
HttpResponse<InputStream> response;
305302
try {
306303
LOG.trace("executeRequest={}", request);
307-
username =
308-
executeRequest(
309-
httpClient,
310-
request,
311-
inputStream -> {
312-
try {
313-
return CharStreams.toString(new InputStreamReader(inputStream, Charsets.UTF_8));
314-
} catch (IOException e) {
315-
throw new UncheckedIOException(e);
316-
}
317-
});
304+
response = executeRequest(httpClient, request, r -> r);
318305
} catch (ScmBadRequestException e) {
319306
throw new ScmCommunicationException(e.getMessage(), e);
320307
}
321308

322-
// Only authenticated users can do the request below, so we must ensure that the username is not
323-
// empty
324-
if (isNullOrEmpty(username)) {
325-
throw buildScmUnauthorizedException();
326-
}
309+
String username = getUsername(response);
327310

328311
try {
329312
List<BitbucketUser> users =
@@ -340,6 +323,28 @@ private BitbucketUser getUser(Optional<String> token)
340323
}
341324
}
342325

326+
private String getUsername(HttpResponse<InputStream> response)
327+
throws ScmCommunicationException, ScmUnauthorizedException {
328+
String username;
329+
try {
330+
// Try to get the username from the response header.
331+
if (response.headers().firstValue(USERNAME_HEADER).isPresent()) {
332+
username = response.headers().firstValue(USERNAME_HEADER).get();
333+
} else {
334+
String result =
335+
CharStreams.toString(new InputStreamReader(response.body(), Charsets.UTF_8));
336+
// Convert the response data the Bitbucket Server object.
337+
OBJECT_MAPPER.readValue(result, BitbucketApplicationProperties.class);
338+
// Throw the unauthorized exception if the response contains the Bitbucket info.
339+
throw buildScmUnauthorizedException();
340+
}
341+
} catch (IOException e) {
342+
// The response does not contain the Bitbucket Server info
343+
throw new ScmCommunicationException("Bad request");
344+
}
345+
return username;
346+
}
347+
343348
private <T> List<T> doGetItems(Optional<String> token, Class<T> tClass, String api, String filter)
344349
throws ScmUnauthorizedException, ScmCommunicationException, ScmBadRequestException,
345350
ScmItemNotFoundException {
@@ -377,10 +382,10 @@ private <T> Page<T> doGetPage(
377382
return executeRequest(
378383
httpClient,
379384
request,
380-
inputStream -> {
385+
response -> {
381386
try {
382387
String result =
383-
CharStreams.toString(new InputStreamReader(inputStream, Charsets.UTF_8));
388+
CharStreams.toString(new InputStreamReader(response.body(), Charsets.UTF_8));
384389
return OM.readValue(result, typeReference);
385390
} catch (IOException e) {
386391
throw new UncheckedIOException(e);
@@ -389,15 +394,17 @@ private <T> Page<T> doGetPage(
389394
}
390395

391396
private <T> T executeRequest(
392-
HttpClient httpClient, HttpRequest request, Function<InputStream, T> bodyConverter)
397+
HttpClient httpClient,
398+
HttpRequest request,
399+
Function<HttpResponse<InputStream>, T> bodyConverter)
393400
throws ScmBadRequestException, ScmItemNotFoundException, ScmCommunicationException,
394401
ScmUnauthorizedException {
395402
try {
396403
HttpResponse<InputStream> response =
397404
httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream());
398405
LOG.trace("executeRequest={} response {}", request, response.statusCode());
399406
if (response.statusCode() == 200) {
400-
return bodyConverter.apply(response.body());
407+
return bodyConverter.apply(response);
401408
} else if (response.statusCode() == 204) {
402409
return null;
403410
} else {

‎wsmaster/che-core-api-factory-bitbucket-server/src/main/java/org/eclipse/che/api/factory/server/bitbucket/server/BitbucketApplicationProperties.java

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
/*
2+
* Copyright (c) 2012-2025 Red Hat, Inc.
3+
* This program and the accompanying materials are made
4+
* available under the terms of the Eclipse Public License 2.0
5+
* which is available at https://www.eclipse.org/legal/epl-2.0/
6+
*
7+
* SPDX-License-Identifier: EPL-2.0
8+
*
9+
* Contributors:
10+
* Red Hat, Inc. - initial API and implementation
11+
*/
12+
package org.eclipse.che.api.factory.server.bitbucket.server;
13+
14+
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
15+
import java.util.Objects;
16+
17+
@JsonIgnoreProperties(ignoreUnknown = true)
18+
public class BitbucketApplicationProperties {
19+
20+
private String version;
21+
private long buildNumber;
22+
private long buildDate;
23+
private String displayName;
24+
25+
public BitbucketApplicationProperties() {}
26+
27+
public BitbucketApplicationProperties(
28+
String version, long buildNumber, long buildDate, String displayName) {
29+
this.version = version;
30+
this.buildNumber = buildNumber;
31+
this.buildDate = buildDate;
32+
this.displayName = displayName;
33+
}
34+
35+
public String getVersion() {
36+
return version;
37+
}
38+
39+
public long getBuildNumber() {
40+
return buildNumber;
41+
}
42+
43+
public long getBuildDate() {
44+
return buildDate;
45+
}
46+
47+
public String getDisplayName() {
48+
return displayName;
49+
}
50+
51+
@Override
52+
public String toString() {
53+
return "BitbucketApplicationProperties{"
54+
+ "version='"
55+
+ version
56+
+ '\''
57+
+ ", buildNumber="
58+
+ buildNumber
59+
+ ", buildDate="
60+
+ buildDate
61+
+ ", displayName='"
62+
+ displayName
63+
+ '\''
64+
+ '}';
65+
}
66+
67+
@Override
68+
public boolean equals(Object o) {
69+
if (o == null || getClass() != o.getClass()) {
70+
return false;
71+
}
72+
BitbucketApplicationProperties that = (BitbucketApplicationProperties) o;
73+
return buildNumber == that.buildNumber
74+
&& buildDate == that.buildDate
75+
&& Objects.equals(version, that.version)
76+
&& Objects.equals(displayName, that.displayName);
77+
}
78+
79+
@Override
80+
public int hashCode() {
81+
return Objects.hash(version, buildNumber, buildDate, displayName);
82+
}
83+
}

‎wsmaster/che-core-api-factory-bitbucket-server/src/test/java/org/eclipse/che/api/factory/server/bitbucket/BitbucketServerURLParserTest.java

+50-7
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,10 @@ public void shouldValidateUrlByApiRequest() {
117117
null, devfileFilenamesProvider, oAuthAPI, mock(PersonalAccessTokenManager.class));
118118
String url = wireMockServer.url("/users/user/repos/repo");
119119
stubFor(
120-
get(urlEqualTo("/plugins/servlet/applinks/whoami"))
121-
.willReturn(aResponse().withStatus(200)));
120+
get(urlEqualTo("/rest/api/1.0/application-properties"))
121+
.willReturn(
122+
aResponse()
123+
.withBodyFile("bitbucket/rest/api.1.0.application-properties/response.json")));
122124

123125
// when
124126
boolean result = bitbucketURLParser.isValid(url);
@@ -135,8 +137,46 @@ public void shouldValidateUrlByApiRequestButFailOnPatternCheck() {
135137
null, devfileFilenamesProvider, oAuthAPI, mock(PersonalAccessTokenManager.class));
136138
String url = wireMockServer.url("/user/repo");
137139
stubFor(
138-
get(urlEqualTo("/plugins/servlet/applinks/whoami"))
139-
.willReturn(aResponse().withStatus(200)));
140+
get(urlEqualTo("/rest/api/1.0/application-properties"))
141+
.willReturn(
142+
aResponse()
143+
.withBodyFile("bitbucket/rest/api.1.0.application-properties/response.json")));
144+
145+
// when
146+
boolean result = bitbucketURLParser.isValid(url);
147+
148+
// then
149+
assertFalse(result);
150+
}
151+
152+
@Test
153+
public void shouldNotValidateUrlByApiRequestWithBadRequest() {
154+
// given
155+
bitbucketURLParser =
156+
new BitbucketServerURLParser(
157+
null, devfileFilenamesProvider, oAuthAPI, mock(PersonalAccessTokenManager.class));
158+
String url = wireMockServer.url("/users/user/repos/repo");
159+
stubFor(
160+
get(urlEqualTo("/rest/api/1.0/application-properties"))
161+
.willReturn(aResponse().withStatus(400)));
162+
163+
// when
164+
boolean result = bitbucketURLParser.isValid(url);
165+
166+
// then
167+
assertFalse(result);
168+
}
169+
170+
@Test
171+
public void shouldNotValidateUrlByApiRequestWithEmptyData() {
172+
// given
173+
bitbucketURLParser =
174+
new BitbucketServerURLParser(
175+
null, devfileFilenamesProvider, oAuthAPI, mock(PersonalAccessTokenManager.class));
176+
String url = wireMockServer.url("/users/user/repos/repo");
177+
stubFor(
178+
get(urlEqualTo("/rest/api/1.0/application-properties"))
179+
.willReturn(aResponse().withBody("")));
140180

141181
// when
142182
boolean result = bitbucketURLParser.isValid(url);
@@ -146,12 +186,15 @@ public void shouldValidateUrlByApiRequestButFailOnPatternCheck() {
146186
}
147187

148188
@Test
149-
public void shouldNotValidateUrlByApiRequest() {
189+
public void shouldNotValidateUrlByApiRequestWithEmptyHeader() {
150190
// given
191+
bitbucketURLParser =
192+
new BitbucketServerURLParser(
193+
null, devfileFilenamesProvider, oAuthAPI, mock(PersonalAccessTokenManager.class));
151194
String url = wireMockServer.url("/users/user/repos/repo");
152195
stubFor(
153-
get(urlEqualTo("/plugins/servlet/applinks/whoami"))
154-
.willReturn(aResponse().withStatus(500)));
196+
get(urlEqualTo("/rest/api/1.0/application-properties"))
197+
.willReturn(aResponse().withStatus(200)));
155198

156199
// when
157200
boolean result = bitbucketURLParser.isValid(url);

‎wsmaster/che-core-api-factory-bitbucket-server/src/test/java/org/eclipse/che/api/factory/server/bitbucket/HttpBitbucketServerApiClientTest.java

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2012-2024 Red Hat, Inc.
2+
* Copyright (c) 2012-2025 Red Hat, Inc.
33
* This program and the accompanying materials are made
44
* available under the terms of the Eclipse Public License 2.0
55
* which is available at https://www.eclipse.org/legal/epl-2.0/
@@ -102,8 +102,8 @@ public String computeAuthorizationHeader(
102102
oAuthAPI,
103103
apiEndpoint);
104104
stubFor(
105-
get(urlEqualTo("/plugins/servlet/applinks/whoami"))
106-
.willReturn(aResponse().withBody("ksmster")));
105+
get(urlEqualTo("/rest/api/1.0/application-properties"))
106+
.willReturn(aResponse().withHeader("x-ausername", "ksmster")));
107107
}
108108

109109
@AfterMethod
@@ -354,7 +354,20 @@ public void shouldBeAbleToThrowScmUnauthorizedExceptionOnGetUser()
354354
throws ScmCommunicationException, ScmUnauthorizedException, ScmItemNotFoundException {
355355
// given
356356
stubFor(
357-
get(urlEqualTo("/plugins/servlet/applinks/whoami")).willReturn(aResponse().withBody("")));
357+
get(urlEqualTo("/rest/api/1.0/application-properties"))
358+
.willReturn(
359+
aResponse()
360+
.withBodyFile("bitbucket/rest/api.1.0.application-properties/response.json")));
361+
362+
// when
363+
bitbucketServer.getUser();
364+
}
365+
366+
@Test(expectedExceptions = ScmCommunicationException.class)
367+
public void shouldBeAbleToThrowScmCommunicationExceptionOnGetUser()
368+
throws ScmCommunicationException, ScmUnauthorizedException, ScmItemNotFoundException {
369+
// given
370+
stubFor(get(urlEqualTo("/rest/api/1.0/application-properties")).willReturn(aResponse()));
358371

359372
// when
360373
bitbucketServer.getUser();

‎wsmaster/che-core-api-factory-bitbucket-server/src/test/resources/__files/bitbucket/rest/api.1.0.application-properties/response.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"version": "8.7.0",
3+
"buildNumber": 8007000,
4+
"buildDate": 1672975062662,
5+
"displayName": "Bitbucket"
6+
}

0 commit comments

Comments
 (0)