@open-xchange/appsuite-codeceptjs 0.1.0

package/src/plugins/testmetrics/index.js

@@ -0,0 +1,135 @@
+/**
+ * @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 { 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')
+
+function durationOf (test) {
+  return test.steps.reduce((sum, step) => sum + (step.endTime - step.startTime), 0)
+}
+
+module.exports = function setupTestMetricsPlugin ({ url, org, token, defaultTags }) {
+  const client = new InfluxDB({ url, token })
+  const performanceRecorder = token
+    ? client.getWriteApi(org, 'ui-performance', 'ms', { defaultTags })
+    // no token, so just record and print collected data
+    : (function () {
+        const points = []
+        return {
+          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 metric = p.tags.metric
+              delete p.tags.metric
+              const cached = p.tags.cached
+              delete p.tags.cached
+              const row = {
+                measurement: p.name,
+                tags: JSON.stringify(p.tags),
+                cached,
+                metric
+              }
+              for (const field of Object.keys(p.fields)) {
+                row[field] = p.fields[field]
+              }
+              return row
+            })))
+            points.splice(0, points.length)
+          },
+          dispose () {
+            return points.length
+          }
+        }
+      })()
+
+  const testRecorder = !!token && client.getWriteApi(org, 'e2e', 'ms', { defaultTags })
+
+  event.dispatcher.on(event.suite.after, function recordSendMetrics () {
+    recorder.add('send metrics data', async function sendMetrics () {
+      try {
+        await performanceRecorder.flush()
+        if (testRecorder) await testRecorder.flush()
+      } catch (error) {
+        console.log(error)
+        console.warn('Could not send metrics data')
+      }
+    })
+  })
+  event.dispatcher.on(event.all.after, function disposeInfluxClient () {
+    const unwrittenPoints = performanceRecorder.dispose() + testRecorder ? testRecorder.dispose() : 0
+    if (unwrittenPoints) console.warn(`Quit with ${unwrittenPoints} unwritten metrics points in queue.`)
+  })
+
+  event.dispatcher.on(event.test.after, function recordTestMetrics (test) {
+    if (!testRecorder) return
+    const point = new Point('run')
+      .tag('feature', test.parent.title)
+      .tag('scenario', test.title)
+      .tag('state', test.state)
+
+    if (process.env.CI) {
+      point.tag('deployment', process.env.REPORT_PROJECT || process.env.CI_COMMIT_REF_SLUG)
+    }
+    try {
+      point.timestamp(Date.now())
+      point.intField('duration', durationOf(test))
+
+      testRecorder.writePoint(point)
+    } catch (error) {
+      console.log(error)
+      console.warn('Could not write test metrics')
+    }
+  })
+
+  return {
+    addPerformanceMeasurement (measurement, fields, { tags = {}, timestamp = Date.now() } = {}) {
+      const p = new Point(measurement)
+      for (const tag in tags) {
+        p.tag(tag, tags[tag])
+      }
+      p.timestamp(timestamp)
+      for (const field of fields) {
+        try {
+          p[field.type](field.name, field.value)
+        } catch (e) {
+          console.log(e)
+          console.warn(`${field.type} is not a valid field type`)
+        }
+      }
+      performanceRecorder.writePoint(p)
+    },
+    metricsClientName: defaultTags.client
+  }
+}

package/src/soap/services/context.js

@@ -0,0 +1,147 @@
+/**
+ * @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 { createClientAsync, logSoapError } = require('../soap.js')
+const { getFilestorageId } = require('./util.js')
+
+const OXContextService = createClientAsync('OXContextService').then(client => client)
+
+/**
+ * This function retrieves the default context from the OXContextService.
+ * @returns {Promise<Object>} The first result from the listAsync method call.
+ */
+async function getDefault () {
+  return (await (await OXContextService).listAsync({ search_pattern: 'defaultcontext' }))[0]
+}
+
+/**
+ * This function removes the context with the specified ID.
+ * @param {number} id The ID of the context to remove.
+ * @returns {Promise<Boolean>} Returns true if it could remove the context and false if it could not
+ */
+async function remove (id) {
+  return !!await (await OXContextService).deleteAsync({ ctx: { id } }).then(() => true).catch(logSoapError)
+}
+
+/**
+ * This function creates a new context.
+ * @param {Object} ctx The context to create.
+ * @returns {Promise<Object>} The created context.
+ */
+async function create (ctx = {}) {
+  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: {
+        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}`
+      }
+    })
+    .then(async context => {
+      await changeModuleAccessByName(context.id, 'all')
+      return context
+    })
+    // .catch(logSoapError)
+}
+
+/**
+ * This function changes the module access of the specified context.
+ * @param {number} id The ID of the context.
+ * @param {string} access_combination_name The name of the access combination to set.
+ * @returns {Promise<void>}
+ */
+// eslint-disable-next-line camelcase
+async function changeModuleAccessByName (id, access_combination_name) {
+  // eslint-disable-next-line camelcase
+  return await (await OXContextService).changeModuleAccessByNameAsync({ ctx: { id }, access_combination_name })
+}
+
+/**
+ * This function changes the capabilities of the specified context.
+ * @param {number} id The ID of the context.
+ * @param {string} capsToAdd The capabilities to add.
+ * @param {string} capsToRemove The capabilities to remove.
+ * @returns {Promise<void>}
+ */
+async function changeCapabilities (id, capsToAdd, capsToRemove) {
+  const data = {}
+  if (capsToAdd) data.capsToAdd = capsToAdd
+  if (capsToRemove) data.capsToRemove = capsToRemove
+  return await (await OXContextService).changeCapabilitiesAsync({ ctx: { id }, ...data })
+}
+
+/**
+ * This function retrieves the module access of the specified context.
+ * @param {number} id The ID of the context.
+ * @returns {Promise<Object>} The module access of the specified context.
+ */
+async function getModuleAccess (id) {
+  return await (await OXContextService).getModuleAccessAsync({ ctx: { id } })
+}
+/**
+ * This function changes the module access of the specified context.
+ * @param {number} id The ID of the context.
+ * @param {Object} moduleAccess The module access to set.
+ * @returns {Promise<void>}
+ */
+async function changeModuleAccess (id, moduleAccess) {
+  const currentAccess = await getModuleAccess(id)
+  return await (await OXContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...moduleAccess } })
+}
+
+/**
+ * This function retrieves the context with the specified ID.
+ * @param {number} id The ID of the context to retrieve.
+ * @returns {Promise<Object>} The context with the specified ID.
+ */
+async function get (id) {
+  return await (await OXContextService).getDataAsync({ ctx: { id } })
+}
+
+/**
+ * This function changes the context with the specified ID.
+ * @param {Object} ctx The context to change.
+ * @returns {Promise<void>}
+ */
+async function change (ctx) {
+  return await (await OXContextService).changeAsync({ ctx })
+}
+
+module.exports = {
+  getDefault,
+  remove,
+  create,
+  changeModuleAccessByName,
+  changeCapabilities,
+  getModuleAccess,
+  changeModuleAccess,
+  get,
+  change
+}

package/src/soap/services/oxaas.js

@@ -0,0 +1,36 @@
+/**
+ * @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 { createClientAsync } = require('../soap.js')
+
+const OXaaSService = createClientAsync('OXaaSService').then(client => client)
+
+async function setMailQuota (data) {
+  return await (await OXaaSService).setMailQuotaAsync(data)
+}
+
+async function createSharedDomain (data) {
+  return await (await OXaaSService).createSharedDomain(data)
+}
+
+module.exports = {
+  setMailQuota,
+  createSharedDomain
+}

package/src/soap/services/resellerContext.js

@@ -0,0 +1,65 @@
+/**
+ * @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 { createClientAsync, logSoapError } = require('../soap.js')
+
+const OXResellerContextService = createClientAsync('OXResellerContextService').then(client => client)
+
+async function create (data) {
+  return await (await OXResellerContextService).createAsync(data)
+}
+
+async function remove (contextId) {
+  return !!await (await OXResellerContextService).deleteAsync({
+    ctx: { id: contextId }
+  }).then(() => true).catch(logSoapError)
+}
+
+async function change (ctx) {
+  return await (await OXResellerContextService).changeAsync({ ctx })
+}
+
+async function get (id) {
+  return await (await OXResellerContextService).getDataAsync({ ctx: { id } })
+}
+
+async function getModuleAccess (id) {
+  return await (await OXResellerContextService).getModuleAccessAsync({ ctx: id })
+}
+
+async function changeModuleAccess (id, access) {
+  const currentAccess = await getModuleAccess(id)
+
+  return await (await OXResellerContextService).changeModuleAccessAsync({ ctx: { id }, access: { ...currentAccess, ...access } })
+}
+
+async function listAll (data) {
+  return await (await OXResellerContextService).listAllAsync(data)
+}
+
+module.exports = {
+  create,
+  remove,
+  change,
+  get,
+  getModuleAccess,
+  changeModuleAccess,
+  listAll
+}

package/src/soap/services/resellerUser.js

@@ -0,0 +1,100 @@
+/**
+ * @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 { createClientAsync, logSoapError } = require('../soap.js')
+
+const OXResellerUserService = createClientAsync('OXResellerUserService').then(client => client)
+
+async function remove (contextId, userId) {
+  return !!await (await OXResellerUserService).deleteAsync({
+    ctx: { id: contextId },
+    user: { id: userId }
+  }).then(() => true).catch(logSoapError)
+}
+
+/**
+ * This function changes the context with the specified ID.
+ * @param {Object} context The context of the user to be changed.
+ * @param {Object} usrdata The user to change.
+ * @returns {Promise<void>}
+ */
+async function change (context, usrdata) {
+  return await (await OXResellerUserService).changeAsync({
+    ctx: { id: context.id },
+    usrdata,
+    auth: { login: context.admin.name, password: context.admin.password }
+  })
+}
+
+async function get (data) {
+  return await (await OXResellerUserService).getDataAsync(data)
+}
+
+async function getModuleAccess (context, userId) {
+  return await (await OXResellerUserService).getModuleAccessAsync({
+    ctx: { id: context.id },
+    user: { id: userId },
+    auth: { login: context.admin.name, password: context.admin.password }
+  }).then(
+    (res) => res
+  )
+}
+
+async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
+  return await (await OXResellerUserService).changeByModuleAccessAsync({
+    ctx: { id: context.id },
+    moduleAccess: Object.assign({}, currentAccess, moduleAccess),
+    user: { id: userId },
+    auth: { login: context.admin.name, password: context.admin.password }
+  })
+}
+
+async function changeByModuleAccessName (context, userId, accessCombinationName) {
+  return await (await OXResellerUserService).changeByModuleAccessNameAsync({
+    ctx: { id: context.id },
+    access_combination_name: accessCombinationName,
+    user: { id: userId },
+    auth: { login: context.admin.name, password: context.admin.password }
+  }).catch(error => console.error('Module access change error: ', error))
+}
+
+async function createByModuleAccessName (context, usrdata) {
+  return await (await OXResellerUserService).createByModuleAccessNameAsync({
+    ctx: { id: context.id },
+    usrdata,
+    access_combination_name: 'all',
+    auth: { login: context.admin.name, password: context.admin.password }
+  })
+}
+
+async function listAll (data) {
+  return await (await OXResellerUserService).listAllAsync(data)
+}
+
+module.exports = {
+  remove,
+  change,
+  get,
+  getModuleAccess,
+  changeByModuleAccess,
+  changeByModuleAccessName,
+  createByModuleAccessName,
+  listAll
+}

package/src/soap/services/user.js

@@ -0,0 +1,114 @@
+/**
+ * @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 { createClientAsync, logSoapError } = require('../soap.js')
+
+const OXUserService = createClientAsync('OXUserService').then(client => client)
+
+/**
+ * This function removes the user with the specified context and user ID.
+ * @param {Object} context The context of the user to be removed.
+ * @param {number} userId The ID of the user to be removed.
+ * @returns {Promise<Boolean>} Returns true if it could remove the user and false if it could not
+ */
+async function remove (context, userId) {
+  return !!await (await OXUserService).deleteAsync({
+    ctx: { id: context.id },
+    user: { id: userId },
+    auth: context.admin
+  }).then(() => true).catch(logSoapError)
+}
+
+/**
+ * This function creates a new user.
+ * @param {Object} context The context of the user to be created.
+ * @param {Object} usrdata The user to create.
+ * @returns {Promise<Object>} The created user.
+ */
+async function create (context, usrdata) {
+  return await (await OXUserService).createAsync({
+    ctx: { id: context.id },
+    usrdata,
+    auth: context.admin
+  })
+}
+
+/**
+ * This function changes the context with the specified ID.
+ * @param {Object} context The context of the user to be changed.
+ * @param {Object} usrdata The user to change.
+ * @returns {Promise<void>}
+ */
+async function change (context, usrdata) {
+  return await (await OXUserService).changeAsync({
+    ctx: { id: context.id },
+    usrdata,
+    auth: context.admin
+  })
+}
+
+async function changeByModuleAccess (context, userId, currentAccess, moduleAccess) {
+  return await (await OXUserService).changeByModuleAccessAsync({
+    ctx: { id: context.id },
+    moduleAccess: Object.assign({}, currentAccess, moduleAccess),
+    user: { id: userId },
+    auth: context.admin
+  })
+}
+
+async function changeByModuleAccessName (context, userId, accessCombinationName) {
+  return await (await OXUserService).changeByModuleAccessNameAsync({
+    ctx: { id: context.id },
+    access_combination_name: accessCombinationName,
+    user: { id: userId },
+    auth: context.admin
+  }).catch(error => console.error('Module access change error:', error))
+}
+
+async function getModuleAccess (context, userId) {
+  return await (await OXUserService).getModuleAccessAsync({
+    ctx: { id: context.id },
+    user: { id: userId },
+    auth: context.admin
+  }).then(
+    (res) => res
+  )
+}
+
+async function changeCapabilities (context, userId, capsToAdd, capsToRemove) {
+  const data = {
+    ctx: { id: context.id },
+    user: { id: userId },
+    auth: context.admin
+  }
+  if (capsToAdd) data.capsToAdd = capsToAdd
+  if (capsToRemove) data.capsToRemove = capsToRemove
+  return await (await OXUserService).changeCapabilitiesAsync(data)
+}
+
+module.exports = {
+  create,
+  change,
+  changeByModuleAccess,
+  changeByModuleAccessName,
+  changeCapabilities,
+  getModuleAccess,
+  remove
+}

package/src/soap/services/util.js

@@ -0,0 +1,39 @@
+/**
+ * @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 { createClientAsync } = require('../soap.js')
+
+const OXUtilService = createClientAsync('OXUtilService').then(client => client)
+
+/**
+ * This function retrieves the ID of the first filestorage.
+ * @returns {Promise<number>} The ID of the first filestorage.
+ */
+let fileStoreId
+
+async function getFilestorageId () {
+  if (fileStoreId) return fileStoreId
+  fileStoreId = (await (await OXUtilService).listFilestoreAsync())[0]?.id
+  return fileStoreId
+}
+
+module.exports = {
+  getFilestorageId
+}