codeceptjs 3.7.0-beta.1 → 3.7.0-beta.11

package/lib/helper/AI.js

@@ -3,13 +3,14 @@ const ora = require('ora-classic')
 const fs = require('fs')
 const path = require('path')
 const ai = require('../ai')
-const standardActingHelpers = require('../plugin/standardActingHelpers')
 const Container = require('../container')
 const { splitByChunks, minifyHtml } = require('../html')
 const { beautify } = require('../utils')
 const output = require('../output')
 const { registerVariable } = require('../pause')
 
+const standardActingHelpers = Container.STANDARD_ACTING_HELPERS
+
 const gtpRole = {
   user: 'user',
 }

package/lib/helper/Appium.js

@@ -44,7 +44,7 @@ const vendorPrefix = {
  *
  * This helper should be configured in codecept.conf.ts or codecept.conf.js
  *
- * * `appiumV2`: set this to true if you want to run tests with AppiumV2. See more how to setup [here](https://codecept.io/mobile/#setting-up)
+ * * `appiumV2`: by default is true, set this to false if you want to run tests with AppiumV1. See more how to setup [here](https://codecept.io/mobile/#setting-up)
  * * `app`: Application path. Local path or remote URL to an .ipa or .apk file, or a .zip containing one of these. Alias to desiredCapabilities.appPackage
  * * `host`: (default: 'localhost') Appium host
  * * `port`: (default: '4723') Appium port
@@ -124,7 +124,7 @@ const vendorPrefix = {
  * {
  * helpers: {
  *   Appium: {
- *         appiumV2: true,
+ *         appiumV2: true, // By default is true, set to false if you want to run against Appium v1
  *         host: "hub-cloud.browserstack.com",
  *         port: 4444,
  *         user: process.env.BROWSERSTACK_USER,
@@ -178,14 +178,12 @@ class Appium extends Webdriver {
     super(config)
 
     this.isRunning = false
-    if (config.appiumV2 === true) {
-      this.appiumV2 = true
-    }
+    this.appiumV2 = config.appiumV2 || true
     this.axios = axios.create()
 
     webdriverio = require('webdriverio')
     if (!config.appiumV2) {
-      console.log('The Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. Please migrating to Appium 2.x by adding appiumV2: true to your config.')
+      console.log('The Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. Appium 2.x is used by default.')
       console.log('More info: https://bit.ly/appium-v2-migration')
       console.log('This Appium 1.x support will be removed in next major release.')
     }
@@ -386,7 +384,7 @@ class Appium extends Webdriver {
   _buildAppiumEndpoint() {
     const { protocol, port, hostname, path } = this.browser.options
     // Build path to Appium REST API endpoint
-    return `${protocol}://${hostname}:${port}${path}`
+    return `${protocol}://${hostname}:${port}${path}/session/${this.browser.sessionId}`
   }
 
   /**
@@ -602,7 +600,7 @@ class Appium extends Webdriver {
 
     return this.axios({
       method: 'post',
-      url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/appium/device/remove_app`,
+      url: `${this._buildAppiumEndpoint()}/appium/device/remove_app`,
       data: { appId, bundleId },
     })
   }
@@ -619,7 +617,7 @@ class Appium extends Webdriver {
     onlyForApps.call(this)
     return this.axios({
       method: 'post',
-      url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/appium/app/reset`,
+      url: `${this._buildAppiumEndpoint()}/appium/app/reset`,
     })
   }
 
@@ -693,7 +691,7 @@ class Appium extends Webdriver {
 
     const res = await this.axios({
       method: 'get',
-      url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/orientation`,
+      url: `${this._buildAppiumEndpoint()}/orientation`,
     })
 
     const currentOrientation = res.data.value
@@ -717,7 +715,7 @@ class Appium extends Webdriver {
 
     return this.axios({
       method: 'post',
-      url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/orientation`,
+      url: `${this._buildAppiumEndpoint()}/orientation`,
       data: { orientation },
     })
   }
@@ -956,21 +954,19 @@ class Appium extends Webdriver {
    * ```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 {'tapOutside' | 'pressKey'} [strategy] Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-   * @param {string} [key] Optional key
    */
-  async hideDeviceKeyboard(strategy, key) {
+  async hideDeviceKeyboard() {
     onlyForApps.call(this)
-    strategy = strategy || 'tapOutside'
-    return this.browser.hideKeyboard(strategy, key)
+
+    return this.axios({
+      method: 'post',
+      url: `${this._buildAppiumEndpoint()}/appium/device/hide_keyboard`,
+      data: {},
+    })
   }
 
   /**
@@ -1046,7 +1042,13 @@ class Appium extends Webdriver {
    * @param {*} locator
    */
   async tap(locator) {
-    return this.makeTouchAction(locator, 'tap')
+    const { elementId } = await this.browser.$(parseLocator.call(this, locator))
+
+    return this.axios({
+      method: 'post',
+      url: `${this._buildAppiumEndpoint()}/element/${elementId}/click`,
+      data: {},
+    })
   }
 
   /**
@@ -1493,7 +1495,14 @@ class Appium extends Webdriver {
    */
   async click(locator, context) {
     if (this.isWeb) return super.click(locator, context)
-    return super.click(parseLocator.call(this, locator), parseLocator.call(this, context))
+
+    const { elementId } = await this.browser.$(parseLocator.call(this, locator), parseLocator.call(this, context))
+
+    return this.axios({
+      method: 'post',
+      url: `${this._buildAppiumEndpoint()}/element/${elementId}/click`,
+      data: {},
+    })
   }
 
   /**

package/lib/helper/Playwright.js

@@ -482,6 +482,7 @@ class Playwright extends Helper {
 
   async _before(test) {
     this.currentRunningTest = test
+
     recorder.retry({
       retries: process.env.FAILED_STEP_RETRIES || 3,
       when: err => {
@@ -522,12 +523,17 @@ class Playwright extends Helper {
         this.currentRunningTest.artifacts.har = fileName
         contextOptions.recordHar = this.options.recordHar
       }
+
+      // load pre-saved cookies
+      if (test?.opts?.cookies) contextOptions.storageState = { cookies: test.opts.cookies }
+
       if (this.storageState) contextOptions.storageState = this.storageState
       if (this.options.userAgent) contextOptions.userAgent = this.options.userAgent
       if (this.options.locale) contextOptions.locale = this.options.locale
       if (this.options.colorScheme) contextOptions.colorScheme = this.options.colorScheme
       this.contextOptions = contextOptions
       if (!this.browserContext || !restartsSession()) {
+        this.debugSection('New Session', JSON.stringify(this.contextOptions))
         this.browserContext = await this.browser.newContext(this.contextOptions) // Adding the HTTPSError ignore in the context so that we can ignore those errors
       }
     }
@@ -552,6 +558,15 @@ class Playwright extends Helper {
 
     await this._setPage(mainPage)
 
+    try {
+      // set metadata for reporting
+      test.meta.browser = this.browser.browserType().name()
+      test.meta.browserVersion = this.browser.version()
+      test.meta.windowSize = `${this.page.viewportSize().width}x${this.page.viewportSize().height}`
+    } catch (e) {
+      this.debug('Failed to set metadata for reporting')
+    }
+
     if (this.options.trace) await this.browserContext.tracing.start({ screenshots: true, snapshots: true })
 
     return this.browser
@@ -928,7 +943,8 @@ class Playwright extends Helper {
       throw new Error('Cannot open pages inside an Electron container')
     }
     if (!/^\w+\:(\/\/|.+)/.test(url)) {
-      url = this.options.url + (url.startsWith('/') ? url : `/${url}`)
+      url = this.options.url + (!this.options.url.endsWith('/') && url.startsWith('/') ? url : `/${url}`)
+      this.debug(`Changed URL to base url + relative path: ${url}`)
     }
 
     if (this.options.basicAuth && this.isAuthenticated !== true) {
@@ -3499,6 +3515,11 @@ async function proceedSee(assertType, text, context, strict = false) {
     allText = await Promise.all(els.map(el => el.innerText()))
   }
 
+  if (store?.currentStep?.opts?.ignoreCase === true) {
+    text = text.toLowerCase()
+    allText = allText.map(elText => elText.toLowerCase())
+  }
+
   if (strict) {
     return allText.map(elText => equals(description)[assertType](text, elText))
   }

package/lib/helper/Puppeteer.js

@@ -2769,6 +2769,11 @@ async function proceedSee(assertType, text, context, strict = false) {
     allText = await Promise.all(els.map(el => el.getProperty('innerText').then(p => p.jsonValue())))
   }
 
+  if (store?.currentStep?.opts?.ignoreCase === true) {
+    text = text.toLowerCase()
+    allText = allText.map(elText => elText.toLowerCase())
+  }
+
   if (strict) {
     return allText.map(elText => equals(description)[assertType](text, elText))
   }

package/lib/helper/WebDriver.js

@@ -7,6 +7,7 @@ const Helper = require('@codeceptjs/helper')
 const promiseRetry = require('promise-retry')
 const stringIncludes = require('../assert/include').includes
 const { urlEquals, equals } = require('../assert/equal')
+const store = require('../store')
 const { debug } = require('../output')
 const { empty } = require('../assert/empty')
 const { truth } = require('../assert/truth')
@@ -23,6 +24,7 @@ const { dontSeeTraffic, seeTraffic, grabRecordedNetworkTraffics, stopRecordingTr
 
 const SHADOW = 'shadow'
 const webRoot = 'body'
+let browserLogs = []
 
 /**
  * ## Configuration
@@ -620,6 +622,10 @@ class WebDriver extends Helper {
     }
 
     this.browser.on('dialog', () => {})
+
+    await this.browser.sessionSubscribe({ events: ['log.entryAdded'] })
+    this.browser.on('log.entryAdded', logEvents)
+
     return this.browser
   }
 
@@ -657,6 +663,7 @@ class WebDriver extends Helper {
       if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err
     })
     await this.closeOtherTabs()
+    browserLogs = []
     return this.browser
   }
 
@@ -1521,11 +1528,7 @@ class WebDriver extends Helper {
    * {{> grabBrowserLogs }}
    */
   async grabBrowserLogs() {
-    if (this.browser.isW3C) {
-      this.debug('Logs not available in W3C specification')
-      return
-    }
-    return this.browser.getLogs('browser')
+    return browserLogs
   }
 
   /**
@@ -1787,18 +1790,25 @@ class WebDriver extends Helper {
 
         if (browser) {
           this.debug(`Screenshot of ${sessionName} session has been saved to ${outputFile}`)
-          return browser.saveScreenshot(outputFile)
+          await browser.saveScreenshot(outputFile)
         }
       }
     }
 
     if (!fullPage) {
       this.debug(`Screenshot has been saved to ${outputFile}`)
-      return this.browser.saveScreenshot(outputFile)
+      await this.browser.saveScreenshot(outputFile)
     }
 
     const originalWindowSize = await this.browser.getWindowSize()
 
+    // this case running on device, so we could not set the windowSize
+    if (this.browser.isMobile) {
+      this.debug(`Screenshot has been saved to ${outputFile}, size: ${originalWindowSize.width}x${originalWindowSize.height}`)
+      const buffer = await this.browser.saveScreenshot(outputFile)
+      return buffer
+    }
+
     let { width, height } = await this.browser
       .execute(function () {
         return {
@@ -2698,7 +2708,14 @@ async function proceedSee(assertType, text, context, strict = false) {
   const smartWaitEnabled = assertType === 'assert'
   const res = await this._locate(withStrictLocator(context), smartWaitEnabled)
   assertElementExists(res, context)
-  const selected = await forEachAsync(res, async el => this.browser.getElementText(getElementId(el)))
+  let selected = await forEachAsync(res, async el => this.browser.getElementText(getElementId(el)))
+
+  // apply ignoreCase option
+  if (store?.currentStep?.opts?.ignoreCase === true) {
+    text = text.toLowerCase()
+    selected = selected.map(elText => elText.toLowerCase())
+  }
+
   if (strict) {
     if (Array.isArray(selected) && selected.length !== 0) {
       return selected.map(elText => equals(description)[assertType](text, elText))
@@ -3126,4 +3143,8 @@ function prepareLocateFn(context) {
   }
 }
 
+function logEvents(event) {
+  browserLogs.push(event.text) // add log message to the array
+}
+
 module.exports = WebDriver

package/lib/listener/emptyRun.js

@@ -2,6 +2,7 @@ const figures = require('figures')
 const Container = require('../container')
 const event = require('../event')
 const output = require('../output')
+const { searchWithFusejs } = require('../utils')
 
 module.exports = function () {
   let isEmptyRun = true
@@ -15,8 +16,6 @@ module.exports = function () {
       const mocha = Container.mocha()
 
       if (mocha.options.grep) {
-        const Fuse = require('fuse.js')
-
         output.print()
         output.print('No tests found by pattern: ' + mocha.options.grep)
 
@@ -27,14 +26,12 @@ module.exports = function () {
           })
         })
 
-        const fuse = new Fuse(allTests, {
+        const results = searchWithFusejs(allTests, mocha.options.grep.toString(), {
           includeScore: true,
           threshold: 0.6,
           caseSensitive: false,
         })
 
-        const results = fuse.search(mocha.options.grep.toString())
-
         if (results.length > 0) {
           output.print()
           output.print('Maybe you wanted to run one of these tests?')

package/lib/listener/exit.js

@@ -1,20 +1,17 @@
 const event = require('../event')
+const debug = require('debug')('codeceptjs:exit')
 
 module.exports = function () {
   let failedTests = []
 
-  event.dispatcher.on(event.test.failed, testOrSuite => {
-    // NOTE When an error happens in one of the hooks (BeforeAll/BeforeEach...) the event object
-    // is a suite and not a test
-    const id = testOrSuite.uid || (testOrSuite.ctx && testOrSuite.ctx.test.uid) || 'empty'
+  event.dispatcher.on(event.test.failed, test => {
+    const id = test.uid || (test.ctx && test.ctx.test.uid) || 'empty'
     failedTests.push(id)
   })
 
   // if test was successful after retries
-  event.dispatcher.on(event.test.passed, testOrSuite => {
-    // NOTE When an error happens in one of the hooks (BeforeAll/BeforeEach...) the event object
-    // is a suite and not a test
-    const id = testOrSuite.uid || (testOrSuite.ctx && testOrSuite.ctx.test.uid) || 'empty'
+  event.dispatcher.on(event.test.passed, test => {
+    const id = test.uid || (test.ctx && test.ctx.test.uid) || 'empty'
     failedTests = failedTests.filter(failed => id !== failed)
   })
 

package/lib/listener/globalTimeout.js

@@ -2,8 +2,10 @@ const event = require('../event')
 const output = require('../output')
 const recorder = require('../recorder')
 const Config = require('../config')
-const { timeouts } = require('../store')
-const TIMEOUT_ORDER = require('../step').TIMEOUT_ORDER
+const store = require('../store')
+const debug = require('debug')('codeceptjs:timeout')
+const { TIMEOUT_ORDER, TimeoutError, TestTimeoutError, StepTimeoutError } = require('../timeout')
+const { BeforeSuiteHook, AfterSuiteHook } = require('../mocha/hooks')
 
 module.exports = function () {
   let timeout
@@ -11,16 +13,30 @@ module.exports = function () {
   let currentTest
   let currentTimeout
 
-  if (!timeouts) {
+  if (!store.timeouts) {
     console.log('Timeouts were disabled')
     return
   }
 
+  // disable timeout for BeforeSuite/AfterSuite hooks
+  // add separate configs to them?
+  event.dispatcher.on(event.hook.started, hook => {
+    if (hook instanceof BeforeSuiteHook) {
+      timeout = null
+      suiteTimeout = []
+    }
+    if (hook instanceof AfterSuiteHook) {
+      timeout = null
+      suiteTimeout = []
+    }
+  })
+
   event.dispatcher.on(event.suite.before, suite => {
     suiteTimeout = []
     let timeoutConfig = Config.get('timeout')
 
     if (timeoutConfig) {
+      debug('config:', timeoutConfig)
       if (!Number.isNaN(+timeoutConfig)) {
         checkForSeconds(timeoutConfig)
         suiteTimeout.push(timeoutConfig)
@@ -40,6 +56,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 => {
@@ -64,6 +82,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
@@ -80,24 +105,55 @@ module.exports = function () {
   event.dispatcher.on(event.step.before, step => {
     if (typeof timeout !== 'number') return
 
+    if (!store.timeouts) {
+      debug('step', step.toCode().trim(), 'timeout disabled')
+      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)
     }
   })
 
+  event.dispatcher.on(event.step.after, step => {
+    if (typeof timeout !== 'number') return
+    if (!store.timeouts) return
+
+    recorder.catchWithoutStop(err => {
+      // we wrap timeout errors in a StepTimeoutError
+      // but only if global timeout is set
+      // should we wrap all timeout errors?
+      if (err instanceof TimeoutError) {
+        const testTimeoutExceeded = timeout && +Date.now() - step.startTime >= timeout
+        debug('Step failed due to global test or suite timeout')
+        if (testTimeoutExceeded) {
+          debug('Test failed due to global test or suite timeout')
+          throw new TestTimeoutError(currentTimeout)
+        }
+        throw new StepTimeoutError(currentTimeout, step)
+      }
+      throw err
+    })
+  })
+
   event.dispatcher.on(event.step.finished, step => {
+    if (!store.timeouts) {
+      debug('step', step.toCode().trim(), 'timeout disabled')
+      return
+    }
+
+    if (typeof timeout === 'number') debug('Timeout', timeout)
+
+    debug(`step ${step.toCode().trim()}:${step.status} duration`, step.duration)
     if (typeof timeout === 'number' && !Number.isNaN(timeout)) timeout -= step.duration
 
     if (typeof timeout === 'number' && timeout <= 0 && recorder.isRunning()) {
-      if (currentTest && currentTest.callback) {
-        recorder.reset()
-        // replace mocha timeout with custom timeout
-        currentTest.timeout(0)
-        currentTest.callback(new Error(`Timeout ${currentTimeout}s exceeded (with Before hook)`))
-        currentTest.timedOut = true
-      }
+      debug(`step ${step.toCode().trim()} timed out`)
+      recorder.throw(new TestTimeoutError(currentTimeout))
     }
   })
 }

package/lib/listener/result.js

@@ -0,0 +1,12 @@
+const event = require('../event')
+const container = require('../container')
+
+module.exports = function () {
+  event.dispatcher.on(event.hook.failed, err => {
+    container.result().addStats({ failedHooks: 1 })
+  })
+
+  event.dispatcher.on(event.test.before, test => {
+    container.result().addTest(test)
+  })
+}

package/lib/listener/steps.js

@@ -13,7 +13,6 @@ let currentHook
 module.exports = function () {
   event.dispatcher.on(event.test.before, test => {
     test.startedAt = +new Date()
-    test.artifacts = {}
   })
 
   event.dispatcher.on(event.test.started, test => {
@@ -71,8 +70,7 @@ module.exports = function () {
   })
 
   event.dispatcher.on(event.step.started, step => {
-    step.startedAt = +new Date()
-    step.test = currentTest
+    store.currentStep = step
     if (currentHook && Array.isArray(currentHook.steps)) {
       return currentHook.steps.push(step)
     }
@@ -81,8 +79,7 @@ module.exports = function () {
   })
 
   event.dispatcher.on(event.step.finished, step => {
-    step.finishedAt = +new Date()
-    if (step.startedAt) step.duration = step.finishedAt - step.startedAt
-    debug(`Step '${step}' finished; Duration: ${step.duration || 0}ms`)
+    store.currentStep = null
+    store.stepOptions = null
   })
 }

package/lib/listener/store.js

@@ -2,11 +2,19 @@ const event = require('../event')
 const store = require('../store')
 
 module.exports = function () {
+  event.dispatcher.on(event.suite.before, suite => {
+    store.currentSuite = suite
+  })
+
+  event.dispatcher.on(event.suite.after, () => {
+    store.currentSuite = null
+  })
+
   event.dispatcher.on(event.test.before, test => {
     store.currentTest = test
   })
 
-  event.dispatcher.on(event.test.finished, test => {
+  event.dispatcher.on(event.test.finished, () => {
     store.currentTest = null
   })
 }

package/lib/mocha/asyncWrapper.js

@@ -13,12 +13,19 @@ const injectHook = function (inject, suite) {
     recorder.throw(err)
   }
   recorder.catch(err => {
-    event.emit(event.test.failed, suite, err)
+    suiteTestFailedHookError(suite, err)
     throw err
   })
   return recorder.promise()
 }
 
+function suiteTestFailedHookError(suite, err, hookName) {
+  suite.eachTest(test => {
+    test.err = err
+    event.emit(event.test.failed, test, err, ucfirst(hookName))
+  })
+}
+
 function makeDoneCallableOnce(done) {
   let called = false
   return function (err) {
@@ -61,6 +68,7 @@ module.exports.test = test => {
           err = newErr
         }
       }
+      test.err = err
       event.emit(event.test.failed, test, err)
       event.emit(event.test.finished, test)
       recorder.add(() => doneFn(err))
@@ -112,7 +120,7 @@ module.exports.injected = function (fn, suite, hookName) {
     const errHandler = err => {
       recorder.session.start('teardown')
       recorder.cleanAsyncErr()
-      event.emit(event.test.failed, suite, err)
+      if (hookName == 'before' || hookName == 'beforeSuite') suiteTestFailedHookError(suite, err, hookName)
       if (hookName === 'after') event.emit(event.test.after, suite)
       if (hookName === 'afterSuite') event.emit(event.suite.after, suite)
       recorder.add(() => doneFn(err))
@@ -137,11 +145,13 @@ module.exports.injected = function (fn, suite, hookName) {
     const opts = suite.opts || {}
     const retries = opts[`retry${ucfirst(hookName)}`] || 0
 
+    const currentTest = hookName === 'before' || hookName === 'after' ? suite?.ctx?.currentTest : null
+
     promiseRetry(
       async (retry, number) => {
         try {
           recorder.startUnlessRunning()
-          await fn.call(this, getInjectedArguments(fn))
+          await fn.call(this, { ...getInjectedArguments(fn), suite, test: currentTest })
           await recorder.promise().catch(err => retry(err))
         } catch (err) {
           retry(err)
@@ -156,6 +166,7 @@ module.exports.injected = function (fn, suite, hookName) {
     )
       .then(() => {
         recorder.add('fire hook.passed', () => fireHook(event.hook.passed, suite))
+        recorder.add('fire hook.finished', () => fireHook(event.hook.finished, suite))
         recorder.add(`finish ${hookName} hook`, doneFn)
         recorder.catch()
       })
@@ -166,6 +177,7 @@ module.exports.injected = function (fn, suite, hookName) {
           errHandler(err)
         })
         recorder.add('fire hook.failed', () => fireHook(event.hook.failed, suite, e))
+        recorder.add('fire hook.finished', () => fireHook(event.hook.finished, suite))
       })
   }
 }