codeceptjs 3.7.0-beta.12 → 3.7.0-beta.13

package/lib/plugin/autoLogin.js

@@ -1,5 +1,339 @@
-const auth = require('./auth')
+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
 
-console.log('autoLogin plugin was renamed to auth plugin. Please update your config.')
+const defaultUser = {
+  fetch: I => I.grabCookie(),
+  check: () => {},
+  restore: (I, cookies) => {
+    I.amOnPage('/') // open a page
+    I.setCookie(cookies)
+  },
+}
 
-module.exports = auth
+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 })
+}

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 = Container.STANDARD_ACTING_HELPERS
+const supportedHelpers = require('./standardActingHelpers')
 const { scanForErrorMessages } = require('../html')
 const { output } = require('..')
 const { humanizeString, ucfirst } = require('../utils')

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`)
 
   if (config.registerGlobal) {
     global.retryTo = retryTo

package/lib/plugin/screenshotOnFail.js

@@ -15,7 +15,7 @@ const defaultConfig = {
   fullPageScreenshots: false,
 }
 
-const supportedHelpers = Container.STANDARD_ACTING_HELPERS
+const supportedHelpers = require('./standardActingHelpers')
 
 /**
  * Creates screenshot on failure. Screenshot is saved into `output` directory.

package/lib/plugin/standardActingHelpers.js

@@ -1,6 +1,3 @@
-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
+const standardActingHelpers = ['Playwright', 'WebDriver', 'Puppeteer', 'Appium', 'TestCafe']
 
 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 = Container.STANDARD_ACTING_HELPERS
+const supportedHelpers = require('./standardActingHelpers')
 
 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`)
 
   if (config.registerGlobal) {
     global.tryTo = tryTo

package/lib/step/base.js

@@ -2,7 +2,6 @@ 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
 
@@ -52,10 +51,6 @@ class Step {
     throw new Error('Not implemented')
   }
 
-  addToRecorder(args) {
-    return recordStep(this, args)
-  }
-
   /**
    * @returns {number|undefined}
    */
@@ -195,8 +190,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.0-beta.12",
+  "version": "3.7.0-beta.13",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -74,7 +74,7 @@
     "publish-beta": "./runok.js publish:next-beta-version"
   },
   "dependencies": {
-    "@codeceptjs/configure": "1.0.2",
+    "@codeceptjs/configure": "1.0.1",
     "@codeceptjs/helper": "2.0.4",
     "@cucumber/cucumber-expressions": "18",
     "@cucumber/gherkin": "30",
@@ -94,7 +94,8 @@
     "figures": "3.2.0",
     "fn-args": "4.0.0",
     "fs-extra": "11.3.0",
-    "glob": ">=9.0.0 <12",
+    "fs-extra": "11.2.0",
+    "glob": "^11.0.1",
     "fuse.js": "^7.0.0",
     "html-minifier-terser": "7.2.0",
     "inquirer": "6.5.2",
@@ -123,23 +124,23 @@
     "@codeceptjs/expect-helper": "^0.2.2",
     "@codeceptjs/mock-request": "0.3.1",
     "@eslint/eslintrc": "3.2.0",
-    "@eslint/js": "9.19.0",
+    "@eslint/js": "9.18.0",
     "@faker-js/faker": "9.4.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "5.1.0",
     "@types/chai": "4.3.19",
     "@types/inquirer": "9.0.7",
-    "@types/node": "22.12.0",
-    "@wdio/sauce-service": "9.7.1",
+    "@types/node": "22.10.7",
+    "@wdio/sauce-service": "9.5.7",
     "@wdio/selenium-standalone-service": "8.15.0",
-    "@wdio/utils": "9.6.4",
+    "@wdio/utils": "9.5.0",
     "@xmldom/xmldom": "0.9.7",
     "chai": "^4.0.0",
     "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "documentation": "14.0.3",
-    "electron": "34.0.1",
-    "eslint": "^9.19.0",
+    "electron": "34.0.0",
+    "eslint": "^9.18.0",
     "eslint-plugin-import": "2.31.0",
     "eslint-plugin-mocha": "10.5.0",
     "expect": "29.7.0",
@@ -152,9 +153,9 @@
     "jsdoc": "^3.6.11",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.17.4",
-    "playwright": "1.50.0",
+    "playwright": "1.49.1",
     "prettier": "^3.3.2",
-    "puppeteer": "24.1.1",
+    "puppeteer": "24.1.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "0.9.3",
@@ -170,7 +171,7 @@
     "typedoc-plugin-markdown": "4.4.1",
     "typescript": "5.7.3",
     "wdio-docker-service": "1.5.0",
-    "webdriverio": "^9.7.1",
+    "webdriverio": "^9.5.1",
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },

package/translations/de-DE.js

@@ -1,10 +1,9 @@
-const { gherkinTranslations } = require('./utils')
-const langCode = 'de'
-
 module.exports = {
   I: 'Ich',
   contexts: {
-    ...gherkinTranslations(langCode),
+    Feature: 'Funktionalität',
+    Scenario: 'Szenario',
+    ScenarioOutline: 'Szenariogrundriss',
   },
   actions: {
     amOutsideAngularApp: 'befinde_mich_außerhalb_der_angular_app',

package/translations/fr-FR.js

@@ -1,10 +1,9 @@
-const { gherkinTranslations } = require('./utils')
-const langCode = 'fr'
-
 module.exports = {
   I: 'Je',
   contexts: {
-    ...gherkinTranslations(langCode),
+    Feature: 'Fonctionnalité',
+    Scenario: 'Scénario',
+    ScenarioOutline: 'Plan du scénario',
     Before: 'Avant',
     After: 'Après',
     BeforeSuite: 'AvantLaSuite',

package/translations/index.js

@@ -7,4 +7,3 @@ exports['pt-BR'] = require('./pt-BR')
 exports['ru-RU'] = require('./ru-RU')
 exports['zh-CN'] = require('./zh-CN')
 exports['zh-TW'] = require('./zh-TW')
-exports['nl-NL'] = require('./nl-NL')

package/translations/it-IT.js

@@ -1,10 +1,9 @@
-const { gherkinTranslations } = require('./utils')
-const langCode = 'it'
-
 module.exports = {
   I: 'io',
   contexts: {
-    ...gherkinTranslations(langCode),
+    Feature: 'Caratteristica',
+    Scenario: 'lo_scenario',
+    ScenarioOutline: 'Schema dello scenario',
     Before: 'Prima',
     After: 'Dopo',
     BeforeSuite: 'Prima_della_suite',

package/translations/ja-JP.js

@@ -1,10 +1,9 @@
-const { gherkinTranslations } = require('./utils')
-const langCode = 'ja'
-
 module.exports = {
   I: '私は',
   contexts: {
-    ...gherkinTranslations(langCode),
+    Feature: 'フィーチャ',
+    Scenario: 'シナリオ',
+    ScenarioOutline: 'シナリオアウトライン',
   },
   actions: {
     amOutsideAngularApp: 'Angularの外に出る',

package/translations/pl-PL.js

@@ -1,10 +1,9 @@
-const { gherkinTranslations } = require('./utils')
-const langCode = 'pl'
-
 module.exports = {
   I: 'Ja',
   contexts: {
-    ...gherkinTranslations(langCode),
+    Feature: 'Funkcja',
+    Scenario: 'Scenariusz',
+    ScenarioOutline: 'Szablon scenariusza',
   },
   actions: {
     amOutsideAngularApp: 'jestem_poza_aplikacją_angular',

package/translations/pt-BR.js

@@ -1,10 +1,9 @@
-const { gherkinTranslations } = require('./utils')
-const langCode = 'pt'
-
 module.exports = {
   I: 'Eu',
   contexts: {
-    ...gherkinTranslations(langCode),
+    Feature: 'Funcionalidade',
+    Scenario: 'Cenário',
+    ScenarioOutline: 'Esquema do Cenário',
     Before: 'Antes',
     After: 'Depois',
     BeforeSuite: 'AntesDaSuite',

package/translations/ru-RU.js

@@ -1,10 +1,9 @@
-const { gherkinTranslations } = require('./utils')
-const langCode = 'ru'
-
 module.exports = {
   I: 'Я',
   contexts: {
-    ...gherkinTranslations(langCode),
+    Feature: 'Цель',
+    Scenario: 'Сценарий',
+    ScenarioOutline: 'Структура сценария',
     Before: 'Начало',
     After: 'Конец',
     BeforeSuite: 'Перед_всем',

package/translations/zh-CN.js

@@ -1,10 +1,9 @@
-const { gherkinTranslations } = require('./utils')
-const langCode = 'zh-CN'
-
 module.exports = {
   I: '我',
   contexts: {
-    ...gherkinTranslations(langCode),
+    Feature: '功能',
+    Scenario: '场景',
+    ScenarioOutline: '场景大纲',
   },
   actions: {
     amOutsideAngularApp: '在Angular应用外',