feat(experimental): video attachment upload

DamianOsipiuk · Jun 11, 2021 · 729a251 · 729a251
1 parent 8528439
commit 729a251
Show file tree

Hide file tree

Showing 8 changed files with 154 additions and 28 deletions.
diff --git a/src/config.ts b/src/config.ts
@@ -66,6 +66,10 @@ export const prepareConfig = (options: Config = {} as Config): Config => {
       process.env.TESTRAIL_UPLOAD_SCREENSHOTS == "true" ||
       config.uploadScreenshots ||
       false,
+    uploadVideos:
+      process.env.TESTRAIL_UPLOAD_VIDEOS == "true" ||
+      config.uploadVideos ||
+      false,
     updateRunTestCases:
       process.env.TESTRAIL_UPDATE_RUN_TEST_CASES == "true" ||
       config.updateRunTestCases !== false,

diff --git a/src/index.ts b/src/index.ts
@@ -2,13 +2,20 @@ import moment from "moment";
 import { TestRail, TestStatus, Run, AddResultForCase } from "testrail-js-api";
 
 import { prepareConfig, verifyConfig } from "./config";
-import { prepareReference, prepareReportName, throwOnApiError } from "./utils";
+import {
+  prepareReference,
+  prepareReportName,
+  throwOnApiError,
+  uploadScreenshots,
+  uploadVideos,
+} from "./utils";
 import type {
   Config,
   Meta,
   Screenshot,
   TaskResult,
   TestRunInfo,
+  Video,
 } from "./types";
 
 const Status = {
@@ -132,6 +139,9 @@ class TestcafeTestrailReporter {
   screenshots: {
     [key: string]: Screenshot[];
   };
+  videos: {
+    [key: string]: Video[];
+  };
 
   constructor() {
     this.config = prepareConfig();
@@ -141,6 +151,7 @@ class TestcafeTestrailReporter {
     this.noColors = false;
     this.results = [];
     this.screenshots = {};
+    this.videos = {};
   }
 
   reportTaskStart = async (_startTime: number, userAgents: string[]) => {
@@ -195,6 +206,9 @@ class TestcafeTestrailReporter {
       if (testRunInfo.screenshots.length) {
         this.screenshots[caseId] = testRunInfo.screenshots;
       }
+      if (testRunInfo.videos?.length) {
+        this.videos[caseId] = testRunInfo.videos;
+      }
     } else {
       console.log(
         `[TestRail] Test missing the TestRail Case ID in test metadata: ${name}`
@@ -266,32 +280,23 @@ class TestcafeTestrailReporter {
     );
     const { value: tests } = await throwOnApiError(testrailAPI.getTests(runId));
 
-    if (this.config.uploadScreenshots) {
-      console.log("[TestRail] Uploading screenshots...");
-      for (let i = 0; i < resultsToPush.length; i++) {
-        const test = tests.find(
-          (test) => test.case_id === resultsToPush[i].case_id
-        );
-        const result = results.find((result) => result.test_id === test?.id);
-        if (result) {
-          const screenshots = this.screenshots[resultsToPush[i].case_id];
-          if (screenshots) {
-            for (let j = 0; j < screenshots.length; j++) {
-              await throwOnApiError(
-                testrailAPI.addAttachmentToResult(
-                  result.id,
-                  screenshots[j].screenshotPath
-                )
-              );
-            }
-          }
-        } else {
-          console.error(
-            `[TestRail] Could not upload screenshot for a failed test. Case ID: ${resultsToPush[i].caseId}. Test ID: ${test?.id}`
-          );
-        }
-      }
-    }
+    uploadScreenshots({
+      config: this.config,
+      tests,
+      results,
+      resultsToPush,
+      screenshots: this.screenshots,
+      testrailAPI,
+    });
+
+    uploadVideos({
+      config: this.config,
+      tests,
+      results,
+      resultsToPush,
+      videos: this.videos,
+      testrailAPI,
+    });
 
     if (results.length == 0) {
       console.log("[TestRail] No data has been published to TestRail");

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -15,6 +15,7 @@ export interface Config<T = number> {
   caseMeta: string;
   runCloseAfterDays?: number;
   uploadScreenshots: boolean;
+  uploadVideos: boolean;
   updateRunTestCases: boolean;
 }
 
@@ -36,13 +37,18 @@ export interface Screenshot {
   takenOnFail: boolean;
 }
 
+export interface Video {
+  videoPath: string;
+}
+
 export interface TestRunInfo {
   errs: Record<string, unknown>[];
   warnings: string[];
   durationMs: number;
   unstable: boolean;
   screenshotPath: string;
   screenshots: Screenshot[];
+  videos: Video[];
   quarantine: { [key: string]: { passed: boolean } };
   skipped: boolean;
 }
diff --git a/src/utils/index.ts b/src/utils/index.ts
@@ -0,0 +1,3 @@
+export { uploadScreenshots } from "./upload-screenshots";
+export { uploadVideos } from "./upload-videos";
+export { prepareReference, prepareReportName, throwOnApiError } from "./utils";
diff --git a/src/utils/upload-screenshots.ts b/src/utils/upload-screenshots.ts
@@ -0,0 +1,51 @@
+import { TestRail, AddResultForCase, Test, Result } from "testrail-js-api";
+
+import { throwOnApiError } from "../utils";
+import type { Config, Screenshot } from "../types";
+
+type UploadScreenshots = (options: {
+  config: Config;
+  tests: Test[];
+  results: Result[];
+  resultsToPush: AddResultForCase[];
+  screenshots: {
+    [key: string]: Screenshot[];
+  };
+  testrailAPI: TestRail;
+}) => void;
+
+export const uploadScreenshots: UploadScreenshots = async ({
+  config,
+  tests,
+  results,
+  resultsToPush,
+  screenshots,
+  testrailAPI,
+}) => {
+  if (config.uploadScreenshots) {
+    console.log("[TestRail] Uploading screenshots...");
+    for (let i = 0; i < resultsToPush.length; i++) {
+      const test = tests.find(
+        (test) => test.case_id === resultsToPush[i].case_id
+      );
+      const result = results.find((result) => result.test_id === test?.id);
+      if (result) {
+        const screenshotList = screenshots[resultsToPush[i].case_id];
+        if (screenshotList) {
+          for (let j = 0; j < screenshotList.length; j++) {
+            await throwOnApiError(
+              testrailAPI.addAttachmentToResult(
+                result.id,
+                screenshotList[j].screenshotPath
+              )
+            );
+          }
+        }
+      } else {
+        console.error(
+          `[TestRail] Could not upload screenshot for a failed test. Case ID: ${resultsToPush[i].caseId}. Test ID: ${test?.id}`
+        );
+      }
+    }
+  }
+};
diff --git a/src/utils/upload-videos.ts b/src/utils/upload-videos.ts
@@ -0,0 +1,51 @@
+import { TestRail, AddResultForCase, Test, Result } from "testrail-js-api";
+
+import { throwOnApiError } from "../utils";
+import type { Config, Video } from "../types";
+
+type UploadVideos = (options: {
+  config: Config;
+  tests: Test[];
+  results: Result[];
+  resultsToPush: AddResultForCase[];
+  videos: {
+    [key: string]: Video[];
+  };
+  testrailAPI: TestRail;
+}) => void;
+
+export const uploadVideos: UploadVideos = async ({
+  config,
+  tests,
+  results,
+  resultsToPush,
+  videos,
+  testrailAPI,
+}) => {
+  if (config.uploadVideos) {
+    console.log("[TestRail] Uploading videos...");
+    for (let i = 0; i < resultsToPush.length; i++) {
+      const test = tests.find(
+        (test) => test.case_id === resultsToPush[i].case_id
+      );
+      const result = results.find((result) => result.test_id === test?.id);
+      if (result) {
+        const videoList = videos[resultsToPush[i].case_id];
+        if (videoList) {
+          for (let j = 0; j < videoList.length; j++) {
+            await throwOnApiError(
+              testrailAPI.addAttachmentToResult(
+                result.id,
+                videoList[j].videoPath
+              )
+            );
+          }
+        }
+      } else {
+        console.error(
+          `[TestRail] Could not upload videos for a failed test. Case ID: ${resultsToPush[i].caseId}. Test ID: ${test?.id}`
+        );
+      }
+    }
+  }
+};
diff --git a/src/utils.ts → src/utils/utils.ts b/src/utils.ts → src/utils/utils.ts
@@ -1,7 +1,7 @@
 import moment from "moment";
 import { Response } from "node-fetch";
 
-import type { Config } from "./types";
+import type { Config } from "../types";
 
 export async function throwOnApiError<
   T extends { response: Response; value: unknown }

diff --git a/tests/config/prepareConfig.test.ts b/tests/config/prepareConfig.test.ts
@@ -26,6 +26,7 @@ const defaultConfig = {
   suiteId: 0,
   updateRunTestCases: true,
   uploadScreenshots: false,
+  uploadVideos: false,
   user: undefined,
 };
 
@@ -46,6 +47,7 @@ const envConfig = {
   TESTRAIL_CASE_META: "meta",
   TESTRAIL_RUN_CLOSE_AFTER_DAYS: 111,
   TESTRAIL_UPLOAD_SCREENSHOTS: "true",
+  TESTRAIL_UPLOAD_VIDEOS: "true",
   TESTRAIL_UPDATE_RUN_TEST_CASES: "true",
 };
 
@@ -66,6 +68,7 @@ const fileConfig = {
   suiteId: "4444",
   updateRunTestCases: true,
   uploadScreenshots: false,
+  uploadVideos: false,
   user: "user2",
 };
 
@@ -144,6 +147,7 @@ describe("prepareConfig", () => {
       suiteId: 234,
       updateRunTestCases: true,
       uploadScreenshots: true,
+      uploadVideos: true,
       user: "user",
     });
   });
@@ -170,6 +174,7 @@ describe("prepareConfig", () => {
       suiteId: 4444,
       updateRunTestCases: true,
       uploadScreenshots: false,
+      uploadVideos: false,
       user: "user2",
     });
   });
@@ -197,6 +202,7 @@ describe("prepareConfig", () => {
       suiteId: 234,
       updateRunTestCases: true,
       uploadScreenshots: true,
+      uploadVideos: true,
       user: "user",
     });
   });