codeceptjs 3.7.0-beta.4 → 3.7.0-beta.5

package/lib/helper/Appium.js

@@ -386,7 +386,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 +602,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 +619,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 +693,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 +717,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 +956,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 +1044,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 +1497,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 => {
@@ -552,6 +553,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
@@ -3499,6 +3509,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')
@@ -2698,7 +2699,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))

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/globalTimeout.js

@@ -2,9 +2,9 @@ const event = require('../event')
 const output = require('../output')
 const recorder = require('../recorder')
 const Config = require('../config')
-const { timeouts } = require('../store')
+const store = require('../store')
 const debug = require('debug')('codeceptjs:timeout')
-const TIMEOUT_ORDER = require('../step').TIMEOUT_ORDER
+const { TIMEOUT_ORDER } = require('../step/timeout')
 const { BeforeSuiteHook, AfterSuiteHook } = require('../mocha/hooks')
 
 module.exports = function () {
@@ -13,7 +13,7 @@ module.exports = function () {
   let currentTest
   let currentTimeout
 
-  if (!timeouts) {
+  if (!store.timeouts) {
     console.log('Timeouts were disabled')
     return
   }
@@ -22,9 +22,11 @@ module.exports = function () {
   // 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 = []
     }
   })
@@ -103,6 +105,11 @@ 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)
@@ -113,6 +120,11 @@ module.exports = function () {
   })
 
   event.dispatcher.on(event.step.finished, step => {
+    if (!store.timeouts) {
+      debug('step', step.toCode().trim(), 'timeout disabled')
+      return
+    }
+
     if (typeof timeout === 'number' && !Number.isNaN(timeout)) timeout -= step.duration
 
     if (typeof timeout === 'number' && timeout <= 0 && recorder.isRunning()) {

package/lib/listener/steps.js

@@ -73,6 +73,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)
     }
@@ -84,5 +85,7 @@ module.exports = function () {
     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/mocha/cli.js

@@ -1,6 +1,7 @@
 const {
   reporters: { Base },
 } = require('mocha')
+const figures = require('figures')
 const ms = require('ms')
 const event = require('../event')
 const AssertionFailedError = require('../assert/error')
@@ -163,33 +164,49 @@ class Cli extends Base {
         const err = test.err
 
         let log = ''
+        let originalMessage = err.message
 
         if (err instanceof AssertionFailedError) {
           err.message = err.inspect()
         }
 
+        // multi-line error messages
+        err.message = '\n  ' + (err.message || '').replace(/^/gm, '  ').trim()
+
         const steps = test.steps || (test.ctx && test.ctx.test.steps)
 
         if (steps && steps.length) {
           let scenarioTrace = ''
           steps.reverse().forEach(step => {
-            const line = `- ${step.toCode()} ${step.line()}`
-            // if (step.status === 'failed') line = '' + line;
+            const hasFailed = step.status === 'failed'
+            let line = `${hasFailed ? output.styles.bold(figures.cross) : figures.tick} ${step.toCode()} ${step.line()}`
+            if (hasFailed) line = output.styles.bold(line)
             scenarioTrace += `\n${line}`
           })
-          log += `${output.styles.bold('Scenario Steps')}:${scenarioTrace}\n`
+          log += `${output.styles.basic(figures.circle)} ${output.styles.section('Scenario Steps')}:${scenarioTrace}\n`
         }
 
         // display artifacts in debug mode
         if (test?.artifacts && Object.keys(test.artifacts).length) {
-          log += `\n${output.styles.bold('Artifacts:')}`
+          log += `\n${output.styles.basic(figures.circle)} ${output.styles.section('Artifacts:')}`
           for (const artifact of Object.keys(test.artifacts)) {
             log += `\n- ${artifact}: ${test.artifacts[artifact]}`
           }
         }
 
+        // display metadata
+        if (test.meta && Object.keys(test.meta).length) {
+          log += `\n\n${output.styles.basic(figures.circle)} ${output.styles.section('Metadata:')}`
+          for (const [key, value] of Object.entries(test.meta)) {
+            log += `\n- ${key}: ${value}`
+          }
+        }
+
         try {
-          let stack = err.stack ? err.stack.split('\n') : []
+          let stack = err.stack
+          stack = stack.replace(originalMessage, '')
+          stack = stack ? stack.split('\n') : []
+
           if (stack[0] && stack[0].includes(err.message)) {
             stack.shift()
           }

package/lib/mocha/featureConfig.js

@@ -7,6 +7,19 @@ class FeatureConfig {
     this.suite = suite
   }
 
+  /**
+   * Set metadata for this suite
+   * @param {string} key
+   * @param {string} value
+   * @returns {this}
+   */
+  meta(key, value) {
+    this.suite.tests.forEach(test => {
+      test.meta[key] = value
+    })
+    return this
+  }
+
   /**
    * Retry this test for number of times
    *

package/lib/mocha/scenarioConfig.js

@@ -42,6 +42,17 @@ class ScenarioConfig {
     return this
   }
 
+  /**
+   * Set metadata for this test
+   * @param {string} key
+   * @param {string} value
+   * @returns {this}
+   */
+  meta(key, value) {
+    this.test.meta[key] = value
+    return this
+  }
+
   /**
    * Set timeout for this test
    * @param {number} timeout

package/lib/mocha/test.js

@@ -1,4 +1,5 @@
 const Test = require('mocha/lib/test')
+const Suite = require('mocha/lib/suite')
 const { test: testWrapper } = require('./asyncWrapper')
 const { enhanceMochaSuite } = require('./suite')
 const { genTestId } = require('../utils')
@@ -31,6 +32,12 @@ function enhanceMochaTest(test) {
   test.artifacts = []
   test.inject = {}
   test.opts = {}
+  test.meta = {}
+
+  test.notes = []
+  test.addNote = (type, note) => {
+    test.notes.push({ type, text: note })
+  }
 
   // Add new methods
   /**
@@ -47,6 +54,7 @@ function enhanceMochaTest(test) {
   test.applyOptions = function (opts) {
     if (!opts) opts = {}
     test.opts = opts
+    test.meta = opts.meta || {}
     test.totalTimeout = opts.timeout
     if (opts.retries) this.retries(opts.retries)
   }
@@ -54,7 +62,14 @@ function enhanceMochaTest(test) {
   return test
 }
 
+function repackTestForWorkersTransport(test) {
+  test = Object.assign(new Test(test.title || '', () => {}), test)
+  test.parent = Object.assign(new Suite(test.parent.title), test.parent)
+  return test
+}
+
 module.exports = {
   createTest,
   enhanceMochaTest,
+  repackTestForWorkersTransport,
 }

package/lib/mocha/types.d.ts

@@ -7,6 +7,11 @@ declare global {
       title: string
       tags: string[]
       steps: string[]
+      meta: Record<string, any>
+      notes: Array<{
+        type: string
+        text: string
+      }>
       config: Record<string, any>
       artifacts: string[]
       inject: Record<string, any>
@@ -15,6 +20,7 @@ declare global {
       totalTimeout?: number
       addToSuite(suite: Mocha.Suite): void
       applyOptions(opts: Record<string, any>): void
+      addNote(type: string, note: string): void
       codeceptjs: boolean
     }