Test(files)/add performance tests

.gitignore

@@ -348,3 +348,6 @@ MigrationBackup/
 
 ci.conf
 out.yaml
+
+#Performance Tests
+dist

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/.babelrc

@@ -0,0 +1,8 @@
+{
+  "presets": ["@babel/env", "@babel/typescript"],
+  "plugins": [
+    "@babel/proposal-class-properties",
+
+    "@babel/proposal-object-rest-spread"
+  ]
+}

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/external.module.declarations.ts

@@ -0,0 +1 @@
+declare module "https://jslib.k6.io/k6chaijs/4.3.4.2/index.js";

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "performance-test-files",
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/core": "7.13.16",
+    "@babel/plugin-proposal-class-properties": "7.13.0",
+    "@babel/plugin-proposal-object-rest-spread": "7.13.8",
+    "@babel/preset-env": "7.13.15",
+    "@babel/preset-typescript": "7.13.0",
+    "@types/k6": "~0.41.0",
+    "@types/webpack": "5.28.0",
+    "babel-loader": "8.2.2",
+    "clean-webpack-plugin": "4.0.0-alpha.0",
+    "copy-webpack-plugin": "^9.0.1",
+    "k6-expect": "^0.0.15",
+    "prettier": "2.8.4",
+    "typescript": "4.2.4",
+    "webpack": "^5.75.0",
+    "webpack-cli": "4.6.0",
+    "webpack-glob-entries": "^1.0.1"
+  }
+}

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/prettierrc.json

@@ -0,0 +1,15 @@
+{
+  "endOfLine": "lf",
+  "printWidth": 120,
+  "tabWidth": 4,
+  "trailingComma": "none",
+  "semi": true,
+  "overrides": [
+    {
+      "files": ["*.yaml", "*.yml"],
+      "options": {
+        "tabWidth": 2
+      }
+    }
+  ]
+}

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/run-all.ps1

@@ -0,0 +1,19 @@
+Param(
+    [parameter(Mandatory)] $baseUrl,
+    [parameter(Mandatory)] $username,
+    [parameter(Mandatory)] $password,
+    [parameter(Mandatory)] $size
+)
+
+Write-Host "Running files performance tests..."
+
+npm install
+npx webpack
+
+Get-ChildItem -Path "./dist" -Filter *.test.js |
+
+Foreach-Object {
+    k6 run -e HOST=$baseUrl -e USERNAME=$username -e PASSWORD=$password -e CLIENT_SECRET=test -e SIZE=$size $_.FullName
+}
+
+Write-Host "OK"

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/run-all.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+while getopts h:u:p:s: opt
+do
+    case $opt in
+        h) BASEURL=$OPTARG ;;
+        u) USERNAME=$OPTARG ;;
+        p) PASSWORD=$OPTARG ;;
+        s) SIZE=$OPTARG ;;
+    esac
+done
+
+echo "Running files performance tests..."
+
+npm install
+npx webpack
+
+for file in "./dist/"*.test.js ; do 
+    k6 run -e HOST=$BASEURL -e USERNAME=$USERNAME -e PASSWORD=$PASSWORD -e CLIENT_SECRET=test -e SIZE=$SIZE $file
+done
+
+echo "OK"

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/src/download-file.test.ts

@@ -0,0 +1,77 @@
+import http from "k6/http";
+import { Options } from "k6/options";
+import {
+  describe,
+  expect,
+} from "https://jslib.k6.io/k6chaijs/4.3.4.2/index.js";
+import { getJwt, assertEnvVarExists, Size, tomorrow } from "./utils";
+
+assertEnvVarExists();
+
+const apiEndpoint = __ENV.HOST + "/api/v1";
+
+interface Data {
+  authToken: string;
+  fileId: string;
+}
+
+function size(): Size {
+  switch (__ENV.SIZE) {
+    case "S":
+      return { vus: 1, iterations: 10 };
+    case "M":
+      return { vus: 10, iterations: 50 };
+    case "L":
+      return { vus: 50, iterations: 100 };
+    default:
+      throw new Error("Invalid 'Size' value: " + __ENV.SIZE);
+  }
+}
+
+export const options: Options = {
+  vus: size().vus,
+  thresholds: {
+    http_req_duration: ["p(90)<160", "p(98)<190"],
+  },
+  iterations: size().iterations,
+};
+
+export function setup(): Data {
+  const authToken = getJwt();
+
+  const bodyFileContent = {
+    content: http.file(
+      "For performance testing purposes.",
+      "PerformanceTest.txt"
+    ),
+    cipherHash: "AAAA",
+    expiresAt: tomorrow().toJSON().slice(0, 10),
+    encryptedProperties: "AAAA",
+  };
+
+  const fileId = http
+    .post(`${apiEndpoint}/Files`, bodyFileContent, {
+      headers: {
+        Authorization: `Bearer ${authToken}`,
+      },
+    })
+    .json("result.id")!
+    .toString();
+
+  return {
+    authToken: authToken,
+    fileId: fileId,
+  };
+}
+
+export default function (data: Data): void {
+  describe("Get a File download:", () => {
+    const response = http.get(`${apiEndpoint}/Files/${data.fileId}`, {
+      headers: {
+        Authorization: `Bearer ${data.authToken}`,
+      },
+    });
+
+    expect(response.status, "response status").to.equal(200);
+  });
+}

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/src/get-metadata.test.ts

@@ -0,0 +1,77 @@
+import http from "k6/http";
+import { Options } from "k6/options";
+import {
+  describe,
+  expect,
+} from "https://jslib.k6.io/k6chaijs/4.3.4.2/index.js";
+import { getJwt, assertEnvVarExists, Size, tomorrow } from "./utils";
+
+assertEnvVarExists();
+
+const apiEndpoint = __ENV.HOST + "/api/v1";
+
+interface Data {
+  authToken: string;
+  fileId: string;
+}
+
+function size(): Size {
+  switch (__ENV.SIZE) {
+    case "S":
+      return { vus: 1, iterations: 10 };
+    case "M":
+      return { vus: 10, iterations: 50 };
+    case "L":
+      return { vus: 50, iterations: 100 };
+    default:
+      throw new Error("Invalid 'Size' value: " + __ENV.SIZE);
+  }
+}
+
+export const options: Options = {
+  vus: size().vus,
+  thresholds: {
+    http_req_duration: ["p(90)<50", "p(98)<100"],
+  },
+  iterations: size().iterations,
+};
+
+export function setup(): Data {
+  const authToken = getJwt();
+
+  const bodyFileContent = {
+    content: http.file(
+      "For performance testing purposes.",
+      "PerformanceTest.txt"
+    ),
+    cipherHash: "AAAA",
+    expiresAt: tomorrow().toJSON().slice(0, 10),
+    encryptedProperties: "AAAA",
+  };
+
+  const fileId = http
+    .post(`${apiEndpoint}/Files`, bodyFileContent, {
+      headers: {
+        Authorization: `Bearer ${authToken}`,
+      },
+    })
+    .json("result.id")!
+    .toString();
+
+  return {
+    authToken: authToken,
+    fileId: fileId,
+  };
+}
+
+export default function (data: Data): void {
+  describe("Get a File metadata:", () => {
+    const response = http.get(`${apiEndpoint}/Files/${data.fileId}/metadata`, {
+      headers: {
+        Authorization: `Bearer ${data.authToken}`,
+      },
+    });
+
+    expect(response.status, "response status").to.equal(200);
+  });
+}

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/src/get.test.ts

@@ -0,0 +1,52 @@
+import http from "k6/http";
+import { Options } from "k6/options";
+import {
+  describe,
+  expect,
+} from "https://jslib.k6.io/k6chaijs/4.3.4.2/index.js";
+import { getJwt, assertEnvVarExists, Size } from "./utils";
+
+assertEnvVarExists();
+
+const apiEndpoint = __ENV.HOST + "/api/v1";
+
+interface Data {
+  authToken: string;
+}
+
+function size(): Size {
+  switch (__ENV.SIZE) {
+    case "S":
+      return { vus: 1, iterations: 10 };
+    case "M":
+      return { vus: 10, iterations: 50 };
+    case "L":
+      return { vus: 50, iterations: 100 };
+    default:
+      throw new Error("Invalid 'Size' value: " + __ENV.SIZE);
+  }
+}
+
+export const options: Options = {
+  vus: size().vus,
+  thresholds: {
+    http_req_duration: ["p(90)<50", "p(98)<100"],
+  },
+  iterations: size().iterations,
+};
+
+export function setup(): Data {
+  return { authToken: getJwt() };
+}
+
+export default function (data: Data): void {
+  describe("Get list of Files:", () => {
+    const response = http.get(`${apiEndpoint}/Files`, {
+      headers: {
+        Authorization: `Bearer ${data.authToken}`,
+      },
+    });
+
+    expect(response.status, "response status").to.equal(200);
+  });
+}

Modules/Files/test/Files.API.Tests.Performance.EndToEnd/src/post-with-auth.test.ts

@@ -0,0 +1,62 @@
+import http from "k6/http";
+import { Options } from "k6/options";
+import {
+  describe,
+  expect,
+} from "https://jslib.k6.io/k6chaijs/4.3.4.2/index.js";
+import { getJwt, assertEnvVarExists, Size, tomorrow } from "./utils";
+
+assertEnvVarExists();
+
+const apiEndpoint = __ENV.HOST + "/api/v1";
+
+interface Data {
+  authToken: string;
+}
+
+function size(): Size {
+  switch (__ENV.SIZE) {
+    case "S":
+      return { vus: 1, iterations: 1 };
+    case "M":
+      return { vus: 2, iterations: 5 };
+    case "L":
+      return { vus: 3, iterations: 10 };
+    default:
+      throw new Error("Invalid 'Size' value: " + __ENV.SIZE);
+  }
+}
+
+export const options: Options = {
+  vus: size().vus,
+  thresholds: {
+    http_req_duration: ["p(90)<160", "p(98)<190"],
+  },
+  iterations: size().iterations,
+};
+
+export function setup(): Data {
+  return { authToken: getJwt() };
+}
+
+export default function (data: Data): void {
+  describe("Upload a File with Authentication:", () => {
+    const bodyFileContent = {
+      content: http.file(
+        "For performance testing purposes.",
+        "PerformanceTest.txt"
+      ),
+      cipherHash: "AAAA",
+      expiresAt: tomorrow().toJSON().slice(0, 10),
+      encryptedProperties: "AAAA",
+    };
+
+    const response = http.post(`${apiEndpoint}/Files`, bodyFileContent, {
+      headers: {
+        Authorization: `Bearer ${data.authToken}`,
+      },
+    });
+
+    expect(response.status, "response status").to.equal(201);
+  });
+}