codeceptjs 4.0.0-beta.2 → 4.0.0-beta.20

package/lib/step/meta.js

@@ -0,0 +1,99 @@
+import Step from './base.js'
+import event from '../event.js'
+import { humanizeString } from '../utils.js'
+
+class MetaStep extends Step {
+  constructor(actor, method) {
+    if (!method) method = ''
+    super(method)
+
+    /** @member {boolean} collsapsed hide children steps from output */
+    this.collapsed = false
+
+    this.actor = actor
+  }
+
+  /** @return {boolean} */
+  isBDD() {
+    if (this.actor && this.actor.match && this.actor.match(/^(Given|When|Then|And|But)/)) {
+      return true
+    }
+    return false
+  }
+
+  toCliStyled() {
+    return this.toString()
+  }
+
+  toString() {
+    const actorText = this.actor
+
+    if (this.isBDD()) {
+      return `${this.prefix}${actorText} ${this.name} "${this.humanizeArgs()}${this.suffix}"`
+    }
+
+    if (actorText === 'I') {
+      return `${this.prefix}${actorText} ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`
+    }
+
+    if (!this.actor) {
+      return `${this.name} ${this.humanizeArgs()}${this.suffix}`.trim()
+    }
+
+    return `On ${this.prefix}${actorText}: ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`.trim()
+  }
+
+  humanize() {
+    return humanizeString(this.name)
+  }
+
+  setTrace() {}
+
+  setContext(context) {
+    this.context = context
+  }
+
+  /** @return {*} */
+  run(fn) {
+    this.status = 'queued'
+    this.setArguments(Array.from(arguments).slice(1))
+    let result
+
+    const registerStep = step => {
+      this.setMetaStep(null)
+      step.setMetaStep(this)
+    }
+    event.dispatcher.prependListener(event.step.before, registerStep)
+    // Handle async and sync methods.
+    if (fn.constructor.name === 'AsyncFunction') {
+      result = fn
+        .apply(this.context, this.args)
+        .then(result => {
+          return result
+        })
+        .catch(error => {
+          this.setStatus('failed')
+          throw error
+        })
+        .finally(() => {
+          this.endTime = Date.now()
+          event.dispatcher.removeListener(event.step.before, registerStep)
+        })
+    } else {
+      try {
+        this.startTime = Date.now()
+        result = fn.apply(this.context, this.args)
+      } catch (error) {
+        this.setStatus('failed')
+        throw error
+      } finally {
+        this.endTime = Date.now()
+        event.dispatcher.removeListener(event.step.before, registerStep)
+      }
+    }
+
+    return result
+  }
+}
+
+export default MetaStep

package/lib/step/record.js

@@ -0,0 +1,74 @@
+import event from '../event.js'
+import recorder from '../recorder.js'
+import StepConfig from './config.js'
+import output from '../output.js'
+import store from '../store.js'
+import { TIMEOUT_ORDER } from '../timeout.js'
+import retryStep from './retry.js'
+function recordStep(step, args) {
+  step.status = 'queued'
+
+  // apply step configuration
+  const lastArg = args[args.length - 1]
+  if (lastArg instanceof StepConfig) {
+    const stepConfig = args.pop()
+    const { opts, timeout, retry } = stepConfig.getConfig()
+
+    if (opts) {
+      output.debug(`Step ${step.name}: options applied ${JSON.stringify(opts)}`)
+      store.stepOptions = opts
+      step.opts = opts
+    }
+    if (timeout) {
+      output.debug(`Step ${step.name} timeout ${timeout}s`)
+      step.setTimeout(timeout * 1000, TIMEOUT_ORDER.codeLimitTime)
+    }
+    if (retry) retryStep(retry)
+  }
+
+  step.setArguments(args)
+  // run async before step hooks
+  event.emit(event.step.before, step)
+
+  const task = `${step.name}: ${step.humanizeArgs()}`
+  let val
+
+  // run step inside promise
+  recorder.add(
+    task,
+    () => {
+      if (!step.startTime) {
+        // step can be retries
+        event.emit(event.step.started, step)
+        step.startTime = +Date.now()
+      }
+      return (val = step.run(...args))
+    },
+    false,
+    undefined,
+    step.timeout,
+  )
+
+  event.emit(event.step.after, step)
+
+  recorder.add('step passed', () => {
+    step.endTime = +Date.now()
+    event.emit(event.step.passed, step, val)
+    event.emit(event.step.finished, step)
+  })
+
+  recorder.catch(err => {
+    step.status = 'failed'
+    step.endTime = +Date.now()
+    event.emit(event.step.failed, step, err)
+    event.emit(event.step.finished, step)
+    throw err
+  })
+
+  recorder.add('return result', () => val)
+  // run async after step hooks
+
+  return recorder.promise()
+}
+
+export default recordStep

package/lib/step/retry.js

@@ -0,0 +1,11 @@
+import recorder from '../recorder.js'
+import event from '../event.js'
+
+function retryStep(opts) {
+  if (opts === undefined) opts = 1
+  recorder.retry(opts)
+  // remove retry once the step passed
+  recorder.add(() => event.dispatcher.once(event.step.finished, () => recorder.retries.pop()))
+}
+
+export default retryStep

package/lib/step/section.js

@@ -0,0 +1,55 @@
+import MetaStep from './meta.js'
+import event from '../event.js'
+
+let currentSection
+
+class Section {
+  constructor(name = '') {
+    this.name = name
+
+    this.metaStep = new MetaStep(null, name)
+
+    this.attachMetaStep = step => {
+      if (currentSection !== this) return
+      if (!step) return
+      const metaStep = getRootMetaStep(step)
+
+      if (metaStep !== this.metaStep) {
+        metaStep.metaStep = this.metaStep
+      }
+    }
+  }
+
+  hidden() {
+    this.metaStep.collapsed = true
+    return this
+  }
+
+  start() {
+    if (currentSection) currentSection.end()
+    currentSection = this
+    event.dispatcher.prependListener(event.step.before, this.attachMetaStep)
+    event.dispatcher.once(event.test.finished, () => this.end())
+    return this
+  }
+
+  end() {
+    currentSection = null
+    event.dispatcher.off(event.step.started, this.attachMetaStep)
+    return this
+  }
+
+  /**
+   * @returns {Section}
+   */
+  static current() {
+    return currentSection
+  }
+}
+
+function getRootMetaStep(step) {
+  if (step.metaStep) return getRootMetaStep(step.metaStep)
+  return step
+}
+
+export default Section

package/lib/step.js

@@ -1,334 +1,23 @@
-// TODO: place MetaStep in other file, disable rule
-/* eslint-disable max-classes-per-file */
-import { store } from './store.js';
-
-import Secret from './secret.js';
-import * as event from './event.js';
-
-const STACK_LINE = 4;
-
+// refactored step class, moved to helper
 /**
- * Each command in test executed through `I.` object is wrapped in Step.
- * Step allows logging executed commands and triggers hook before and after step execution.
- * @param {CodeceptJS.Helper} helper
- * @param {string} name
+ * Step is wrapper around a helper method.
+ * It is used to create a new step that is a combination of other steps.
  */
-export class Step {
-  static get TIMEOUT_ORDER() {
-    return {
-      /**
-       * timeouts set with order below zero only override timeouts of higher order if their value is smaller
-       */
-      testOrSuite: -5,
-      /**
-       * 0-9 - designated for override of timeouts set from code, 5 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=true
-       */
-      stepTimeoutHard: 5,
-      /**
-       * 10-19 - designated for timeouts set from code, 15 is order of I.setTimeout(t) operation
-       */
-      codeLimitTime: 15,
-      /**
-       * 20-29 - designated for timeout settings which could be overriden in tests code, 25 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=false
-       */
-      stepTimeoutSoft: 25,
-    };
-  }
-
-  constructor(helper, name) {
-    /** @member {string} */
-    this.actor = 'I'; // I = actor
-    /** @member {CodeceptJS.Helper} */
-    this.helper = helper; // corresponding helper
-    /** @member {string} */
-    this.name = name; // name of a step console
-    /** @member {string} */
-    this.helperMethod = name; // helper method
-    /** @member {string} */
-    this.status = 'pending';
-    /**
-     * @member {string} suffix
-     * @memberof CodeceptJS.Step#
-     */
-    /** @member {string} */
-    this.prefix = this.suffix = '';
-    /** @member {string} */
-    this.comment = '';
-    /** @member {Array<*>} */
-    this.args = [];
-    /** @member {MetaStep} */
-    this.metaStep = undefined;
-    /** @member {string} */
-    this.stack = '';
-
-    const timeouts = new Map();
-    /**
-     * @method
-     * @returns {number|undefined}
-     */
-    this.getTimeout = function () {
-      let totalTimeout;
-      // iterate over all timeouts starting from highest values of order
-      new Map([...timeouts.entries()].sort().reverse()).forEach((timeout, order) => {
-        if (timeout !== undefined && (
-          // when orders >= 0 - timeout value overrides those set with higher order elements
-          (// when `order < 0` - timeout overrides higher values of timeout or 'no timeout' (totalTimeout === 0) set by elements with higher order
-            (order >= 0
-
-          // when `order < 0 && totalTimeout === undefined` - timeout is used when nothing is set by elements with higher order
-          || totalTimeout === undefined || timeout > 0 && (timeout < totalTimeout || totalTimeout === 0)))
-        )) {
-          totalTimeout = timeout;
-        }
-      });
-      return totalTimeout;
-    };
-    /**
-     * @method
-     * @param {number} timeout - timeout in milliseconds or 0 if no timeout
-     * @param {number} order - order defines the priority of timeout, timeouts set with lower order override those set with higher order.
-     *                         When order below 0 value of timeout only override if new value is lower
-     */
-    this.setTimeout = function (timeout, order) {
-      timeouts.set(order, timeout);
-    };
-
-    this.setTrace();
-  }
-
-  /** @function */
-  setTrace() {
-    Error.captureStackTrace(this);
-  }
-
-  /** @param {Array<*>} args */
-  setArguments(args) {
-    this.args = args;
-  }
-
-  /**
-   * @param {...any} args
-   * @return {*}
-   */
-  run() {
-    this.args = Array.prototype.slice.call(arguments);
-    if (store.dryRun) {
-      this.setStatus('success');
-      return Promise.resolve(new Proxy({}, dryRunResolver()));
-    }
-    let result;
-    try {
-      if (this.helperMethod !== 'say') {
-        result = this.helper[this.helperMethod].apply(this.helper, this.args);
-      }
-      this.setStatus('success');
-    } catch (err) {
-      this.setStatus('failed');
-      throw err;
-    }
-    return result;
-  }
-
-  /** @param {string} status */
-  setStatus(status) {
-    this.status = status;
-    if (this.metaStep) {
-      this.metaStep.setStatus(status);
-    }
-  }
-
-  /** @return {string} */
-  humanize() {
-    return humanizeString(this.name);
-  }
-
-  /** @return {string} */
-  humanizeArgs() {
-    return this.args.map((arg) => {
-      if (!arg) {
-        return '';
-      }
-      if (typeof arg === 'string') {
-        return `"${arg}"`;
-      }
-      if (Array.isArray(arg)) {
-        try {
-          const res = JSON.stringify(arg);
-          return res;
-        } catch (err) {
-          return `[${arg.toString()}]`;
-        }
-      } else if (typeof arg === 'function') {
-        return arg.toString();
-      } else if (typeof arg === 'undefined') {
-        return `${arg}`;
-      } else if (arg instanceof Secret) {
-        return arg.getMasked();
-      } else if (arg.toString && arg.toString() !== '[object Object]') {
-        return arg.toString();
-      } else if (typeof arg === 'object') {
-        const returnedArg = {};
-        for (const [key, value] of Object.entries(arg)) {
-          returnedArg[key] = value;
-          if (value instanceof Secret) returnedArg[key] = value.getMasked();
-        }
-        return JSON.stringify(returnedArg);
-      }
-      return arg;
-    }).join(', ');
-  }
-
-  /** @return {string} */
-  line() {
-    const lines = this.stack.split('\n');
-    if (lines[STACK_LINE]) {
-      return lines[STACK_LINE].trim().replace(global.codecept_dir || '', '.').trim();
-    }
-    return '';
-  }
-
-  /** @return {string} */
-  toString() {
-    return `${this.prefix}${this.actor} ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`;
-  }
-
-  /** @return {string} */
-  toCode() {
-    return `${this.prefix}${this.actor}.${this.name}(${this.humanizeArgs()})${this.suffix}`;
-  }
-
-  isMetaStep() {
-    return this.constructor.name === 'MetaStep';
-  }
-
-  /** @return {boolean} */
-  hasBDDAncestor() {
-    let hasBDD = false;
-    let processingStep;
-    processingStep = this;
-
-    while (processingStep.metaStep) {
-      if (processingStep.metaStep.actor.match(/^(Given|When|Then|And)/)) {
-        hasBDD = true;
-        break;
-      } else {
-        processingStep = processingStep.metaStep;
-      }
-    }
-    return hasBDD;
-  }
-}
-
-/** @extends Step */
-export class MetaStep extends Step {
-  constructor(obj, method) {
-    super(null, method);
-    this.actor = obj;
-  }
+import BaseStep from './step/base.js'
+import StepConfig from './step/config.js'
+import Step from './step/helper.js'
 
-  /** @return {boolean} */
-  isBDD() {
-    if (this.actor && this.actor.match && this.actor.match(/^(Given|When|Then|And)/)) {
-      return true;
-    }
-    return false;
-  }
-
-  isWithin() {
-    if (this.actor && this.actor.match && this.actor.match(/^(Within)/)) {
-      return true;
-    }
-    return false;
-  }
-
-  toString() {
-    const actorText = this.actor;
-
-    if (this.isBDD() || this.isWithin()) {
-      return `${this.prefix}${actorText} ${this.name} "${this.humanizeArgs()}${this.suffix}"`;
-    }
-
-    if (actorText === 'I') {
-      return `${this.prefix}${actorText} ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`;
-    }
-
-    return `On ${this.prefix}${actorText}: ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`;
-  }
-
-  humanize() {
-    return humanizeString(this.name);
-  }
-
-  setTrace() {
-  }
-
-  setContext(context) {
-    this.context = context;
-  }
-
-  /** @return {*} */
-  run(fn) {
-    this.status = 'queued';
-    this.setArguments(Array.from(arguments).slice(1));
-    let result;
-
-    const registerStep = (step) => {
-      this.metaStep = null;
-      step.metaStep = this;
-    };
-    event.dispatcher.prependListener(event.step.before, registerStep);
-    // Handle async and sync methods.
-    if (fn.constructor.name === 'AsyncFunction') {
-      result = fn.apply(this.context, this.args).then((result) => {
-        return result;
-      }).catch((error) => {
-        this.setStatus('failed');
-        throw error;
-      }).finally(() => {
-        this.endTime = Date.now();
-        event.dispatcher.removeListener(event.step.before, registerStep);
-      });
-    } else {
-      try {
-        this.startTime = Date.now();
-        result = fn.apply(this.context, this.args);
-      } catch (error) {
-        this.setStatus('failed');
-        throw error;
-      } finally {
-        this.endTime = Date.now();
-        event.dispatcher.removeListener(event.step.before, registerStep);
-      }
-    }
-
-    return result;
-  }
-}
-
-Step.TIMEOUTS = {};
-
-/** @type {Class<MetaStep>} */
-Step.MetaStep = MetaStep;
-
-function dryRunResolver() {
-  return {
-    get(target, prop) {
-      if (prop === 'toString') return () => '<VALUE>';
-      return new Proxy({}, dryRunResolver());
-    },
-  };
-}
-
-function humanizeString(string) {
-  // split strings by words, then make them all lowercase
-  const _result = string.replace(/([a-z](?=[A-Z]))/g, '$1 ')
-    .split(' ')
-    .map(word => word.toLowerCase());
+/**
+ * MetaStep is a step that is used to wrap other steps.
+ * It is used to create a new step that is a combination of other steps.
+ * It is used to create a new step that is a combination of other steps.
+ */
+import MetaStep from './step/meta.js'
 
-  _result[0] = _result[0] === 'i' ? capitalizeFLetter(_result[0]) : _result[0];
-  return _result.join(' ').trim();
-}
+/**
+ * Step used to execute a single function
+ */
+import FuncStep from './step/func.js'
 
-function capitalizeFLetter(string) {
-  return (string[0].toUpperCase() + string.slice(1));
-}
+export default Step
+export { MetaStep, BaseStep, StepConfig, FuncStep }

package/lib/steps.js

@@ -0,0 +1,54 @@
+import StepConfig from './step/config.js'
+import SectionClass from './step/section.js'
+function stepOpts(opts = {}) {
+  return new StepConfig(opts)
+}
+
+function stepTimeout(timeout) {
+  return new StepConfig().timeout(timeout)
+}
+
+function stepRetry(retry) {
+  return new StepConfig().retry(retry)
+}
+
+function section(name) {
+  if (!name) return endSection()
+  return new SectionClass(name).start()
+}
+
+function endSection() {
+  return SectionClass.current().end()
+}
+
+// Section function to be added here
+
+const step = {
+  // steps.opts syntax
+  opts: stepOpts,
+  timeout: stepTimeout,
+  retry: stepRetry,
+
+  // one-function syntax
+  stepTimeout,
+  stepRetry,
+  stepOpts,
+
+  // sections
+  section,
+  endSection,
+
+  Section: section,
+  EndSection: endSection,
+
+  // shortcuts
+  Given: () => section('Given'),
+  When: () => section('When'),
+  Then: () => section('Then'),
+}
+
+export default step
+
+// Named exports for ESM compatibility
+export const Section = step.Section
+export const EndSection = step.EndSection

package/lib/store.js

@@ -2,14 +2,45 @@
  * global values for current session
  * @namespace
  */
-export const store = {
-  /** @type {boolean} */
+const store = {
+  /**
+   * If we are in --debug mode
+   * @type {boolean}
+   */
   debugMode: false,
-  /** @type {boolean} */
+
+  /**
+   * Is timeouts enabled
+   * @type {boolean}
+   */
   timeouts: true,
-  /** @type {boolean} */
+
+  /**
+   * If auto-retries are enabled by retryFailedStep plugin
+   * tryTo effect disables them
+   * @type {boolean}
+   */
+  autoRetries: false,
+
+  /**
+   * Tests are executed via dry-run
+   * @type {boolean}
+   */
   dryRun: false,
-};
+  /**
+   * If we are in pause mode
+   * @type {boolean}
+   */
+  onPause: false,
+
+  // current object states
+
+  /** @type {CodeceptJS.Test | null} */
+  currentTest: null,
+  /** @type {CodeceptJS.Step | null} */
+  currentStep: null,
+  /** @type {CodeceptJS.Suite | null} */
+  currentSuite: null,
+}
 
-/** @type {boolean} */
-export const timeouts = true;
+export default store