Updated to upload video file to suite

lib/cypressReporter.js

@@ -33,6 +33,7 @@ const { reporterEvents, testItemStatuses } = require('./constants');
 const { IPC_EVENTS } = require('./ipcEvents');
 const {
   getConfig,
+  getStringDifference,
   getLaunchStartObject,
   getSuiteStartObject,
   getSuiteEndObject,
@@ -64,6 +65,18 @@ class CypressReporter extends Mocha.reporters.Base {
       const configListener = (cypressFullConfig) => {
         CypressReporter.cypressConfig = cypressFullConfig;
         CypressReporter.calcTotalLaunches();
+
+        /* Set Test and Video Relative Paths to each other */
+        if (!cypressFullConfig.integrationFolder) cypressFullConfig.integrationFolder = 'cypress/integration';
+        if (!cypressFullConfig.videosFolder) cypressFullConfig.videosFolder = 'cypress/videos';
+        CypressReporter.cypressConfig.testRelPath = getStringDifference(cypressFullConfig.videosFolder, cypressFullConfig.integrationFolder);
+        if (!CypressReporter.cypressConfig.testRelPath.endsWith('\\') || !CypressReporter.cypressConfig.testRelPath.endsWith('/')) {
+          CypressReporter.cypressConfig.testRelPath += '/';
+        }
+        CypressReporter.cypressConfig.videoRelPath = getStringDifference(cypressFullConfig.integrationFolder, cypressFullConfig.videosFolder);
+        if (!CypressReporter.cypressConfig.videoRelPath.endsWith('\\') || !CypressReporter.cypressConfig.videoRelPath.endsWith('/')) {
+          CypressReporter.cypressConfig.videoRelPath += '/';
+        }
       };
       const logListener = (log) => this.worker.send({ event: reporterEvents.LOG, log });
       const launchLogListener = (log) =>
@@ -129,7 +142,7 @@ class CypressReporter extends Mocha.reporters.Base {
 
     this.runner.on(EVENT_SUITE_END, (suite) => {
       if (!suite.title) return;
-      this.worker.send({ event: EVENT_SUITE_END, suite: getSuiteEndObject(suite) });
+      this.worker.send({ event: EVENT_SUITE_END, suite: getSuiteEndObject(suite, CypressReporter.cypressConfig) });
     });
 
     this.runner.on(EVENT_TEST_BEGIN, (test) => {

lib/reporter.js

@@ -20,6 +20,7 @@ const {
   getFailedScreenshot,
   getPassedScreenshots,
   getCustomScreenshots,
+  getVideoFile,
   getTestStartObject,
   getTestEndObject,
   getHookStartObject,
@@ -112,6 +113,21 @@ class Reporter {
     const suiteId = this.testItemIds.get(suite.id);
     const suiteTestCaseId = this.suiteTestCaseIds.get(suite.title);
     const suiteStatus = this.suiteStatuses.get(suite.title);
+
+    const videoFileDetails = getVideoFile(suite.videoFile);
+    if (videoFileDetails) {
+      const sendVideoPromise = this.client.sendLog(
+        suiteId,
+        {
+          message: `Video recording of '${suite.title}' tests'`,
+          level: logLevels.INFO,
+          time: new Date().valueOf(),
+        },
+        videoFileDetails,
+      ).promise;
+      promiseErrorHandler(sendVideoPromise, 'Fail to save video');
+    }
+
     const finishTestItemPromise = this.client.finishTestItem(
       suiteId,
       Object.assign(

lib/utils.js

@@ -28,6 +28,20 @@ const base64Encode = (file) => {
   return Buffer.from(bitmap).toString('base64');
 };
 
+const getVideoFile = (videoFileName) => {
+  const videoFilePath = `**/${videoFileName}`
+  const videoFile = glob.sync(videoFilePath);
+  if (videoFile.length) {
+    return {
+      name: videoFilePath.split('/').pop(),
+      type: 'video/mp4',
+      content: base64Encode(videoFile[0]),
+    };
+  }
+
+  return undefined;
+}
+
 const getCustomScreenshots = (customScreenshotsFileNames, specFilePath) => {
   if (!customScreenshotsFileNames.length) return [];
 
@@ -121,13 +135,31 @@ const getConfig = (initialConfig) => {
   };
 };
 
+const getStringDifference = (stringA, stringB) => {
+  var stringAIndex = 0;
+  var stringBIndex = 0;
+  var result = "";
+
+  while (stringBIndex < stringB.length)
+  {
+      if (stringAIndex != stringBIndex || stringA[stringAIndex] != stringB[stringBIndex] || stringAIndex == stringA.length) {
+          result += stringB[stringBIndex];
+      } else {
+        stringAIndex++;
+      }
+      stringBIndex++;
+  }
+  return result;
+}
+
 const getLaunchStartObject = (config) => {
   const launchAttributes = (config.reporterOptions.attributes || []).concat(
     getSystemAttributes(config),
   );
 
   return {
     launch: config.reporterOptions.launch,
+    mode: config.reporterOptions.mode,
     description: config.reporterOptions.description,
     attributes: launchAttributes,
     rerun: config.reporterOptions.rerun,
@@ -147,9 +179,11 @@ const getSuiteStartObject = (suite, testFileName) => ({
   parentId: !suite.root ? suite.parent.id : undefined,
 });
 
-const getSuiteEndObject = (suite) => ({
+const getSuiteEndObject = (suite, cypressConfig) => ({
   id: suite.id,
   title: suite.title,
+  testFile: suite.parent.file,
+  videoFile: `${suite.parent.file.replace(cypressConfig.testRelPath, cypressConfig.videoRelPath)}.mp4`,
   endTime: new Date().valueOf(),
 });
 
@@ -263,9 +297,11 @@ const getTotalSpecs = ({
 };
 
 module.exports = {
+  getStringDifference,
   getFailedScreenshot,
   getPassedScreenshots,
   getCustomScreenshots,
+  getVideoFile,
   getAgentInfo,
   getCodeRef,
   getSystemAttributes,