Open-xchange specific codecept helpers


stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
Minified + gzip package size for @open-xchange/codecept-helper in KB


Open-Xchange App Suite: Codecept helpers

This library contains appsuite specific helpers and actors for Open-Xchange App Suite.


Basic config

// inside codecept.conf.js

module.exports.config = {
    'helpers': {
        // other helpers...
        OpenXchange: {
            require: './node_modules/@open-xchange/codecept-helper/src/helper',
            // OpenXchange helpers and actors rely on users array provided via config
            users: [{
                username: 'testuser1',
                password: 'ultimatelySecure',
                mail: 'testuser1@example.com'
    'include': {
        'I': './node_modules/@open-xchange/codecept-helper/src/actor'

If you want to have other actor functions bound to the I object, you can extend our actor in another file as follows:

// inside actor.js

module.exports = function () {
    const {actor} = require('@open-xchange/codecept-helper');
    return actor({
        customFunction: function () {
            // do custom stuff

Run the tests

Before running the tests, you need to make sure that you have a URL to a working Open-Xchange installation which allows access via SOAP (e.g. http://e2e-develop.ui.cloud.open-xchange.com/appsuite/) and you need working installation of a selenium with chrome (e.g. via docker run -p 4444:4444 -d selenium/standalone-chrome). Then you can run the test locally with the following command:

LAUNCH_URL=http://e2e-develop.ui.cloud.open-xchange.com/appsuite/ SELENIUM_HOST=localhost yarn test

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.