-
Notifications
You must be signed in to change notification settings - Fork 840
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixed an issue where request-level signer overridden from execution i…
…nterceptor is not honored (#5420)
- Loading branch information
Showing
5 changed files
with
172 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "type": "bugfix", | ||
| "category": "AWS SDK for Java v2", | ||
| "contributor": "", | ||
| "description": "Fixed the issue where request-level signer override provided through ExecutionInterceptor is not honored." | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
66 changes: 0 additions & 66 deletions
66
...d-classes-test/src/test/java/software/amazon/awssdk/services/AsyncSignerOverrideTest.java
This file was deleted.
Oops, something went wrong.
119 changes: 119 additions & 0 deletions
119
...erated-classes-test/src/test/java/software/amazon/awssdk/services/SignerOverrideTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| /* | ||
| * Copyright 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. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. 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 software.amazon.awssdk.services; | ||
|
|
||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.verify; | ||
| import static software.amazon.awssdk.core.client.config.SdkAdvancedClientOption.SIGNER; | ||
|
|
||
| import java.net.URI; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.MockitoJUnitRunner; | ||
| import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; | ||
| import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; | ||
| import software.amazon.awssdk.awscore.AwsRequest; | ||
| import software.amazon.awssdk.core.SdkRequest; | ||
| import software.amazon.awssdk.core.async.AsyncRequestBody; | ||
| import software.amazon.awssdk.core.interceptor.Context; | ||
| import software.amazon.awssdk.core.interceptor.ExecutionAttributes; | ||
| import software.amazon.awssdk.core.interceptor.ExecutionInterceptor; | ||
| import software.amazon.awssdk.core.signer.Signer; | ||
| import software.amazon.awssdk.http.SdkHttpFullRequest; | ||
| import software.amazon.awssdk.regions.Region; | ||
| import software.amazon.awssdk.services.protocolrestjson.ProtocolRestJsonAsyncClient; | ||
| import software.amazon.awssdk.services.protocolrestjson.ProtocolRestJsonClient; | ||
| import software.amazon.awssdk.services.protocolrestjson.model.AllTypesRequest; | ||
| import software.amazon.awssdk.services.protocolrestjson.model.StreamingInputOperationRequest; | ||
|
|
||
|
|
||
| @RunWith(MockitoJUnitRunner.class) | ||
| public class SignerOverrideTest { | ||
| @Mock | ||
| public Signer mockSigner; | ||
|
|
||
| /** | ||
| * Test to ensure that operations that use the {@link software.amazon.awssdk.auth.signer.AsyncAws4Signer} don't apply | ||
| * the override when the signer is overridden by the customer. | ||
| */ | ||
| @Test | ||
| public void test_signerOverriddenForStreamingInput_takesPrecedence() { | ||
| ProtocolRestJsonAsyncClient asyncClient = ProtocolRestJsonAsyncClient.builder() | ||
| .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create("akid", "skid"))) | ||
| .region(Region.US_WEST_2) | ||
| .overrideConfiguration(o -> o.putAdvancedOption(SIGNER, mockSigner)) | ||
| .build(); | ||
|
|
||
| try { | ||
| asyncClient.streamingInputOperation(StreamingInputOperationRequest.builder().build(), | ||
| AsyncRequestBody.fromString("test")).join(); | ||
| } catch (Exception expected) { | ||
| } | ||
|
|
||
| verify(mockSigner).sign(any(SdkHttpFullRequest.class), any(ExecutionAttributes.class)); | ||
| } | ||
|
|
||
| @Test | ||
| public void asyncClient_oldSignerOverriddenInExecutionInterceptor_takesPrecedence() { | ||
| try (ProtocolRestJsonAsyncClient asyncClient = ProtocolRestJsonAsyncClient.builder() | ||
| .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create("akid", "skid"))) | ||
| .region(Region.US_WEST_2) | ||
| .endpointOverride(URI.create("http://localhost:8080")) | ||
| .overrideConfiguration(o -> o.addExecutionInterceptor(signerOverrideExecutionInterceptor(mockSigner))) | ||
| .build()) { | ||
| asyncClient.allTypes(AllTypesRequest.builder().build()).join(); | ||
| } catch (Exception expected) { | ||
| // Doesn't matter if the request succeeds or not | ||
| } | ||
|
|
||
| verify(mockSigner).sign(any(SdkHttpFullRequest.class), any(ExecutionAttributes.class)); | ||
| } | ||
|
|
||
| @Test | ||
| public void syncClient_oldSignerOverriddenInExecutionInterceptor_takesPrecedence() { | ||
| try (ProtocolRestJsonClient client = ProtocolRestJsonClient.builder() | ||
| .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create("akid", "skid"))) | ||
| .region(Region.US_WEST_2) | ||
| .endpointOverride(URI.create("http://localhost:8080")) | ||
| .overrideConfiguration(o -> o.addExecutionInterceptor(signerOverrideExecutionInterceptor(mockSigner))) | ||
| .build()) { | ||
| client.allTypes(AllTypesRequest.builder().build()); | ||
| } catch (Exception expected) { | ||
| // Doesn't matter if the request succeeds or not | ||
| } | ||
|
|
||
| verify(mockSigner).sign(any(SdkHttpFullRequest.class), any(ExecutionAttributes.class)); | ||
| } | ||
|
|
||
| private ExecutionInterceptor signerOverrideExecutionInterceptor(Signer signer) { | ||
| return new ExecutionInterceptor() { | ||
| @Override | ||
| public SdkRequest modifyRequest(Context.ModifyRequest context, ExecutionAttributes executionAttributes) { | ||
| AwsRequest.Builder builder = (AwsRequest.Builder) context.request().toBuilder(); | ||
| builder.overrideConfiguration(c -> c.signer(signer) | ||
| .build()); | ||
|
|
||
| return builder.build(); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| // TODO(sra-identity-and-auth): Add test for SRA way of overriding signer to assert that overridden signer is used. | ||
| // At that point, rename this class to SignerOverrideTest, not specific to AsyncSignerOverride (which was for operation | ||
| // level codegen changes). | ||
|
|
||
| } |