test(client-s3): attempt to add e2e test

Author: AllanZhengYP

clients/client-s3/.gitignore

@@ -11,5 +11,5 @@ package-lock.json
 
 *.d.ts
 *.js
-!jest.config.js
+!karma.conf.js
 *.js.map

clients/client-s3/S3.spec.ts

@@ -1,3 +1,4 @@
+/// <reference types="jest" />
 import { S3 } from "./S3";
 import { SerializeMiddleware } from "@aws-sdk/types";
 import { HttpRequest } from "@aws-sdk/protocol-http";

clients/client-s3/e2e/S3.ispec.ts

@@ -0,0 +1,43 @@
+/// <reference types="mocha" />
+/**
+ * This is the integration test that make sure the client can make request cross-platform-ly
+ * in NodeJS, Chromium and Firefox. This test is written in mocha.
+ */
+import { expect } from "chai";
+import { S3Client, PutObjectCommand, DeleteObjectCommand } from "../index";
+declare let defaultRegion: string;
+declare const credentials: any;
+declare const isBrowser: boolean; //undefined by default, used for NodeJS.
+
+const Bucket = "aws-sdk-unit-test"; // this bucket requires enabling CORS
+const Key = `${Date.now()}`;
+
+describe("@aws-sdk/client-s3", () => {
+  const client = new S3Client({
+    region: defaultRegion,
+    credentials
+  });
+
+  after(async () => {
+    await client.send(
+      new DeleteObjectCommand({
+        Bucket,
+        Key
+      })
+    );
+  });
+
+  if (isBrowser) {
+    it("PutObject should succeed when given blob body", async () => {
+      const smallBody = [];
+      const result = await client.send(
+        new PutObjectCommand({
+          Bucket,
+          Key,
+          Body: new Blob(["abc"])
+        })
+      );
+      expect(result.$metadata.httpStatusCode).to.eql(200);
+    });
+  }
+});

clients/client-s3/jest.config.js

@@ -0,0 +1,73 @@
+module.exports = function (config) {
+  config.set({
+    basePath: "",
+    frameworks: ["mocha", "chai"],
+    files: ["e2e/**/*.ispec.ts"],
+    preprocessors: {
+      "e2e/**/*.ispec.ts": ["webpack", "sourcemap", "credentials"]
+    },
+    webpackMiddleware: {
+      stats: "minimal"
+    },
+    webpack: {
+      resolve: {
+        extensions: [".ts", ".js"]
+      },
+      mode: "development",
+      module: {
+        rules: [
+          {
+            test: /\.tsx?$/,
+            use: [
+              {
+                loader: "ts-loader",
+                options: {
+                  configFile: "tsconfig.e2e.json",
+                  compilerOptions: {
+                    rootDir: "./"
+                  }
+                }
+              }
+            ],
+            exclude: /node_modules/
+          }
+        ]
+      },
+      // stats: {
+      //   // colors: false,
+      //   // modules: false,
+      //   // reasons: false,
+      //   // assets: false,
+      //   // moduleAssets: false,
+      //   // chunks: false,
+      //   // errorDetails: true
+      //   all: false
+      // },
+      devtool: "inline-source-map"
+    },
+    plugins: [
+      "@aws-sdk/karma-credential-loader",
+      "karma-chrome-launcher",
+      "karma-firefox-launcher",
+      "karma-mocha",
+      "karma-chai",
+      "karma-webpack",
+      "karma-coverage",
+      "karma-sourcemap-loader"
+    ],
+    port: 9876,
+    colors: true,
+    logLevel: config.LOG_WARN,
+    autoWatch: false,
+    browsers: ["ChromeHeadless", "FirefoxHeadless"],
+    customLaunchers: {
+      FirefoxHeadless: {
+        base: "Firefox",
+        flags: ["-headless"]
+      }
+    },
+    singleRun: true,
+    concurrency: Infinity,
+    exclude: ["**/*.d.ts", "*.spec.ts"]
+  });
+};

clients/client-s3/karma.conf.js

@@ -12,7 +12,7 @@
     "remove-documentation": "rimraf ./docs",
     "remove-js": "rimraf *.js && rimraf ./commands/*.js && rimraf ./models/*.js && rimraf ./protocols/*.js",
     "remove-maps": "rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./models/*.js.map && rimraf ./protocols/*.js.map",
-    "test": "jest --passWithNoTests",
+    "test:browser": "karma start karma.conf.js",
     "build:es": "tsc -p tsconfig.es.json",
     "build": "yarn pretest && yarn build:es"
   },
@@ -39,6 +39,7 @@
     "@aws-sdk/hash-node": "1.0.0-gamma.1",
     "@aws-sdk/hash-stream-node": "1.0.0-gamma.1",
     "@aws-sdk/invalid-dependency": "1.0.0-gamma.1",
+    "@aws-sdk/karma-credential-loader": "1.0.0-gamma.0",
     "@aws-sdk/md5-js": "1.0.0-gamma.1",
     "@aws-sdk/middleware-apply-body-checksum": "1.0.0-gamma.1",
     "@aws-sdk/middleware-bucket-endpoint": "1.0.0-gamma.1",
@@ -74,8 +75,9 @@
     "tslib": "^1.8.0"
   },
   "devDependencies": {
+    "@types/chai": "^4.2.11",
+    "@types/mocha": "^7.0.2",
     "@types/node": "^12.7.5",
-    "jest": "^25.1.0",
     "rimraf": "^3.0.0",
     "tslib": "^1.8.0",
     "typedoc": "^0.15.0",

clients/client-s3/package.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "..",
+    "target": "es5",
+    "lib": ["dom"],
+    "types": ["mocha"]
+  },
+  "exclude": ["./*.spec.ts", "dist", "types"]
+}

clients/client-s3/tsconfig.e2e.json

@@ -12,7 +12,8 @@
     "incremental": true,
     "resolveJsonModule": true,
     "declarationDir": "./types",
-    "outDir": "dist/cjs"
+    "outDir": "dist/cjs",
+    "types": ["jest"]
   },
   "typedocOptions": {
     "exclude": "**/node_modules/**",
@@ -23,5 +24,6 @@
     "mode": "file",
     "out": "./docs",
     "plugin": "@aws-sdk/client-documentation-generator"
-  }
+  },
+  "exclude": ["e2e", "types"]
 }

clients/client-s3/tsconfig.json

@@ -40,6 +40,7 @@
     "@commitlint/config-conventional": "^8.3.4",
     "@types/fs-extra": "^8.0.1",
     "@types/jest": "^25.1.4",
+    "chai": "^4.2.0",
     "codecov": "^3.4.0",
     "cucumber": "^6.0.5",
     "fs-extra": "^9.0.0",
@@ -49,15 +50,24 @@
     "jest": "^25.1.0",
     "jmespath": "^0.15.0",
     "karma": "^5.1.0",
+    "karma-chai": "^0.1.0",
     "karma-chrome-launcher": "^3.1.0",
     "karma-coverage": "^2.0.2",
+    "karma-firefox-launcher": "^1.3.0",
     "karma-jasmine": "^3.3.1",
+    "karma-mocha": "^2.0.1",
+    "karma-sourcemap-loader": "^0.3.7",
     "karma-typescript": "^5.0.3",
+    "karma-webpack": "^4.0.2",
     "lerna": "3.22.1",
     "lint-staged": "^10.0.1",
+    "mocha": "^8.0.1",
     "prettier": "2.0.5",
     "puppeteer": "^4.0.0",
+    "ts-loader": "^7.0.5",
     "typescript": "~3.8.3",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.12",
     "yarn": "1.22.4"
   },
   "workspaces": {

package.json

@@ -0,0 +1,4 @@
+# Smoke Tests
+
+Smoke tests is used to make sure the SDK can make API request correctly to the AWS backend. It does not intended to
+integration tests for more abstract interfaces or utilities.

tests/functional/smoke/README.md

@@ -1720,6 +1720,11 @@
   dependencies:
     "@babel/types" "^7.3.0"
 
+"@types/chai@^4.2.11":
+  version "4.2.11"
+  resolved "https://registry.yarnpkg.com/@types/chai/-/chai-4.2.11.tgz#d3614d6c5f500142358e6ed24e1bf16657536c50"
+  integrity sha512-t7uW6eFafjO+qJ3BIV2gGUyZs27egcNRkUdalkud+Qa3+kg//f129iuOFivHDXQ+vnU3fDXuwgv0cqMCbcE8sw==
+
 "@types/color-name@^1.1.1":
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/@types/color-name/-/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0"
@@ -1821,6 +1826,11 @@
   resolved "https://registry.yarnpkg.com/@types/minimist/-/minimist-1.2.0.tgz#69a23a3ad29caf0097f06eda59b361ee2f0639f6"
   integrity sha1-aaI6OtKcrwCX8G7aWbNh7i8GOfY=
 
+"@types/mocha@^7.0.2":
+  version "7.0.2"
+  resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-7.0.2.tgz#b17f16cf933597e10d6d78eae3251e692ce8b0ce"
+  integrity sha512-ZvO2tAcjmMi8V/5Z3JsyofMe3hasRcaw88cto5etSVMwVQfeivGAlEYmaQgceUSVYFofVjT+ioHsATjdWcFt1w==
+
 "@types/node@*", "@types/node@>= 8":
   version "14.0.13"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-14.0.13.tgz#ee1128e881b874c371374c1f72201893616417c9"