fix: add saveErrorDetails option, unit-test, fix readme

gemini-testing · Sep 27, 2019 · 043b4b7 · 043b4b7
1 parent 5c374b5
commit 043b4b7
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,7 @@ Plugin has following configuration:
 * **path** (optional) `String` - path to directory for saving html report file; by
 default html report will be saved into `gemini-report/index.html` inside current work
 directory.
+* **saveErrorDetails** (optional) `Boolean` – save/don't save error details to json-files (to error-details folder); `false` by default
 * **defaultView** (optional) `String` - default view mode. Available values are:
   * `all` - show all tests. Default value.
   * `failed` - show only failed tests.

diff --git a/lib/config.js b/lib/config.js
@@ -76,6 +76,12 @@ const getParser = () => {
             defaultValue: 'html-report',
             validate: assertString('path')
         }),
+        saveErrorDetails: option({
+            defaultValue: false,
+            parseEnv: JSON.parse,
+            parseCli: JSON.parse,
+            validate: assertBoolean('saveErrorDetails')
+        }),
         defaultView: option({
             defaultValue: configDefaults.defaultView,
             validate: assertString('defaultView')

diff --git a/lib/constants/defaults.js b/lib/constants/defaults.js
@@ -3,6 +3,7 @@
 module.exports = {
     CIRCLE_RADIUS: 150,
     config: {
+        saveErrorDetails: false,
         defaultView: 'all',
         baseHost: '',
         scaleImages: false,

diff --git a/lib/report-builder-factory/report-builder.js b/lib/report-builder-factory/report-builder.js
@@ -119,7 +119,7 @@ module.exports = class ReportBuilder {
             browserId, suite, sessionId, description, imagesInfo, screenshot, multipleTabs, errorDetails
         } = result;
 
-        const {baseHost} = this._pluginConfig;
+        const {baseHost, saveErrorDetails} = this._pluginConfig;
         const suiteUrl = suite.getUrl({browserId, baseHost});
         const metaInfo = _.merge(_.cloneDeep(result.meta), {url: suite.fullUrl, file: suite.file, sessionId});
 
@@ -128,7 +128,7 @@ module.exports = class ReportBuilder {
             screenshot: Boolean(screenshot), multipleTabs
         }, props);
 
-        if (errorDetails) {
+        if (saveErrorDetails && errorDetails) {
             testResult.errorDetails = _.pick(errorDetails, ['title', 'filePath']);
         }
 

diff --git a/lib/test-adapter/hermione-test-adapter.js b/lib/test-adapter/hermione-test-adapter.js
@@ -145,7 +145,7 @@ module.exports = class HermioneTestResultAdapter extends TestAdapter {
     }
 
     get errorDetails() {
-        if (this._errorDetails !== undefined) {
+        if (!_.isUndefined(this._errorDetails)) {
             return this._errorDetails;
         }
 

diff --git a/test/unit/lib/config.js b/test/unit/lib/config.js
@@ -68,6 +68,30 @@ describe('config', () => {
         });
     });
 
+    describe('"saveErrorDetails" option', () => {
+        it('should be false by default', () => {
+            assert.isFalse(parseConfig({}).saveErrorDetails);
+        });
+
+        it('should set from configuration file', () => {
+            const config = parseConfig({saveErrorDetails: true});
+
+            assert.isTrue(config.saveErrorDetails);
+        });
+
+        it('should set from environment variable', () => {
+            process.env['html_reporter_save_error_details'] = 'true';
+
+            assert.isTrue(parseConfig({}).saveErrorDetails);
+        });
+
+        it('should set from cli', () => {
+            process.argv = process.argv.concat('--html-reporter-save-error-details', 'true');
+
+            assert.isTrue(parseConfig({}).saveErrorDetails);
+        });
+    });
+
     describe('"defaultView" option', () => {
         it('should show all suites by default', () => {
             assert.equal(parseConfig({}).defaultView, 'all');

diff --git a/test/unit/lib/report-builder-factory/report-builder.js b/test/unit/lib/report-builder-factory/report-builder.js
@@ -208,6 +208,34 @@ describe('ReportBuilder', () => {
         });
     });
 
+    it('should add error details to result if saveErrorDetails is set', () => {
+        const reportBuilder = mkReportBuilder_({pluginConfig: {saveErrorDetails: true}});
+
+        reportBuilder.addFail(stubTest_({
+            errorDetails: {title: 'some-title', filePath: 'some-path'}
+        }));
+
+        assert.match(getReportBuilderResult_(reportBuilder), {
+            errorDetails: {
+                title: 'some-title', filePath: 'some-path'
+            }
+        });
+    });
+
+    it('should not add error details to result if saveErrorDetails is not set', () => {
+        const reportBuilder = mkReportBuilder_({pluginConfig: {saveErrorDetails: false}});
+
+        reportBuilder.addFail(stubTest_({
+            errorDetails: {title: 'some-title', filePath: 'some-path'}
+        }));
+
+        assert.notDeepInclude(getReportBuilderResult_(reportBuilder), {
+            errorDetails: {
+                title: 'some-title', filePath: 'some-path'
+            }
+        });
+    });
+
     it('should add error test to result', () => {
         const reportBuilder = mkReportBuilder_();