Allow disabling plugin

lib/constants.js

@@ -61,10 +61,16 @@ const reporterEvents = {
   SET_LAUNCH_STATUS: 'setLaunchStatus',
 };
 
+const requiredReporterOptions = ['token', 'endpoint', 'launch', 'project'];
+// cypress-multi-reporter uses camel cased package name
+const reporterMultiReporterKey = 'reportportalAgentJsCypressReporterOptions';
+
 module.exports = {
   testItemStatuses,
   logLevels,
   entityType,
   hookTypesMap,
   reporterEvents,
+  requiredReporterOptions,
+  reporterMultiReporterKey,
 };

lib/cypressReporter.js

@@ -40,6 +40,7 @@ const {
   getTestInfo,
   getHookInfo,
   getTotalSpecs,
+  validateConfig,
 } = require('./utils');
 
 const { FAILED } = testItemStatuses;
@@ -48,7 +49,16 @@ class CypressReporter extends Mocha.reporters.Base {
   constructor(runner, initialConfig) {
     super(runner);
     this.runner = runner;
+
+    try {
+      validateConfig(initialConfig);
+    } catch (error) {
+      // do not continue on error
+      return;
+    }
+
     const config = getConfig(initialConfig);
+
     CypressReporter.currentLaunch += 1;
     CypressReporter.reporterOptions = config.reporterOptions;
 

lib/plugin/index.js

@@ -17,44 +17,56 @@
 const ipc = require('node-ipc');
 const { connectIPCClient } = require('./ipcClient');
 const { IPC_EVENTS } = require('./../ipcEvents');
+const { prepareReporterOptions, validateConfig } = require('./../utils');
 
 const registerReportPortalPlugin = (on, config) => {
-  connectIPCClient(config);
+  try {
+    validateConfig(config);
+    connectIPCClient(prepareReporterOptions(config));
+  } catch (error) {
+    console.log(`Report Portal plugin disabled. ${error}`);
+  }
+
+  const emit = (event, value) => {
+    if (ipc && ipc.of && ipc.of.reportportal) {
+      ipc.of.reportportal.emit(event, value);
+    }
+  };
 
   on('task', {
     rp_Log(log) {
-      ipc.of.reportportal.emit(IPC_EVENTS.LOG, log);
+      emit(IPC_EVENTS.LOG, log);
       return null;
     },
     rp_launchLog(log) {
-      ipc.of.reportportal.emit(IPC_EVENTS.LAUNCH_LOG, log);
+      emit(IPC_EVENTS.LAUNCH_LOG, log);
       return null;
     },
     rp_addTestAttributes(attributes) {
-      ipc.of.reportportal.emit(IPC_EVENTS.ADD_ATTRIBUTES, attributes);
+      emit(IPC_EVENTS.ADD_ATTRIBUTES, attributes);
       return null;
     },
     rp_setTestDescription(description) {
-      ipc.of.reportportal.emit(IPC_EVENTS.SET_DESCRIPTION, description);
+      emit(IPC_EVENTS.SET_DESCRIPTION, description);
       return null;
     },
     rp_setTestCaseId(testCaseIdInfo) {
-      ipc.of.reportportal.emit(IPC_EVENTS.SET_TEST_CASE_ID, testCaseIdInfo);
+      emit(IPC_EVENTS.SET_TEST_CASE_ID, testCaseIdInfo);
       return null;
     },
     rp_screenshot(screenshotInfo) {
       ipc.of.reportportal.emit(IPC_EVENTS.CUSTOM_SCREENSHOT, screenshotInfo);
       return null;
     },
     rp_setStatus(statusInfo) {
-      ipc.of.reportportal.emit(IPC_EVENTS.SET_STATUS, statusInfo);
+      emit(IPC_EVENTS.SET_STATUS, statusInfo);
       return null;
     },
     rp_setLaunchStatus(statusInfo) {
-      ipc.of.reportportal.emit(IPC_EVENTS.SET_LAUNCH_STATUS, statusInfo);
+      emit(IPC_EVENTS.SET_LAUNCH_STATUS, statusInfo);
       return null;
     },
   });
 };
 
-module.exports = registerReportPortalPlugin;
+module.exports = { registerReportPortalPlugin };

lib/utils.js

@@ -18,8 +18,14 @@ const fs = require('fs');
 const glob = require('glob');
 const path = require('path');
 const minimatch = require('minimatch');
-const { entityType, hookTypesMap, testItemStatuses } = require('./constants');
+const {
+  entityType,
+  hookTypesMap,
+  testItemStatuses,
+  reporterMultiReporterKey,
+} = require('./constants');
 const pjson = require('./../package.json');
+const { requiredReporterOptions } = require('./constants');
 
 const { FAILED, PASSED, SKIPPED } = testItemStatuses;
 
@@ -101,6 +107,7 @@ const getSystemAttributes = (config) => {
 };
 
 const getConfig = (initialConfig) => {
+  if (!initialConfig) return initialConfig;
   const attributes = initialConfig.reporterOptions.attributes || [];
 
   if (
@@ -121,6 +128,40 @@ const getConfig = (initialConfig) => {
   };
 };
 
+const validateConfig = (config) => {
+  if (!config || !config.reporterOptions) throw new Error(`Undefined configuration.`);
+
+  let options = config.reporterOptions[reporterMultiReporterKey];
+  if (!options) {
+    options = config.reporterOptions;
+  }
+
+  if (
+    !requiredReporterOptions.every(
+      (prop) => Object.prototype.hasOwnProperty.call(options, prop) && options[prop],
+    )
+  ) {
+    throw new Error(`Missing required config option. Required options: ${requiredReporterOptions}`);
+  }
+};
+
+const prepareReporterOptions = (config) => {
+  // copy this options from cypess config to report portal options
+  const passthroughOptions = {
+    videosFolder: config.videosFolder,
+    screenshotsFolder: config.screenshotsFolder,
+    videoUploadOnPasses: config.videoUploadOnPasses,
+  };
+
+  return {
+    ...config,
+    reporterOptions: {
+      ...passthroughOptions,
+      ...config.reporterOptions,
+    },
+  };
+};
+
 const getLaunchStartObject = (config) => {
   const launchAttributes = (config.reporterOptions.attributes || []).concat(
     getSystemAttributes(config),
@@ -292,6 +333,8 @@ module.exports = {
   getHookStartObject,
   getTotalSpecs,
   getConfig,
+  prepareReporterOptions,
+  validateConfig,
   getExcludeSpecPattern,
   getFixtureFolderPattern,
   getSpecPattern,

test/utils.test.js

@@ -20,8 +20,10 @@ const {
   getFixtureFolderPattern,
   getExcludeSpecPattern,
   getSpecPattern,
+  validateConfig,
 } = require('./../lib/utils');
 const pjson = require('./../package.json');
+const { reporterMultiReporterKey } = require('./../lib/constants');
 
 const { RealDate, MockedDate, currentDate, getDefaultConfig } = require('./mock/mock');
 
@@ -301,6 +303,47 @@ describe('utils script', () => {
       });
     });
 
+    describe('validateReporterOptions', function() {
+      it('should not throw if has all required options', function() {
+        const config = getDefaultConfig();
+        expect(() => {
+          validateConfig(config);
+        }).not.toThrow();
+      });
+
+      it('should not throw if configured by cypress-multi-reporter', function() {
+        const config = {
+          reporterOptions: {
+            reporterEnabled: `@twi/agent-js-cypress, spec`,
+            [reporterMultiReporterKey]: getDefaultConfig().reporterOptions,
+          },
+        };
+        expect(() => {
+          validateConfig(config);
+        }).not.toThrow();
+      });
+
+      it('should throw error if config is undefined', function() {
+        const config = undefined;
+        expect(() => {
+          validateConfig(config);
+        }).toThrow();
+
+        const configWithoutReporterOptions = {};
+        expect(() => {
+          validateConfig(configWithoutReporterOptions);
+        }).toThrow();
+      });
+
+      it('should throw error if required option is missing', function() {
+        const initialConfig = { ...getDefaultConfig() };
+        initialConfig.reporterOptions.token = undefined;
+        expect(() => {
+          validateConfig(initialConfig);
+        }).toThrow();
+      });
+    });
+
     describe('getLaunchStartObject', () => {
       test('should return start launch object with correct values', () => {
         const expectedStartLaunchObject = {