@open-xchange/appsuite-codeceptjs 0.1.1 → 0.2.1

package/index.js

@@ -23,7 +23,7 @@ const dotenv = require('dotenv')
 dotenv.config({ path: '.env' })
 dotenv.config({ path: '.env.defaults' })
 
-const requiredEnvVars = ['LAUNCH_URL', 'PROVISIONING_URL', 'CONTEXT_ID']
+const requiredEnvVars = ['LAUNCH_URL', 'PROVISIONING_URL']
 
 requiredEnvVars.forEach(function notdefined (key) {
   if (process.env[key]) return
@@ -58,7 +58,7 @@ module.exports = {
             '--no-first-run',
             '--no-sandbox',
             '--no-zygote'
-          ]
+          ].concat((process.env.CHROME_ARGS || '').split(' '))
         },
         url: process.env.LAUNCH_URL,
         show: process.env.HEADLESS === 'false',
@@ -124,8 +124,8 @@ module.exports = {
     async teardown () {
       const { contexts } = global.inject()
       // we need to run this sequentially, less stress on the MW
-      for (const ctx of contexts.filter(ctx => ctx.id > 100)) {
-        if (ctx.id !== 10) await ctx.remove().catch(e => console.error(e.message))
+      for (const ctx of contexts.filter(ctx => /e2e-context-/.test(String(ctx.loginMappings)))) {
+        await ctx.remove().catch(e => console.error(e.message))
       }
     },
     reporter: 'mocha-multi',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/appsuite-codeceptjs",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "OX App Suite CodeceptJS Configuration and Helpers",
   "main": "index.js",
   "bin": {
@@ -14,14 +14,13 @@
     "@codeceptjs/helper": "^2.0.3",
     "@influxdata/influxdb-client": "^1.33.2",
     "@open-xchange/codecept-horizontal-scaler": "^0.1.7",
-    "@playwright/test": "^1.42.0",
-    "@types/node": "^20.11.22",
+    "@playwright/test": "1.44.0",
     "allure-codeceptjs": "^2.13.0",
     "chai": "^5.1.0",
     "chai-subset": "^1.6.0",
     "chalk": "^4.1.0",
     "chalk-table": "^1.0.2",
-    "codeceptjs": "^3.5.14",
+    "codeceptjs": "3.6.2",
     "dotenv": "^16.4.4",
     "mocha": "^10.3.0",
     "mocha-junit-reporter": "^2.2.1",
@@ -29,11 +28,20 @@
     "moment": "^2.30.1",
     "moment-timezone": "^0.5.43",
     "p-retry": "^6.2.0",
-    "playwright-core": "^1.42.0",
-    "playwright": "^1.42.0",
-    "short-uuid": "^4.2.2",
-    "soap": "^1.0.0",
+    "playwright-core": "1.43.1",
+    "short-uuid": "^5.0.0",
+    "soap": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.22",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3"
+  },
+  "pnpm": {
+    "updateConfig": {
+      "ignoreDependencies": [
+        "chalk"
+      ]
+    }
   }
 }

package/src/appsuiteHttpClient.js

@@ -26,6 +26,13 @@ const pRetry = import('p-retry').then(module => module.default)
 const cache = {}
 const baseURL = codecept.config.get().helpers.Playwright.url.replace(/\/$/, '')
 
+/**
+ * Fetches data from a given URL with retry functionality.
+ * @param {string} url - The URL to fetch data from.
+ * @param {object} options - The options for the fetch request.
+ * @returns {Promise<object>} - A promise that resolves to an object containing the fetched data and the response.
+ * @throws {Error} - Throws an error if there is an HTTP request error.
+ */
 async function fetchWithRetry (url, options) {
   return (await pRetry)(async () => {
     const res = await fetch(url, options)

package/src/contexts/contexts.js

@@ -23,7 +23,7 @@ const users = require('../users/users')()
 const util = require('../util')
 const event = require('../event')
 const contextService = require('../soap/services/context')
-const utilService = require('../soap/services/util')
+const crypto = require('node:crypto')
 
 class Context {
   constructor ({ ctxdata, admin, auth }) {
@@ -105,7 +105,7 @@ class Context {
     return contextService.change({ id: this.id, maxQuota })
   }
 
-  static async create (ctx = { }, adminUser = { }, auth = util.admin()) {
+  static async create (ctx = { filestoreId: undefined, id: undefined }, adminUser = { }, auth = util.admin()) {
     adminUser = Object.assign({
       name: 'oxadmin',
       password: 'secret',
@@ -116,26 +116,25 @@ class Context {
       primaryEmail: `${adminUser.name || 'oxadmin'}@${util.mxDomain()}`
     }, adminUser)
 
-    let filestoreId = ctx.filestoreId
-
-    if (typeof filestoreId === 'undefined') {
-      filestoreId = await utilService.getFilestorageId()
-    }
-    const newCtx = Object.assign({ id: Number(util.userContextId()), maxQuota: -1, filestoreId }, ctx)
+    const loginMappings = [`e2e-context-${crypto.randomUUID()}`]
+    const newCtx = Object.assign({ maxQuota: -1, loginMappings }, ctx)
     event.emit(event.provisioning.context.create, newCtx, adminUser, auth)
     let data
-
     try {
       data = await contextService.create(newCtx)
-    } catch (e) {
-      newCtx.id = util.addJitter(newCtx.id)
-      return this.create(newCtx)
+    } catch (error) {
+      // For mws that don't have autocontextid
+      if (error.message.includes('Mandatory fields in context not set: [id]')) {
+        newCtx.filestoreId = await util.getContextFilestorageId()
+        newCtx.id = util.addJitter(util.userContextId())
+        data = await contextService.create(newCtx)
+      } else throw error
     }
-
+    // Add loginMapping since we don't get the correct one from the mw
+    data.loginMappings.push(loginMappings[0])
     const context = new Context({ ctxdata: data, admin: adminUser, auth })
     created.push(context)
     // only provide defaults for fresh contexts
-    await context.hasAccessCombination('all')
     event.emit(event.provisioning.context.created, context)
     return context
   }

package/src/contexts/reseller.js

@@ -68,20 +68,9 @@ class ResellerContext {
     const configMap = userAttributes.entries.find(entry => entry.key === 'config') || { key: 'config' }
     configMap.value = configMap.value || { entries: [] }
     configMap.value.entries.push({ key: `com.openexchange.capability.${cap}`, value })
-    return resellerContextService.change({
-      ctx: {
-        id: this.id,
-        userAttributes
-      }
-    }).then(() => {
-      return resellerContextService.get({
-        ctx: { id: this.id },
-        auth: { login: this.admin.name, password: this.admin.password }
-      })
-    }).then(r => {
-      this.ctxdata = r[0].return
-      return this
-    }).catch((err) => { throw new util.PropagatedError(err) })
+    return resellerContextService
+      .change({ id: this.ctxdata.id, userAttributes })
+      .then(() => resellerContextService.get(this.ctxdata.id))
   }
 
   doesntHaveCapability (capability) {
@@ -169,7 +158,7 @@ class ResellerContext {
     }
   }
 
-  static async create (ctx = { }, adminUser = { }, auth = util.admin(), numberOfUsers = Number(process.env.PROVISIONING_USERS || 10)) {
+  static async create (ctx = {}, adminUser = {}, auth = util.admin(), numberOfUsers = Number(process.env.PROVISIONING_USERS || 10)) {
     ctx = Object.assign({ id: util.userContextId(), maxQuota: -1 }, ctx)
     adminUser = Object.assign({
       name: `${ctx.name || ctx.id}_admin`

package/src/helper.js

@@ -812,6 +812,18 @@ class AppSuiteHelper extends Helper {
     await helper.browserContext.grantPermissions(['clipboard-read'], { origin: config.url })
     return await page.evaluate(async () => { return navigator.clipboard.readText() })
   }
+
+  async createGenericFile (filename, size) {
+    const filePath = path.join(codecept_dir, 'media/files/generic', filename)
+    try {
+      await fs.access(filePath, fs.constants.F_OK)
+    } catch (error) {
+      if (error.code === 'ENOENT') {
+        const content = crypto.randomBytes(size)
+        await fs.writeFile(filePath, content)
+      }
+    }
+  }
 }
 
 module.exports = AppSuiteHelper

package/src/pageobjects/calendar.js

@@ -213,7 +213,7 @@ module.exports = {
     }, title)
     if (skipRefresh === true) return
     I.click('#io-ox-refresh-icon')
-    I.waitForDetached('#io-ox-refresh-icon .fa-spin')
+    I.waitForDetached('#io-ox-refresh-icon .animate-spin')
   },
 
   async setDateTo (dateString) {

package/src/pageobjects/fragments/viewer.js

@@ -45,15 +45,15 @@ module.exports = {
   },
 
   /**
- * Set a browser selection.
- * @param {string} startText - The 'innerText' of the node that starts the selection.
- * @param {string} endText - The 'innerText' of the node that ends the selection.
- * @param {string} wrapperClass - The selection is searched inside the wrapper. Provide a class name ('.className') for it.
- * *
- * Using the recommended workaround by pupeteer(v20.30) to select text.
- * "dragging and selecting text is not possible using page.mouse"
- * https://pptr.dev/api/puppeteer.mouse#example-1
- */
+   * Set a browser selection.
+   * @param {string} startText - The 'innerText' of the node that starts the selection.
+   * @param {string} endText - The 'innerText' of the node that ends the selection.
+   * @param {string} wrapperClass - The selection is searched inside the wrapper. Provide a class name ('.className') for it.
+   * *
+   * Using the recommended workaround by pupeteer(v20.30) to select text.
+   * "dragging and selecting text is not possible using page.mouse"
+   * https://pptr.dev/api/puppeteer.mouse#example-1
+   */
   async setBrowserSelection (startText, endText, wrapperClass) {
     await I.executeScript(({ startText, endText, wrapperClass }) => {
       const selection = window.getSelection()

package/src/pageobjects/mobile/mobileCalendar.js

@@ -23,13 +23,13 @@ const { I } = inject()
 module.exports = {
 
   // attr: [startDate, endDate]
-  setDate (attr, value) {
-    const date = value.format('YYYY-MM-DDTHH:mm')
-    I.executeScript(({ attr, date }) => {
+  async setDate (attr, value) {
+    const date = value.toFormat("yyyy-MM-dd'T'HH:mm")
+    await I.executeScript(async ({ attr, date }) => {
       const fieldset = document.querySelector(`fieldset[data-attribute="${attr}"]`)
       const input = fieldset.querySelector('input')
       input.value = date
-      input.dispatchEvent(new Event('input'))
+      input.dispatchEvent(new Event('mouseout'))
     }, { attr, date })
   },
   async newAppointment () {

package/src/soap/services/context.js

@@ -19,7 +19,6 @@
  */
 
 const { createClientAsync, logSoapError } = require('../soap.js')
-const { getFilestorageId } = require('./util.js')
 
 const OXContextService = createClientAsync('OXContextService').then(client => client)
 
@@ -43,18 +42,27 @@ async function remove (id) {
 /**
  * This function creates a new context.
  * @param {Object} ctx The context to create.
+ * @param {Object} adminUser The admin user of the context.
+ *    Defaults to:
+ *    ```JSON
+ *    {
+        name: 'oxadmin',
+        password: 'secret',
+        display_name: 'context admin',
+        sur_name: 'admin',
+        given_name: 'context',
+        email1: `oxadmin@${process.env.MX_DOMAIN}`,
+        primaryEmail: `oxadmin@${process.env.MX_DOMAIN}`
+      }
+      All properties are needed and will be inserted if not provided.
+      ```
  * @returns {Promise<Object>} The created context.
  */
-async function create (ctx = {}) {
+async function create (ctx = {}, adminUser = {}) {
   return await (await OXContextService)
     .createAsync({
-      ctx: {
-        id: process.env.CONTEXT_ID || Math.floor(Date.now() / 1000),
-        maxQuota: 1000,
-        filestoreId: String(await getFilestorageId()),
-        ...ctx
-      },
-      admin_user: {
+      ctx,
+      admin_user: Object.assign({
         name: 'oxadmin',
         password: 'secret',
         display_name: 'context admin',
@@ -62,13 +70,16 @@ async function create (ctx = {}) {
         given_name: 'context',
         email1: `oxadmin@${process.env.MX_DOMAIN}`,
         primaryEmail: `oxadmin@${process.env.MX_DOMAIN}`
-      }
+      }, adminUser)
     })
     .then(async context => {
       await changeModuleAccessByName(context.id, 'all')
       return context
     })
-    // .catch(logSoapError)
+    .catch(e => {
+      logSoapError(e)
+      throw e
+    })
 }
 
 /**
@@ -116,6 +127,17 @@ async function changeModuleAccess (id, moduleAccess) {
   return await (await OXContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...moduleAccess } })
 }
 
+/**
+ * Search for contexts.
+ * @param {String} searchPattern The pattern to search for
+ * @param {Object} options Additional options
+ * @param {Boolean} options.excludeDisabled Exclude disabled contexts from the search results (default: true)
+ * @returns {Promise<Array<Object>>} The list of contexts that match the search pattern.
+ */
+async function list (searchPattern, { excludeDisabled = true }) {
+  return await (await OXContextService).listAsync({ search_pattern: searchPattern, exclude_disabled: excludeDisabled })
+}
+
 /**
  * This function retrieves the context with the specified ID.
  * @param {number} id The ID of the context to retrieve.
@@ -143,5 +165,6 @@ module.exports = {
   getModuleAccess,
   changeModuleAccess,
   get,
+  list,
   change
 }

package/src/soap/soap.js

@@ -85,7 +85,9 @@ function shouldAbortRetry (error) {
       /already exists in this context/,
       /Shared Domain already exists/,
       /Shared Domain already in use/,
-      /No such user/
+      /No such user/,
+      /Mandatory fields in context not set/,
+      /A mapping with login info .* already exists/
     ]
     const blockedExceptions = [
       'ContextExistsException',
@@ -154,7 +156,7 @@ async function createClientAsync (type) {
             throw new Error(soapError?.faultstring || e.message)
           })
           performance.mark(endMark)
-          performance.measure(`  ⏱ SOAP: ${type} -> ${prop}`, startMark, endMark)
+          performance.measure(`  ⏱ SOAP: ${type} -> ${String(prop)}`, startMark, endMark)
           // Return only the first result from the SOAP method call, as we don't need the SOAP envelope and other stuff.
           if (!result || !result[0]) return
           return result[0]?.return

package/src/users/users.js

@@ -121,7 +121,6 @@ class User {
 
   static getRandom ({ name = 'test.user', password = util.getDefaultUserPassword(), sur_name = '', given_name = 'User' } = {}) {
     const id = short.generate().slice(0, 9).toLowerCase()
-    // eslint-disable-next-line camelcase
     if (!sur_name) sur_name = id
     if (name === 'test.user') name = `${name}-${id}`
     const domain = util.mxDomain()

package/src/util.js

@@ -20,6 +20,7 @@
 
 const codecept = require('codeceptjs')
 const url = require('node:url')
+const { getFilestorageId } = require('./soap/services/util')
 
 module.exports = {
 
@@ -57,7 +58,7 @@ module.exports = {
 
   userContextId () {
     const ox = codecept.config.get().helpers.AppSuite
-    return typeof ox.contextId === 'undefined' ? 10 : ox.contextId
+    return typeof ox.contextId === 'undefined' ? Math.floor(Date.now() / 1000) : ox.contextId
   },
 
   admin () {
@@ -84,6 +85,11 @@ module.exports = {
     return ox.defaultUserPassword || 'secret'
   },
 
+  async getContextFilestorageId () {
+    const ox = codecept.config.get().helpers.AppSuite
+    return ox.filestoreId || String(await getFilestorageId())
+  },
+
   PropagatedError: class PropagatedError extends Error {
     constructor (error) {
       super(error.message)
@@ -97,7 +103,7 @@ module.exports = {
   },
 
   addJitter (id) {
-    const [JITTER_MIN, JITTER_MAX] = [1000, 2000]
+    const [JITTER_MIN, JITTER_MAX] = [1000, 5000]
     return Math.trunc(id) + Math.floor(Math.random() * (JITTER_MAX - JITTER_MIN + 1) + JITTER_MIN)
   }