Skip to content

Commit 59b5914

Browse files
JacksonTianyndu13
JacksonTian
authored and
yndu13
committed
improve the error messages
1 parent 8742514 commit 59b5914

File tree

6 files changed

+63
-31
lines changed

6 files changed

+63
-31
lines changed

‎aliyun-java-sdk-core/src/main/java/com/aliyuncs/endpoint/ChainedEndpointResolver.java

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,12 @@ private void checkProductCode(ResolveEndpointRequest request) throws ClientExcep
2424
}
2525

2626
if (!productCodeValid) {
27+
String fmt = "No endpoint for product '%s'.\n" +
28+
"Please check the product code, or set an endpoint for your request explicitly.\n" +
29+
"See https://api.alibabacloud.com/product/%s\n";
30+
2731
throw new ClientException(ErrorCodeConstant.SDK_ENDPOINT_RESOLVING_ERROR,
28-
String.format(ErrorMessageConstant.ENDPOINT_NO_PRODUCT, request.productCode));
32+
String.format(fmt, request.productCode, request.productCode));
2933
}
3034
}
3135

@@ -70,9 +74,16 @@ public String resolve(ResolveEndpointRequest request) throws ClientException {
7074

7175
checkProductCode(request);
7276
checkRegionId(request);
73-
74-
throw new ClientException(ErrorCodeConstant.SDK_ENDPOINT_RESOLVING_ERROR,
75-
String.format(ErrorMessageConstant.ENDPOINT_NO_REGION, request.regionId, request.productCode,
76-
getAvailableRegionsHint(request.productCode)));
77+
String fmt = "No endpoint in the region '%s' for product '%s'.\n" +
78+
"You can set an endpoint for your request explicitly.%s\n" +
79+
"See https://api.alibabacloud.com/product/%s";
80+
String message = String.format(
81+
fmt,
82+
request.regionId,
83+
request.productCode,
84+
getAvailableRegionsHint(request.productCode),
85+
request.productCode
86+
);
87+
throw new ClientException(ErrorCodeConstant.SDK_ENDPOINT_RESOLVING_ERROR, message);
7788
}
7889
}

‎aliyun-java-sdk-core/src/main/java/com/aliyuncs/exceptions/ErrorMessageConstant.java

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,8 @@
2020
package com.aliyuncs.exceptions;
2121

2222
public class ErrorMessageConstant {
23-
24-
public static final String SDK_ENDPOINT_MANAGEMENT_DOC_HTML =
25-
"https://www.alibabacloud.com/help/zh/doc-detail/92049.htm";
26-
2723
public static final String INVALID_REGION_ID =
2824
"No such region '%s'. Please check your region ID.";
29-
public static final String ENDPOINT_NO_REGION =
30-
"No endpoint in the region '%s' for product '%s'. \n" +
31-
"You can set an endpoint for your request explicitly.%s\n" +
32-
"See " + SDK_ENDPOINT_MANAGEMENT_DOC_HTML + "\n";
33-
34-
/**
35-
* Or use available regions:
36-
*/
37-
public static final String ENDPOINT_NO_PRODUCT =
38-
"No endpoint for product '%s'. \n" +
39-
"Please check the product code, or set an endpoint for your request explicitly.\n" +
40-
"See " + SDK_ENDPOINT_MANAGEMENT_DOC_HTML + "\n";
41-
4225
public static final String SERVER_RESPONSE_HTTP_BODY_EMPTY =
4326
"Failed to parse the response. The request was succeeded, but the server returned an empty HTTP body.";
4427
}

‎aliyun-java-sdk-core/src/test/java/com/aliyuncs/endpoint/DefaultEndpointResolverTest.java

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22

33
import static org.junit.Assert.*;
44
import static org.mockito.Mockito.*;
5+
6+
import org.junit.Assert;
57
import org.junit.Test;
68

79
import com.aliyuncs.profile.DefaultProfile;
810
import com.aliyuncs.DefaultAcsClient;
911
import com.aliyuncs.exceptions.ClientException;
12+
import org.junit.function.ThrowingRunnable;
1013

1114
public class DefaultEndpointResolverTest {
1215
@Test
@@ -50,4 +53,25 @@ public void testConstructor() throws ClientException {
5053
assertEquals("cloudapi-vpc.test.aliyuncs.com", resolver.resolve(request));
5154
}
5255

56+
@Test
57+
public void testConstructorWithCustomLocationService() throws ClientException {
58+
DefaultAcsClient client = mock(DefaultAcsClient.class);
59+
DefaultProfile profile = DefaultProfile.getProfile();
60+
profile.setLocationServiceEndpoint("location-readonly.aliyuncs.com");
61+
profile.setLocationServiceApiVersion("2015-12-25");
62+
final DefaultEndpointResolver resolver = new DefaultEndpointResolver(
63+
client, "{}", profile);
64+
65+
final ResolveEndpointRequest request = new ResolveEndpointRequest("test", "cloudapi", null, null);
66+
ClientException ex = Assert.assertThrows(ClientException.class, new ThrowingRunnable() {
67+
@Override
68+
public void run() throws Throwable {
69+
resolver.resolve(request);
70+
}
71+
});
72+
Assert.assertEquals("SDK.EndpointResolvingError : No endpoint in the region 'test' for product 'cloudapi'.\n" +
73+
"You can set an endpoint for your request explicitly.\n" +
74+
"Or you can use the other available regions: cn-shenzhen cn-beijing ap-south-1 eu-west-1 ap-northeast-1 me-east-1 cn-qingdao cn-shanghai cn-hongkong ap-southeast-1 ap-southeast-2 ap-southeast-3 eu-central-1 cn-huhehaote ap-southeast-5 us-east-1 us-west-1 cn-zhangjiakou cn-hangzhou\n" +
75+
"See https://api.alibabacloud.com/product/cloudapi", ex.getMessage());
76+
}
5377
}

‎aliyun-java-sdk-core/src/test/java/com/aliyuncs/exceptions/ClientExceptionTest.java

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,20 @@
33
import org.junit.Assert;
44
import org.junit.Test;
55

6+
import java.util.HashMap;
7+
import java.util.Map;
8+
69
public class ClientExceptionTest {
10+
11+
@Test
12+
public void constructorTest0() {
13+
Map<String, Object> detail = new HashMap<String, Object>();
14+
ClientException ex = new ClientException("code", "message", "requestid", "description", detail);
15+
Assert.assertSame(detail, ex.getAccessDeniedDetail());
16+
ClientException ex4 = new ClientException("code", "message", new Exception("cause"));
17+
Assert.assertEquals(ErrorType.Client, ex4.getErrorType());
18+
}
19+
720
@Test
821
public void constructorTest() {
922
ClientException ex = new ClientException("client exception message");

‎aliyun-java-sdk-core/src/test/java/com/aliyuncs/http/clients/ApacheHttpClientTest.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -544,6 +544,7 @@ public void testCreateSSLSocketFactoryWithManagers() throws Exception {
544544
}
545545

546546
@Test
547+
@Ignore
547548
public void testThrowSSLHandshakeException() throws ClientException, IOException {
548549
thrown.expect(SSLHandshakeException.class);
549550
HttpClientConfig clientConfig = HttpClientConfig.getDefault();

‎java-sdk-function-test/src/test/java/com/aliyuncs/NewEndpointTest.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -195,9 +195,9 @@ public void testLocationServiceMiss() throws ClientException {
195195
Assert.fail();
196196
} catch (ClientException e) {
197197
Assert.assertEquals(ErrorCodeConstant.SDK_ENDPOINT_RESOLVING_ERROR, e.getErrCode());
198-
Assert.assertEquals("No endpoint in the region 'mars' for product 'Ram'. \n" +
198+
Assert.assertEquals("No endpoint in the region 'mars' for product 'Ram'.\n" +
199199
"You can set an endpoint for your request explicitly.\n" +
200-
"See https://www.alibabacloud.com/help/zh/doc-detail/92049.htm\n", e.getErrMsg());
200+
"See https://api.alibabacloud.com/product/Ram", e.getErrMsg());
201201
}
202202
}
203203
// Bad region ID with another product
@@ -206,10 +206,10 @@ public void testLocationServiceMiss() throws ClientException {
206206
Assert.fail();
207207
} catch (ClientException e) {
208208
Assert.assertEquals(ErrorCodeConstant.SDK_ENDPOINT_RESOLVING_ERROR, e.getErrCode());
209-
Assert.assertEquals("No endpoint in the region 'mars' for product 'Ecs'. \n" +
209+
Assert.assertEquals("No endpoint in the region 'mars' for product 'Ecs'.\n" +
210210
"You can set an endpoint for your request explicitly.\n" +
211211
"Or you can use the other available regions: cn-shenzhen cn-beijing ap-south-1 eu-west-1 ap-northeast-1 me-east-1 cn-qingdao cn-shanghai cn-hongkong ap-southeast-1 ap-southeast-2 ap-southeast-3 eu-central-1 cn-huhehaote ap-southeast-5 us-east-1 cn-zhangjiakou us-west-1 cn-hangzhou\n" +
212-
"See https://www.alibabacloud.com/help/zh/doc-detail/92049.htm\n", e.getErrMsg());
212+
"See https://api.alibabacloud.com/product/Ecs", e.getErrMsg());
213213
}
214214
Assert.assertEquals(3, locationServiceEndpointResolver.locationServiceCallCounter);
215215

@@ -220,7 +220,7 @@ public void testLocationServiceMiss() throws ClientException {
220220
Assert.fail();
221221
} catch (ClientException e) {
222222
Assert.assertEquals(ErrorCodeConstant.SDK_ENDPOINT_RESOLVING_ERROR, e.getErrCode());
223-
Assert.assertTrue(e.getErrMsg().startsWith("" + "No endpoint for product 'InvalidProductCode'. \n"
223+
Assert.assertTrue(e.getErrMsg().startsWith("No endpoint for product 'InvalidProductCode'.\n"
224224
+ "Please check the product code, or set an endpoint for your request explicitly.\n"));
225225
}
226226
}
@@ -230,7 +230,7 @@ public void testLocationServiceMiss() throws ClientException {
230230
Assert.fail();
231231
} catch (ClientException e) {
232232
Assert.assertEquals(ErrorCodeConstant.SDK_ENDPOINT_RESOLVING_ERROR, e.getErrCode());
233-
Assert.assertTrue(e.getErrMsg().startsWith("" + "No endpoint for product 'InvalidProductCode'. \n"
233+
Assert.assertTrue(e.getErrMsg().startsWith("No endpoint for product 'InvalidProductCode'.\n"
234234
+ "Please check the product code, or set an endpoint for your request explicitly.\n"));
235235
}
236236
Assert.assertEquals(4, locationServiceEndpointResolver.locationServiceCallCounter);
@@ -244,10 +244,10 @@ public void testTryToGetEndpointWithInvalidRegionId() {
244244
Assert.fail();
245245
} catch (ClientException e) {
246246
Assert.assertEquals(ErrorCodeConstant.SDK_ENDPOINT_RESOLVING_ERROR, e.getErrCode());
247-
Assert.assertEquals("No endpoint in the region 'mars' for product 'Ecs'. \n" +
247+
Assert.assertEquals("No endpoint in the region 'mars' for product 'Ecs'.\n" +
248248
"You can set an endpoint for your request explicitly.\n" +
249249
"Or you can use the other available regions: cn-shenzhen cn-beijing ap-south-1 eu-west-1 ap-northeast-1 me-east-1 cn-qingdao cn-shanghai cn-hongkong ap-southeast-1 ap-southeast-2 ap-southeast-3 eu-central-1 cn-huhehaote ap-southeast-5 us-east-1 cn-zhangjiakou us-west-1 cn-hangzhou\n" +
250-
"See https://www.alibabacloud.com/help/zh/doc-detail/92049.htm\n", e.getErrMsg());
250+
"See https://api.alibabacloud.com/product/Ecs", e.getErrMsg());
251251
}
252252
}
253253

@@ -260,7 +260,7 @@ public void testTryToGetEndpointWithInvalidProductCode() {
260260
} catch (ClientException e) {
261261
Assert.assertEquals(ErrorCodeConstant.SDK_ENDPOINT_RESOLVING_ERROR, e.getErrCode());
262262
System.out.println(e.getErrMsg());
263-
Assert.assertTrue(e.getErrMsg().startsWith("" + "No endpoint for product 'InvalidProductCode'. \n"
263+
Assert.assertTrue(e.getErrMsg().startsWith("No endpoint for product 'InvalidProductCode'.\n"
264264
+ "Please check the product code, or set an endpoint for your request explicitly.\n"));
265265
}
266266
}

0 commit comments

Comments
 (0)