@jahia/cypress 4.0.0 → 4.2.0

package/README.md

@@ -102,4 +102,9 @@ module.exports = (on, config) => {
 ```
 ## Open-Source
 
-This is an Open-Source codebase, you can find more details about Open-Source @ Jahia [in this repository](https://github.com/Jahia/open-source)
+This is an Open-Source codebase, you can find more details about Open-Source @ Jahia [in this repository](https://github.com/Jahia/open-source)
+
+## How to release
+Ensure and eventually change the version in [package.json](package.json) to match the version to release.
+
+From Github release panel, draft a new release with a tag named `vX.Y.Z` and a title `vX.Y.Z`. The release will be published to NPM automatically.

package/dist/page-object/moonstone/menu.d.ts

@@ -5,9 +5,11 @@ export declare class Menu extends BaseComponent {
     static overlaySelector: string;
     submenu(item: string, menu: string): Menu;
     shouldHaveItem(item: string): void;
+    shouldHaveRoleItem(role: string): void;
     shouldNotHaveItem(item: string): void;
+    shouldNotHaveRoleItem(role: string): void;
     select(item: string): Menu;
-    selectByRole(item: string): Menu;
+    selectByRole(role: string): Menu;
     /** Can be used for choicelist dropdown menu */
     selectByValue(value: string): Menu;
     close(): Chainable<unknown>;

package/dist/page-object/moonstone/menu.js

@@ -24,29 +24,38 @@ var Menu = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     Menu.prototype.submenu = function (item, menu) {
-        this.get().find('.moonstone-menuItem').contains(item).scrollIntoView().should('be.visible');
+        this.shouldHaveItem(item);
         this.get().find('.moonstone-menuItem').contains(item).realHover();
         return utils_1.getComponentByRole(Menu, menu);
     };
     Menu.prototype.shouldHaveItem = function (item) {
-        this.get().find('.moonstone-menuItem').contains(item).scrollIntoView().should('be.visible');
+        this.get().find('.moonstone-menuItem').contains(item).scrollIntoView();
+        this.get().find('.moonstone-menuItem').contains(item).should('be.visible');
+    };
+    Menu.prototype.shouldHaveRoleItem = function (role) {
+        this.get().find(".moonstone-menuItem[data-sel-role=" + role + "]").scrollIntoView();
+        this.get().find(".moonstone-menuItem[data-sel-role=" + role + "]").should('be.visible');
     };
     Menu.prototype.shouldNotHaveItem = function (item) {
         this.get().find('.moonstone-menuItem').contains(item).should('not.exist');
     };
+    Menu.prototype.shouldNotHaveRoleItem = function (role) {
+        this.get().find(".moonstone-menuItem[data-sel-role=\"" + role + "\"]").should('not.exist');
+    };
     Menu.prototype.select = function (item) {
-        this.get().find('.moonstone-menuItem').contains(item).scrollIntoView().should('be.visible');
+        this.shouldHaveItem(item);
         this.get().find('.moonstone-menuItem').contains(item).trigger('click');
         return this;
     };
-    Menu.prototype.selectByRole = function (item) {
-        this.get().find(".moonstone-menuItem[data-sel-role=\"" + item + "\"]").scrollIntoView().should('be.visible');
-        this.get().find(".moonstone-menuItem[data-sel-role=\"" + item + "\"]").trigger('click');
+    Menu.prototype.selectByRole = function (role) {
+        this.shouldHaveRoleItem(role);
+        this.get().find(".moonstone-menuItem[data-sel-role=\"" + role + "\"]").trigger('click');
         return this;
     };
     /** Can be used for choicelist dropdown menu */
     Menu.prototype.selectByValue = function (value) {
-        this.get().find(".moonstone-menuItem[data-value=\"" + value + "\"]").scrollIntoView().should('be.visible');
+        this.get().find(".moonstone-menuItem[data-value=\"" + value + "\"]").scrollIntoView();
+        this.get().find(".moonstone-menuItem[data-value=\"" + value + "\"]").should('be.visible');
         this.get().find(".moonstone-menuItem[data-value=\"" + value + "\"]").trigger('click');
         return this;
     };

package/dist/utils/ExportHelper.d.ts

@@ -0,0 +1,27 @@
+import { JahiaServer } from '../support';
+export declare type ExportParameters = {
+    viewContent?: boolean;
+    viewVersion?: boolean;
+    viewAcl?: boolean;
+    viewLinks?: boolean;
+    viewMetadata?: boolean;
+    viewWorkflow?: boolean;
+    exportPath?: string;
+    exportformat: 'all' | 'site' | 'xml' | 'zip';
+    root?: string;
+    live?: boolean;
+    users?: boolean;
+    sitebox?: string[];
+    paths?: string[];
+    cleanup?: 'template' | 'simple';
+    filesToZip?: string;
+};
+declare type ExportContentParams = {
+    workspace?: string;
+    nodePath?: string;
+    exportFormat?: string;
+    params?: ExportParameters;
+    jahiaServer?: JahiaServer;
+};
+export declare const exportContent: ({ workspace, nodePath, exportFormat, params, jahiaServer }: ExportContentParams) => void;
+export {};

package/dist/utils/ExportHelper.js

@@ -0,0 +1,40 @@
+"use strict";
+// Utility methods to call import/export Jahia API
+var __spreadArray = (this && this.__spreadArray) || function (to, from) {
+    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
+        to[j] = from[i];
+    return to;
+};
+exports.__esModule = true;
+exports.exportContent = void 0;
+var API_NAME = '/cms/export';
+var serverDefaults = {
+    url: Cypress.config().baseUrl,
+    username: 'root',
+    password: Cypress.env('SUPER_USER_PASSWORD')
+};
+var exportContent = function (_a) {
+    var _b, _c;
+    var _d = _a.workspace, workspace = _d === void 0 ? 'default' : _d, _e = _a.nodePath, nodePath = _e === void 0 ? '/export' : _e, _f = _a.exportFormat, exportFormat = _f === void 0 ? 'zip' : _f, _g = _a.params, params = _g === void 0 ? {
+        exportformat: 'site',
+        live: true,
+        users: true
+    } : _g, _h = _a.jahiaServer, jahiaServer = _h === void 0 ? serverDefaults : _h;
+    var queryStringParams = Object.keys(params)
+        .filter(function (key) { return !['paths', 'sitebox'].includes(key); })
+        .map(function (key) { return encodeURIComponent(key) + "=" + encodeURIComponent(params[key]); }) || [];
+    var sitebox = ((_b = params.sitebox) === null || _b === void 0 ? void 0 : _b.map(function (sb) { return "sitebox=" + encodeURIComponent(sb); })) || [];
+    var paths = ((_c = params.paths) === null || _c === void 0 ? void 0 : _c.map(function (path) { return "path=" + encodeURIComponent(path); })) || [];
+    var qs = __spreadArray(__spreadArray(__spreadArray([], queryStringParams), sitebox), paths).join('&');
+    // It is not possible to use the "qs" field of RequestOptions for querystring as it does not support multiple parameters with the same name (path or sitebox)
+    cy.request({
+        url: "" + jahiaServer.url + API_NAME + "/" + workspace + nodePath + "." + exportFormat + "?" + qs,
+        method: 'GET',
+        auth: {
+            user: jahiaServer.username,
+            pass: jahiaServer.password,
+            sendImmediately: true
+        }
+    });
+};
+exports.exportContent = exportContent;

package/dist/utils/JCRHelper.d.ts

@@ -6,13 +6,15 @@ export declare const addNode: (variables: {
     parentPathOrId: string;
     primaryNodeType: string;
     name: string;
-    properties?: any[];
-    children?: any[];
-    mixins?: any[];
+    properties?: [];
+    children?: [];
+    mixins?: [];
 }) => Cypress.Chainable;
+export declare const addMixins: (pathOrId: string, mixins: string[]) => Cypress.Chainable;
 export declare const getNodeByPath: (path: string, properties?: string[], language?: string, childrenTypes?: string[], workspace?: Workspace) => Cypress.Chainable;
 export declare const getNodeAcl: (path: string) => Cypress.Chainable;
 export declare const moveNode: (pathOrId: string, destParentPathOrId: string, destName?: string) => Cypress.Chainable;
 export declare const getNodeTypes: (filter?: {}) => Cypress.Chainable;
+export declare const markForDeletion: (pathOrId: string) => Cypress.Chainable;
 export declare const uploadFile: (fixturePath: string, parentPathOrId: string, name: string, mimeType: string) => Cypress.Chainable;
 export {};

package/dist/utils/JCRHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 exports.__esModule = true;
-exports.uploadFile = exports.getNodeTypes = exports.moveNode = exports.getNodeAcl = exports.getNodeByPath = exports.addNode = exports.deleteNodeProperty = exports.deleteNode = exports.setNodeProperty = void 0;
+exports.uploadFile = exports.markForDeletion = exports.getNodeTypes = exports.moveNode = exports.getNodeAcl = exports.getNodeByPath = exports.addMixins = exports.addNode = exports.deleteNodeProperty = exports.deleteNode = exports.setNodeProperty = void 0;
 var setNodeProperty = function (pathOrId, property, value, language) {
     var mutationFile = 'graphql/jcr/mutation/setProperty.graphql';
     if (value instanceof Array) {
@@ -39,7 +39,6 @@ var deleteNodeProperty = function (pathOrId, property, language) {
     });
 };
 exports.deleteNodeProperty = deleteNodeProperty;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 var addNode = function (variables) {
     return cy.apollo({
         variables: variables,
@@ -47,6 +46,14 @@ var addNode = function (variables) {
     });
 };
 exports.addNode = addNode;
+var addMixins = function (pathOrId, mixins) {
+    return cy.apollo({
+        variables: { pathOrId: pathOrId, mixins: mixins },
+        mutationFile: 'graphql/jcr/mutation/addMixins.graphql'
+    });
+};
+exports.addMixins = addMixins;
+// eslint-disable-next-line max-params
 var getNodeByPath = function (path, properties, language, childrenTypes, workspace) {
     if (childrenTypes === void 0) { childrenTypes = []; }
     if (workspace === void 0) { workspace = 'EDIT'; }
@@ -92,6 +99,15 @@ var getNodeTypes = function (filter) {
     });
 };
 exports.getNodeTypes = getNodeTypes;
+var markForDeletion = function (pathOrId) {
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId
+        },
+        mutationFile: 'graphql/jcr/mutation/markForDeletion.graphql'
+    });
+};
+exports.markForDeletion = markForDeletion;
 var uploadFile = function (fixturePath, parentPathOrId, name, mimeType) {
     return cy.fixture(fixturePath, 'binary')
         .then(function (image) {

package/dist/utils/SAMHelper.d.ts

@@ -6,6 +6,15 @@ import Chainable = Cypress.Chainable;
  * @param probeNamesFilter return and calculate health status only for the probes with the given names, default is null
  */
 export declare const healthCheck: (severity?: string, probeHealthFilter?: any, probeNamesFilter?: string[]) => Chainable<any>;
+declare type WaitUntilSAMStatusParams = {
+    expectedHealth: string;
+    severity?: string;
+    probeHealthFilter?: any;
+    probeNamesFilter?: string[] | null;
+    timeout?: number;
+    interval?: number;
+    statusMatchCount?: number;
+};
 /**
  * Wait until the health check returns the expected health
  * @param expectedHealth the expected health status
@@ -16,15 +25,7 @@ export declare const healthCheck: (severity?: string, probeHealthFilter?: any, p
  * @param interval the interval in milliseconds, default is 500
  * @param statusMatchCount the number of consecutive status matches before the waitUntil resolves, default is 3
  */
-export declare const waitUntilSAMStatus: ({ expectedHealth, severity, probeHealthFilter, probeNamesFilter, timeout, interval, statusMatchCount }: {
-    expectedHealth: any;
-    severity?: string;
-    probeHealthFilter?: any;
-    probeNamesFilter?: any;
-    timeout?: number;
-    interval?: number;
-    statusMatchCount?: number;
-}) => void;
+export declare const waitUntilSAMStatus: ({ expectedHealth, severity, probeHealthFilter, probeNamesFilter, timeout, interval, statusMatchCount }: WaitUntilSAMStatusParams) => void;
 /**
  When Jahia is starting or performing provisioning operations
  it is expected for the SAM probe to alternate beween GREEN, YELLOW and RED statuses.
@@ -36,3 +37,4 @@ export declare const waitUntilSAMStatus: ({ expectedHealth, severity, probeHealt
  GREEN status was returned a number of consecutive times (greenMatchCount).
  */
 export declare const waitUntilSAMStatusGreen: (severity?: string, timeout?: number, interval?: number, greenMatchCount?: number) => void;
+export {};

package/dist/utils/UsersHelper.d.ts

@@ -4,5 +4,8 @@ export declare const createUser: (userName: string, password: string, properties
     name: string;
     value: string;
 }[]) => void;
+export declare const getUserPath: (username: string, siteKey?: string) => Cypress.Chainable;
 export declare const deleteUser: (userName: string) => void;
+export declare const createGroup: (groupName: string, hidden?: boolean, siteKey?: string) => void;
+export declare const deleteGroup: (groupName: string, siteKey?: string) => void;
 export declare const addUserToGroup: (userName: string, groupName: string, siteKey?: string) => void;

package/dist/utils/UsersHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 exports.__esModule = true;
-exports.addUserToGroup = exports.deleteUser = exports.createUser = exports.revokeRoles = exports.grantRoles = void 0;
+exports.addUserToGroup = exports.deleteGroup = exports.createGroup = exports.deleteUser = exports.getUserPath = exports.createUser = exports.revokeRoles = exports.grantRoles = void 0;
 var grantRoles = function (pathOrId, roleNames, principalName, principalType) {
     cy.log('Grant role(s) ' + roleNames + ' with principal type ' + principalType + ' to ' + principalName + ' on node ' + pathOrId);
     return cy.apollo({
@@ -39,12 +39,42 @@ var createUser = function (userName, password, properties) {
     });
 };
 exports.createUser = createUser;
+var getUserPath = function (username, siteKey) {
+    if (siteKey === void 0) { siteKey = ''; }
+    return cy.apollo({
+        variables: {
+            siteKey: siteKey,
+            username: username
+        },
+        queryFile: 'graphql/jcr/query/getUserPath.graphql'
+    });
+};
+exports.getUserPath = getUserPath;
 var deleteUser = function (userName) {
     cy.executeGroovy('groovy/admin/deleteUser.groovy', {
         USER_NAME: userName
     });
 };
 exports.deleteUser = deleteUser;
+var createGroup = function (groupName, hidden, siteKey) {
+    if (siteKey === void 0) { siteKey = ''; }
+    cy.executeGroovy('groovy/admin/userGroupHelper.groovy', {
+        OPERATION: 'create',
+        GROUPNAME: groupName,
+        HIDDEN: hidden ? 'true' : 'false',
+        SITEKEY: siteKey
+    });
+};
+exports.createGroup = createGroup;
+var deleteGroup = function (groupName, siteKey) {
+    if (siteKey === void 0) { siteKey = ''; }
+    cy.executeGroovy('groovy/admin/userGroupHelper.groovy', {
+        OPERATION: 'delete',
+        GROUPNAME: groupName,
+        SITEKEY: siteKey
+    });
+};
+exports.deleteGroup = deleteGroup;
 var addUserToGroup = function (userName, groupName, siteKey) {
     cy.executeGroovy('groovy/admin/addUserToGroup.groovy', {
         USER_NAME: userName,

package/dist/utils/index.d.ts

@@ -7,3 +7,4 @@ export * from './ClusterHelper';
 export * from './JahiaPlatformHelper';
 export * from './GraphQLHelper';
 export * from './SAMHelper';
+export * from './ExportHelper';

package/dist/utils/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./ClusterHelper"), exports);
 __exportStar(require("./JahiaPlatformHelper"), exports);
 __exportStar(require("./GraphQLHelper"), exports);
 __exportStar(require("./SAMHelper"), exports);
+__exportStar(require("./ExportHelper"), exports);

package/env.debug.sh

@@ -2,14 +2,6 @@
 # This script can be used to warmup the environment and execute the tests
 # It is used by the docker image at startup
 
-BASEDIR=$(dirname $(readlink -f $0))
+echo "$(date +'%d %B %Y - %k:%M') == env.debug.sh == Run Cypress in interactive mode"
 
-bash $BASEDIR/env.provision.sh
-
-source $BASEDIR/set-env.sh
-
-if [[ -z "${CYPRESS_CONFIGURATION_FILE}" ]]; then
-  CYPRESS_CONFIGURATION_FILE=cypress.config.ts
-fi
-
-yarn e2e:debug --config-file "${CYPRESS_CONFIGURATION_FILE}"
+MODE=debug ./env.run.sh

package/env.provision.sh

@@ -9,7 +9,7 @@ source $BASEDIR/set-env.sh
 #!/usr/bin/env bash
 START_TIME=$SECONDS
 
-echo "$(date +'%d %B %Y - %k:%M') == Printing the most important environment variables"
+echo "$(date +'%d %B %Y - %k:%M') == env.provision.sh == Printing the most important environment variables"
 echo " MANIFEST: ${MANIFEST}"
 echo " NEXUS_USERNAME: ${NEXUS_USERNAME:0:3}***${NEXUS_USERNAME:(-6)}"
 echo " TESTS_IMAGE: ${TESTS_IMAGE}"

package/env.run.sh

@@ -8,9 +8,12 @@ bash $BASEDIR/env.provision.sh
 
 source $BASEDIR/set-env.sh
 
+MODE=${MODE:-ci}
+
 echo "$(date +'%d %B %Y - %k:%M') == env.run.sh == Printing the most important environment variables"
 echo "$(date +'%d %B %Y - %k:%M') == NEXUS_USERNAME: ${NEXUS_USERNAME:0:3}***${NEXUS_USERNAME:(-6)}"
 echo "$(date +'%d %B %Y - %k:%M') == DEBUG: ${DEBUG}"
+echo "$(date +'%d %B %Y - %k:%M') == CYPRESS MODE: ${MODE}"
 
 if [[ "${DEBUG}" == "true" ]]; then
   touch /tmp/debug
@@ -48,7 +51,7 @@ fi
 
 echo "$(date +'%d %B %Y - %k:%M') == Running Cypress with configuration file ${CYPRESS_CONFIGURATION_FILE} =="
 
-NO_COLOR=1 yarn e2e:ci --config-file "${CYPRESS_CONFIGURATION_FILE}"
+NO_COLOR=1 yarn e2e:${MODE} --config-file "${CYPRESS_CONFIGURATION_FILE}"
 
 if [[ $? -eq 0 ]]; then
   echo "$(date +'%d %B %Y - %k:%M') == Full execution successful =="

package/fixtures/graphql/jcr/mutation/addMixins.graphql

@@ -0,0 +1,8 @@
+mutation addMixins($pathOrId: String!, $mixins: [String]! = []) {
+    jcr(workspace: EDIT) {
+        mutateNode(pathOrId: $pathOrId) {
+            addMixins(mixins: $mixins)
+            uuid
+        }
+    }
+}

package/fixtures/graphql/jcr/mutation/markForDeletion.graphql

@@ -0,0 +1,7 @@
+mutation startWorkflow($pathOrId: String!) {
+  jcr {
+    mutateNode(pathOrId:$pathOrId) {
+      markForDeletion
+    }
+  }
+}

package/fixtures/graphql/jcr/query/getUserPath.graphql

@@ -0,0 +1,11 @@
+query($username: String!, $siteKey: String) {
+    admin {
+        userAdmin {
+            user(username: $username, site: $siteKey) {
+                node {
+                    path
+                }
+            }
+        }
+    }
+}

package/fixtures/groovy/admin/userGroupHelper.groovy

@@ -0,0 +1,29 @@
+import org.jahia.services.content.JCRCallback
+import org.jahia.services.content.JCRSessionWrapper
+import org.jahia.services.content.JCRTemplate
+import org.jahia.services.usermanager.JahiaGroupManagerService
+import org.jahia.services.usermanager.JahiaUserManagerService
+import javax.jcr.RepositoryException
+
+JahiaGroupManagerService groupManagerService = JahiaGroupManagerService.getInstance();
+
+JCRTemplate.getInstance().doExecuteWithSystemSession(session -> {
+    String operation = "OPERATION";
+    String groupName = "GROUPNAME"
+    String siteKey = "SITEKEY".equals("") ? null : "SITEKEY";
+    boolean hidden = Boolean.parseBoolean("HIDDEN")
+    log.info("{} : {}", operation, groupName)
+    switch (operation) {
+        case "create":
+            groupManagerService.createGroup(siteKey, groupName, null, hidden,  session)
+            break;
+        case "delete":
+            def group = groupManagerService.lookupGroup(siteKey, groupName);
+            if (group != null) {
+                groupManagerService.deleteGroup(group.getPath(), session)
+            }
+            break;
+    }
+    session.save()
+    return null
+})

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@jahia/cypress",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "scripts": {
     "build": "tsc",
-    "lint": "eslint src -c .eslintrc.json --ext .ts"
+    "lint": "eslint src -c .eslintrc.json --ext .ts --max-warnings=0"
   },
   "bin": {
     "ci.build": "./ci.build.sh",

package/src/page-object/moonstone/menu.ts

@@ -7,34 +7,45 @@ export class Menu extends BaseComponent {
     static overlaySelector = '.moonstone-menu_overlay';
 
     submenu(item: string, menu: string): Menu {
-        this.get().find('.moonstone-menuItem').contains(item).scrollIntoView().should('be.visible');
+        this.shouldHaveItem(item);
         this.get().find('.moonstone-menuItem').contains(item).realHover();
         return getComponentByRole(Menu, menu);
     }
 
     shouldHaveItem(item: string):void {
-        this.get().find('.moonstone-menuItem').contains(item).scrollIntoView().should('be.visible');
+        this.get().find('.moonstone-menuItem').contains(item).scrollIntoView();
+        this.get().find('.moonstone-menuItem').contains(item).should('be.visible');
+    }
+
+    shouldHaveRoleItem(role: string):void {
+        this.get().find(`.moonstone-menuItem[data-sel-role=${role}]`).scrollIntoView();
+        this.get().find(`.moonstone-menuItem[data-sel-role=${role}]`).should('be.visible');
     }
 
     shouldNotHaveItem(item: string):void {
         this.get().find('.moonstone-menuItem').contains(item).should('not.exist');
     }
 
+    shouldNotHaveRoleItem(role: string):void {
+        this.get().find(`.moonstone-menuItem[data-sel-role="${role}"]`).should('not.exist');
+    }
+
     select(item: string): Menu {
-        this.get().find('.moonstone-menuItem').contains(item).scrollIntoView().should('be.visible');
+        this.shouldHaveItem(item);
         this.get().find('.moonstone-menuItem').contains(item).trigger('click');
         return this;
     }
 
-    selectByRole(item: string): Menu {
-        this.get().find(`.moonstone-menuItem[data-sel-role="${item}"]`).scrollIntoView().should('be.visible');
-        this.get().find(`.moonstone-menuItem[data-sel-role="${item}"]`).trigger('click');
+    selectByRole(role: string): Menu {
+        this.shouldHaveRoleItem(role);
+        this.get().find(`.moonstone-menuItem[data-sel-role="${role}"]`).trigger('click');
         return this;
     }
 
     /** Can be used for choicelist dropdown menu */
     selectByValue(value: string): Menu {
-        this.get().find(`.moonstone-menuItem[data-value="${value}"]`).scrollIntoView().should('be.visible');
+        this.get().find(`.moonstone-menuItem[data-value="${value}"]`).scrollIntoView();
+        this.get().find(`.moonstone-menuItem[data-value="${value}"]`).should('be.visible');
         this.get().find(`.moonstone-menuItem[data-value="${value}"]`).trigger('click');
         return this;
     }

package/src/utils/ClusterHelper.ts

@@ -1,4 +1,4 @@
-export const waitUntilJournalSync = (predicate?: (cluster: any) => boolean, timeout = 60000,
+export const waitUntilJournalSync = (predicate?: (cluster) => boolean, timeout = 60000,
     interval = 1000) : void => {
     cy.waitUntil(() =>
         cy.apollo({

package/src/utils/ExportHelper.ts

@@ -0,0 +1,72 @@
+// Utility methods to call import/export Jahia API
+
+// http://localhost:8080/cms/export/default/export.zip?exportformat=site&live=true&users=true&path=/groups&path=/settings/mail-server-1&sitebox=digitall&exportPath=abc
+// Export
+
+import {JahiaServer} from '../support';
+
+const API_NAME = '/cms/export';
+
+export type ExportParameters = {
+    viewContent?: boolean;
+    viewVersion?: boolean;
+    viewAcl?: boolean;
+    viewLinks?: boolean;
+    viewMetadata?: boolean;
+    viewWorkflow?: boolean;
+    exportPath?: string;
+    exportformat: 'all' | 'site' | 'xml' | 'zip';
+    root?: string;
+    live?: boolean;
+    users?: boolean;
+    sitebox?: string[];
+    paths?: string[];
+    cleanup?: 'template' | 'simple';
+    filesToZip?: string;
+}
+
+const serverDefaults: JahiaServer = {
+    url: Cypress.config().baseUrl,
+    username: 'root',
+    password: Cypress.env('SUPER_USER_PASSWORD')
+};
+
+type ExportContentParams = {
+    workspace?: string;
+    nodePath?: string;
+    exportFormat?: string;
+    params?: ExportParameters;
+    jahiaServer?: JahiaServer;
+}
+
+export const exportContent = (
+    {
+        workspace = 'default',
+        nodePath = '/export',
+        exportFormat = 'zip',
+        params = {
+            exportformat: 'site',
+            live: true,
+            users: true
+        },
+        jahiaServer = serverDefaults
+    }: ExportContentParams): void => {
+    const queryStringParams = Object.keys(params)
+        .filter(key => !['paths', 'sitebox'].includes(key))
+        .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`) || [];
+
+    const sitebox: string[] = params.sitebox?.map(sb => `sitebox=${encodeURIComponent(sb)}`) || [];
+    const paths: string[] = params.paths?.map(path => `path=${encodeURIComponent(path)}`) || [];
+    const qs = [...queryStringParams, ...sitebox, ...paths].join('&');
+    // It is not possible to use the "qs" field of RequestOptions for querystring as it does not support multiple parameters with the same name (path or sitebox)
+    cy.request({
+        url: `${jahiaServer.url}${API_NAME}/${workspace}${nodePath}.${exportFormat}?${qs}`,
+        method: 'GET',
+        auth: {
+            user: jahiaServer.username,
+            pass: jahiaServer.password,
+            sendImmediately: true
+        }
+    });
+};
+

package/src/utils/JCRHelper.ts

@@ -38,14 +38,28 @@ export const deleteNodeProperty = (pathOrId: string, property: string, language:
     });
 };
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const addNode = (variables: { parentPathOrId: string, primaryNodeType: string, name: string, properties?: any[], children?: any[], mixins?: any[] }): Cypress.Chainable => {
+export const addNode = (variables: {
+    parentPathOrId: string,
+    primaryNodeType: string,
+    name: string,
+    properties?: [],
+    children?: [],
+    mixins?: []
+}): Cypress.Chainable => {
     return cy.apollo({
         variables: variables,
         mutationFile: 'graphql/jcr/mutation/addNode.graphql'
     });
 };
 
+export const addMixins = (pathOrId: string, mixins: string[]): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {pathOrId: pathOrId, mixins: mixins},
+        mutationFile: 'graphql/jcr/mutation/addMixins.graphql'
+    });
+};
+
+// eslint-disable-next-line max-params
 export const getNodeByPath = (path: string, properties?: string[], language?: string, childrenTypes: string[] = [], workspace: Workspace = 'EDIT'): Cypress.Chainable => {
     return cy.apollo({
         variables: {
@@ -88,6 +102,17 @@ export const getNodeTypes = (filter = {}): Cypress.Chainable => {
     });
 };
 
+export const markForDeletion = (pathOrId: string): Cypress.Chainable => {
+    return cy.apollo(
+        {
+            variables: {
+                pathOrId: pathOrId
+            },
+            mutationFile: 'graphql/jcr/mutation/markForDeletion.graphql'
+        }
+    );
+};
+
 export const uploadFile = (fixturePath: string, parentPathOrId: string, name: string, mimeType: string): Cypress.Chainable => {
     return cy.fixture(fixturePath, 'binary')
         .then(image => {

package/src/utils/SAMHelper.ts

@@ -23,6 +23,16 @@ export const healthCheck = (severity = 'MEDIUM', probeHealthFilter = null, probe
         });
 };
 
+type WaitUntilSAMStatusParams = {
+    expectedHealth: string;
+    severity?: string;
+    probeHealthFilter?: any;
+    probeNamesFilter?: string[] | null;
+    timeout?: number;
+    interval?: number;
+    statusMatchCount?: number;
+};
+
 /**
  * Wait until the health check returns the expected health
  * @param expectedHealth the expected health status
@@ -33,7 +43,7 @@ export const healthCheck = (severity = 'MEDIUM', probeHealthFilter = null, probe
  * @param interval the interval in milliseconds, default is 500
  * @param statusMatchCount the number of consecutive status matches before the waitUntil resolves, default is 3
  */
-export const waitUntilSAMStatus = ({expectedHealth, severity = 'MEDIUM', probeHealthFilter = null, probeNamesFilter = null, timeout = 60000, interval = 500, statusMatchCount = 3}) : void => {
+export const waitUntilSAMStatus = ({expectedHealth, severity = 'MEDIUM', probeHealthFilter = null, probeNamesFilter = null, timeout = 60000, interval = 500, statusMatchCount = 3}: WaitUntilSAMStatusParams) : void => {
     let statusCount = 0;
     let lastGraphqlResponse = {};
     cy.waitUntil(() =>

package/src/utils/UsersHelper.ts

@@ -1,4 +1,3 @@
-
 export const grantRoles = (pathOrId: string, roleNames: Array<string>, principalName: string, principalType: string): Cypress.Chainable => {
     cy.log('Grant role(s) ' + roleNames + ' with principal type ' + principalType + ' to ' + principalName + ' on node ' + pathOrId);
     return cy.apollo({
@@ -25,7 +24,10 @@ export const revokeRoles = (pathOrId: string, roleNames: Array<string>, principa
     });
 };
 
-export const createUser = (userName: string, password: string, properties: { name: string, value: string }[] = []): void => {
+export const createUser = (userName: string, password: string, properties: {
+    name: string,
+    value: string
+}[] = []): void => {
     const userProperties = properties.map(property => {
         return 'properties.setProperty("' + property.name + '", "' + property.value + '")';
     });
@@ -36,12 +38,40 @@ export const createUser = (userName: string, password: string, properties: { nam
     });
 };
 
+export const getUserPath = (username: string, siteKey = ''): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {
+            siteKey,
+            username
+        },
+        queryFile: 'graphql/jcr/query/getUserPath.graphql'
+    }
+    );
+};
+
 export const deleteUser = (userName: string): void => {
     cy.executeGroovy('groovy/admin/deleteUser.groovy', {
         USER_NAME: userName
     });
 };
 
+export const createGroup = (groupName: string, hidden?: boolean, siteKey = ''): void => {
+    cy.executeGroovy('groovy/admin/userGroupHelper.groovy', {
+        OPERATION: 'create',
+        GROUPNAME: groupName,
+        HIDDEN: hidden ? 'true' : 'false',
+        SITEKEY: siteKey
+    });
+};
+
+export const deleteGroup = (groupName: string, siteKey = ''): void => {
+    cy.executeGroovy('groovy/admin/userGroupHelper.groovy', {
+        OPERATION: 'delete',
+        GROUPNAME: groupName,
+        SITEKEY: siteKey
+    });
+};
+
 export const addUserToGroup = (userName: string, groupName: string, siteKey?: string): void => {
     cy.executeGroovy('groovy/admin/addUserToGroup.groovy', {
         USER_NAME: userName,

package/src/utils/index.ts

@@ -7,3 +7,4 @@ export * from './ClusterHelper';
 export * from './JahiaPlatformHelper';
 export * from './GraphQLHelper';
 export * from './SAMHelper';
+export * from './ExportHelper';