codeceptjs 3.7.0-beta.2 → 3.7.0-beta.4

package/lib/listener/globalTimeout.js

@@ -3,7 +3,9 @@ const output = require('../output')
 const recorder = require('../recorder')
 const Config = require('../config')
 const { timeouts } = require('../store')
+const debug = require('debug')('codeceptjs:timeout')
 const TIMEOUT_ORDER = require('../step').TIMEOUT_ORDER
+const { BeforeSuiteHook, AfterSuiteHook } = require('../mocha/hooks')
 
 module.exports = function () {
   let timeout
@@ -16,12 +18,23 @@ module.exports = function () {
     return
   }
 
+  // disable timeout for BeforeSuite/AfterSuite hooks
+  // add separate configs to them?
+  event.dispatcher.on(event.hook.started, hook => {
+    if (hook instanceof BeforeSuiteHook) {
+      suiteTimeout = []
+    }
+    if (hook instanceof AfterSuiteHook) {
+      suiteTimeout = []
+    }
+  })
+
   event.dispatcher.on(event.suite.before, suite => {
-    timeout = null;
     suiteTimeout = []
     let timeoutConfig = Config.get('timeout')
 
     if (timeoutConfig) {
+      debug('config:', timeoutConfig)
       if (!Number.isNaN(+timeoutConfig)) {
         checkForSeconds(timeoutConfig)
         suiteTimeout.push(timeoutConfig)
@@ -41,6 +54,8 @@ module.exports = function () {
 
     if (suite.totalTimeout) suiteTimeout.push(suite.totalTimeout)
     output.log(`Timeouts: ${suiteTimeout}`)
+
+    if (suiteTimeout.length > 0) debug(suite.title, 'timeout', suiteTimeout)
   })
 
   event.dispatcher.on(event.test.before, test => {
@@ -65,6 +80,13 @@ module.exports = function () {
 
     timeout = test.totalTimeout || testTimeout || suiteTimeout[suiteTimeout.length - 1]
     if (!timeout) return
+
+    debug(test.title, 'timeout', {
+      'config from file': testTimeout,
+      'suite timeout': suiteTimeout,
+      'dynamic config': test.totalTimeout,
+    })
+
     currentTimeout = timeout
     output.debug(`Test Timeout: ${timeout}s`)
     timeout *= 1000
@@ -82,8 +104,10 @@ module.exports = function () {
     if (typeof timeout !== 'number') return
 
     if (timeout < 0) {
+      debug('Previous steps timed out, setting timeout to 0.01s')
       step.setTimeout(0.01, TIMEOUT_ORDER.testOrSuite)
     } else {
+      debug(`Setting timeout ${timeout}ms for step ${step.toCode().trim()}`)
       step.setTimeout(timeout, TIMEOUT_ORDER.testOrSuite)
     }
   })
@@ -92,7 +116,9 @@ module.exports = function () {
     if (typeof timeout === 'number' && !Number.isNaN(timeout)) timeout -= step.duration
 
     if (typeof timeout === 'number' && timeout <= 0 && recorder.isRunning()) {
+      debug(`step ${step.toCode().trim()} timed out`)
       if (currentTest && currentTest.callback) {
+        debug(`Failing test ${currentTest.title} with timeout ${currentTimeout}s`)
         recorder.reset()
         // replace mocha timeout with custom timeout
         currentTest.timeout(0)

package/lib/step/section.js

@@ -0,0 +1,25 @@
+const event = require('../event')
+
+class Section {
+  constructor(name = '') {
+    this.name = name
+
+    this.attachMetaStep = (step) => {
+      console.log('attach meta step', this.name)
+    }
+  }
+
+  start() {
+    event.dispatcher.on(event.step.started, this.attachMetaStep)
+  }
+
+  end() {
+    event.dispatcher.off(event.step.started, this.attachMetaStep)
+  }
+}
+
+
+function getRootMetaStep(step) {
+  if (step.metaStep) return getRootMetaStep(step.metaStep)
+  return step
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.0-beta.2",
+  "version": "3.7.0-beta.4",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",

package/typings/promiseBasedTypes.d.ts

@@ -608,17 +608,11 @@ declare namespace CodeceptJS {
          * ```js
          * // taps outside to hide keyboard per default
          * I.hideDeviceKeyboard();
-         * I.hideDeviceKeyboard('tapOutside');
-         *
-         * // or by pressing key
-         * I.hideDeviceKeyboard('pressKey', 'Done');
          * ```
          *
          * Appium: support Android and iOS
-         * @param [strategy] - Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-         * @param [key] - Optional key
          */
-        hideDeviceKeyboard(strategy?: 'tapOutside' | 'pressKey', key?: string): Promise<any>;
+        hideDeviceKeyboard(): Promise<any>;
         /**
          * Send a key event to the device.
          * List of keys: https://developer.android.com/reference/android/view/KeyEvent.html
@@ -1773,12 +1767,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1911,12 +1899,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -2958,12 +2940,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6348,12 +6324,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8168,12 +8138,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9326,12 +9290,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/typings/types.d.ts

@@ -608,17 +608,11 @@ declare namespace CodeceptJS {
          * ```js
          * // taps outside to hide keyboard per default
          * I.hideDeviceKeyboard();
-         * I.hideDeviceKeyboard('tapOutside');
-         *
-         * // or by pressing key
-         * I.hideDeviceKeyboard('pressKey', 'Done');
          * ```
          *
          * Appium: support Android and iOS
-         * @param [strategy] - Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-         * @param [key] - Optional key
          */
-        hideDeviceKeyboard(strategy?: 'tapOutside' | 'pressKey', key?: string): void;
+        hideDeviceKeyboard(): void;
         /**
          * Send a key event to the device.
          * List of keys: https://developer.android.com/reference/android/view/KeyEvent.html
@@ -1800,12 +1794,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1938,12 +1926,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3051,12 +3033,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6592,12 +6568,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8548,12 +8518,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9766,12 +9730,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -12207,24 +12165,49 @@ declare namespace CodeceptJS {
     function session(sessionName: CodeceptJS.LocatorOrString, config: ((...params: any[]) => any) | {
         [key: string]: any;
     }, fn?: (...params: any[]) => any): any;
+    /**
+     * StepConfig is a configuration object for a step.
+     * It is used to create a new step that is a combination of other steps.
+     */
+    class StepConfig {
+        config: any;
+        /**
+         * Set the options for the step.
+         * @param opts - The options for the step.
+         * @returns - The step configuration object.
+         */
+        opts(opts: any): StepConfig;
+        /**
+         * Set the timeout for the step.
+         * @param timeout - The timeout for the step.
+         * @returns - The step configuration object.
+         */
+        timeout(timeout: number): StepConfig;
+        /**
+         * Set the retry for the step.
+         * @param retry - The retry for the step.
+         * @returns - The step configuration object.
+         */
+        retry(retry: number): StepConfig;
+    }
     /**
      * 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.
      */
     class Step {
-        constructor(helper: CodeceptJS.Helper, name: string);
-        actor: string;
-        helper: CodeceptJS.Helper;
+        constructor(name: string);
         name: string;
+        timeouts: Map<number, number>;
+        args: any[];
+        opts: Record<string, any>;
+        actor: string;
         helperMethod: string;
         status: string;
-        suffix: string;
         prefix: string;
         comment: string;
-        args: any[];
-        metaStep: MetaStep;
+        metaStep: any;
         stack: string;
-        getTimeout(): number | undefined;
+        timeout: any;
         /**
          * @param timeout - timeout in milliseconds or 0 if no timeout
          * @param order - order defines the priority of timeout, timeouts set with lower order override those set with higher order.
@@ -12233,7 +12216,6 @@ declare namespace CodeceptJS {
         setTimeout(timeout: number, order: number): void;
         setTrace(): void;
         setArguments(args: any[]): void;
-        run(...args: any[]): any;
         setStatus(status: string): void;
         humanize(): string;
         humanizeArgs(): string;
@@ -12242,11 +12224,6 @@ declare namespace CodeceptJS {
         toCliStyled(): string;
         toCode(): string;
         hasBDDAncestor(): boolean;
-        static MetaStep: typeof MetaStep;
-    }
-    class MetaStep extends Step {
-        isBDD(): boolean;
-        run(): any;
     }
     /**
      * global values for current session
@@ -12255,7 +12232,9 @@ declare namespace CodeceptJS {
         var debugMode: boolean;
         var timeouts: boolean;
         var dryRun: boolean;
+        var onPause: boolean;
         var currentTest: CodeceptJS.Test | null;
+        var currentStep: any;
     }
     /**
      * Describe a "suite" with the given `title`
@@ -12948,22 +12927,12 @@ declare namespace CodeceptJS {
 }
 
 /**
- * timeouts set with order below zero only override timeouts of higher order if their value is smaller
- */
-declare var testOrSuite: any;
-
-/**
- * 0-9 - designated for override of timeouts set from code, 5 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=true
- */
-declare var stepTimeoutHard: any;
-
-/**
- * 10-19 - designated for timeouts set from code, 15 is order of I.setTimeout(t) operation
+ * corresponding helper
  */
-declare var codeLimitTime: any;
+declare var helper: CodeceptJS.Helper;
 
 /**
- * 20-29 - designated for timeout settings which could be overriden in tests code, 25 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=false
+ * name of method to be executed
  */
-declare var stepTimeoutSoft: any;
+declare var helperMethod: string;