/*
* Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://aws.amazon.com/apache2.0
*
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
* OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and
* limitations under the License.
*/
package com.amazonaws.retry;
import com.amazonaws.AmazonClientException;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.ClientConfiguration;
import com.amazonaws.http.AmazonHttpClient;
import com.amazonaws.http.ExecutionContext;
import com.amazonaws.util.AWSRequestMetrics;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import java.util.Random;
/**
* Tests the behavior when both
* {@link ClientConfiguration#setMaxErrorRetry(int)} and
* {@link ClientConfiguration#setRetryPolicy(RetryPolicy)} are used.
*/
public class ClientConfigurationMaxErrorRetryTest extends RetryPolicyTestBase {
private static final Random random = new Random();
@Before
public void resetClientConfiguration() {
clientConfiguration = new ClientConfiguration();
testedClient = new AmazonHttpClient(clientConfiguration);
injectMockHttpClient(testedClient, new ReturnServiceErrorHttpClient(500,
"fake 500 service error"));
}
/**
* -- No explicit calls on ClientConfiguration#setMaxErrorRetry(int); --
* Default RetryPolicy's.
*/
@Test
public void testDefaultMaxErrorRetry() {
/* SDK default */
Assert.assertTrue(clientConfiguration.getRetryPolicy() == PredefinedRetryPolicies.DEFAULT);
// Don't change any of the default settings in ClientConfiguration
testActualRetries(PredefinedRetryPolicies.DEFAULT_MAX_ERROR_RETRY);
/* DynamoDB default */
// Change to dynamodb default policy.
clientConfiguration.setRetryPolicy(PredefinedRetryPolicies.DYNAMODB_DEFAULT);
testActualRetries(PredefinedRetryPolicies.DYNAMODB_DEFAULT_MAX_ERROR_RETRY);
}
/**
* -- Explicitly set maxErrorRetry in ClientConfiguration level; --
* Default/custom RetryPolicy's that don't override such setting.
*/
@Test
public void testClientConfigLevelMaxErrorRetry() {
int CLIENT_CONFIG_LEVEL_MAX_RETRY = random.nextInt(3);
clientConfiguration.setMaxErrorRetry(CLIENT_CONFIG_LEVEL_MAX_RETRY);
// SDK default policy should honor the ClientConfig level maxErrorRetry
testActualRetries(CLIENT_CONFIG_LEVEL_MAX_RETRY);
// DynamoDB default policy should also honor that
clientConfiguration.setRetryPolicy(PredefinedRetryPolicies.DYNAMODB_DEFAULT);
testActualRetries(CLIENT_CONFIG_LEVEL_MAX_RETRY);
// A custom policy that honors the ClientConfig level maxErrorRetry
clientConfiguration.setRetryPolicy(new RetryPolicy(null, null, 5, true));
testActualRetries(CLIENT_CONFIG_LEVEL_MAX_RETRY);
}
/**
* -- Explicitly set maxErrorRetry in ClientConfiguration level; -- Custom
* RetryPolicy's that want to override such setting.
*/
@Test
public void testRetryPolicyLevelMaxErrorRetry() {
// This should be ignored
clientConfiguration.setMaxErrorRetry(random.nextInt(3));
// A custom policy that doesn't honor the ClientConfig level
// maxErrorRetry
int RETRY_POLICY_LEVEL_MAX_ERROR_RETRY = 5;
clientConfiguration.setRetryPolicy(new RetryPolicy(null, null,
RETRY_POLICY_LEVEL_MAX_ERROR_RETRY, false));
testActualRetries(RETRY_POLICY_LEVEL_MAX_ERROR_RETRY);
// A custom policy that "honors" the ClientConfig level maxErrorRetry,
// but actually denies any retry in its condition.
clientConfiguration.setRetryPolicy(new RetryPolicy(
new RetryPolicy.RetryCondition() {
@Override
public boolean shouldRetry(
AmazonWebServiceRequest originalRequest,
AmazonClientException exception,
int retriesAttempted) {
return false;
}
}, null, RETRY_POLICY_LEVEL_MAX_ERROR_RETRY, true)
);
// No retry is expected
testActualRetries(0);
}
/**
* Verifies the request is actually retried for the expected times.
*/
private static void testActualRetries(int expectedRetryAttempts) {
// The ExecutionContext should collect the expected RequestCount
ExecutionContext context = new ExecutionContext(true);
try {
testedClient.execute(getSampleRequestWithRepeatableContent(originalRequest),
null,
errorResponseHandler,
context);
Assert.fail("AmazonServiceException is expected.");
} catch (AmazonServiceException ase) {
}
// Check the RequestCount metric equals the expected value.
Assert.assertEquals(
expectedRetryAttempts + 1, // request count = retries + 1
context.getAwsRequestMetrics()
.getTimingInfo()
.getCounter(AWSRequestMetrics.Field.RequestCount.toString()).intValue());
}
}