@open-xchange/appsuite-codeceptjs 0.6.17 → 0.6.19

package/index.js

@@ -89,6 +89,7 @@ module.exports = {
       I: '@open-xchange/appsuite-codeceptjs/src/actor',
       users: '@open-xchange/appsuite-codeceptjs/src/users',
       contexts: '@open-xchange/appsuite-codeceptjs/src/contexts',
+      sharedaccounts: '@open-xchange/appsuite-codeceptjs/src/sharedaccounts',
       ...pageobjects
     },
     async bootstrap () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/appsuite-codeceptjs",
-  "version": "0.6.17",
+  "version": "0.6.19",
   "description": "OX App Suite CodeceptJS Configuration and Helpers",
   "main": "index.js",
   "bin": {
@@ -33,8 +33,8 @@
     "p-retry": "^7.1.1",
     "playwright-core": "1.58.2",
     "short-uuid": "^6.0.3",
-    "@open-xchange/codecept-horizontal-scaler": "0.1.14",
-    "@open-xchange/soap-client": "0.0.10"
+    "@open-xchange/soap-client": "0.0.11",
+    "@open-xchange/codecept-horizontal-scaler": "0.1.14"
   },
   "devDependencies": {
     "@types/node": "^24.10.3",

package/src/actor.js

@@ -32,9 +32,16 @@ module.exports = function (customSteps) {
       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,36 +69,33 @@ module.exports = function (customSteps) {
      * 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)
+      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')
     },
 
@@ -105,10 +109,9 @@ module.exports = function (customSteps) {
      *
      * @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)
       })
@@ -131,7 +134,7 @@ module.exports = function (customSteps) {
     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) {

package/src/appsuiteHttpClient.js

@@ -61,8 +61,10 @@ async function fetchWithRetry (url, options) {
 function createHttpClient (options) {
   let user = util.resolveUser(options?.user)
   if (user.toJSON) user = user.toJSON()
+  const params = options?.params
 
   async function request (url, options = {}) {
+    if (params) options.params = { ...params, ...options.params }
     if (user) {
       if (!cache[user.name]) await login(user)
       options.headers = { Cookie: cache[user.name].cookies, ...options.headers }

package/src/helper.js

@@ -919,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/sharedaccounts/sharedaccounts.js

@@ -0,0 +1,180 @@
+/**
+ * @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.
+ */
+
+const short = require('short-uuid')
+const { sharedAccountService } = require('@open-xchange/soap-client/common')
+const { util } = require('../util')
+
+const sharedAccounts = []
+
+class SharedAccount {
+  constructor (opt) {
+    this.sharedAccountData = opt.sharedAccountData
+    this.context = opt.context
+    return new Proxy(this, {
+      get (target, prop) {
+        return prop in target ? target[prop] : target.sharedAccountData[prop]
+      }
+    })
+  }
+
+  static getRandom () {
+    const id = `e2e-${short.generate().slice(0, 9).toLowerCase()}`
+    const domain = util.mxDomain()
+    const name = `${id}-Anmeldung`
+
+    return {
+      imapServer: util.imapServer(),
+      smtpServer: util.smtpServer(),
+      language: 'de_DE',
+      mailenabled: 1,
+      name,
+      display_name: name,
+      imapLogin: name,
+      primaryEmail: `${id}-anmeldung@${domain}`,
+      email1: `${id}-anmeldung@${domain}`,
+      timezone: 'Europe/Berlin',
+      password: 'secret'
+    }
+  }
+
+  /**
+   * Create a shared account with the specified account data:
+   *
+   * @param {object} sharedAccountData
+   *  Properties:
+   *  - display_name
+   *  - imapServer
+   *  - smtpServer
+   *  - language
+   *  - mailenabled
+   *  - name
+   *  - primaryEmail
+   *  - email1
+   *  - timezone
+   *  - password
+   *
+   * @param {*} ctx
+   *
+   * @returns {Promise<Object>} A promise resolving with the created shared account object.
+   */
+  static async create (sharedAccountData, ctx = {}) {
+    sharedAccountData = { ...this.getRandom(), ...sharedAccountData }
+
+    const { contexts } = inject()
+    let sharedAccountContext
+    try {
+      // @ts-ignore
+      sharedAccountContext = await contexts.reuse(ctx, ctx.admin, ctx.auth)
+    } catch (e) {
+      // @ts-ignore
+      sharedAccountContext = await contexts.create(Object.assign({ maxQuota: 1000 }, ctx))
+    }
+
+    const data = await sharedAccountService.create(sharedAccountContext, sharedAccountData)
+    const sharedAccount = new SharedAccount({ sharedAccountData: data, context: sharedAccountContext })
+    sharedAccounts.push(sharedAccount)
+    return sharedAccount
+  }
+
+  /**
+   * Get the default configuration for creating shared account permissions for mail and calendar.
+   *
+   * @returns {Object} The default configuration object.
+   */
+  static getDefaultConfig () {
+    return {
+      permissionLevel: 'author',
+      // grantedCapability: ['sendAs', 'sendOnBehalf', 'snippets', 'writeSnippets'],
+      grantedCapability: [],
+      deniedCapability: []
+    }
+  }
+
+  /**
+   * Add users and groups with specified permissions and capabilities to the shared account using the OX Shared Account Service.
+   *
+   * @returns {Promise<void>}
+   */
+  async createPermissions ({ users = [], groups = [], mail = SharedAccount.getDefaultConfig(), calendar = SharedAccount.getDefaultConfig() }) {
+    // use context of the first user or the first group
+    // -> in every call to 'createSharedAccountPermissions' all users and groups must be in the same context
+    const context = users[0].context || groups[0].context
+
+    return sharedAccountService.createSharedAccountPermissions(context, this.context, this.sharedAccountData, mail, calendar, users, groups)
+  }
+
+  /**
+   * List all shared accounts in the specified context.
+   *
+   * @returns {Promise<Object[]>} A promise resolving with the list of shared account objects.
+   */
+  static async list (context) {
+    return sharedAccountService.list(context)
+  }
+
+  /**
+   * Returns the fully qualified identifier of the shared account.
+   *
+   * @returns {string}
+   *  The fully qualified identifier of the shared account.
+   */
+  getFullId () {
+    return this.sharedAccountData.id + '@' + this.context.id
+  }
+
+  /**
+   * Get all data of the shared account.
+   *
+   * @returns {Promise<Object>} A promise resolving with all data of the shared account.
+   */
+  async getData () {
+    return sharedAccountService.getData(this.context, this.sharedAccountData)
+  }
+
+  /**
+   * Remove the shared account.
+   *
+   * @returns {Promise<void>}
+   */
+  async remove () {
+    const index = sharedAccounts.indexOf(this)
+    if (index < 0) return
+    sharedAccounts.splice(index, 1)
+    return sharedAccountService.remove(this.context, this.sharedAccountData)
+  }
+
+  toJSON () {
+    return {
+      context: { ...this.context },
+      ...this.sharedAccountData
+    }
+  }
+}
+
+module.exports = () => {
+  return new Proxy(sharedAccounts, {
+    // act like an array if an index is being used
+    get (target, prop) {
+      if (prop in target) { return target[prop] }
+      return SharedAccount[prop]
+    }
+  })
+}

package/src/sharedaccounts.js

@@ -0,0 +1,23 @@
+/**
+ * @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.
+ */
+
+const moduleToLoad = './sharedaccounts/sharedaccounts'
+
+module.exports = require(moduleToLoad)

package/steps.d.ts

@@ -2,12 +2,11 @@
 type steps_file = typeof import('@codeceptjs/configure/test/integration/steps_file.js')
 type users = typeof import('./src/users.js')
 type contexts = typeof import('./src/contexts.js')
-type ResellerContext = typeof import('./src/reseller/context.js')
-type ResellerUser = typeof import('./src/reseller/user.js')
+type sharedaccounts = typeof import('./src/sharedaccounts.js')
 type AppSuite = import('./src/helper.js')
 
 declare namespace CodeceptJS {
-  interface SupportObject { I: I, current: any, users: users, contexts: contexts, ResellerContext: ResellerContext, ResellerUser: ResellerUser }
+  interface SupportObject { I: I, current: any, users: users, contexts: contexts, sharedaccounts: sharedaccounts }
   interface Methods extends Playwright, AppSuite {}
   interface I extends ReturnType<steps_file>, WithTranslation<AppSuite> {}
   namespace Translation {