oxygenhq · savkaoleg · Oct 21, 2021
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -48,6 +48,7 @@
   },
   "dependencies": {
     "@applitools/eyes-webdriverio": "5.31.9",
+    "@ffmpeg-installer/ffmpeg": "^1.1.0",
     "@lambdatest/node-rest-client": "1.0.0",
     "@oxygenhq/chrome-remote-interface": "0.30.0",
     "@oxygenhq/logger": "0.5.1",

diff --git a/src/core/OxygenCore.js b/src/core/OxygenCore.js
@@ -10,6 +10,7 @@ import StepResult from '../model/step-result';
 import OxygenEvents from './OxygenEvents';
 import oxutil from '../lib/util';
 import * as coreUtils from './utils';
+import { commandsWhichShouldBeExcludedTakeScreenshot } from './constants';
 import OxError from '../errors/OxygenError';
 import errorHelper from '../errors/helper';
 import STATUS from '../model/status.js';
@@ -64,7 +65,8 @@ const DEFAULT_CTX = {
 const DEFAULT_RESULT_STORE = {
     steps: [],
     logs: [],
-    har: null
+    har: null,
+    video: null
 };
 
 export default class Oxygen extends OxygenEvents {
@@ -205,6 +207,7 @@ export default class Oxygen extends OxygenEvents {
         this.resultStore.steps = [];
         this.resultStore.logs = [];
         this.har = null;
+        this.video = null;
     }
 
     async onBeforeCase(context) {
@@ -216,6 +219,7 @@ export default class Oxygen extends OxygenEvents {
             try {
                 module.onBeforeCase && await module.onBeforeCase(context);
                 module._iterationStart && await module._iterationStart();
+                await this._callServicesonBeforeCase(context, module);
             }
             catch (e) {
                 this.logger.error(`Failed to call "onBeforeCase" method of ${moduleName} module.`, e);
@@ -233,6 +237,7 @@ export default class Oxygen extends OxygenEvents {
                 // await for avoid stuck on *.dispose call
                 module.onAfterCase && await module.onAfterCase(error);
                 module._iterationEnd && await module._iterationEnd(error);
+                await this._callServicesonAfterCase(module);
             }
             catch (e) {
                 this.logger.error(`Failed to call "onAfterCase" method of ${moduleName} module.`, e);
@@ -782,6 +787,7 @@ export default class Oxygen extends OxygenEvents {
             step.stats = {};
         }
 
+        let doNotTryTakeScreenshot = false;
         if (err) {
             if (err && err.type && err.type === errorHelper.errorCode.ASSERT_PASSED) {
                 //ignore
@@ -805,11 +811,27 @@ export default class Oxygen extends OxygenEvents {
                         }
                         catch (e) {
                             // FIXME: indicate to user that an attempt to take a screenshot has failed
+                            doNotTryTakeScreenshot = true;
                         }
                     }
                 }
             }
         }
+
+        if (this.opts.video) {
+            if (
+                !doNotTryTakeScreenshot &&
+                ['web'].includes(moduleName) &&
+                commandsWhichShouldBeExcludedTakeScreenshot.includes(methodName)
+            ) {
+                try {
+                    module._saveScreenshot();
+                } catch (e) {
+                    this.logger.error('takeScreenshotSilent failed:', e);
+                }
+            }
+        }
+
         return step;
     }
 
@@ -905,6 +927,44 @@ export default class Oxygen extends OxygenEvents {
             }
         }
     }
+    async _callServicesonBeforeCase(context, module) {
+        if (!this || !this.services) {
+            return;
+        }
+        for (let serviceName in this.services) {
+            const service = this.services[serviceName];
+            if (!service) {
+                continue;
+            }
+            try {
+                if (service.onBeforeCase) {
+                    service.onBeforeCase(context, module);
+                }
+            }
+            catch (e) {
+                this.logger.error(`Failed to call "_callServicesonBeforeCase" method of ${serviceName} service.`, e);
+            }
+        }
+    }
+    async _callServicesonAfterCase(module) {
+        if (!this || !this.services) {
+            return;
+        }
+        for (let serviceName in this.services) {
+            const service = this.services[serviceName];
+            if (!service) {
+                continue;
+            }
+            try {
+                if (service.onAfterCase) {
+                    await service.onAfterCase(module);
+                }
+            }
+            catch (e) {
+                this.logger.error(`Failed to call "_callServicesonAfterCase" method of ${serviceName} service.`, e);
+            }
+        }
+    }
     _populateParametersValue(args) {
         if (!args || !Array.isArray(args) || args.length == 0) {
             return args;

diff --git a/src/core/constants.js b/src/core/constants.js
@@ -0,0 +1,35 @@
+const webCommands = [
+    'alertAccept',
+    'alertDismiss',
+    'back',
+    'clear',
+    'click',
+    'clickHidden',
+    'closeWindow',
+    'deleteCookies',
+    'deselect',
+    'doubleClick',
+    'dragAndDrop',
+    'execute',
+    'fileBrowse',
+    'isVisible',
+    'makeVisible',
+    'newWindow',
+    'open',
+    'point',
+    'pointJS',
+    'refresh',
+    'rightClick',
+    'rightClickActions',
+    'scrollToElement',
+    'select',
+    'selectFrame',
+    'selectWindow',
+    'sendKeys',
+    'setWindowSize',
+    'type'
+];
+
+export const commandsWhichShouldBeExcludedTakeScreenshot = [
+    ...webCommands
+];
diff --git a/src/lib/cli-util.js b/src/lib/cli-util.js
@@ -205,6 +205,7 @@ export function getCommandLineOptions(argv) {
         iterations : argv.i ? parseInt(argv.i) : (argv.iter ? parseInt(argv.iter) : null),
         debugPort: argv.dbgport || null,
         delay: argv.d || argv.delay || null,
+        video: argv.video ? argv.video === 'true' : false
     };
     // switch: --rf flag
     if (argv.rf && typeof argv.rf === 'string' && argv.rf.length > 0) {

diff --git a/src/lib/cli.js b/src/lib/cli.js
@@ -130,6 +130,7 @@ Web test options:
   -b, --browser={chrome|ie|safari|firefox}  Browser name. Default is chrome.
   -s, --server=SERVER_URL    Selenium hub URL. Default is http://localhost:4444/wd/hub.
       --reopen={true|false}  Reopen browser on each iteration. Default is false.
+      --video={true|false}   Enable/Disable video recording
 
 Mobile test options:
     -s, --server=SERVER_URL  Appium server URL. Default is http://localhost:4723/wd/hub.`);

diff --git a/src/model/case-result.js b/src/model/case-result.js
@@ -22,6 +22,7 @@ module.exports = function () {
         steps: [],    // array of step-result.js
         logs: [],
         har: null,
+        video: null,
         failure: null,
         context: null
     };

diff --git a/src/ox_modules/module-web.js b/src/ox_modules/module-web.js
@@ -58,7 +58,8 @@ import perfectoReporting from 'perfecto-reporting';
 import request from 'request';
 import mergeImages from '../lib/img-merge';
 import errorHelper from '../errors/helper';
-
+import fs from 'fs';
+import path from 'path';
 const MODULE_NAME = 'web';
 const DEFAULT_SELENIUM_URL = 'http://localhost:4444/wd/hub';
 const DEFAULT_BROWSER_NAME = 'chrome';
@@ -78,6 +79,7 @@ export default class WebModule extends WebDriverModule {
         this.errHelper = errHelper;
         // holds element operation timeout value
         this.waitForTimeout = DEFAULT_WAIT_TIMEOUT;
+        this.frameNumber = 0; // for video support
     }
 
     get name() {
@@ -563,6 +565,56 @@ export default class WebModule extends WebDriverModule {
         }
     }
 
+    async _saveScreenshot() {
+        const recordingPath = path.join(this.options.cwd, 'video');
+        this.createFolderIfNotExists(recordingPath);
+
+        const filename = this.frameNumber.toString().padStart(4, '0') + '.png';
+        const filePath = path.resolve(recordingPath, filename);
+
+        let error;
+        try {
+            if (
+                this.driver &&
+                this.driver.saveScreenshot
+            ) {
+                let retval;
+                this.driver.call(() => {
+                    return new Promise((resolve, reject) => {
+                        const waitUntilRetVal = this.driver.waitUntil(async() => {
+                            return await this.driver.saveScreenshot(filePath);
+                        },
+                        { timeout: 30*1000 });
+
+                        if (waitUntilRetVal && waitUntilRetVal.then) {
+                            waitUntilRetVal.then(() => {
+                                this.frameNumber++;
+                                resolve();
+                            }).catch((err) => {
+                                reject(err);
+                            });
+                        } else {
+                            this.frameNumber++;
+                            resolve();
+                        }
+                    });
+                });
+                return filePath;
+            }
+        } catch (e) {
+            this.logger.error('Cannot saveScreenshot', e);
+        }
+    }
+
+    createFolderIfNotExists(folderPath) {
+        try {
+            fs.mkdirSync(folderPath);
+        } catch (e) {
+            if ( e.code != 'EEXIST' ) throw e;
+        }
+        return folderPath;
+    }
+
     _adjustBrowserLog(log) {
         if (!log || typeof log !== 'object') {
             return null;

diff --git a/src/ox_reporters/html/tests-details.ejs b/src/ox_reporters/html/tests-details.ejs
@@ -52,6 +52,9 @@
                                             <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion" href="#collapse-<%=resultIndex%>-<%=suiteIndex%>-<%=caseIndex%>">
                                                 <%= caseResult.name %> (Iteration #<%= caseResult.iterationNum %>)</a>
                                                 <%- caseResult.status === 'passed' ? PASSED_LABEL : FAILED_LABEL %>
+                                                <% if (caseResult.video) { %>
+                                                    <a target="_blank" href="<%= caseResult.video %>">🎥 Video</a>
+                                                <% } %>
                                             </h3>
                                         </div>
                                         <div id="collapse-<%=resultIndex%>-<%=suiteIndex%>-<%=caseIndex%>" class="panel-collapse collapse in">

diff --git a/src/ox_reporters/reporter-html.js b/src/ox_reporters/reporter-html.js
@@ -91,6 +91,7 @@ export default class HtmlReporter extends FileReporterBase {
         const resultFolderPath = path.dirname(resultFilePath);
 
         this.replaceScreenshotsWithFiles(results, resultFolderPath);
+        this.moveVideoToReports(results, resultFolderPath);
         this.formatTotalDuration(results);
 
         const templatePath = path.join(__dirname, '../ox_reporters/html/index.ejs');