@open-xchange/appsuite-codeceptjs 0.7.2 → 0.8.1

package/CHANGELOG.md

@@ -0,0 +1,178 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [0.8.1] - 2026-03-26
+
+### Added
+
+- TypeScript type fixes and additions (chai globals)
+- Emit events for shared accounts
+
+### Fixed
+
+- Include TypeScript test files in build
+
+## [0.8.0] - 2026-03-15
+
+### Changed
+
+- Replace chalk and dotenv with Node.js built-ins
+- Clean up dependencies, packaging, and config files
+- Clean up Chromium args and add renderer process limit
+
+## [0.7.2] - 2026-03-09
+
+### Added
+
+- TypeScript type definitions
+
+## [0.7.0] - 2026-02-24
+
+### Changed
+
+- Switch container base image to wolfi/playwright and make output directory configurable
+
+## [0.6.20] - 2026-02-24
+
+### Fixed
+
+- Fix typo in import statement
+
+## [0.6.19] - 2026-02-24
+
+### Added
+
+- Support for shared accounts in e2e tests
+
+## [0.6.18] - 2026-02-23
+
+### Changed
+
+- Convert various step functions to sync
+
+## [0.6.17] - 2026-02-13
+
+### Added
+
+- Helpers for manipulating user settings in tests
+- Allow passing more custom steps to actor()
+
+### Fixed
+
+- Internal Node exception when requiring appsuite-codeceptjs and chai (#18)
+
+## [0.6.16] - 2026-01-22
+
+### Added
+
+- `e2e-context-` prefix check to prevent accidental context deletion
+- Export "actor" from main module
+
+### Changed
+
+- Use existing helper instead of creating new instance for every user
+
+### Fixed
+
+- Location of "reporter" option inside "mocha" object
+- Move `util.getURLRoot` call into actor
+
+### Removed
+
+- Unnecessary default context fetch on module load
+
+## [0.6.14] - 2025-12-12
+
+### Changed
+
+- Switch Playwright base image from jammy to noble
+
+## [0.6.13] - 2025-09-30
+
+### Fixed
+
+- Unhandled rejection timeout errors in soap-client
+
+### Removed
+
+- Unit tests (moved elsewhere)
+
+## [0.6.12] - 2025-09-25
+
+### Changed
+
+- Use pageobjects package from core-ui
+
+## [0.6.10] - 2025-09-15
+
+### Fixed
+
+- Use job group name as node-prefix for filter suite
+
+## [0.6.7] - 2025-07-18
+
+### Fixed
+
+- Do not load common contexts when using reseller API
+
+## [0.6.4] - 2025-06-13
+
+### Changed
+
+- Update pageobjects and actor to work with unpatched CodeceptJS
+
+## [0.6.3] - 2025-06-11
+
+### Added
+
+- Documentation for overwriting helpers locally
+
+### Changed
+
+- Move soap to own library
+- Clean up codeceptjs dependencies
+- Update paths for gitlab.com move
+
+### Fixed
+
+- Setting startDate and endDate in calendar/createAppointment
+- getNextMonday (pageobjects/calendar) to work on Sunday correctly
+
+### Removed
+
+- chai-subset (now merged with chai)
+
+## [0.6.2] - 2024-12-17
+
+### Changed
+
+- Replace Jest with Vitest and improve test infrastructure
+- Switch to neostandard library
+
+## [0.6.0] - 2024-10-10
+
+### Added
+
+- allure-js-commons module
+
+## [0.5.0] - 2024-09-30
+
+### Added
+
+- E2E setup and testing for appsuite-codeceptjs
+- Container image
+
+## [0.4.4] - 2024-08-27
+
+### Fixed
+
+- Reseller API support for pre-assembled contexts
+
+## [0.4.3] - 2024-08-22
+
+### Added
+
+- Initial release

package/README.md

@@ -55,18 +55,4 @@ const { config } = require('@open-xchange/appsuite-codeceptjs')
 config.tests = './costum_directory/*_test.js'
 
 module.exports.config = config
-```
-
-## Known Issues
-
-Add this to your `package.json` to ignore CVE-2025-5889 when installing this package with `pnpm`:
-
-```
-"pnpm": {
-  "auditConfig": {
-    "ignoreCves": [
-      "CVE-2025-5889"
-    ]
-  }
-}
-```
+```

package/index.d.ts

@@ -26,6 +26,20 @@ declare module '@open-xchange/appsuite-codeceptjs' {
 
   export { recorder, event as codeceptEvents } from 'codeceptjs'
 
+  // chai ---------------------------------------------------------------------
+
+  // from src/chai.js
+  global {
+    const assert: Chai.AssertStatic
+    const expect: Chai.ExpectStatic
+
+    namespace Chai {
+      interface Assertion {
+        accessible: Assertion
+      }
+    }
+  }
+
   // util ---------------------------------------------------------------------
 
   /**
@@ -237,6 +251,9 @@ declare module '@open-xchange/appsuite-codeceptjs' {
     'provisioning.context.create': [context: ContextData, admin: ContextAdmin, auth: AuthData]
     'provisioning.context.created': [context: Context]
     'provisioning.context.removed': [context: Context]
+    'provisioning.sharedaccount.create': [sharedAccount: SharedAccountData, context: Context]
+    'provisioning.sharedaccount.created': [sharedAccount: SharedAccount]
+    'provisioning.sharedaccount.removed': [sharedAccount: SharedAccount]
   }
 
   export const event: {
@@ -251,6 +268,11 @@ declare module '@open-xchange/appsuite-codeceptjs' {
         readonly created: 'provisioning.context.created'
         readonly removed: 'provisioning.context.removed'
       }
+      readonly sharedaccount: {
+        readonly create: 'provisioning.sharedaccount.create'
+        readonly created: 'provisioning.sharedaccount.created'
+        readonly removed: 'provisioning.sharedaccount.removed'
+      }
     }
     dispatcher: NodeJS.EventEmitter<AppSuiteCodeceptEventMap>
     emit <K extends keyof AppSuiteCodeceptEventMap> (event: K, ...params: AppSuiteCodeceptEventMap[K]): void
@@ -316,8 +338,7 @@ declare module '@open-xchange/appsuite-codeceptjs' {
     grabAxeReport (options?: { disableRules?: string | string[]; exclude?: string | string[]; include?: string | string[] }): Promise<object>
     selectFolder (id: string, context?: string): Promise<void>
     throttleNetwork (networkConfig: 'OFFLINE' | 'GPRS' | '2G' | '3G' | '4G' | 'DSL' | 'ONLINE'): Promise<void>
-    haveSetting (settings: Record<string, unknown>, options?: UserOptions): Promise<void>
-    haveSetting (key: string, value: unknown, options?: UserOptions): Promise<void>
+    haveSetting (...args: [settings: Record<string, unknown>, options?: UserOptions] | [key: string, value: unknown, options?: UserOptions]): Promise<void>
     /**
      * Changes a configuration item of a user account during a test.
      *
@@ -593,6 +614,16 @@ declare module '@open-xchange/appsuite-codeceptjs' {
         users: Users
         viewer: OXPO.ViewerFragment
       }
+
+      interface Suite {
+        suites: Suite[]
+        tests: Test[]
+        eachTest (fn: (test: Test) => void): this
+      }
+
+      interface Test {
+        parent: Suite
+      }
     }
   }
 }

package/index.js

@@ -22,8 +22,9 @@ require('./src/chai')
 const { recorder, event: codeceptEvents } = require('codeceptjs')
 const pageobjects = require('@open-xchange/appsuite-codeceptjs-pageobjects')
 
-const dotenv = require('dotenv')
-dotenv.config({ path: ['.env', '.env.defaults'], quiet: true })
+for (const envFile of ['.env', '.env.defaults']) {
+  try { process.loadEnvFile(envFile) } catch {}
+}
 
 const outputDir = process.env.E2E_OUTPUT_DIR || './output'
 
@@ -42,7 +43,7 @@ module.exports = {
   codeceptEvents,
   recorder,
   config: {
-    tests: './tests/**/*_test.js',
+    tests: './tests/**/*_test.{js,ts}',
     timeout: Number(process.env.TEST_TIMEOUT) || 120,
     output: outputDir,
     helpers: {
@@ -52,20 +53,14 @@ module.exports = {
         browser: 'chromium',
         chromium: {
           args: [
-            '--disable-print-preview',
-            '--disable-crash-reporter',
-            '--disable-dev-shm-usage',
-            '--disable-features=IsolateOrigins',
             '--disable-gpu',
-            '--disable-notifications', // to disable native notification window on Mac OS,
+            '--disable-notifications', // to disable native notification window on Mac OS
             '--disable-print-preview',
             '--disable-setuid-sandbox',
-            '--disable-site-isolation-trials',
             '--disable-web-security',
-            '--no-first-run',
-            '--no-sandbox',
-            '--no-zygote'
-          ].concat((process.env.CHROME_ARGS || '').split(' '))
+            '--no-zygote',
+            '--renderer-process-limit=1'
+          ].concat((process.env.CHROME_ARGS || '').split(' ').filter(Boolean))
         },
         url: process.env.LAUNCH_URL,
         show: process.env.HEADLESS === 'false',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/appsuite-codeceptjs",
-  "version": "0.7.2",
+  "version": "0.8.1",
   "description": "OX App Suite CodeceptJS Configuration and Helpers",
   "main": "index.js",
   "types": "index.d.ts",
@@ -15,17 +15,14 @@
   "license": "AGPL-3.0-or-later",
   "private": false,
   "dependencies": {
-    "@axe-core/playwright": "^4.11.0",
+    "@axe-core/playwright": "^4.11.1",
     "@codeceptjs/helper": "^2.0.4",
     "@influxdata/influxdb-client": "^1.35.0",
     "@open-xchange/appsuite-codeceptjs-pageobjects": "^1.1.1",
     "@playwright/test": "1.58.2",
     "allure-codeceptjs": "2.15.1",
-    "chai": "^6.2.1",
-    "chalk": "^4.1.2",
-    "chalk-table": "^1.0.2",
-    "codeceptjs": "3.7.6",
-    "dotenv": "^17.2.3",
+    "chai": "^6.2.2",
+    "codeceptjs": "3.7.7",
     "mocha": "^11.7.5",
     "mocha-junit-reporter": "^2.2.1",
     "mocha-multi": "^1.1.7",
@@ -34,17 +31,14 @@
     "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.12"
+    "@open-xchange/soap-client": "0.1.0",
+    "@open-xchange/codecept-horizontal-scaler": "0.1.15"
   },
   "devDependencies": {
-    "@types/node": "^24.10.3",
+    "@types/node": "^25.5.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.3",
-    "@open-xchange/lint": "0.2.1"
-  },
-  "resolutions": {
-    "axios": ">1.12.0"
+    "typescript": "^6.0.0",
+    "@open-xchange/lint": "0.3.0"
   },
   "scripts": {
     "lint": "eslint ."

package/src/contexts/contexts.js

@@ -18,7 +18,6 @@
  * Any use of the work other than as authorized under this license or copyright law is prohibited.
  */
 
-const created = []
 const users = require('../users/users')()
 const util = require('../util')
 const event = require('../event')
@@ -26,6 +25,8 @@ const { contextService, getFilestorageId } = require('@open-xchange/soap-client/
 const crypto = require('node:crypto')
 const codecept = require('codeceptjs')
 
+const created = []
+
 class Context {
   constructor ({ ctxdata, admin, auth }) {
     this.id = ctxdata.id

package/src/contexts/reseller.js

@@ -22,6 +22,7 @@ const event = require('../event')
 const users = require('../users/reseller')()
 const util = require('../util')
 const { resellerContextService, resellerUserService } = require('@open-xchange/soap-client/reseller')
+
 const contexts = []
 const created = []
 

package/src/event.js

@@ -36,7 +36,12 @@ module.exports = {
       create: 'provisioning.context.create',
       created: 'provisioning.context.created',
       removed: 'provisioning.context.removed'
-    }
+    },
+    sharedaccount: {
+      create: 'provisioning.sharedaccount.create',
+      created: 'provisioning.sharedaccount.created',
+      removed: 'provisioning.sharedaccount.removed'
+    },
   },
   emit (event, param) {
     let msg = `Emitted | ${event}`

package/src/plugins/testmetrics/index.js

@@ -21,8 +21,7 @@
 const { InfluxDB, Point } = require('@influxdata/influxdb-client')
 const event = require('codeceptjs/lib/event')
 const recorder = require('codeceptjs/lib/recorder')
-const chalk = require('chalk')
-const chalkTable = require('chalk-table')
+const { styleText } = require('node:util')
 
 function durationOf (test) {
   return test.steps.reduce((sum, step) => sum + (step.endTime - step.startTime), 0)
@@ -39,18 +38,16 @@ module.exports = function setupTestMetricsPlugin ({ url, org, token, defaultTags
           writePoint (p) { points.push(p) },
           flush () {
             if (!points.length) return
-            const options = {
-              columns: [
-                { field: 'measurement', name: chalk.cyan('Measurement') },
-                { field: 'metric', name: chalk.cyan('Metric') },
-                { field: 'duration', name: chalk.green('Duration') },
-                { field: 'transferSize', name: chalk.green('Transfer size') },
-                { field: 'decodedBodySize', name: chalk.green('Dec. body size') },
-                { field: 'cached', name: chalk.yellow('Cached') },
-                { field: 'tags', name: chalk.cyan('Tags') }
-              ]
-            }
-            console.log(chalkTable(options, points.filter(p => p.name !== 'testrun').map(p => {
+            const columns = [
+              { field: 'measurement', name: 'Measurement', color: 'cyan' },
+              { field: 'metric', name: 'Metric', color: 'cyan' },
+              { field: 'duration', name: 'Duration', color: 'green' },
+              { field: 'transferSize', name: 'Transfer size', color: 'green' },
+              { field: 'decodedBodySize', name: 'Dec. body size', color: 'green' },
+              { field: 'cached', name: 'Cached', color: 'yellow' },
+              { field: 'tags', name: 'Tags', color: 'cyan' }
+            ]
+            const rows = points.filter(p => p.name !== 'testrun').map(p => {
               const metric = p.tags.metric
               delete p.tags.metric
               const cached = p.tags.cached
@@ -65,7 +62,11 @@ module.exports = function setupTestMetricsPlugin ({ url, org, token, defaultTags
                 row[field] = p.fields[field]
               }
               return row
-            })))
+            })
+            const widths = columns.map(col => Math.max(col.name.length, ...rows.map(r => String(r[col.field] ?? '').length)))
+            const header = columns.map((col, i) => styleText(col.color, col.name.padEnd(widths[i]))).join('  ')
+            const lines = rows.map(row => columns.map((col, i) => String(row[col.field] ?? '').padEnd(widths[i])).join('  '))
+            console.log([header, ...lines].join('\n'))
             points.splice(0, points.length)
           },
           dispose () {

package/src/sharedaccounts/sharedaccounts.js

@@ -20,6 +20,7 @@
 
 const short = require('short-uuid')
 const { sharedAccountService } = require('@open-xchange/soap-client/common')
+const event = require('../event')
 const util = require('../util')
 
 const sharedAccounts = []
@@ -77,6 +78,7 @@ class SharedAccount {
    */
   static async create (sharedAccountData, ctx = {}) {
     sharedAccountData = { ...this.getRandom(), ...sharedAccountData }
+    event.emit(event.provisioning.sharedaccount.create, sharedAccountData, ctx)
 
     const { contexts } = inject()
     let sharedAccountContext
@@ -91,6 +93,7 @@ class SharedAccount {
     const data = await sharedAccountService.create(sharedAccountContext, sharedAccountData)
     const sharedAccount = new SharedAccount({ sharedAccountData: data, context: sharedAccountContext })
     sharedAccounts.push(sharedAccount)
+    event.emit(event.provisioning.sharedaccount.created, sharedAccount)
     return sharedAccount
   }
 
@@ -155,10 +158,12 @@ class SharedAccount {
    * @returns {Promise<void>}
    */
   async remove () {
+    await sharedAccountService.remove(this.context, this.sharedAccountData)
     const index = sharedAccounts.indexOf(this)
-    if (index < 0) return
-    sharedAccounts.splice(index, 1)
-    return sharedAccountService.remove(this.context, this.sharedAccountData)
+    if (index >= 0) {
+      sharedAccounts.splice(index, 1)
+      event.emit(event.provisioning.sharedaccount.removed, this)
+    }
   }
 
   toJSON () {

package/src/users/reseller.js

@@ -18,14 +18,14 @@
  * Any use of the work other than as authorized under this license or copyright law is prohibited.
  */
 
+const short = require('short-uuid')
+const { resellerUserService, oxaasService } = require('@open-xchange/soap-client/reseller')
 const event = require('../event')
+const util = require('../util')
 
 const users = []
 const usersToRemove = []
 const preprovisionedUsers = []
-const util = require('../util')
-const short = require('short-uuid')
-const { resellerUserService, oxaasService } = require('@open-xchange/soap-client/reseller')
 
 class User {
   constructor (opt) {

package/src/users/users.js

@@ -19,12 +19,13 @@
  */
 
 /* eslint-disable camelcase */
-const event = require('../event')
 
-const users = []
-const util = require('../util')
 const short = require('short-uuid')
 const { userService } = require('@open-xchange/soap-client/common')
+const event = require('../event')
+const util = require('../util')
+
+const users = []
 
 class User {
   constructor (opt) {

package/.env.defaults

@@ -1,48 +0,0 @@
-# Default environment variables
-#
-# Do not edit this file, instead create a .env file in the root directory!
-
-# CONTEXT_ID only needs to be set for local development
-# CONTEXT_ID=
-
-# Admin credentials for e2e middleware
-# PROVISIONING_USER=
-# PROVISIONING_PASSWORD=
-
-# SMTP and IMAP server for e2e-tests
-SMTP_SERVER=main-asbox-postfix
-IMAP_SERVER=main-asbox-dovecot
-
-# Number of maximum retries of e2e-test runs and minimal successful e2e-test runs
-MIN_SUCCESS=1
-MAX_RERUNS=1
-
-# URL to the App Suite Middleware for e2e-provisioning via SOAP
-PROVISIONING_URL=https://appsuite-main.dev.oxui.de/
-
-# URL to the App Suite UI for e2e-tests
-LAUNCH_URL=https://core-ui-main.dev.oxui.de
-
-# MX domain for e2e-tests
-MX_DOMAIN=box.ox.io
-
-# API used for e2e user provisioning (common/reseller)
-PROVISIONING_API=common
-
-# Default timeout for all wait operations for e2e tests in ms
-WAIT_TIMEOUT=5000
-
-# Run test headless or in chrome (Must be true for CI)
-HEADLESS=true
-
-# Test metrics plugin configuration
-E2E_TEST_METRICS_CLIENT=
-E2E_TEST_METRICS_TOKEN=
-
-# Path to the chrome binary
-CHROME_BIN=/Applications/Google Chrome.app/Contents/MacOS/Google Chrome
-
-# See https://peter.sh/experiments/chromium-command-line-switches
-CHROME_ARGS=
-# CHROME_ARGS: '--disable-accelerated-2d-canvas --no-zygote --single-process'
-DOTENV_CONFIG_QUIET=true

package/container/Dockerfile

@@ -1 +0,0 @@
-FROM registry.gitlab.com/openxchange/base-images/wolfi/playwright:1.58.2

package/pnpm-workspace.yaml

@@ -1,14 +0,0 @@
-packages:
-  - ../lint
-  - ../soap-client
-  - ../codecept-horizontal-scaler
-
-ignoredBuiltDependencies:
-  - detox
-
-onlyBuiltDependencies:
-  - dtrace-provider
-  - unrs-resolver
-
-publicHoistPattern:
-  - '*eslint*'