codeceptjs 4.0.0-beta.3 → 4.0.0-beta.5

package/lib/mocha/ui.js

@@ -0,0 +1,232 @@
+const escapeRe = require('escape-string-regexp')
+const { test, setup, teardown, suiteSetup, suiteTeardown, injected } = require('./asyncWrapper')
+const ScenarioConfig = require('./scenarioConfig')
+const FeatureConfig = require('./featureConfig')
+const addDataContext = require('../data/context')
+const { createTest } = require('./test')
+const { createSuite } = require('./suite')
+const { HookConfig, AfterSuiteHook, AfterHook, BeforeSuiteHook, BeforeHook } = require('./hooks')
+
+const setContextTranslation = context => {
+  const container = require('../container')
+  const contexts = container.translation().value('contexts')
+
+  if (contexts) {
+    for (const key of Object.keys(contexts)) {
+      if (context[key]) {
+        context[contexts[key]] = context[key]
+      }
+    }
+  }
+}
+
+/**
+ * Codecept-style interface:
+ *
+ * Feature('login');
+ *
+ * Scenario('login as regular user', ({I}) {
+ *   I.fillField();
+ *   I.click();
+ *   I.see('Hello, '+data.login);
+ * });
+ *
+ * @param {Mocha.Suite} suite Root suite.
+ * @ignore
+ */
+module.exports = function (suite) {
+  const suites = [suite]
+  suite.timeout(0)
+  let afterAllHooks
+  let afterEachHooks
+  let afterAllHooksAreLoaded
+  let afterEachHooksAreLoaded
+
+  suite.on('pre-require', (context, file, mocha) => {
+    const common = require('mocha/lib/interfaces/common')(suites, context, mocha)
+
+    const addScenario = function (title, opts = {}, fn) {
+      const suite = suites[0]
+
+      if (typeof opts === 'function' && !fn) {
+        fn = opts
+        opts = {}
+      }
+      if (suite.pending) {
+        fn = null
+      }
+      const test = createTest(title, fn)
+      test.file = file
+      test.addToSuite(suite)
+      test.applyOptions(opts)
+
+      return new ScenarioConfig(test)
+    }
+
+    // create dispatcher
+
+    context.BeforeAll = common.before
+    context.AfterAll = common.after
+
+    context.run = mocha.options.delay && common.runWithSuite(suite)
+    /**
+     * Describe a "suite" with the given `title`
+     * and callback `fn` containing nested suites
+     * and/or tests.
+     * @global
+     * @param {string} title
+     * @param {Object<string, *>} [opts]
+     * @returns {FeatureConfig}
+     */
+
+    context.Feature = function (title, opts) {
+      if (suites.length > 1) {
+        suites.shift()
+      }
+
+      afterAllHooks = []
+      afterEachHooks = []
+      afterAllHooksAreLoaded = false
+      afterEachHooksAreLoaded = false
+
+      const suite = createSuite(suites[0], title)
+      suite.applyOptions(opts)
+
+      suite.file = file
+      suites.unshift(suite)
+      suite.beforeEach('codeceptjs.before', () => setup(suite))
+      afterEachHooks.push(['finalize codeceptjs', () => teardown(suite)])
+
+      suite.beforeAll('codeceptjs.beforeSuite', () => suiteSetup(suite))
+      afterAllHooks.push(['codeceptjs.afterSuite', () => suiteTeardown(suite)])
+
+      return new FeatureConfig(suite)
+    }
+
+    /**
+     * Exclusive test suite - runs only this feature.
+     * @global
+     * @kind constant
+     * @type {CodeceptJS.IFeature}
+     */
+    context.Feature.only = function (title, opts) {
+      const reString = `^${escapeRe(`${title}:`)}`
+      mocha.grep(new RegExp(reString))
+      process.env.FEATURE_ONLY = true
+      return context.Feature(title, opts)
+    }
+
+    /**
+     * Pending test suite.
+     * @global
+     * @kind constant
+     * @type {CodeceptJS.IFeature}
+     */
+    context.xFeature = context.Feature.skip = function (title, opts) {
+      const skipInfo = {
+        skipped: true,
+        message: 'Skipped due to "skip" on Feature.',
+      }
+      return context.Feature(title, { ...opts, skipInfo })
+    }
+
+    context.BeforeSuite = function (fn) {
+      suites[0].beforeAll('BeforeSuite', injected(fn, suites[0], 'beforeSuite'))
+      return new HookConfig(new BeforeSuiteHook({ suite: suites[0] }))
+    }
+
+    context.AfterSuite = function (fn) {
+      afterAllHooks.unshift(['AfterSuite', injected(fn, suites[0], 'afterSuite')])
+      return new HookConfig(new AfterSuiteHook({ suite: suites[0] }))
+    }
+
+    context.Background = context.Before = function (fn) {
+      suites[0].beforeEach('Before', injected(fn, suites[0], 'before'))
+      return new HookConfig(new BeforeHook({ suite: suites[0] }))
+    }
+
+    context.After = function (fn) {
+      afterEachHooks.unshift(['After', injected(fn, suites[0], 'after')])
+      return new HookConfig(new AfterHook({ suite: suites[0] }))
+    }
+
+    /**
+     * Describe a specification or test-case
+     * with the given `title` and callback `fn`
+     * acting as a thunk.
+     * @ignore
+     */
+    context.Scenario = addScenario
+    /**
+     * Exclusive test-case.
+     * @ignore
+     */
+    context.Scenario.only = function (title, opts, fn) {
+      const reString = `^${escapeRe(`${suites[0].title}: ${title}`.replace(/( \| {.+})?$/g, ''))}`
+      mocha.grep(new RegExp(reString))
+      process.env.SCENARIO_ONLY = true
+      return addScenario(title, opts, fn)
+    }
+
+    /**
+     * Pending test case.
+     * @global
+     * @kind constant
+     * @type {CodeceptJS.IScenario}
+     */
+    context.xScenario = context.Scenario.skip = function (title, opts = {}, fn) {
+      if (typeof opts === 'function' && !fn) {
+        opts = {}
+      }
+
+      return context.Scenario(title, opts)
+    }
+
+    /**
+     * Pending test case with message: 'Test not implemented!'.
+     * @global
+     * @kind constant
+     * @type {CodeceptJS.IScenario}
+     */
+    context.Scenario.todo = function (title, opts = {}, fn) {
+      if (typeof opts === 'function' && !fn) {
+        fn = opts
+        opts = {}
+      }
+
+      const skipInfo = {
+        message: 'Test not implemented!',
+        description: fn ? fn.toString() : '',
+      }
+
+      return context.Scenario(title, { ...opts, skipInfo })
+    }
+
+    /**
+     * For translation
+     */
+
+    setContextTranslation(context)
+
+    addDataContext(context)
+  })
+
+  suite.on('post-require', () => {
+    /**
+     * load hooks from arrays to suite to prevent reordering
+     */
+    if (!afterEachHooksAreLoaded && Array.isArray(afterEachHooks)) {
+      afterEachHooks.forEach(hook => {
+        suites[0].afterEach(hook[0], hook[1])
+      })
+      afterEachHooksAreLoaded = true
+    }
+
+    if (!afterAllHooksAreLoaded && Array.isArray(afterAllHooks)) {
+      afterAllHooks.forEach(hook => {
+        suites[0].afterAll(hook[0], hook[1])
+      })
+      afterAllHooksAreLoaded = true
+    }
+  })
+}

package/lib/output.js

@@ -1,5 +1,6 @@
-const colors = require('chalk');
-const figures = require('figures');
+const colors = require('chalk')
+const figures = require('figures')
+const { maskSensitiveData } = require('invisi-data')
 
 const styles = {
   error: colors.bgRed.white.bold,
@@ -9,11 +10,12 @@ const styles = {
   debug: colors.cyan,
   log: colors.grey,
   bold: colors.bold,
-};
+  section: colors.white.dim.bold,
+}
 
-let outputLevel = 0;
-let outputProcess = '';
-let newline = true;
+let outputLevel = 0
+let outputProcess = ''
+let newline = true
 
 /**
  * @alias output
@@ -27,7 +29,7 @@ module.exports = {
   stepShift: 0,
 
   standWithUkraine() {
-    return `#${colors.bold.yellow('StandWith')}${colors.bold.cyan('Ukraine')}`;
+    return `#${colors.bold.yellow('StandWith')}${colors.bold.cyan('Ukraine')}`
   },
 
   /**
@@ -36,8 +38,8 @@ module.exports = {
    * @returns {number}
    */
   level(level) {
-    if (level !== undefined) outputLevel = level;
-    return outputLevel;
+    if (level !== undefined) outputLevel = level
+    return outputLevel
   },
 
   /**
@@ -47,9 +49,9 @@ module.exports = {
    * @returns {string}
    */
   process(process) {
-    if (process === null) return outputProcess = '';
-    if (process) outputProcess = String(process).length === 1 ? `[0${process}]` : `[${process}]`;
-    return outputProcess;
+    if (process === null) return (outputProcess = '')
+    if (process) outputProcess = String(process).length === 1 ? `[0${process}]` : `[${process}]`
+    return outputProcess
   },
 
   /**
@@ -57,8 +59,9 @@ module.exports = {
    * @param {string} msg
    */
   debug(msg) {
+    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 2) {
-      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${msg}`));
+      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${_msg}`))
     }
   },
 
@@ -67,8 +70,9 @@ module.exports = {
    * @param {string} msg
    */
   log(msg) {
+    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 3) {
-      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${msg}`, this.spaceShift)));
+      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)))
     }
   },
 
@@ -77,7 +81,7 @@ module.exports = {
    * @param {string} msg
    */
   error(msg) {
-    print(styles.error(msg));
+    print(styles.error(msg))
   },
 
   /**
@@ -85,7 +89,7 @@ module.exports = {
    * @param {string} msg
    */
   success(msg) {
-    print(styles.success(msg));
+    print(styles.success(msg))
   },
 
   /**
@@ -94,7 +98,7 @@ module.exports = {
    * @param {string} msg
    */
   plugin(pluginName, msg = '') {
-    this.debug(`<${pluginName}> ${msg}`);
+    this.debug(`<${pluginName}> ${msg}`)
   },
 
   /**
@@ -102,25 +106,26 @@ module.exports = {
    * @param {CodeceptJS.Step} step
    */
   step(step) {
-    if (outputLevel === 0) return;
-    if (!step) return;
+    if (outputLevel === 0) return
+    if (!step) return
     // Avoid to print non-gherkin steps, when gherkin is running for --steps mode
     if (outputLevel === 1) {
       if (typeof step === 'object' && step.hasBDDAncestor()) {
-        return;
+        return
       }
     }
 
-    let stepLine = step.toString();
+    let stepLine = step.toCliStyled ? step.toCliStyled() : step.toString()
     if (step.metaStep && outputLevel >= 1) {
       // this.stepShift += 2;
-      stepLine = colors.green(truncate(stepLine, this.spaceShift));
+      stepLine = colors.dim(truncate(stepLine, this.spaceShift))
     }
     if (step.comment) {
-      stepLine += colors.grey(step.comment.split('\n').join('\n' + ' '.repeat(4))); // eslint-disable-line
+      stepLine += colors.grey(step.comment.split('\n').join('\n' + ' '.repeat(4)))
     }
 
-    print(' '.repeat(this.stepShift), truncate(stepLine, this.spaceShift));
+    const _stepLine = isMaskedData() ? maskSensitiveData(stepLine) : stepLine
+    print(' '.repeat(this.stepShift), truncate(_stepLine, this.spaceShift))
   },
 
   /** @namespace */
@@ -128,10 +133,11 @@ module.exports = {
     /**
      * @param {Mocha.Suite} suite
      */
-    started: (suite) => {
-      if (!suite.title) return;
-      print(`${colors.bold(suite.title)} --`);
-      if (suite.comment) print(suite.comment);
+    started: suite => {
+      if (!suite.title) return
+      print(`${colors.bold(suite.title)} --`)
+      if (suite.file && outputLevel >= 1) print(colors.underline.grey(suite.file))
+      if (suite.comment) print(suite.comment)
     },
   },
 
@@ -141,25 +147,25 @@ module.exports = {
      * @param {Mocha.Test} test
      */
     started(test) {
-      print(`  ${colors.magenta.bold(test.title)}`);
+      print(`  ${colors.magenta.bold(test.title)}`)
     },
     /**
      * @param {Mocha.Test} test
      */
     passed(test) {
-      print(`  ${colors.green.bold(figures.tick)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`);
+      print(`  ${colors.green.bold(figures.tick)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`)
     },
     /**
      * @param {Mocha.Test} test
      */
     failed(test) {
-      print(`  ${colors.red.bold(figures.cross)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`);
+      print(`  ${colors.red.bold(figures.cross)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`)
     },
     /**
      * @param {Mocha.Test} test
      */
     skipped(test) {
-      print(`  ${colors.yellow.bold('S')} ${test.title}`);
+      print(`  ${colors.yellow.bold('S')} ${test.title}`)
     },
   },
 
@@ -167,23 +173,41 @@ module.exports = {
   scenario: {
     /**
      * @param {Mocha.Test} test
-    */
-    /* eslint-disable */
-    started(test) {},
-    /* eslint-enable */
+     */
+
+    started(test) {
+      if (outputLevel < 1) return
+      print(`  ${colors.dim.bold('Scenario()')}`)
+    },
+
     /**
      * @param {Mocha.Test} test
      */
     passed(test) {
-      print(`  ${colors.green.bold(`${figures.tick} OK`)} ${colors.grey(`in ${test.duration}ms`)}`);
-      print();
+      print(`  ${colors.green.bold(`${figures.tick} OK`)} ${colors.grey(`in ${test.duration}ms`)}`)
+      print()
     },
     /**
      * @param {Mocha.Test} test
      */
     failed(test) {
-      print(`  ${colors.red.bold(`${figures.cross} FAILED`)} ${colors.grey(`in ${test.duration}ms`)}`);
-      print();
+      print(`  ${colors.red.bold(`${figures.cross} FAILED`)} ${colors.grey(`in ${test.duration}ms`)}`)
+      print()
+    },
+  },
+
+  hook: {
+    started(hook) {
+      if (outputLevel < 1) return
+      print(`  ${colors.dim.bold(hook.toCode())}`)
+    },
+    passed(hook) {
+      if (outputLevel < 1) return
+      print()
+    },
+    failed(hook) {
+      if (outputLevel < 1) return
+      print(`  ${colors.red.bold(hook.toCode())}`)
     },
   },
 
@@ -195,9 +219,9 @@ module.exports = {
    */
   say(message, color = 'cyan') {
     if (colors[color] === undefined) {
-      color = 'cyan';
+      color = 'cyan'
     }
-    if (outputLevel >= 1) print(`   ${colors[color].bold(message)}`);
+    if (outputLevel >= 1) print(`   ${colors[color].bold(message)}`)
   },
 
   /**
@@ -207,50 +231,54 @@ module.exports = {
    * @param {number|string} duration
    */
   result(passed, failed, skipped, duration, failedHooks = 0) {
-    let style = colors.bgGreen;
-    let msg = ` ${passed || 0} passed`;
-    let status = style.bold('  OK ');
+    let style = colors.bgGreen
+    let msg = ` ${passed || 0} passed`
+    let status = style.bold('  OK ')
     if (failed) {
-      style = style.bgRed;
-      status = style.bold('  FAIL ');
-      msg += `, ${failed} failed`;
+      style = style.bgRed
+      status = style.bold('  FAIL ')
+      msg += `, ${failed} failed`
     }
 
     if (failedHooks > 0) {
-      style = style.bgRed;
-      status = style.bold('  FAIL ');
-      msg += `, ${failedHooks} failedHooks`;
+      style = style.bgRed
+      status = style.bold('  FAIL ')
+      msg += `, ${failedHooks} failedHooks`
     }
-    status += style.grey(' |');
+    status += style.grey(' |')
 
     if (skipped) {
-      if (!failed) style = style.bgYellow;
-      msg += `, ${skipped} skipped`;
+      if (!failed) style = style.bgYellow
+      msg += `, ${skipped} skipped`
     }
-    msg += '  ';
-    print(status + style(msg) + colors.grey(` // ${duration}`));
+    msg += '  '
+    print(status + style(msg) + colors.grey(` // ${duration}`))
   },
-};
+}
 
 function print(...msg) {
   if (outputProcess) {
-    msg.unshift(outputProcess);
+    msg.unshift(outputProcess)
   }
   if (!newline) {
-    console.log();
-    newline = true;
+    console.log()
+    newline = true
   }
 
-  console.log.apply(this, msg);
+  console.log.apply(this, msg)
 }
 
 function truncate(msg, gap = 0) {
   if (msg.indexOf('\n') > 0 || outputLevel >= 3) {
-    return msg; // don't cut multi line steps or on verbose log level
+    return msg // don't cut multi line steps or on verbose log level
   }
-  const width = (process.stdout.columns || 200) - gap - 4;
+  const width = (process.stdout.columns || 200) - gap - 4
   if (msg.length > width) {
-    msg = msg.substr(0, width - 1) + figures.ellipsis;
+    msg = msg.substr(0, width - 1) + figures.ellipsis
   }
-  return msg;
+  return msg
+}
+
+function isMaskedData() {
+  return global.maskSensitiveData === true || false
 }