@jahia/cypress 4.2.0 → 4.4.0

package/ci.startup.sh

@@ -27,12 +27,12 @@ if [[ -z ${JAHIA_LICENSE} ]]; then
 fi
 
 echo "$(date +'%d %B %Y - %k:%M') == Cluster enabled: ${JAHIA_CLUSTER_ENABLED} =="
-if [[ "${JAHIA_CLUSTER_ENABLED}" == "true" ]]; then
+if [[ "${JAHIA_CLUSTER_ENABLED}" == "true" ||  ${JAHIA_CLUSTER_ENABLED} == true ]]; then
     export CLUSTER_PROFILE="--profile cluster"
 fi
 
 echo "$(date +'%d %B %Y - %k:%M') == Starting environment =="
-docker-compose up -d --renew-anon-volumes ${CLUSTER_PROFILE}
+docker-compose ${CLUSTER_PROFILE} up -d --renew-anon-volumes
 if [[ "$1" != "notests" ]]; then
     docker ps -a
     docker stats --no-stream

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

@@ -33,8 +33,8 @@ var Menu = /** @class */ (function (_super) {
         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');
+        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');

package/dist/support/login.d.ts

@@ -2,10 +2,16 @@
 declare global {
     namespace Cypress {
         interface Chainable<Subject> {
-            login(username?: string, password?: string, url?: string): Chainable<Cypress.Response<any>>;
+            login(username?: string, password?: string, config?: string | {
+                url?: string;
+                rememberMe?: boolean;
+            }): Chainable<Cypress.Response<any>>;
             loginAndStoreSession(username?: string, password?: string, url?: string): Chainable<Cypress.Response<any>>;
         }
     }
 }
-export declare const login: (username?: string, password?: string, url?: string) => void;
+export declare const login: (username: string, password: string, config: string | {
+    url?: string;
+    rememberMe?: boolean;
+}) => void;
 export declare const loginAndStoreSession: (username?: string, password?: string, url?: string) => void;

package/dist/support/login.js

@@ -3,10 +3,12 @@
 exports.__esModule = true;
 exports.loginAndStoreSession = exports.login = void 0;
 /// <reference types="cypress" />
-var login = function (username, password, url) {
+// Disable linter to keep as this for backward compatibility
+// eslint-disable-next-line default-param-last
+var login = function (username, password, config) {
+    var _a;
     if (username === void 0) { username = 'root'; }
     if (password === void 0) { password = Cypress.env('SUPER_USER_PASSWORD'); }
-    if (url === void 0) { url = '/cms/login'; }
     Cypress.log({
         name: 'login',
         message: "Login with " + username,
@@ -16,10 +18,21 @@ var login = function (username, password, url) {
             };
         }
     });
+    var body = { username: username, password: password };
+    var url = '/cms/login';
+    if (typeof config === 'object') {
+        if (config.rememberMe) {
+            body.useCookie = 'on';
+        }
+        url = (_a = config.url) !== null && _a !== void 0 ? _a : url;
+    }
+    else {
+        url = config !== null && config !== void 0 ? config : url;
+    }
     cy.request({
         method: 'POST',
         form: true,
-        body: { username: username, password: password },
+        body: body,
         followRedirect: false,
         log: false,
         url: url

package/dist/support/provisioning/runProvisioningScript.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="cypress" />
+import RequestOptions = Cypress.RequestOptions;
 declare global {
     namespace Cypress {
         interface Chainable<Subject> {
@@ -21,4 +22,4 @@ export declare type JahiaServer = {
     username: string;
     password: string;
 };
-export declare const runProvisioningScript: (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer, options?: Cypress.Loggable, timeout?: number) => void;
+export declare const runProvisioningScript: (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer, options?: Cypress.Loggable, timeout?: number, requestOptions?: Partial<RequestOptions>) => void;

package/dist/support/provisioning/runProvisioningScript.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 exports.__esModule = true;
 exports.runProvisioningScript = void 0;
 function processContent(formFile) {
@@ -36,9 +47,10 @@ function isFormFile(script) {
     return Boolean(script.fileContent || script.fileName);
 }
 // eslint-disable-next-line default-param-last, max-params
-var runProvisioningScript = function (script, files, jahiaServer, options, timeout) {
+var runProvisioningScript = function (script, files, jahiaServer, options, timeout, requestOptions) {
     if (jahiaServer === void 0) { jahiaServer = serverDefaults; }
     if (options === void 0) { options = { log: true }; }
+    if (requestOptions === void 0) { requestOptions = {}; }
     var formData = new FormData();
     if (isFormFile(script)) {
         append(script, formData, 'script');
@@ -75,17 +87,11 @@ var runProvisioningScript = function (script, files, jahiaServer, options, timeo
             }
         });
     }
-    var request = {
-        url: jahiaServer.url + "/modules/api/provisioning",
-        method: 'POST',
-        auth: {
+    var request = __assign({ url: jahiaServer.url + "/modules/api/provisioning", method: 'POST', auth: {
             user: jahiaServer.username,
             pass: jahiaServer.password,
             sendImmediately: true
-        },
-        body: formData,
-        log: false
-    };
+        }, body: formData, log: false }, requestOptions);
     if (typeof timeout !== 'undefined') {
         request.timeout = timeout;
     }

package/dist/utils/JCRHelper.d.ts

@@ -6,9 +6,9 @@ export declare const addNode: (variables: {
     parentPathOrId: string;
     primaryNodeType: string;
     name: string;
-    properties?: [];
-    children?: [];
-    mixins?: [];
+    properties?: any[];
+    children?: any[];
+    mixins?: string[];
 }) => 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/cypress",
-  "version": "4.2.0",
+  "version": "4.4.0",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts --max-warnings=0"

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

@@ -18,8 +18,8 @@ export class Menu extends BaseComponent {
     }
 
     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');
+        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 {

package/src/support/login.ts

@@ -7,13 +7,14 @@ declare global {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         interface Chainable<Subject> {
-            login(username?: string, password?: string, url?: string): Chainable<Cypress.Response<any>>
+            login(username?: string, password?: string, config?: string| {url?: string; rememberMe?: boolean}): Chainable<Cypress.Response<any>>
             loginAndStoreSession(username?: string, password?: string, url?: string): Chainable<Cypress.Response<any>>
         }
     }
 }
-
-export const login = (username = 'root', password: string = Cypress.env('SUPER_USER_PASSWORD'), url = '/cms/login'): void => {
+// Disable linter to keep as this for backward compatibility
+// eslint-disable-next-line default-param-last
+export const login = (username = 'root', password: string = Cypress.env('SUPER_USER_PASSWORD'), config: string | { url?: string, rememberMe?: boolean }): void => {
     Cypress.log({
         name: 'login',
         message: `Login with ${username}`,
@@ -23,11 +24,22 @@ export const login = (username = 'root', password: string = Cypress.env('SUPER_U
             };
         }
     });
+    const body: {username: string, password: string, useCookie?: string} = {username, password};
+    let url = '/cms/login';
+    if (typeof config === 'object') {
+        if (config.rememberMe) {
+            body.useCookie = 'on';
+        }
+
+        url = config.url ?? url;
+    } else {
+        url = config ?? url;
+    }
 
     cy.request({
         method: 'POST',
         form: true,
-        body: {username, password},
+        body,
         followRedirect: false,
         log: false,
         url

package/src/support/provisioning/runProvisioningScript.md

@@ -45,6 +45,15 @@ Additional files that can be referenced in the script. When an operation require
 
 - `log` : should the command be logged or not
 
+#### > timeout (`number`)
+
+the timeout in milliseconds
+
+#### > requestOptions (`RequestOptions`)
+
+Addition options for the cypress request object, some useful ones are:
+- `failOnStatusCode` : useful when you expect a 4xx or 5xx error and need to test it
+
 ### Yields
 
 The provisioning script result, as JSON object

package/src/support/provisioning/runProvisioningScript.ts

@@ -69,7 +69,7 @@ function isFormFile(script: FormFile | StringDictionary[]): script is FormFile {
 }
 
 // eslint-disable-next-line default-param-last, max-params
-export const runProvisioningScript = (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer: JahiaServer = serverDefaults, options: Cypress.Loggable = {log: true}, timeout?: number): void => {
+export const runProvisioningScript = (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer: JahiaServer = serverDefaults, options: Cypress.Loggable = {log: true}, timeout?: number, requestOptions: Partial<RequestOptions> = {}): void => {
     const formData = new FormData();
 
     if (isFormFile(script)) {
@@ -119,7 +119,8 @@ export const runProvisioningScript = (script: FormFile | StringDictionary[], fil
             sendImmediately: true
         },
         body: formData,
-        log: false
+        log: false,
+        ...requestOptions
     };
 
     if (typeof timeout !== 'undefined') {

package/src/utils/JCRHelper.ts

@@ -42,9 +42,11 @@ export const addNode = (variables: {
     parentPathOrId: string,
     primaryNodeType: string,
     name: string,
-    properties?: [],
-    children?: [],
-    mixins?: []
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    properties?: any [],
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    children?: any [],
+    mixins?: string []
 }): Cypress.Chainable => {
     return cy.apollo({
         variables: variables,