Update comment to explain more about those tests

aws · Oct 4, 2023 · db5a488 · db5a488
1 parent fb7eca9
commit db5a488
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/...ain/java/software/amazon/awssdk/core/internal/http/pipeline/stages/HttpChecksumStage.java b/...ain/java/software/amazon/awssdk/core/internal/http/pipeline/stages/HttpChecksumStage.java
@@ -75,8 +75,7 @@ public SdkHttpFullRequest.Builder execute(SdkHttpFullRequest.Builder request, Re
             return request;
         }
 
-        // If SRA is enabled, we skip flexible checksum in header, as it is not supported in the HttpSigner right now
-        // TODO: we should remove this after it is supported
+        // If SRA is enabled, skip flexible checksum in header, since it is handled by SRA signer
         if (sraSigningEnabled(context)) {
             return request;
         }
@@ -136,8 +135,7 @@ private void addMd5ChecksumInHeader(SdkHttpFullRequest.Builder request) {
 
     private boolean flexibleChecksumInTrailerRequired(RequestExecutionContext context, ChecksumSpecs checksumSpecs) {
 
-        // If SRA is enabled and it's sync client,
-        // skip it since flexible checksum trailer is handled in SRA signer
+        // If SRA is enabled and it's sync client, skip flexible checksum trailer, since it is handled in SRA signer
         if (sraSigningEnabled(context) && clientType == ClientType.SYNC) {
             return false;
         }

diff --git a/...it/java/software/amazon/awssdk/services/s3/checksum/AsyncHttpChecksumIntegrationTest.java b/...it/java/software/amazon/awssdk/services/s3/checksum/AsyncHttpChecksumIntegrationTest.java
@@ -233,9 +233,16 @@ void asyncValidSignedTrailerChecksumCalculatedBySdkClient() {
         assertThat(response).isEqualTo("Hello world");
     }
 
+    /**
+     * S3 clients by default don't do payload signing. But when http is used, payload signing is expected to be enforced. But
+     * payload signing is not currently supported in async path (for both pre/post SRA signers).
+     * However, this test passes, because of https://github
+     * .com/aws/aws-sdk-java-v2/blob/38e221bd815af31a6c6b91557499af155103c21a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/internal/AbstractAwsS3V4Signer.java#L279-L285.
+     * Keeping this test enabled, to ensure moving to SRA Identity & Auth, does not break current behavior.
+     * TODO: Update this test with right asserts when payload signing is supported in async.
+     */
     @Test
     public void putObject_with_bufferCreatedFromEmptyString() {
-
         s3HttpAsync.putObject(PutObjectRequest.builder()
                                               .bucket(BUCKET)
                                               .key(KEY)
@@ -255,6 +262,14 @@ public void putObject_with_bufferCreatedFromEmptyString() {
         assertThat(response).isEqualTo("");
     }
 
+    /**
+     * S3 clients by default don't do payload signing. But when http is used, payload signing is expected to be enforced. But
+     * payload signing is not currently supported in async path (for both pre/post SRA signers).
+     * However, this test passes, because of https://github
+     * .com/aws/aws-sdk-java-v2/blob/38e221bd815af31a6c6b91557499af155103c21a/core/auth/src/main/java/software/amazon/awssdk/auth/signer/internal/AbstractAwsS3V4Signer.java#L279-L285.
+     * Keeping this test enabled, to ensure moving to SRA Identity & Auth, does not break current behavior.
+     * TODO: Update this test with right asserts when payload signing is supported in async.
+     */
     @Test
     public void putObject_with_bufferCreatedFromZeroCapacityByteBuffer() {
         ByteBuffer content = ByteBuffer.allocate(0);