codeceptjs 4.0.0-beta.3 → 4.0.0-beta.4

package/README.md

@@ -312,17 +312,17 @@ Thanks all to those who are and will have contributing to this awesome project!
 <a href="https://github.com/tsuemura"><img src="https://avatars.githubusercontent.com/u/17092259?v=4" title="tsuemura" width="80" height="80"></a>
 <a href="https://github.com/EgorBodnar"><img src="https://avatars.githubusercontent.com/u/63167966?v=4" title="EgorBodnar" width="80" height="80"></a>
 <a href="https://github.com/VikalpP"><img src="https://avatars.githubusercontent.com/u/11846339?v=4" title="VikalpP" width="80" height="80"></a>
+<a href="https://github.com/thomashohn"><img src="https://avatars.githubusercontent.com/u/3414869?v=4" title="thomashohn" width="80" height="80"></a>
 <a href="https://github.com/elaichenkov"><img src="https://avatars.githubusercontent.com/u/29764053?v=4" title="elaichenkov" width="80" height="80"></a>
 <a href="https://github.com/BorisOsipov"><img src="https://avatars.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
+<a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
 <a href="https://github.com/nitschSB"><img src="https://avatars.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
 <a href="https://github.com/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
 <a href="https://github.com/jploskonka"><img src="https://avatars.githubusercontent.com/u/669483?v=4" title="jploskonka" width="80" height="80"></a>
-<a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
 <a href="https://github.com/maojunxyz"><img src="https://avatars.githubusercontent.com/u/28778042?v=4" title="maojunxyz" width="80" height="80"></a>
 <a href="https://github.com/abhimanyupandian"><img src="https://avatars.githubusercontent.com/u/36107381?v=4" title="abhimanyupandian" width="80" height="80"></a>
 <a href="https://github.com/martomo"><img src="https://avatars.githubusercontent.com/u/1850135?v=4" title="martomo" width="80" height="80"></a>
 <a href="https://github.com/hatufacci"><img src="https://avatars.githubusercontent.com/u/4963181?v=4" title="hatufacci" width="80" height="80"></a>
-<a href="https://github.com/johnyb"><img src="https://avatars.githubusercontent.com/u/86358?v=4" title="johnyb" width="80" height="80"></a>
 
 [//]: contributor-faces
 

package/lib/cli.js

@@ -219,7 +219,6 @@ class Cli extends Base {
 
     this.failures.forEach((failure) => {
       if (failure.constructor.name === 'Hook') {
-        stats.failures -= stats.failures
         stats.failedHooks += 1
       }
     })

package/lib/codecept.js

@@ -92,6 +92,9 @@ class Codecept {
 
       // debug mode
       global.debugMode = false;
+
+      // mask sensitive data
+      global.maskSensitiveData = this.config.maskSensitiveData || false;
     }
   }
 

package/lib/command/dryRun.js

@@ -7,7 +7,7 @@ const store = require('../store')
 const Container = require('../container')
 
 module.exports = async function (test, options) {
-  if (options.grep) process.env.grep = options.grep.toLowerCase()
+  if (options.grep) process.env.grep = options.grep
   const configFile = options.config
   let codecept
 
@@ -60,35 +60,40 @@ function printTests(files) {
   let numOfTests = 0
   let numOfSuites = 0
   let outputString = ''
-  const filterBy = process.env.grep ? process.env.grep.toLowerCase() : undefined
+  const filterBy = process.env.grep
 
+  let filterRegex
   if (filterBy) {
-    for (const suite of mocha.suite.suites) {
-      const currentSuite = suite.title
-      if (suite.title.toLowerCase().includes(filterBy)) {
-        outputString += `${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')} -- ${mocha.suite.suites.length} tests\n`
-        numOfSuites++
-      }
-
-      for (test of suite.tests) {
-        if (test.title.toLowerCase().includes(filterBy)) {
-          numOfTests++
-          outputString += `${colors.white.bold(test.parent.title)} -- ${output.styles.log(test.parent.file || '')} -- ${mocha.suite.suites.length} tests\n`
-          outputString += `  ${output.styles.scenario(figures.checkboxOff)} ${test.title}\n`
-        }
-      }
+    try {
+      filterRegex = new RegExp(filterBy, 'i') // Case-insensitive matching
+    } catch (err) {
+      console.error(`Invalid grep pattern: ${filterBy}`)
+      process.exit(1)
     }
-    numOfSuites = countSuites(outputString)
-  } else {
-    for (const suite of mocha.suite.suites) {
-      output.print(
-        `${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')} -- ${mocha.suite.suites.length} tests`,
-      )
+  }
+
+  for (const suite of mocha.suite.suites) {
+    const suiteMatches = filterRegex ? filterRegex.test(suite.title) : true
+    let suiteHasMatchingTests = false
+
+    if (suiteMatches) {
+      outputString += `${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')}\n`
+      suiteHasMatchingTests = true
       numOfSuites++
+    }
+
+    for (const test of suite.tests) {
+      const testMatches = filterRegex ? filterRegex.test(test.title) : true
+
+      if (testMatches) {
+        if (!suiteMatches && !suiteHasMatchingTests) {
+          outputString += `${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')}\n`
+          suiteHasMatchingTests = true
+          numOfSuites++
+        }
 
-      for (test of suite.tests) {
         numOfTests++
-        output.print(`  ${output.styles.scenario(figures.checkboxOff)} ${test.title}`)
+        outputString += `  ${output.styles.scenario(figures.checkboxOff)} ${test.title}\n`
       }
     }
   }
@@ -108,15 +113,5 @@ function printFooter() {
 function removeDuplicates(inputString) {
   const array = inputString.split('\n')
   const uniqueLines = [...new Set(array)]
-  const resultString = uniqueLines.join('\n')
-
-  return resultString
-}
-
-function countSuites(inputString) {
-  const array = inputString.split('\n')
-
-  const uniqueLines = [...new Set(array)]
-  const res = uniqueLines.filter((item) => item.includes('-- '))
-  return res.length
+  return uniqueLines.join('\n')
 }

package/lib/command/gherkin/snippets.js

@@ -127,6 +127,6 @@ ${step.type}(${step.regexp ? '/^' : "'"}${step}${step.regexp ? '$/' : "'"}, () =
 
   if (!options.dryRun) {
     output.success(`Snippets added to ${output.colors.bold(stepFile)}`);
-    fs.writeFileSync(stepFile, fs.readFileSync(stepFile).toString() + snippets.join('\n') + '\n'); // eslint-disable-line
+    fs.writeFileSync(stepFile, fs.readFileSync(stepFile).toString() + snippets.join('\n') + '\n');
   }
 };

package/lib/command/workers/runTests.js

@@ -13,9 +13,8 @@ const container = require('../../container');
 const { getConfig } = require('../utils');
 const { tryOrDefault, deepMerge } = require('../../utils');
 
-// eslint-disable-next-line no-unused-vars
 let stdout = '';
-/* eslint-enable no-unused-vars */
+
 const stderr = '';
 
 // Requiring of Codecept need to be after tty.getWindowSize is available.

package/lib/heal.js

@@ -113,7 +113,7 @@ class Heal {
           });
 
           if (typeof codeSnippet === 'string') {
-            const I = Container.support('I'); // eslint-disable-line
+            const I = Container.support('I');
             await eval(codeSnippet); // eslint-disable-line
           } else if (typeof codeSnippet === 'function') {
             await codeSnippet(Container.support());

package/lib/helper/ApiDataFactory.js

@@ -51,7 +51,7 @@ const REST = require('./REST')
  *
  * module.exports = new Factory()
  *    // no need to set id, it will be set by REST API
- *    .attr('author', () => faker.name.findName())
+ *    .attr('author', () => faker.person.findName())
  *    .attr('title', () => faker.lorem.sentence())
  *    .attr('body', () => faker.lorem.paragraph());
  * ```

package/lib/helper/Appium.js

@@ -491,17 +491,15 @@ class Appium extends Webdriver {
    * });
    * ```
    *
-   * @param {*} fn
    */
-  /* eslint-disable */
-  async runInWeb(fn) {
+
+  async runInWeb() {
     if (!this.isWeb) return
     recorder.session.start('Web-only actions')
 
     recorder.add('restore from Web session', () => recorder.session.restore(), true)
     return recorder.promise()
   }
-  /* eslint-enable */
 
   _runWithCaps(caps, fn) {
     if (typeof caps === 'object') {
@@ -1077,7 +1075,7 @@ class Appium extends Webdriver {
    *
    * Appium: support Android and iOS
    */
-  /* eslint-disable */
+
   async swipe(locator, xoffset, yoffset, speed = 1000) {
     onlyForApps.call(this)
     const res = await this.browser.$(parseLocator.call(this, locator))
@@ -1087,7 +1085,6 @@ class Appium extends Webdriver {
       y: (await res.getLocation()).y + yoffset,
     })
   }
-  /* eslint-enable */
 
   /**
    * Perform a swipe on the screen.

package/lib/helper/GraphQLDataFactory.js

@@ -55,7 +55,7 @@ const GraphQL = require('./GraphQL')
  *    input: { ...buildObj },
  * }))
  *    // 'attr'-id can be left out depending on the GraphQl resolvers
- *    .attr('name', () => faker.name.findName())
+ *    .attr('name', () => faker.person.findName())
  *    .attr('email', () => faker.interact.email())
  * ```
  * For more options see [rosie documentation](https://github.com/rosiejs/rosie).

package/lib/helper/Nightmare.js

@@ -1324,7 +1324,7 @@ class Nightmare extends Helper {
         offsetY,
       )
     }
-    // eslint-disable-next-line prefer-arrow-callback
+
     return this.executeScript(
       function (x, y) {
         return window.scrollTo(x, y)
@@ -1345,7 +1345,6 @@ class Nightmare extends Helper {
    * {{> scrollPageToBottom }}
    */
   async scrollPageToBottom() {
-    /* eslint-disable prefer-arrow-callback, comma-dangle */
     return this.executeScript(function () {
       const body = document.body
       const html = document.documentElement
@@ -1354,21 +1353,19 @@ class Nightmare extends Helper {
         Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight),
       )
     })
-    /* eslint-enable */
   }
 
   /**
    * {{> grabPageScrollPosition }}
    */
   async grabPageScrollPosition() {
-    /* eslint-disable comma-dangle */
     function getScrollPosition() {
       return {
         x: window.pageXOffset,
         y: window.pageYOffset,
       }
     }
-    /* eslint-enable comma-dangle */
+
     return this.executeScript(getScrollPosition)
   }
 }

package/lib/helper/Playwright.js

@@ -1241,14 +1241,13 @@ class Playwright extends Helper {
    * {{> grabPageScrollPosition }}
    */
   async grabPageScrollPosition() {
-    /* eslint-disable comma-dangle */
     function getScrollPosition() {
       return {
         x: window.pageXOffset,
         y: window.pageYOffset,
       }
     }
-    /* eslint-enable comma-dangle */
+
     return this.executeScript(getScrollPosition)
   }
 
@@ -1284,7 +1283,7 @@ class Playwright extends Helper {
    * ```
    */
   async _locate(locator) {
-    const context = (await this.context) || (await this._getContext())
+    const context = await this._getContext()
 
     if (this.frame) return findElements(this.frame, locator)
 
@@ -1300,7 +1299,7 @@ class Playwright extends Helper {
    * ```
    */
   async _locateElement(locator) {
-    const context = (await this.context) || (await this._getContext())
+    const context = await this._getContext()
     return findElement(context, locator)
   }
 
@@ -2737,7 +2736,7 @@ class Playwright extends Helper {
   }
 
   async _getContext() {
-    if (this.context && this.context.constructor.name === 'FrameLocator') {
+    if ((this.context && this.context.constructor.name === 'FrameLocator') || this.context) {
       return this.context
     }
     return this.page
@@ -2839,11 +2838,14 @@ class Playwright extends Helper {
       }
     } else {
       // we have this as https://github.com/microsoft/playwright/issues/26829 is not yet implemented
-      // eslint-disable-next-line no-lonely-if
+
       const _contextObject = this.frame ? this.frame : contextObject
       let count = 0
       do {
-        waiter = await _contextObject.locator(`:has-text("${text}")`).first().isVisible()
+        waiter = await _contextObject
+          .locator(`:has-text(${JSON.stringify(text)})`)
+          .first()
+          .isVisible()
         if (waiter) break
         await this.wait(1)
         count += 1000
@@ -3813,7 +3815,6 @@ function parseWindowSize(windowSize) {
 // List of key values to key definitions
 // https://github.com/puppeteer/puppeteer/blob/v1.20.0/lib/USKeyboardLayout.js
 const keyDefinitionMap = {
-  /* eslint-disable quote-props */
   0: 'Digit0',
   1: 'Digit1',
   2: 'Digit2',
@@ -3861,7 +3862,6 @@ const keyDefinitionMap = {
   '\\': 'Backslash',
   ']': 'BracketRight',
   "'": 'Quote',
-  /* eslint-enable quote-props */
 }
 
 function getNormalizedKey(key) {

package/lib/helper/Protractor.js

@@ -595,7 +595,6 @@ class Protractor extends Helper {
   async pressKey(key) {
     let modifier
     if (Array.isArray(key) && ~['Control', 'Command', 'Shift', 'Alt'].indexOf(key[0])) {
-      // eslint-disable-line no-bitwise
       modifier = Key[key[0].toUpperCase()]
       key = key[1]
     }
@@ -1106,7 +1105,6 @@ class Protractor extends Helper {
     }
 
     let { width, height } = await this.browser.executeScript(() => ({
-      // eslint-disable-line
       height: document.body.scrollHeight,
       width: document.body.scrollWidth,
     }))
@@ -1614,7 +1612,7 @@ class Protractor extends Helper {
       }
       const elem = res[0]
       const location = await elem.getLocation()
-      /* eslint-disable prefer-arrow-callback */
+
       return this.executeScript(
         function (x, y) {
           return window.scrollTo(x, y)
@@ -1622,10 +1620,8 @@ class Protractor extends Helper {
         location.x + offsetX,
         location.y + offsetY,
       )
-      /* eslint-enable */
     }
 
-    /* eslint-disable prefer-arrow-callback, comma-dangle */
     return this.executeScript(
       function (x, y) {
         return window.scrollTo(x, y)
@@ -1633,7 +1629,6 @@ class Protractor extends Helper {
       offsetX,
       offsetY,
     )
-    /* eslint-enable */
   }
 
   /**
@@ -1647,7 +1642,6 @@ class Protractor extends Helper {
    * {{> scrollPageToBottom }}
    */
   async scrollPageToBottom() {
-    /* eslint-disable prefer-arrow-callback, comma-dangle */
     return this.executeScript(function () {
       const body = document.body
       const html = document.documentElement
@@ -1656,21 +1650,19 @@ class Protractor extends Helper {
         Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight),
       )
     })
-    /* eslint-enable */
   }
 
   /**
    * {{> grabPageScrollPosition }}
    */
   async grabPageScrollPosition() {
-    /* eslint-disable comma-dangle */
     function getScrollPosition() {
       return {
         x: window.pageXOffset,
         y: window.pageYOffset,
       }
     }
-    /* eslint-enable comma-dangle */
+
     return this.executeScript(getScrollPosition)
   }
 

package/lib/helper/Puppeteer.js

@@ -861,14 +861,13 @@ class Puppeteer extends Helper {
    * {{> grabPageScrollPosition }}
    */
   async grabPageScrollPosition() {
-    /* eslint-disable comma-dangle */
     function getScrollPosition() {
       return {
         x: window.pageXOffset,
         y: window.pageYOffset,
       }
     }
-    /* eslint-enable comma-dangle */
+
     return this.executeScript(getScrollPosition)
   }
 
@@ -3106,7 +3105,6 @@ async function getClickablePoint(el) {
 // List of key values to key definitions
 // https://github.com/GoogleChrome/puppeteer/blob/v1.20.0/lib/USKeyboardLayout.js
 const keyDefinitionMap = {
-  /* eslint-disable quote-props */
   0: 'Digit0',
   1: 'Digit1',
   2: 'Digit2',
@@ -3154,7 +3152,6 @@ const keyDefinitionMap = {
   '\\': 'Backslash',
   ']': 'BracketRight',
   "'": 'Quote',
-  /* eslint-enable quote-props */
 }
 
 function getNormalizedKey(key) {

package/lib/helper/REST.js

@@ -408,6 +408,30 @@ class REST extends Helper {
 
     return this._executeRequest(request)
   }
+
+  /**
+   * Sends DELETE request to API with payload.
+   *
+   * ```js
+   * I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' });
+   * ```
+   *
+   * @param {*} url
+   * @param {*} [payload={}] - the payload to be sent. By default it is sent as an empty object
+   * @param {object} [headers={}] - the headers object to be sent. By default, it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
+   */
+  async sendDeleteRequestWithPayload(url, payload = {}, headers = {}) {
+    const request = {
+      baseURL: this._url(url),
+      method: 'DELETE',
+      data: payload,
+      headers,
+    }
+
+    return this._executeRequest(request)
+  }
 }
 
 module.exports = REST

package/lib/helper/TestCafe.js

@@ -1049,7 +1049,6 @@ class TestCafe extends Helper {
     }
     const getCookie = ClientFunction(
       () => {
-        // eslint-disable-next-line prefer-template
         const v = document.cookie.match('(^|;) ?' + name + '=([^;]*)(;|$)')
         return v ? v[2] : null
       },
@@ -1220,12 +1219,11 @@ async function waitForFunction(browserFn, waitTimeout) {
     })
 
   const start = Date.now()
-  // eslint-disable-next-line no-constant-condition
+
   while (true) {
     let result
     try {
       result = await browserFn()
-      // eslint-disable-next-line no-empty
     } catch (err) {
       throw new Error(`Error running function ${err.toString()}`)
     }