test(client-s3): integration tests for flexible checksums (#3360)

Author: trivikr

clients/client-s3/test/flexibleChecksums.spec.ts

@@ -0,0 +1,150 @@
+/// <reference types="mocha" />
+import { ChecksumAlgorithm } from "@aws-sdk/middleware-flexible-checksums";
+import { HttpRequest } from "@aws-sdk/protocol-http";
+import { BuildMiddleware } from "@aws-sdk/types";
+import chai from "chai";
+import chaiAsPromised from "chai-as-promised";
+import { Readable } from "stream";
+
+import { S3 } from "../src/S3";
+
+chai.use(chaiAsPromised);
+const { expect } = chai;
+
+describe("Flexible Checksums", () => {
+  const testCases = [
+    ["", ChecksumAlgorithm.CRC32, "AAAAAA=="],
+    ["abc", ChecksumAlgorithm.CRC32, "NSRBwg=="],
+    ["Hello world", ChecksumAlgorithm.CRC32, "i9aeUg=="],
+
+    ["", ChecksumAlgorithm.CRC32C, "AAAAAA=="],
+    ["abc", ChecksumAlgorithm.CRC32C, "Nks/tw=="],
+    ["Hello world", ChecksumAlgorithm.CRC32C, "crUfeA=="],
+
+    ["", ChecksumAlgorithm.SHA1, "2jmj7l5rSw0yVb/vlWAYkK/YBwk="],
+    ["abc", ChecksumAlgorithm.SHA1, "qZk+NkcGgWq6PiVxeFDCbJzQ2J0="],
+    ["Hello world", ChecksumAlgorithm.SHA1, "e1AsOh9IyGCa4hLN+2Od7jlnP14="],
+
+    ["", ChecksumAlgorithm.SHA256, "47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU="],
+    ["abc", ChecksumAlgorithm.SHA256, "ungWv48Bz+pBQUDeXa4iI7ADYaOWF3qctBD/YfIAFa0="],
+    ["Hello world", ChecksumAlgorithm.SHA256, "ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuyjfzw="],
+  ];
+
+  describe("putObject", () => {
+    testCases.forEach(([body, checksumAlgorithm, checksumValue]) => {
+      const checksumHeader = `x-amz-checksum-${checksumAlgorithm.toLowerCase()}`;
+
+      describe(`sets ${checksumHeader}="${checksumValue}"" for checksum="${checksumAlgorithm}"`, () => {
+        const getBodyAsReadableStream = (content: string) => {
+          const readableStream = new Readable();
+          const separator = " ";
+          const wordsAsChunks = content.split(separator);
+          wordsAsChunks.forEach((word, index) => {
+            readableStream.push(word);
+            if (index !== wordsAsChunks.length - 1) {
+              readableStream.push(separator);
+            }
+          });
+          readableStream.push(null);
+          return readableStream;
+        };
+
+        it(`when body is sent as a request`, async () => {
+          const requestChecksumValidator: BuildMiddleware<any, any> = (next) => async (args) => {
+            // middleware intercept the request and return it early
+            const request = args.request as HttpRequest;
+            const { headers } = request;
+            expect(headers["x-amz-sdk-checksum-algorithm"]).to.equal(checksumAlgorithm);
+            expect(headers[checksumHeader]).to.equal(checksumValue);
+            return { output: {} as any, response: {} as any };
+          };
+
+          const client = new S3({});
+          client.middlewareStack.addRelativeTo(requestChecksumValidator, {
+            relation: "after",
+            toMiddleware: "flexibleChecksumsMiddleware",
+          });
+
+          return await client.putObject({
+            Bucket: "bucket",
+            Key: "key",
+            Body: body,
+            ChecksumAlgorithm: checksumAlgorithm,
+          });
+        });
+
+        it(`when body is sent as a stream`, async () => {
+          const requestChecksumValidator: BuildMiddleware<any, any> = (next) => async (args) => {
+            // middleware intercept the request and return it early
+            const request = args.request as HttpRequest;
+            const { headers } = request;
+            expect(headers["content-length"]).to.be.undefined;
+            expect(headers["content-encoding"]).to.equal("aws-chunked");
+            expect(headers["transfer-encoding"]).to.equal("chunked");
+            expect(headers["x-amz-content-sha256"]).to.equal("STREAMING-UNSIGNED-PAYLOAD-TRAILER");
+            expect(headers["x-amz-trailer"]).to.equal(checksumHeader);
+            return { output: {} as any, response: {} as any };
+          };
+
+          const client = new S3({});
+          client.middlewareStack.addRelativeTo(requestChecksumValidator, {
+            relation: "after",
+            toMiddleware: "flexibleChecksumsMiddleware",
+          });
+
+          const bodyStream = getBodyAsReadableStream(body);
+          return await client.putObject({
+            Bucket: "bucket",
+            Key: "key",
+            Body: bodyStream,
+            ChecksumAlgorithm: checksumAlgorithm,
+          });
+        });
+      });
+    });
+  });
+
+  describe("getObject", async () => {
+    testCases.forEach(([body, checksumAlgorithm, checksumValue]) => {
+      const checksumHeader = `x-amz-checksum-${checksumAlgorithm.toLowerCase()}`;
+
+      it(`validates ${checksumHeader}="${checksumValue}"" set for checksum="${checksumAlgorithm}"`, async () => {
+        const responseBody = new Readable();
+        responseBody.push(body);
+        responseBody.push(null);
+        const responseChecksumValidator: BuildMiddleware<any, any> = (next, context) => async (args) => {
+          const request = args.request as HttpRequest;
+          return {
+            output: {
+              $metadata: { attempts: 0, httpStatusCode: 200 },
+              request,
+              context,
+              Body: responseBody,
+            } as any,
+            response: {
+              body: responseBody,
+              headers: {
+                [checksumHeader]: checksumValue,
+              },
+            } as any,
+          };
+        };
+
+        const client = new S3({});
+        client.middlewareStack.addRelativeTo(responseChecksumValidator, {
+          relation: "after",
+          toMiddleware: "flexibleChecksumsMiddleware",
+        });
+
+        const { Body } = await client.getObject({
+          Bucket: "bucket",
+          Key: "key",
+          ChecksumMode: "ENABLED",
+        });
+        (Body as Readable).on("data", (chunk) => {
+          expect(chunk.toString()).to.equal(body);
+        });
+      });
+    });
+  });
+});