codeceptjs 3.7.0-beta.9 → 3.7.0

package/lib/plugin/autoLogin.js

@@ -1,339 +1,5 @@
-const fs = require('fs')
-const path = require('path')
-const { fileExists } = require('../utils')
-const container = require('../container')
-const store = require('../store')
-const recorder = require('../recorder')
-const { debug } = require('../output')
-const isAsyncFunction = require('../utils').isAsyncFunction
+const auth = require('./auth')
 
-const defaultUser = {
-  fetch: I => I.grabCookie(),
-  check: () => {},
-  restore: (I, cookies) => {
-    I.amOnPage('/') // open a page
-    I.setCookie(cookies)
-  },
-}
+console.log('autoLogin plugin was renamed to auth plugin. Please update your config.')
 
-const defaultConfig = {
-  saveToFile: false,
-  inject: 'login',
-}
-
-/**
- * Logs user in for the first test and reuses session for next tests.
- * Works by saving cookies into memory or file.
- * If a session expires automatically logs in again.
- *
- * > For better development experience cookies can be saved into file, so a session can be reused while writing tests.
- *
- * #### Usage
- *
- * 1. Enable this plugin and configure as described below
- * 2. Define user session names (example: `user`, `editor`, `admin`, etc).
- * 3. Define how users are logged in and how to check that user is logged in
- * 4. Use `login` object inside your tests to log in:
- *
- * ```js
- * // inside a test file
- * // use login to inject auto-login function
- * Feature('Login');
- *
- * Before(({ login }) => {
- *    login('user'); // login using user session
- * });
- *
- * // Alternatively log in for one scenario.
- * Scenario('log me in', ( { I, login } ) => {
- *    login('admin');
- *    I.see('I am logged in');
- * });
- * ```
- *
- * #### Configuration
- *
- * * `saveToFile` (default: false) - save cookies to file. Allows to reuse session between execution.
- * * `inject` (default: `login`) - name of the login function to use
- * * `users` - an array containing different session names and functions to:
- *    * `login` - sign in into the system
- *     * `check` - check that user is logged in
- *     * `fetch` - to get current cookies (by default `I.grabCookie()`)
- *     * `restore` - to set cookies (by default `I.amOnPage('/'); I.setCookie(cookie)`)
- *
- * #### How It Works
- *
- * 1. `restore` method is executed. It should open a page and set credentials.
- * 2. `check` method is executed. It should reload a page (so cookies are applied) and check that this page belongs to logged-in user. When you pass the second args `session`, you could perform the validation using passed session.
- * 3. If `restore` and `check` were not successful, `login` is executed
- * 4. `login` should fill in login form
- * 5. After successful login, `fetch` is executed to save cookies into memory or file.
- *
- * #### Example: Simple login
- *
- * ```js
- * autoLogin: {
- *   enabled: true,
- *   saveToFile: true,
- *   inject: 'login',
- *   users: {
- *     admin: {
- *       // loginAdmin function is defined in `steps_file.js`
- *       login: (I) => I.loginAdmin(),
- *       // if we see `Admin` on page, we assume we are logged in
- *       check: (I) => {
- *          I.amOnPage('/');
- *          I.see('Admin');
- *       }
- *     }
- *   }
- * }
- * ```
- *
- * #### Example: Multiple users
- *
- * ```js
- * autoLogin: {
- *   enabled: true,
- *   saveToFile: true,
- *   inject: 'loginAs', // use `loginAs` instead of login
- *   users: {
- *     user: {
- *       login: (I) => {
- *          I.amOnPage('/login');
- *          I.fillField('email', 'user@site.com');
- *          I.fillField('password', '123456');
- *          I.click('Login');
- *       },
- *       check: (I) => {
- *          I.amOnPage('/');
- *          I.see('User', '.navbar');
- *       },
- *     },
- *     admin: {
- *       login: (I) => {
- *          I.amOnPage('/login');
- *          I.fillField('email', 'admin@site.com');
- *          I.fillField('password', '123456');
- *          I.click('Login');
- *       },
- *       check: (I) => {
- *          I.amOnPage('/');
- *          I.see('Admin', '.navbar');
- *       },
- *     },
- *   }
- * }
- * ```
- *
- * #### Example: Keep cookies between tests
- *
- * If you decide to keep cookies between tests you don't need to save/retrieve cookies between tests.
- * But you need to login once work until session expires.
- * For this case, disable `fetch` and `restore` methods.
- *
- * ```js
- * helpers: {
- *    WebDriver: {
- *      // config goes here
- *      keepCookies: true; // keep cookies for all tests
- *    }
- * },
- * plugins: {
- *    autoLogin: {
- *      users: {
- *        admin: {
- *          login: (I) => {
- *            I.amOnPage('/login');
- *            I.fillField('email', 'admin@site.com');
- *            I.fillField('password', '123456');
- *            I.click('Login');
- *          },
- *          check: (I) => {
- *            I.amOnPage('/dashboard');
- *            I.see('Admin', '.navbar');
- *          },
- *          fetch: () => {}, // empty function
- *          restore: () => {}, // empty funciton
- *        }
- *     }
- *   }
- * }
- * ```
- *
- * #### Example: Getting sessions from local storage
- *
- * If your session is stored in local storage instead of cookies you still can obtain sessions.
- *
- * ```js
- * plugins: {
- *    autoLogin: {
- *     admin: {
- *       login: (I) => I.loginAsAdmin(),
- *       check: (I) => I.see('Admin', '.navbar'),
- *       fetch: (I) => {
- *         return I.executeScript(() => localStorage.getItem('session_id'));
- *       },
- *       restore: (I, session) => {
- *         I.amOnPage('/');
- *         I.executeScript((session) => localStorage.setItem('session_id', session), session);
- *       },
- *     }
- *   }
- * }
- * ```
- *
- * #### Tips: Using async function in the autoLogin
- *
- * If you use async functions in the autoLogin plugin, login function should be used with `await` keyword.
- *
- * ```js
- * autoLogin: {
- *   enabled: true,
- *   saveToFile: true,
- *   inject: 'login',
- *   users: {
- *     admin: {
- *       login: async (I) => {  // If you use async function in the autoLogin plugin
- *          const phrase = await I.grabTextFrom('#phrase')
- *          I.fillField('username', 'admin'),
- *          I.fillField('password', 'password')
- *          I.fillField('phrase', phrase)
- *       },
- *       check: (I) => {
- *          I.amOnPage('/');
- *          I.see('Admin');
- *       },
- *     }
- *   }
- * }
- * ```
- *
- * ```js
- * Scenario('login', async ( {I, login} ) => {
- *   await login('admin') // you should use `await`
- * })
- * ```
- *
- * #### Tips: Using session to validate user
- *
- * Instead of asserting on page elements for the current user in `check`, you can use the `session` you saved in `fetch`
- *
- * ```js
- * autoLogin: {
- *   enabled: true,
- *   saveToFile: true,
- *   inject: 'login',
- *   users: {
- *     admin: {
- *       login: async (I) => {  // If you use async function in the autoLogin plugin
- *          const phrase = await I.grabTextFrom('#phrase')
- *          I.fillField('username', 'admin'),
- *          I.fillField('password', 'password')
- *          I.fillField('phrase', phrase)
- *       },
- *       check: (I, session) => {
- *          // Throwing an error in `check` will make CodeceptJS perform the login step for the user
- *          if (session.profile.email !== the.email.you.expect@some-mail.com) {
- *               throw new Error ('Wrong user signed in');
- *         }
- *       },
- *     }
- *   }
- * }
- * ```
- *
- * ```js
- * Scenario('login', async ( {I, login} ) => {
- *   await login('admin') // you should use `await`
- * })
- *
- *
- */
-module.exports = function (config) {
-  config = Object.assign(defaultConfig, config)
-  Object.keys(config.users).map(
-    u =>
-      (config.users[u] = {
-        ...defaultUser,
-        ...config.users[u],
-      }),
-  )
-
-  if (config.saveToFile) {
-    // loading from file
-    for (const name in config.users) {
-      const fileName = path.join(global.output_dir, `${name}_session.json`)
-      if (!fileExists(fileName)) continue
-      const data = fs.readFileSync(fileName).toString()
-      try {
-        store[`${name}_session`] = JSON.parse(data)
-      } catch (err) {
-        throw new Error(`Could not load session from ${fileName}\n${err}`)
-      }
-      debug(`Loaded user session for ${name}`)
-    }
-  }
-
-  const loginFunction = async name => {
-    const userSession = config.users[name]
-    const I = container.support('I')
-    const cookies = store[`${name}_session`]
-    const shouldAwait = isAsyncFunction(userSession.login) || isAsyncFunction(userSession.restore) || isAsyncFunction(userSession.check)
-
-    const loginAndSave = async () => {
-      if (shouldAwait) {
-        await userSession.login(I)
-      } else {
-        userSession.login(I)
-      }
-
-      const cookies = await userSession.fetch(I)
-      if (!cookies) {
-        debug("Cannot save user session with empty cookies from auto login's fetch method")
-        return
-      }
-      if (config.saveToFile) {
-        debug(`Saved user session into file for ${name}`)
-        fs.writeFileSync(path.join(global.output_dir, `${name}_session.json`), JSON.stringify(cookies))
-      }
-      store[`${name}_session`] = cookies
-    }
-
-    if (!cookies) return loginAndSave()
-
-    recorder.session.start('check login')
-    if (shouldAwait) {
-      await userSession.restore(I, cookies)
-      await userSession.check(I, cookies)
-    } else {
-      userSession.restore(I, cookies)
-      userSession.check(I, cookies)
-    }
-    recorder.session.catch(err => {
-      debug(`Failed auto login for ${name} due to ${err}`)
-      debug('Logging in again')
-      recorder.session.start('auto login')
-      return loginAndSave()
-        .then(() => {
-          recorder.add(() => recorder.session.restore('auto login'))
-          recorder.catch(() => debug('continue'))
-        })
-        .catch(err => {
-          recorder.session.restore('auto login')
-          recorder.session.restore('check login')
-          recorder.throw(err)
-        })
-    })
-    recorder.add(() => {
-      recorder.session.restore('check login')
-    })
-
-    return recorder.promise()
-  }
-
-  // adding this to DI container
-  const support = {}
-  support[config.inject] = loginFunction
-  container.append({ support })
-}
+module.exports = auth

package/lib/plugin/pageInfo.js

@@ -3,7 +3,7 @@ const fs = require('fs')
 const Container = require('../container')
 const recorder = require('../recorder')
 const event = require('../event')
-const supportedHelpers = require('./standardActingHelpers')
+const supportedHelpers = Container.STANDARD_ACTING_HELPERS
 const { scanForErrorMessages } = require('../html')
 const { output } = require('..')
 const { humanizeString, ucfirst } = require('../utils')

package/lib/plugin/retryFailedStep.js

@@ -1,8 +1,6 @@
 const event = require('../event')
 const recorder = require('../recorder')
-const container = require('../container')
-const { log } = require('../output')
-
+const store = require('../store')
 const defaultConfig = {
   retries: 3,
   defaultIgnoredSteps: ['amOnPage', 'wait*', 'send*', 'execute*', 'run*', 'have*'],
@@ -70,9 +68,9 @@ const defaultConfig = {
  * Use scenario configuration to disable plugin for a test
  *
  * ```js
- * Scenario('scenario tite', () => {
+ * Scenario('scenario tite', { disableRetryFailedStep: true }, () => {
  *    // test goes here
- * }).config(test => test.disableRetryFailedStep = true)
+ * })
  * ```
  *
  */
@@ -85,19 +83,14 @@ module.exports = config => {
 
   const when = err => {
     if (!enableRetry) return
-    const store = require('../store')
     if (store.debugMode) return false
+    if (!store.autoRetries) return false
     if (customWhen) return customWhen(err)
     return true
   }
   config.when = when
 
   event.dispatcher.on(event.step.started, step => {
-    if (process.env.TRY_TO === 'true') {
-      log('Info: RetryFailedStep plugin is disabled inside tryTo block')
-      return
-    }
-
     // if a step is ignored - return
     for (const ignored of config.ignoredSteps) {
       if (step.name === ignored) return
@@ -113,9 +106,15 @@ module.exports = config => {
   })
 
   event.dispatcher.on(event.test.before, test => {
-    if (test && test.disableRetryFailedStep) return // disable retry when a test is not active
-    // this env var is used to set the retries inside _before() block of helpers
-    process.env.FAILED_STEP_RETRIES = config.retries
+    // pass disableRetryFailedStep is a preferred way to disable retries
+    // test.disableRetryFailedStep is used for backward compatibility
+    if (test.opts.disableRetryFailedStep || test.disableRetryFailedStep) {
+      store.autoRetries = false
+      return // disable retry when a test is not active
+    }
+    // this option is used to set the retries inside _before() block of helpers
+    store.autoRetries = true
+    test.opts.conditionalRetries = config.retries
     recorder.retry(config)
   })
 }

package/lib/plugin/retryTo.js

@@ -1,23 +1,12 @@
 const { retryTo } = require('../effects')
 
-module.exports = function (config) {
-  console.log(`
-Deprecation Warning: 'retryTo' has been moved to the effects module.
-You should update your tests to use it as follows:
-
-\`\`\`javascript
-const { retryTo } = require('codeceptjs/effects');
-
-// Example: Retry these steps 5 times before failing
-await retryTo((tryNum) => {
-  I.switchTo('#editor frame');
-  I.click('Open');
-  I.see('Opened');
-}, 5);
-\`\`\`
+const defaultConfig = {
+  registerGlobal: true,
+}
 
-For more details, refer to the documentation.
-  `)
+module.exports = function (config) {
+  config = Object.assign(defaultConfig, config)
+  console.log(`Deprecation Warning: 'retryTo' has been moved to the 'codeceptjs/effects' module. Disable retryTo plugin to remove this warning.`)
 
   if (config.registerGlobal) {
     global.retryTo = retryTo

package/lib/plugin/screenshotOnFail.js

@@ -15,7 +15,7 @@ const defaultConfig = {
   fullPageScreenshots: false,
 }
 
-const supportedHelpers = require('./standardActingHelpers')
+const supportedHelpers = Container.STANDARD_ACTING_HELPERS
 
 /**
  * Creates screenshot on failure. Screenshot is saved into `output` directory.
@@ -83,13 +83,12 @@ module.exports = function (config) {
       async () => {
         const dataType = 'image/png'
         // This prevents data driven to be included in the failed screenshot file name
-        let fileName = testToFileName(test)
+        let fileName
 
         if (options.uniqueScreenshotNames && test) {
-          const uuid = _getUUID(test)
-          fileName = `${fileName.substring(0, 10)}_${uuid}.failed.png`
+          fileName = `${testToFileName(test, _getUUID(test))}.failed.png`
         } else {
-          fileName += '.failed.png'
+          fileName = `${testToFileName(test)}.failed.png`
         }
         output.plugin('screenshotOnFail', 'Test failed, try to save a screenshot')
 

package/lib/plugin/standardActingHelpers.js

@@ -1,3 +1,6 @@
-const standardActingHelpers = ['Playwright', 'WebDriver', 'Puppeteer', 'Appium', 'TestCafe']
+const Container = require('../container')
+// due to using this in internal tooling we won't post deprecation warning
+// but please switch to Container.STANDARD_ACTING_HELPERS
+const standardActingHelpers = Container.STANDARD_ACTING_HELPERS
 
 module.exports = standardActingHelpers

package/lib/plugin/stepByStepReport.js

@@ -12,7 +12,7 @@ const event = require('../event')
 const output = require('../output')
 const { template, deleteDir } = require('../utils')
 
-const supportedHelpers = require('./standardActingHelpers')
+const supportedHelpers = Container.STANDARD_ACTING_HELPERS
 
 const defaultConfig = {
   deleteSuccessful: true,

package/lib/plugin/tryTo.js

@@ -1,21 +1,12 @@
 const { tryTo } = require('../effects')
 
-module.exports = function (config) {
-  console.log(`
-Deprecated Warning: 'tryTo' has been moved to the effects module.
-You should update your tests to use it as follows:
-
-\`\`\`javascript
-const { tryTo } = require('codeceptjs/effects');
-
-// Example: failed step won't fail a test but will return true/false
-await tryTo(() => {
-  I.switchTo('#editor frame');
-});
-\`\`\`
+const defaultConfig = {
+  registerGlobal: true,
+}
 
-For more details, refer to the documentation.
-  `)
+module.exports = function (config) {
+  config = Object.assign(defaultConfig, config)
+  console.log(`Deprecation Warning: 'tryTo' has been moved to the 'codeceptjs/effects' module. Disable tryTo plugin to remove this warning.`)
 
   if (config.registerGlobal) {
     global.tryTo = tryTo

package/lib/recorder.js

@@ -192,6 +192,7 @@ module.exports = {
         .pop()
       // no retries or unnamed tasks
       debug(`${currentQueue()} Running | ${taskName} | Timeout: ${timeout || 'None'}`)
+      if (retryOpts) debug(`${currentQueue()} Retry opts`, JSON.stringify(retryOpts))
 
       if (!retryOpts || !taskName || !retry) {
         const [promise, timer] = getTimeoutPromise(timeout, taskName)

package/lib/step/base.js

@@ -2,6 +2,7 @@ const color = require('chalk')
 const Secret = require('../secret')
 const { getCurrentTimeout } = require('../timeout')
 const { ucfirst, humanizeString, serializeError } = require('../utils')
+const recordStep = require('./record')
 
 const STACK_LINE = 5
 
@@ -24,8 +25,7 @@ class Step {
     this.opts = {}
     /** @member {string} */
     this.actor = 'I' // I = actor
-    /** @member {string} */
-    this.helperMethod = name // helper method
+
     /** @member {string} */
     this.status = 'pending'
     /** @member {string} */
@@ -37,6 +37,13 @@ class Step {
     /** @member {string} */
     this.stack = ''
 
+    // These are part of HelperStep class
+    // but left here for types compatibility
+    /** @member {any} */
+    this.helper = null
+    /** @member {string} */
+    this.helperMethod = name
+
     this.startTime = 0
     this.endTime = 0
 
@@ -51,6 +58,10 @@ class Step {
     throw new Error('Not implemented')
   }
 
+  addToRecorder(args) {
+    return recordStep(this, args)
+  }
+
   /**
    * @returns {number|undefined}
    */
@@ -190,8 +201,8 @@ class Step {
           args.push(arg.name)
         } else if (typeof arg == 'string') {
           args.push(arg)
-        } else {
-          args.push(JSON.stringify(arg).slice(0, 300))
+        } else if (arg) {
+          args.push((JSON.stringify(arg) || '').slice(0, 300))
         }
       }
     }

package/lib/step/comment.js

@@ -0,0 +1,10 @@
+const FuncStep = require('./func')
+
+class CommentStep extends FuncStep {
+  constructor(name, comment) {
+    super(name)
+    this.fn = () => {}
+  }
+}
+
+module.exports = CommentStep

package/lib/store.js

@@ -3,17 +3,41 @@
  * @namespace
  */
 const store = {
-  /** @type {boolean} */
+  /**
+   * 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,
-  /** @type {boolean} */
+  /**
+   * If we are in pause mode
+   * @type {boolean}
+   */
   onPause: false,
+
+  // current object states
+
   /** @type {CodeceptJS.Test | null} */
   currentTest: null,
-  /** @type {any} */
+  /** @type {CodeceptJS.Step | null} */
   currentStep: null,
   /** @type {CodeceptJS.Suite | null} */
   currentSuite: null,

package/lib/utils.js

@@ -13,7 +13,7 @@ function deepMerge(target, source) {
 }
 
 module.exports.genTestId = test => {
-  return require('crypto').createHash('sha256').update(test.fullTitle()).digest('base64').slice(0, -2)
+  return this.clearString(require('crypto').createHash('sha256').update(test.fullTitle()).digest('base64').slice(0, -2))
 }
 
 module.exports.deepMerge = deepMerge

package/lib/within.js

@@ -7,6 +7,8 @@ const MetaStep = require('./step/meta')
 const { isAsyncFunction } = require('./utils')
 
 /**
+ * TODO: move to effects
+ *
  * @param {CodeceptJS.LocatorOrString}  context
  * @param {Function}  fn
  * @return {Promise<*> | undefined}