Merge branch '3.x' of github.com:codeceptjs/CodeceptJS into 3.x

Author: DavertMik

.github/workflows/appiumV2_Android.yml

@@ -9,6 +9,8 @@ env:
   CI: true
   # Force terminal colors. @see https://www.npmjs.com/package/colors
   FORCE_COLOR: 1
+  SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
+  SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
 
 jobs:
   appium:
@@ -20,17 +22,23 @@ jobs:
         test-suite: ['other', 'quick']
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm i --force
-      env:
-        PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true
-        PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true
-    - run: "npm run test:appium-${{ matrix.test-suite }}"
-      env: # Or as an environment variable
-        SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
-        SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
+      - uses: actions/checkout@v4
 
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - run: npm i
+        env:
+          PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true
+          PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true
+
+      - name: Upload APK to Sauce Labs
+        run: |
+          curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" \
+          --location --request POST 'https://api.us-west-1.saucelabs.com/v1/storage/upload' \
+          --form 'payload=@test/data/mobile/selendroid-test-app-0.17.0.apk' \
+          --form 'name="selendroid-test-app-0.17.0.apk"'
+
+      - run: 'npm run test:appium-${{ matrix.test-suite }}'

.github/workflows/appiumV2_iOS.yml

@@ -9,6 +9,8 @@ env:
   CI: true
   # Force terminal colors. @see https://www.npmjs.com/package/colors
   FORCE_COLOR: 1
+  SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
+  SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
 
 jobs:
   appium:
@@ -29,8 +31,12 @@ jobs:
         env:
           PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true
           PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true
-      - run: "npm run test:ios:appium-${{ matrix.test-suite }}"
-        env: # Or as an environment variable
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
 
+      - name: Upload APK to Sauce Labs
+        run: |
+          curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" \
+          --location --request POST 'https://api.us-west-1.saucelabs.com/v1/storage/upload' \
+          --form 'payload=@test/data/mobile/TestApp-iphonesimulator.zip' \
+          --form 'name="TestApp-iphonesimulator.zip"'
+
+      - run: 'npm run test:ios:appium-${{ matrix.test-suite }}'

docs/helpers/Appium.md

@@ -550,19 +550,10 @@ Hide the keyboard.
 ```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
 
-#### Parameters
-
-*   `strategy` **(`"tapOutside"` | `"pressKey"`)?** Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-*   `key` **[string][5]?** Optional key
-
 ### sendDeviceKeyEvent
 
 Send a key event to the device.

lib/effects.js

@@ -0,0 +1,123 @@
+const recorder = require('./recorder')
+const { debug } = require('./output')
+const store = require('./store')
+
+/**
+ * @module hopeThat
+ *
+ * `hopeThat` is a utility function for CodeceptJS tests that allows for soft assertions.
+ * It enables conditional assertions without terminating the test upon failure.
+ * This is particularly useful in scenarios like A/B testing, handling unexpected elements,
+ * or performing multiple assertions where you want to collect all results before deciding
+ * on the test outcome.
+ *
+ * ## Use Cases
+ *
+ * - **Multiple Conditional Assertions**: Perform several assertions and evaluate all their outcomes together.
+ * - **A/B Testing**: Handle different variants in A/B tests without failing the entire test upon one variant's failure.
+ * - **Unexpected Elements**: Manage elements that may or may not appear, such as "Accept Cookie" banners.
+ *
+ * ## Examples
+ *
+ * ### Multiple Conditional Assertions
+ *
+ * Add the assertion library:
+ * ```js
+ * const assert = require('assert');
+ * const { hopeThat } = require('codeceptjs/effects');
+ * ```
+ *
+ * Use `hopeThat` with assertions:
+ * ```js
+ * const result1 = await hopeThat(() => I.see('Hello, user'));
+ * const result2 = await hopeThat(() => I.seeElement('.welcome'));
+ * assert.ok(result1 && result2, 'Assertions were not successful');
+ * ```
+ *
+ * ### Optional Click
+ *
+ * ```js
+ * const { hopeThat } = require('codeceptjs/effects');
+ *
+ * I.amOnPage('/');
+ * await hopeThat(() => I.click('Agree', '.cookies'));
+ * ```
+ *
+ * Performs a soft assertion within CodeceptJS tests.
+ *
+ * This function records the execution of a callback containing assertion logic.
+ * If the assertion fails, it logs the failure without stopping the test execution.
+ * It is useful for scenarios where multiple assertions are performed, and you want
+ * to evaluate all outcomes before deciding on the test result.
+ *
+ * ## Usage
+ *
+ * ```js
+ * const result = await hopeThat(() => I.see('Welcome'));
+ *
+ * // If the text "Welcome" is on the page, result => true
+ * // If the text "Welcome" is not on the page, result => false
+ * ```
+ *
+ * @async
+ * @function hopeThat
+ * @param {Function} callback - The callback function containing the soft assertion logic.
+ * @returns {Promise<boolean | any>} - Resolves to `true` if the assertion is successful, or `false` if it fails.
+ *
+ * @example
+ * // Multiple Conditional Assertions
+ * const assert = require('assert');
+ * const { hopeThat } = require('codeceptjs/effects');
+ *
+ * const result1 = await hopeThat(() => I.see('Hello, user'));
+ * const result2 = await hopeThat(() => I.seeElement('.welcome'));
+ * assert.ok(result1 && result2, 'Assertions were not successful');
+ *
+ * @example
+ * // Optional Click
+ * const { hopeThat } = require('codeceptjs/effects');
+ *
+ * I.amOnPage('/');
+ * await hopeThat(() => I.click('Agree', '.cookies'));
+ */
+async function hopeThat(callback) {
+  if (store.dryRun) return
+  const sessionName = 'hopeThat'
+
+  let result = false
+  return recorder.add(
+    'hopeThat',
+    () => {
+      recorder.session.start(sessionName)
+      store.hopeThat = true
+      callback()
+      recorder.add(() => {
+        result = true
+        recorder.session.restore(sessionName)
+        return result
+      })
+      recorder.session.catch(err => {
+        result = false
+        const msg = err.inspect ? err.inspect() : err.toString()
+        debug(`Unsuccessful assertion > ${msg}`)
+        recorder.session.restore(sessionName)
+        return result
+      })
+      return recorder.add(
+        'result',
+        () => {
+          store.hopeThat = undefined
+          return result
+        },
+        true,
+        false,
+      )
+    },
+    false,
+    false,
+  )
+}
+
+module.exports = {
+  hopeThat,
+}

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: {},
+    })
   }
 
   /**

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?')

lib/pause.js

@@ -2,7 +2,6 @@ const colors = require('chalk')
 const readline = require('readline')
 const ora = require('ora-classic')
 const debug = require('debug')('codeceptjs:pause')
-const Fuse = require('fuse.js')
 
 const container = require('./container')
 const history = require('./history')
@@ -11,7 +10,7 @@ const aiAssistant = require('./ai')
 const recorder = require('./recorder')
 const event = require('./event')
 const output = require('./output')
-const { methodsOfObject } = require('./utils')
+const { methodsOfObject, searchWithFusejs } = require('./utils')
 
 // npm install colors
 let rl
@@ -218,15 +217,12 @@ function completer(line) {
     return [completions, line]
   }
 
-  // Initialize Fuse with completions
-  const fuse = new Fuse(completions, {
+  // Search using Fuse.js
+  const searchResults = searchWithFusejs(completions, line, {
     threshold: 0.3,
     distance: 100,
     minMatchCharLength: 1,
   })
-
-  // Search using Fuse.js
-  const searchResults = fuse.search(line)
   const hits = searchResults.map(result => result.item)
 
   return [hits, line]