Save command result values in Json Report. (#4258)

* Save command result values in Json Report.

* Small fix in saved file name.

* Fix result from new Element API commands not getting returned to asynctree and logged.

Also fixes a bug where the nodes from new Element API were getting resolved early due to which the following Nightwatch commands were getting added as child nodes of the last new Element API command.

lib/api/web-element/scoped-element.js

@@ -287,19 +287,23 @@ class ScopedWebElement {
 
     const createAction = (actions, webElement) => function () {
       if (isFunction(commandName)) {
-        return commandName(webElement, ...args).then((result) => {
-          node.deferred.resolve(result);
-        });
+        return commandName(webElement, ...args);
       }
 
-      return actions[commandName](webElement, ...args).then((result) => {
-        // eslint-disable-next-line no-prototype-builtins
-        node.deferred.resolve(result.hasOwnProperty('value') ? result.value : result);
-      });
+      return actions[commandName](webElement, ...args);
     };
 
     const node = this.queueAction({name: commandName, createAction});
 
+    // TODO: check what changes if we keep the original `getResult` instead of below.
+    node.getResult = function(result) {
+      // here, we resolve the node with `result.value` even if the result contains an error and status === -1
+      // which results in the command result to be `null` in test case as well, while the command actually failed.
+      // Is this expected? To return `null` result in case of failure as well?
+      // eslint-disable-next-line no-prototype-builtins
+      return result.hasOwnProperty('value') ? result.value : result;
+    };
+
     return node;
   }
 

lib/reporter/index.js

@@ -1,3 +1,4 @@
+const path = require('path');
 const Utils = require('../utils');
 const TestResults = require('./results.js');
 const SimplifiedReporter = require('./simplified.js');
@@ -217,6 +218,17 @@ class Reporter extends SimplifiedReporter {
           stack,
           beautifiedStack
         };
+
+        if (this.settings.reporter_options.save_command_result_value) {
+          if (Utils.isString(result.value) && result.value.length > 500) {
+            const filepath = path.join(this.settings.output_folder || '', 'tmp', this.testResults.uuid, `${node.fullName}_${Date.now()}.txt`);
+            commandResult.valuePath = filepath;
+
+            Utils.writeToFile(filepath, result.value);
+          } else {
+            commandResult.value = result.value;
+          }
+        }
       }
 
       if (this.shouldLogCommand(node)) {

lib/reporter/results.js

@@ -1,4 +1,5 @@
 const lodashMerge = require('lodash/merge');
+const uuid = require('uuid');
 const Utils = require('../utils');
 const {Logger} = Utils;
 
@@ -54,6 +55,7 @@ module.exports = class Results {
     this.name = opts.suiteName || '';
     this.tags = opts.tags || [];
     this.__retryTest = false;
+    this.__uuid = uuid.v4();
 
     this.initCount(allScreenedTests);
   }
@@ -103,6 +105,10 @@ module.exports = class Results {
     return this.getTestResult(testName, {returnFullResult: true});
   }
 
+  get uuid() {
+    return this.__uuid;
+  }
+
   /**
    * @param {TestCase} value
    */
@@ -234,6 +240,7 @@ module.exports = class Results {
       moduleKey,
       hasFailures: !this.testsPassed(),
       results: {
+        uuid: this.uuid,
         reportPrefix,
         assertionsCount: this.initialResult.assertions.length
       }

lib/settings/defaults.js

@@ -148,7 +148,10 @@ module.exports = {
     // The file name formatting to use while saving HTML report
     filename_format: null,
 
-    minimal_report_file_path: 'tests_output/minimal_report.json'
+    minimal_report_file_path: 'tests_output/minimal_report.json',
+
+    // Save command result values in Json report (inline or in separate file).
+    save_command_result_value: false
   },
 
   // A string or array of folders (excluding subfolders) where the tests are located.