Skip to content

Add proxy methods to support invocation for inputstream/bytes #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 7, 2020
Merged

Add proxy methods to support invocation for inputstream/bytes #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
293cfb1
Add proxy methods to support invocation for inputstream/bytes
xiwhuang May 7, 2020
cf0f7cb
Scope s3 dependency to test as it is only for unit tests
xiwhuang May 7, 2020
648418b
Add two proxy methods in code-gen template
xiwhuang May 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,11 @@
<groupId>software.amazon.awssdk</groupId>
<artifactId>apache-client</artifactId>
</dependency>
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>s3</artifactId>
<scope>test</scope>
</dependency>

<!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
<dependency>
Expand Down
14 changes: 14 additions & 0 deletions python/rpdk/java/templates/init/guided_aws/AbstractTestBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
import software.amazon.awssdk.awscore.AwsRequest;
import software.amazon.awssdk.awscore.AwsResponse;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.ResponseBytes;
import software.amazon.awssdk.core.ResponseInputStream;
import software.amazon.awssdk.core.pagination.sync.SdkIterable;
import software.amazon.cloudformation.proxy.AmazonWebServicesClientProxy;
import software.amazon.cloudformation.proxy.Credentials;
Expand Down Expand Up @@ -43,6 +45,18 @@ static ProxyClient<SdkClient> MOCK_PROXY(
return proxy.injectCredentialsAndInvokeIterableV2(request, requestFunction);
}

@Override
public <RequestT extends AwsRequest, ResponseT extends AwsResponse> ResponseInputStream<ResponseT>
injectCredentialsAndInvokeV2InputStream(RequestT requestT, Function<RequestT, ResponseInputStream<ResponseT>> function) {
throw new UnsupportedOperationException();
}

@Override
public <RequestT extends AwsRequest, ResponseT extends AwsResponse> ResponseBytes<ResponseT>
injectCredentialsAndInvokeV2Bytes(RequestT requestT, Function<RequestT, ResponseBytes<ResponseT>> function) {
throw new UnsupportedOperationException();
}

@Override
public SdkClient client() {
return sdkClient;
Expand Down
56 changes: 56 additions & 0 deletions src/main/java/software/amazon/cloudformation/proxy/AmazonWebServicesClientProxy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@
import software.amazon.awssdk.awscore.AwsResponse;
import software.amazon.awssdk.awscore.exception.AwsErrorDetails;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.ResponseBytes;
import software.amazon.awssdk.core.ResponseInputStream;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.NonRetryableException;
import software.amazon.awssdk.core.exception.RetryableException;
Expand Down Expand Up @@ -124,6 +126,22 @@ public <ClientT> ProxyClient<ClientT> newProxy(@Nonnull Supplier<ClientT> client
return AmazonWebServicesClientProxy.this.injectCredentialsAndInvokeIterableV2(request, requestFunction);
}

@Override
public <RequestT extends AwsRequest, ResponseT extends AwsResponse>
ResponseInputStream<ResponseT>
injectCredentialsAndInvokeV2InputStream(RequestT request,
Function<RequestT, ResponseInputStream<ResponseT>> requestFunction) {
return AmazonWebServicesClientProxy.this.injectCredentialsAndInvokeV2InputStream(request, requestFunction);
}

@Override
public <RequestT extends AwsRequest, ResponseT extends AwsResponse>
ResponseBytes<ResponseT>
injectCredentialsAndInvokeV2Bytes(RequestT request,
Function<RequestT, ResponseBytes<ResponseT>> requestFunction) {
return AmazonWebServicesClientProxy.this.injectCredentialsAndInvokeV2Bytes(request, requestFunction);
}

@Override
public ClientT client() {
return client.get();
Expand Down Expand Up @@ -512,6 +530,44 @@ public final long getRemainingTimeInMillis() {
}
}

public <RequestT extends AwsRequest, ResultT extends AwsResponse>
ResponseInputStream<ResultT>
injectCredentialsAndInvokeV2InputStream(final RequestT request,
final Function<RequestT, ResponseInputStream<ResultT>> requestFunction) {

AwsRequestOverrideConfiguration overrideConfiguration = AwsRequestOverrideConfiguration.builder()
.credentialsProvider(v2CredentialsProvider).build();

@SuppressWarnings("unchecked")
RequestT wrappedRequest = (RequestT) request.toBuilder().overrideConfiguration(overrideConfiguration).build();

try {
return requestFunction.apply(wrappedRequest);
} catch (final Throwable e) {
loggerProxy.log(String.format("Failed to execute remote function: {%s}", e.getMessage()));
throw e;
}
}

public <RequestT extends AwsRequest, ResultT extends AwsResponse>
ResponseBytes<ResultT>
injectCredentialsAndInvokeV2Bytes(final RequestT request,
final Function<RequestT, ResponseBytes<ResultT>> requestFunction) {

AwsRequestOverrideConfiguration overrideConfiguration = AwsRequestOverrideConfiguration.builder()
.credentialsProvider(v2CredentialsProvider).build();

@SuppressWarnings("unchecked")
RequestT wrappedRequest = (RequestT) request.toBuilder().overrideConfiguration(overrideConfiguration).build();

try {
return requestFunction.apply(wrappedRequest);
} catch (final Throwable e) {
loggerProxy.log(String.format("Failed to execute remote function: {%s}", e.getMessage()));
throw e;
}
}

public <RequestT, ClientT, ModelT, CallbackT extends StdCallbackContext>
ProgressEvent<ModelT, CallbackT>
defaultHandler(RequestT request, Exception e, ClientT client, ModelT model, CallbackT context) throws Exception {
Expand Down
41 changes: 41 additions & 0 deletions src/main/java/software/amazon/cloudformation/proxy/ProxyClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
import java.util.function.Function;
import software.amazon.awssdk.awscore.AwsRequest;
import software.amazon.awssdk.awscore.AwsResponse;
import software.amazon.awssdk.core.ResponseBytes;
import software.amazon.awssdk.core.ResponseInputStream;
import software.amazon.awssdk.core.pagination.sync.SdkIterable;

/**
Expand Down Expand Up @@ -94,6 +96,45 @@ public interface ProxyClient<ClientT> {
IterableT
injectCredentialsAndInvokeIterableV2(RequestT request, Function<RequestT, IterableT> requestFunction);

/**
* This is a synchronous version of making API calls which implement
* ResponseInputStream in the SDKv2
*
* @param request, the AWS service request that we need to make
* @param requestFunction, this is a Lambda closure that provide the actual API
* that needs to be invoked.
* @param <RequestT> the request type
* @param <ResponseT> the response from the request
* @return the response if successful. Else it will propagate all
* {@link software.amazon.awssdk.awscore.exception.AwsServiceException}
* that is thrown or
* {@link software.amazon.awssdk.core.exception.SdkClientException} if
* there is client side problem
*/
<RequestT extends AwsRequest, ResponseT extends AwsResponse>
ResponseInputStream<ResponseT>
injectCredentialsAndInvokeV2InputStream(RequestT request,
Function<RequestT, ResponseInputStream<ResponseT>> requestFunction);

/**
* This is a synchronous version of making API calls which implement
* ResponseBytes in the SDKv2
*
* @param request, the AWS service request that we need to make
* @param requestFunction, this is a Lambda closure that provide the actual API
* that needs to be invoked.
* @param <RequestT> the request type
* @param <ResponseT> the response from the request
* @return the response if successful. Else it will propagate all
* {@link software.amazon.awssdk.awscore.exception.AwsServiceException}
* that is thrown or
* {@link software.amazon.awssdk.core.exception.SdkClientException} if
* there is client side problem
*/
<RequestT extends AwsRequest, ResponseT extends AwsResponse>
ResponseBytes<ResponseT>
injectCredentialsAndInvokeV2Bytes(RequestT request, Function<RequestT, ResponseBytes<ResponseT>> requestFunction);

/**
* @return the actual AWS service client that we need to use to provide the
* actual method we are going to call.
Expand Down
150 changes: 150 additions & 0 deletions src/test/java/software/amazon/cloudformation/proxy/AmazonWebServicesClientProxyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
import static org.junit.jupiter.api.Assertions.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
Expand All @@ -42,11 +44,15 @@
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.awscore.exception.AwsErrorDetails;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.ResponseBytes;
import software.amazon.awssdk.core.ResponseInputStream;
import software.amazon.awssdk.core.exception.NonRetryableException;
import software.amazon.awssdk.http.SdkHttpResponse;
import software.amazon.awssdk.services.cloudformation.CloudFormationAsyncClient;
import software.amazon.awssdk.services.cloudformation.CloudFormationClient;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetObjectResponse;
import software.amazon.cloudformation.exceptions.ResourceAlreadyExistsException;
import software.amazon.cloudformation.exceptions.TerminalException;
import software.amazon.cloudformation.proxy.delay.Constant;
Expand Down Expand Up @@ -229,6 +235,150 @@ public void testInjectCredentialsAndInvokeV2Async_WithException() {

}

@Test
public void testInjectCredentialsAndInvokeV2InputStream() {

final LoggerProxy loggerProxy = mock(LoggerProxy.class);
final Credentials credentials = new Credentials("accessKeyId", "secretAccessKey", "sessionToken");
final ResponseInputStream<?> responseInputStream = mock(ResponseInputStream.class);

final AmazonWebServicesClientProxy proxy = new AmazonWebServicesClientProxy(loggerProxy, credentials, () -> 1000L);

final software.amazon.awssdk.services.s3.model.GetObjectRequest wrappedRequest = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.class);

final software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder builder = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder.class);
when(builder.overrideConfiguration(any(AwsRequestOverrideConfiguration.class))).thenReturn(builder);
when(builder.build()).thenReturn(wrappedRequest);
final software.amazon.awssdk.services.s3.model.GetObjectRequest request = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.class);
when(request.toBuilder()).thenReturn(builder);

final S3Client client = mock(S3Client.class);

doReturn(responseInputStream).when(client)
.getObject(any(software.amazon.awssdk.services.s3.model.GetObjectRequest.class));

final ResponseInputStream<
GetObjectResponse> result = proxy.injectCredentialsAndInvokeV2InputStream(request, client::getObject);

// verify request is rebuilt for injection
verify(request).toBuilder();

// verify the wrapped request is sent over the initiate
verify(client).getObject(wrappedRequest);

// ensure the return type matches
assertThat(result).isEqualTo(responseInputStream);
}

@Test
public void testInjectCredentialsAndInvokeV2InputStream_Exception() {

final LoggerProxy loggerProxy = mock(LoggerProxy.class);
final Credentials credentials = new Credentials("accessKeyId", "secretAccessKey", "sessionToken");

final AmazonWebServicesClientProxy proxy = new AmazonWebServicesClientProxy(loggerProxy, credentials, () -> 1000L);

final software.amazon.awssdk.services.s3.model.GetObjectRequest wrappedRequest = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.class);

final software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder builder = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder.class);
when(builder.overrideConfiguration(any(AwsRequestOverrideConfiguration.class))).thenReturn(builder);
when(builder.build()).thenReturn(wrappedRequest);
final software.amazon.awssdk.services.s3.model.GetObjectRequest request = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.class);
when(request.toBuilder()).thenReturn(builder);

final S3Client client = mock(S3Client.class);

doThrow(new TerminalException(new RuntimeException("Sorry"))).when(client)
.getObject(any(software.amazon.awssdk.services.s3.model.GetObjectRequest.class));

assertThrows(RuntimeException.class, () -> proxy.injectCredentialsAndInvokeV2InputStream(request, client::getObject),
"Expected Runtime Exception.");

// verify request is rebuilt for injection
verify(request).toBuilder();

// verify the wrapped request is sent over the initiate
verify(client).getObject(wrappedRequest);
}

@Test
public void testInjectCredentialsAndInvokeV2Bytes() {

final LoggerProxy loggerProxy = mock(LoggerProxy.class);
final Credentials credentials = new Credentials("accessKeyId", "secretAccessKey", "sessionToken");
final ResponseBytes<?> responseBytes = mock(ResponseBytes.class);

final AmazonWebServicesClientProxy proxy = new AmazonWebServicesClientProxy(loggerProxy, credentials, () -> 1000L);

final software.amazon.awssdk.services.s3.model.GetObjectRequest wrappedRequest = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.class);

final software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder builder = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder.class);
when(builder.overrideConfiguration(any(AwsRequestOverrideConfiguration.class))).thenReturn(builder);
when(builder.build()).thenReturn(wrappedRequest);
final software.amazon.awssdk.services.s3.model.GetObjectRequest request = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.class);
when(request.toBuilder()).thenReturn(builder);

final S3Client client = mock(S3Client.class);

doReturn(responseBytes).when(client)
.getObjectAsBytes(any(software.amazon.awssdk.services.s3.model.GetObjectRequest.class));

final ResponseBytes<
GetObjectResponse> result = proxy.injectCredentialsAndInvokeV2Bytes(request, client::getObjectAsBytes);

// verify request is rebuilt for injection
verify(request).toBuilder();

// verify the wrapped request is sent over the initiate
verify(client).getObjectAsBytes(wrappedRequest);

// ensure the return type matches
assertThat(result).isEqualTo(responseBytes);
}

@Test
public void testInjectCredentialsAndInvokeV2Bytes_Exception() {

final LoggerProxy loggerProxy = mock(LoggerProxy.class);
final Credentials credentials = new Credentials("accessKeyId", "secretAccessKey", "sessionToken");

final AmazonWebServicesClientProxy proxy = new AmazonWebServicesClientProxy(loggerProxy, credentials, () -> 1000L);

final software.amazon.awssdk.services.s3.model.GetObjectRequest wrappedRequest = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.class);

final software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder builder = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder.class);
when(builder.overrideConfiguration(any(AwsRequestOverrideConfiguration.class))).thenReturn(builder);
when(builder.build()).thenReturn(wrappedRequest);
final software.amazon.awssdk.services.s3.model.GetObjectRequest request = mock(
software.amazon.awssdk.services.s3.model.GetObjectRequest.class);
when(request.toBuilder()).thenReturn(builder);

final S3Client client = mock(S3Client.class);

doThrow(new TerminalException(new RuntimeException("Sorry"))).when(client)
.getObjectAsBytes(any(software.amazon.awssdk.services.s3.model.GetObjectRequest.class));

assertThrows(RuntimeException.class, () -> proxy.injectCredentialsAndInvokeV2Bytes(request, client::getObjectAsBytes),
"Expected Runtime Exception.");

// verify request is rebuilt for injection
verify(request).toBuilder();

// verify the wrapped request is sent over the initiate
verify(client).getObjectAsBytes(wrappedRequest);
}

private final Credentials MOCK = new Credentials("accessKeyId", "secretKey", "token");

@Test
Expand Down