@open-xchange/appsuite-codeceptjs 0.6.16 → 0.6.18

package/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(find:*)",
+      "Bash(grep:*)",
+      "Bash(npm view:*)"
+    ]
+  }
+}

package/container/Dockerfile

@@ -1 +1 @@
-FROM registry.gitlab.com/openxchange/appsuite/web-foundation/base-images/playwright:v1.57.0-noble
+FROM registry.gitlab.com/openxchange/appsuite/web-foundation/base-images/playwright:v1.58.2-noble

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/appsuite-codeceptjs",
-  "version": "0.6.16",
+  "version": "0.6.18",
   "description": "OX App Suite CodeceptJS Configuration and Helpers",
   "main": "index.js",
   "bin": {
@@ -18,7 +18,7 @@
     "@codeceptjs/helper": "^2.0.4",
     "@influxdata/influxdb-client": "^1.35.0",
     "@open-xchange/appsuite-codeceptjs-pageobjects": "^1.1.0",
-    "@playwright/test": "1.57.0",
+    "@playwright/test": "1.58.2",
     "allure-codeceptjs": "2.15.1",
     "chai": "^6.2.1",
     "chalk": "^4.1.2",
@@ -31,7 +31,7 @@
     "moment": "^2.30.1",
     "moment-timezone": "^0.6.0",
     "p-retry": "^7.1.1",
-    "playwright-core": "1.57.0",
+    "playwright-core": "1.58.2",
     "short-uuid": "^6.0.3",
     "@open-xchange/soap-client": "0.0.10",
     "@open-xchange/codecept-horizontal-scaler": "0.1.14"

package/src/actor.js

@@ -23,7 +23,7 @@ const { expect } = require('@playwright/test')
 const util = require('./util')
 const codecept = require('codeceptjs')
 
-module.exports = function () {
+module.exports = function (customSteps) {
   const baseURL = util.getURLRoot()
 
   return actor({
@@ -32,9 +32,16 @@ module.exports = function () {
       this.amOnPage(baseURL)
     },
 
-    openApp (appName) {
+    waitForApp () {
+      this.waitForInvisible('#background-loader.busy', 30)
+      this.waitForVisible({ css: 'html.complete' }, 10)
+    },
+
+    openApp (appName, options) {
       this.click('~Navigate to:')
       this.click(appName, '.apps')
+      options = { wait: true, ...options }
+      if (options.wait) this.waitForApp()
     },
 
     /**
@@ -62,38 +69,33 @@ module.exports = function () {
      * After successful login, the page will be navigated to the specified URL with the URL parameters.
      * If the 'isDeepLink' option is true, the URL will be constructed with a '#' prefix.
      * The login process also includes waiting for the page to load and checking for the presence of the app.
-     * @param {string[]|object} urlParams - The URL parameters as an array or object.
+     * @param {string[]|string} urlParams - The URL parameters as an array or string.
      * @param {object} options - The login options.
-     * @returns {Promise<void>} - A promise that resolves when the login process is complete.
      */
-    async login (urlParams, options) {
+    login (urlParams, options) {
       if (urlParams && !urlParams.length) {
         // looks like an object, not string or array
         options = urlParams
-        urlParams = []
+        urlParams = undefined
       }
+      options = { wait: true, ...options }
       urlParams = [].concat(urlParams || [])
-      options = Object.assign({ wait: true }, options)
-      let user = options.user || require('codeceptjs').container.support('users')[0]
-
-      if (typeof user === 'undefined') user = {}
+      if (!options.isDeepLink) urlParams.unshift('!!')
+      let user = util.resolveUser(options.user)
       if (user.toJSON) user = user.toJSON()
       const loginName = process.env.PROVISIONING_API === 'reseller' ? user.name : `${user.name}${user.context.id ? '@' + user.context.id : ''}`
-      await this.makeApiRequest('POST', `${baseURL}/api/login`, {
+      this.makeApiRequest('POST', `${baseURL}/api/login`, {
         params: { action: 'login', client: 'open-xchange-appsuite' },
-        form: {
-          name: loginName,
-          password: user.password
-        }
+        form: { name: loginName, password: user.password }
       })
       this.wait(0.5)
-      this.amOnPage(`${baseURL}/` + (options.isDeepLink ? '#' : '#!!') + (urlParams.length === 0 ? '' : '&' + urlParams.join('&')))
+      this.amOnPage(`${baseURL}/#${urlParams.join('&')}`)
       this.waitForInvisible('#background-loader.busy', util.getLoginTimeout())
-      if (options.wait) await this.waitForApp()
+      if (options.wait) this.waitForVisible({ css: 'html.complete' }, 10)
     },
 
-    async logout () {
-      await this.makeApiRequest('POST', `${baseURL}/api/login`, { params: { action: 'logout' } })
+    logout () {
+      this.makeApiRequest('POST', `${baseURL}/api/login`, { params: { action: 'logout' } })
       this.amOnPage('about:blank')
     },
 
@@ -107,10 +109,9 @@ module.exports = function () {
      *
      * @param {string} locator - The locator of the element. Only accepts css selectors.
      */
-    async waitForFocus (locator) {
-      this.waitForElement(locator)
+    waitForFocus (locator) {
       this.waitForVisible(locator)
-      return this.usePlaywrightTo('wait for focus', async ({ page }) => {
+      this.usePlaywrightTo('wait for focus', async ({ page }) => {
         await expect(page.locator(locator)).toBeFocused()
         this.wait(0.5)
       })
@@ -133,7 +134,7 @@ module.exports = function () {
     clickDropdown (text) {
       this.waitForVisible('.dropdown.open .dropdown-menu, .primary-action > .open .dropdown-menu')
       this.waitForText(text, 10, '.dropdown.open .dropdown-menu, .primary-action > .open .dropdown-menu')
-      return this.click(text, '.dropdown.open .dropdown-menu, .primary-action > .open .dropdown-menu')
+      this.click(text, '.dropdown.open .dropdown-menu, .primary-action > .open .dropdown-menu')
     },
 
     clickToolbar (selector, timeout = 5) {
@@ -169,6 +170,8 @@ module.exports = function () {
     selectLine () {
       const shortcut = platform === 'darwin' ? ['Shift', 'CommandOrControl', 'ArrowLeft'] : ['Shift', 'Home']
       this.pressKey(shortcut)
-    }
+    },
+
+    ...customSteps
   })
 }

package/src/appsuiteHttpClient.js

@@ -20,6 +20,7 @@
 
 const codecept = require('codeceptjs')
 const querystring = require('node:querystring')
+const util = require('./util')
 
 const pRetry = import('p-retry').then(module => module.default)
 
@@ -58,8 +59,7 @@ async function fetchWithRetry (url, options) {
 }
 
 function createHttpClient (options) {
-  options = options || {}
-  let user = options.user || codecept.container.support('users')[0]
+  let user = util.resolveUser(options?.user)
   if (user.toJSON) user = user.toJSON()
 
   async function request (url, options = {}) {

package/src/chai.js

@@ -18,38 +18,38 @@
  * Any use of the work other than as authorized under this license or copyright law is prohibited.
  */
 
-import('chai').then(chai => {
-  chai.util.addProperty(chai.Assertion.prototype, 'accessible', function () {
-    const problems = ['\n', 'Accessibility Violations (' + this._obj.violations.length + ')', '---']
-    const pad = '\n        '
-    if (this._obj.violations.length) {
-      for (const violation of this._obj.violations) {
-        problems.push(pad + '[' + violation.impact.toUpperCase() + '] ' + violation.help + ' (ID: ' + violation.id + ')\n')
-        for (const node of violation.nodes) {
-          problems.push(node.failureSummary.split('\n').join(pad))
-          problems.push('    ' + node.target + ' => ' + node.html)
-          const relatedNodes = []
-          for (const combinedNodes of [node.all, node.any, node.none]) {
-            if (combinedNodes.length > 0) {
-              for (const any of combinedNodes) {
-                for (const relatedNode of any.relatedNodes) {
-                  relatedNodes.push('      ' + relatedNode.target + ' => ' + relatedNode.html)
-                }
+const chai = require('chai')
+
+chai.util.addProperty(chai.Assertion.prototype, 'accessible', function () {
+  const problems = ['\n', 'Accessibility Violations (' + this._obj.violations.length + ')', '---']
+  const pad = '\n        '
+  if (this._obj.violations.length) {
+    for (const violation of this._obj.violations) {
+      problems.push(pad + '[' + violation.impact.toUpperCase() + '] ' + violation.help + ' (ID: ' + violation.id + ')\n')
+      for (const node of violation.nodes) {
+        problems.push(node.failureSummary.split('\n').join(pad))
+        problems.push('    ' + node.target + ' => ' + node.html)
+        const relatedNodes = []
+        for (const combinedNodes of [node.all, node.any, node.none]) {
+          if (combinedNodes.length > 0) {
+            for (const any of combinedNodes) {
+              for (const relatedNode of any.relatedNodes) {
+                relatedNodes.push('      ' + relatedNode.target + ' => ' + relatedNode.html)
               }
             }
           }
-          if (relatedNodes.length > 0) problems.push(relatedNodes.join(pad))
         }
-        problems.push(pad + '---\n')
+        if (relatedNodes.length > 0) problems.push(relatedNodes.join(pad))
       }
+      problems.push(pad + '---\n')
     }
-    this.assert(
-      this._obj.violations.length === 0,
-      `expected to have no violations:\n        ${problems.join(pad)}`,
-      'expected to have violations'
-    )
-  })
-
-  globalThis.expect = chai.expect
-  globalThis.assert = chai.assert
+  }
+  this.assert(
+    this._obj.violations.length === 0,
+    `expected to have no violations:\n        ${problems.join(pad)}`,
+    'expected to have violations'
+  )
 })
+
+globalThis.expect = chai.expect
+globalThis.assert = chai.assert

package/src/helper.js

@@ -34,6 +34,14 @@ const javascriptRoot = util.getJavascriptRoot()
 
 const output = require('codeceptjs/lib/output')
 
+/**
+ * @typedef UserOptions
+ *  Optional parameters to specify a target user account.
+ * @property {object} [user]
+ *  The user account to be used. If omitted, the first created user (`users[0]`)
+ *  will be used.
+ */
+
 function delay (ms) { return new Promise(resolve => setTimeout(resolve, ms)) }
 
 async function retryPromise (fn, timeout = 5, retryDelay = 300) {
@@ -295,6 +303,97 @@ class AppSuiteHelper extends Helper {
     await devTools.send('Network.emulateNetworkConditions', presets[networkConfig.toUpperCase()] || networkConfig)
   }
 
+  /**
+   * Changes a configuration item of a user account during a test.
+   *
+   * Use this method inside test scenarios instead of calling `await
+   * user.hasConfig()` directly to make this call part of the recorder queue,
+   * instead of executing it immediately during test step registration.
+   *
+   * @param {string} key
+   *  The configuration key.
+   *
+   * @param {unknown} value
+   *  The new configuration value.
+   *
+   * @param {UserOptions} [options]
+   *  Optional parameters.
+   */
+  async haveConfig (key, value, options) {
+    await util.resolveUser(options?.user).hasConfig(key, value)
+  }
+
+  /**
+   * Adds a capability to a user account during a test.
+   *
+   * Use this method inside test scenarios instead of calling `await
+   * user.hasCapability()` directly to make this call part of the recorder
+   * queue, instead of executing it immediately during test step registration.
+   *
+   * @param {string} capability
+   *  The capability to be added to the user account.
+   *
+   * @param {UserOptions} [options]
+   *  Optional parameters.
+   */
+  async haveCapability (capability, options) {
+    await util.resolveUser(options?.user).hasCapability(capability)
+  }
+
+  /**
+   * Removes a capability from a user account during a test.
+   *
+   * Use this method inside test scenarios instead of calling `await
+   * user.doesntHaveCapability()` directly to make this call part of the
+   * recorder queue, instead of executing it immediately during test step
+   * registration.
+   *
+   * @param {string} capability
+   *  The capability to be removed from the user account.
+   *
+   * @param {UserOptions} [options]
+   *  Optional parameters.
+   */
+  async dontHaveCapability (capability, options) {
+    await util.resolveUser(options?.user).doesntHaveCapability(capability)
+  }
+
+  /**
+   * Changes the access combination of a user account during a test.
+   *
+   * Use this method inside test scenarios instead of calling `await
+   * user.hasAccessCombination()` directly to make this call part of the
+   * recorder queue, instead of executing it immediately during test step
+   * registration.
+   *
+   * @param {string} accessCombination
+   *  The access combination to be set at the user account.
+   *
+   * @param {UserOptions} [options]
+   *  Optional parameters.
+   */
+  async haveAccessCombination (accessCombination, options) {
+    await util.resolveUser(options?.user).hasAccessCombination(accessCombination)
+  }
+
+  /**
+   * Changes the module access flags of a user account during a test.
+   *
+   * Use this method inside test scenarios instead of calling `await
+   * user.hasAccessCombination()` directly to make this call part of the
+   * recorder queue, instead of executing it immediately during test step
+   * registration.
+   *
+   * @param {Record<string, boolean>} moduleAccess
+   *  The module access flags to be set at the user account.
+   *
+   * @param {UserOptions} [options]
+   *  Optional parameters.
+   */
+  async haveModuleAccess (moduleAccess, options) {
+    await util.resolveUser(options?.user).hasModuleAccess(moduleAccess)
+  }
+
   async haveSetting (obj, options) {
     if (typeof obj === 'string') {
       const input = obj.split('//')
@@ -393,10 +492,38 @@ class AppSuiteHelper extends Helper {
     for (const mail of iterable) await this.haveMail(mail, options)
   }
 
-  async haveAnAlias (alias, options = {}) {
-    console.warn('This method is deprecated, use `user.hasAlias` instead')
-    const user = options.user || codecept.container.support('users')[0]
-    return user.hasAlias(alias)
+  /**
+   * Adds an alias email address to a user account during a test.
+   *
+   * Use this method inside test scenarios instead of calling `await
+   * user.hasAlias()` directly to make this call part of the recorder queue,
+   * instead of executing it immediately during test step registration.
+   *
+   * @param {string} alias
+   *  The alias email address to be added to the user account.
+   *
+   * @param {UserOptions} [options]
+   *  Optional parameters.
+   */
+  async haveAnAlias (alias, options) {
+    await util.resolveUser(options?.user).hasAlias(alias)
+  }
+
+  /**
+   * Removes an alias email address from a user account during a test.
+   *
+   * Use this method inside test scenarios instead of calling `await
+   * user.doesntHaveAlias()` directly to make this call part of the recorder
+   * queue, instead of executing it immediately during test step registration.
+   *
+   * @param {string} alias
+   *  The alias email address to be removed from the user account.
+   *
+   * @param {UserOptions} [options]
+   *  Optional parameters.
+   */
+  async dontHaveAlias (alias, options) {
+    await util.resolveUser(options?.user).doesntHaveAlias(alias)
   }
 
   async haveMailFilterRule (rule, options) {
@@ -792,13 +919,6 @@ class AppSuiteHelper extends Helper {
     )
   }
 
-  async waitForApp () {
-    const { Playwright } = this.helpers
-
-    await Playwright.waitForInvisible('#background-loader.busy', 30)
-    await Playwright.waitForVisible({ css: 'html.complete' }, 10)
-  }
-
   async copyToClipboard () {
     const helper = this.helpers.Playwright
     const { page } = helper

package/src/util.js

@@ -99,6 +99,21 @@ module.exports = {
   addJitter (id) {
     const [JITTER_MIN, JITTER_MAX] = [1000, 5000]
     return Math.trunc(id) + Math.floor(Math.random() * (JITTER_MAX - JITTER_MIN + 1) + JITTER_MIN)
-  }
+  },
 
+  /**
+   * Resolves the effective user account to be used.
+   *
+   * @param {object} [user]
+   *  The user account to be used. Default is the first created user.
+   *
+   * @returns {object}
+   *  The passed user account if existing, otherwise the first created user
+   *  account.
+   */
+  resolveUser (user) {
+    user ??= codecept.container.support('users')[0]
+    if (!user) throw new Error('no users created')
+    return user
+  },
 }

package/eslint.config.mjs

@@ -1,73 +0,0 @@
-/**
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- */
-import config from '@open-xchange/lint'
-import mocha from 'eslint-plugin-mocha'
-import { FlatCompat } from '@eslint/eslintrc'
-
-import path from 'node:path'
-import url from 'node:url'
-
-const __filename = url.fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-const codeceptjs = new FlatCompat({
-  baseDirectory: __dirname
-}).extends('plugin:codeceptjs/recommended')
-
-export default [
-  ...config,
-  {
-    files: ['**/*.js'],
-    plugins: {
-      ...codeceptjs[1].plugins
-    },
-    rules: {
-      ...codeceptjs[1].rules,
-      'no-unused-expressions': 0,
-      'import/no-absolute-path': 0,
-      'codeceptjs/no-skipped-tests': 'off',
-      'codeceptjs/no-pause-in-scenario': 'off'
-    },
-    languageOptions: {
-      globals: {
-        ...codeceptjs[0].languageOptions.globals,
-        ...mocha.configs.recommended.languageOptions.globals,
-        Feature: true,
-        Scenario: true,
-        Before: true,
-        After: true,
-        within: true,
-        assert: true,
-        locate: true,
-        session: true,
-        inject: true,
-        codecept_dir: true,
-        output_dir: true,
-        DataTable: true,
-        Data: true,
-        BeforeSuite: true,
-        AfterSuite: true,
-        actor: true,
-        expect: true,
-        require: true
-      }
-    }
-  }
-]