@jahia/cypress 5.2.0 → 6.0.0

package/dist/support/index.d.ts

@@ -3,3 +3,4 @@ export * from './provisioning';
 export * from './login';
 export * from './logout';
 export * from './repeatUntil';
+export * from './testStep';

package/dist/support/index.js

@@ -15,3 +15,4 @@ __exportStar(require("./provisioning"), exports);
 __exportStar(require("./login"), exports);
 __exportStar(require("./logout"), exports);
 __exportStar(require("./repeatUntil"), exports);
+__exportStar(require("./testStep"), exports);

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

@@ -1,4 +1,4 @@
 export * from './executeGroovy';
 export * from './runProvisioningScript';
-export * from './installBundle';
-export * from './uninstallBundle';
+export * from './installModule';
+export * from './uninstallModule';

package/dist/support/provisioning/index.js

@@ -12,5 +12,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 exports.__esModule = true;
 __exportStar(require("./executeGroovy"), exports);
 __exportStar(require("./runProvisioningScript"), exports);
-__exportStar(require("./installBundle"), exports);
-__exportStar(require("./uninstallBundle"), exports);
+__exportStar(require("./installModule"), exports);
+__exportStar(require("./uninstallModule"), exports);

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

@@ -0,0 +1,11 @@
+/// <reference types="cypress" />
+declare global {
+    namespace Cypress {
+        interface Chainable<Subject> {
+            installModule(moduleFile: string): Chainable<Cypress.Response<any>>;
+            installAndStartModule(moduleFile: string): Chainable<Cypress.Response<any>>;
+        }
+    }
+}
+export declare const installModule: (moduleFile: string) => void;
+export declare const installAndStartModule: (moduleFile: string) => void;

package/dist/support/provisioning/installModule.js

@@ -0,0 +1,25 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
+exports.__esModule = true;
+exports.installAndStartModule = exports.installModule = void 0;
+/// <reference types="cypress" />
+var installModule = function (moduleFile) {
+    cy.runProvisioningScript({
+        script: [{ installModule: moduleFile }],
+        files: [{
+                fileName: moduleFile,
+                type: 'text/plain'
+            }]
+    });
+};
+exports.installModule = installModule;
+var installAndStartModule = function (moduleFile) {
+    cy.runProvisioningScript({
+        script: [{ installAndStartModule: moduleFile }],
+        files: [{
+                fileName: moduleFile,
+                type: 'text/plain'
+            }]
+    });
+};
+exports.installAndStartModule = installAndStartModule;

package/dist/support/provisioning/{uninstallBundle.d.ts → uninstallModule.d.ts}

@@ -2,8 +2,8 @@
 declare global {
     namespace Cypress {
         interface Chainable<Subject> {
-            uninstallBundle(bundleSymbolicName: string): Chainable<Cypress.Response<any>>;
+            uninstallModule(moduleSymbolicName: string): Chainable<Cypress.Response<any>>;
         }
     }
 }
-export declare const uninstallBundle: (bundleSymbolicName: string) => void;
+export declare const uninstallModule: (moduleSymbolicName: string) => void;

package/dist/support/provisioning/{uninstallBundle.js → uninstallModule.js}

@@ -1,14 +1,14 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
 exports.__esModule = true;
-exports.uninstallBundle = void 0;
+exports.uninstallModule = void 0;
 /// <reference types="cypress" />
-var uninstallBundle = function (bundleSymbolicName) {
+var uninstallModule = function (moduleSymbolicName) {
     cy.runProvisioningScript({
         script: {
-            fileContent: '- uninstallBundle: "' + bundleSymbolicName + '"\n',
+            fileContent: '- uninstallModule: "' + moduleSymbolicName + '"\n',
             type: 'application/yaml'
         }
     });
 };
-exports.uninstallBundle = uninstallBundle;
+exports.uninstallModule = uninstallModule;

package/dist/support/registerSupport.js

@@ -7,16 +7,20 @@ var login_1 = require("./login");
 var logout_1 = require("./logout");
 var fixture_1 = require("./fixture");
 var repeatUntil_1 = require("./repeatUntil");
+var testStep_1 = require("./testStep");
 var registerSupport = function () {
     Cypress.Commands.add('apolloClient', apollo_1.apolloClient);
     Cypress.Commands.add('apollo', { prevSubject: 'optional' }, apollo_1.apollo);
     Cypress.Commands.add('runProvisioningScript', provisioning_1.runProvisioningScript);
     Cypress.Commands.add('executeGroovy', provisioning_1.executeGroovy);
-    Cypress.Commands.add('installBundle', provisioning_1.installBundle);
+    Cypress.Commands.add('installModule', provisioning_1.installModule);
+    Cypress.Commands.add('installAndStartModule', provisioning_1.installAndStartModule);
+    Cypress.Commands.add('uninstallModule', provisioning_1.uninstallModule);
     Cypress.Commands.add('login', login_1.login);
     Cypress.Commands.add('loginAndStoreSession', login_1.loginAndStoreSession);
     Cypress.Commands.add('logout', logout_1.logout);
     Cypress.Commands.add('repeatUntil', repeatUntil_1.repeatUntil);
     Cypress.Commands.overwrite('fixture', fixture_1.fixture);
+    Cypress.Commands.add('step', testStep_1.step);
 };
 exports.registerSupport = registerSupport;

package/dist/support/testStep.d.ts

@@ -0,0 +1,27 @@
+/**
+ *  Extends global Cypress Chainable interface with custom commands from 'commands.js' to avoid TypeScript errors when using them.
+ */
+declare global {
+    namespace Cypress {
+        interface Chainable<Subject> {
+            /**
+             * Creates a foldable test-case step with corresponding message in Cypress log
+             * @param {string} message - folder's message
+             * @param {() => void} func - function to be executed and wrapped into the folder
+             * @returns void
+             * @example
+             *         cy.step('Navigate to the destination point', () => {
+             *              cy.get('selector').click();
+             *              ...
+             *         });
+             *
+             *        cy.step('Do something', () => {
+             *              cy.get('element').click();
+             *              ...
+             *         });
+             */
+            step(message: string, func: () => void): void;
+        }
+    }
+}
+export declare const step: (message: string, func: () => void) => void;

package/dist/support/testStep.js

@@ -0,0 +1,15 @@
+"use strict";
+exports.__esModule = true;
+exports.step = void 0;
+var step = function (message, func) {
+    cy.then(function () {
+        // @ts-ignore
+        Cypress.log({ groupStart: true, displayName: '[ STEP ]', message: "" + message });
+    }).then(function () {
+        func();
+    }).then(function () {
+        // @ts-ignore
+        Cypress.log({ groupEnd: true, emitOnly: true });
+    });
+};
+exports.step = step;

package/dist/utils/Logger.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Helper class to decorate Cypress log messages with different log levels (INFO and DEBUG at the moment).
+ * Class contains only static methods and should not be instantiated.
+ * @example
+ *      Log.info('This is an info message');
+ *      Log.debug('This is a debug message');
+ *      Log.json('DEBUG', myJSON);
+ *      Log.info('My info message').then(() => { ... });
+ * @note The log level can be set by changing the `Log.LEVEL` variable in the code (default is `INFO`).
+ *       It tells the logger to log only messages with the given level and above.
+ */
+export declare class Log {
+    static LEVEL: string;
+    private static levels;
+    /**
+     * Logs INFO message
+     * @param {string} message - log message
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     */
+    static info(message: string): Cypress.Chainable;
+    /**
+     * Logs DEBUG message
+     * @param {string} message - log message
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     */
+    static debug(message: string): Cypress.Chainable;
+    /**
+     * Logs JSON object with logging level given
+     * @param {string} level - log level (e.g. 'INFO', 'DEBUG')
+     * @param {string} json - json object to be logged
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     */
+    static json(level: string, json: string): Cypress.Chainable;
+    /**
+     * Private method to send the log message to Cypress log
+     * @param {string} level - log level (e.g. 'INFO', 'DEBUG')
+     * @param {string} message - log message
+     * @note The method checks if the log level is enabled before sending the message to Cypress log
+     *       and uses the Cypress.log method to display the message in the Cypress log
+     * @note The method is private and should not be called directly
+     *       Use the public methods (info, debug, error, warning) to send log messages
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     * @private
+     */
+    private static _send_;
+}

package/dist/utils/Logger.js

@@ -0,0 +1,79 @@
+"use strict";
+exports.__esModule = true;
+exports.Log = void 0;
+/**
+ * Helper class to decorate Cypress log messages with different log levels (INFO and DEBUG at the moment).
+ * Class contains only static methods and should not be instantiated.
+ * @example
+ *      Log.info('This is an info message');
+ *      Log.debug('This is a debug message');
+ *      Log.json('DEBUG', myJSON);
+ *      Log.info('My info message').then(() => { ... });
+ * @note The log level can be set by changing the `Log.LEVEL` variable in the code (default is `INFO`).
+ *       It tells the logger to log only messages with the given level and above.
+ */
+var Log = /** @class */ (function () {
+    function Log() {
+    }
+    /**
+     * Logs INFO message
+     * @param {string} message - log message
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     */
+    Log.info = function (message) {
+        return Log._send_('INFO', message);
+    };
+    /**
+     * Logs DEBUG message
+     * @param {string} message - log message
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     */
+    Log.debug = function (message) {
+        return Log._send_('DEBUG', message);
+    };
+    /**
+     * Logs JSON object with logging level given
+     * @param {string} level - log level (e.g. 'INFO', 'DEBUG')
+     * @param {string} json - json object to be logged
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     */
+    Log.json = function (level, json) {
+        return Log._send_(level, JSON.stringify(json, null, 2));
+    };
+    /**
+     * Private method to send the log message to Cypress log
+     * @param {string} level - log level (e.g. 'INFO', 'DEBUG')
+     * @param {string} message - log message
+     * @note The method checks if the log level is enabled before sending the message to Cypress log
+     *       and uses the Cypress.log method to display the message in the Cypress log
+     * @note The method is private and should not be called directly
+     *       Use the public methods (info, debug, error, warning) to send log messages
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     * @private
+     */
+    Log._send_ = function (level, message) {
+        var _a, _b;
+        // Check if the log level is valid
+        if (!Log.levels.includes(level.toUpperCase())) {
+            throw new Error("Log level \"" + level + "\" is not supported. Supported levels are: " + Log.levels.join(', '));
+        }
+        // Check if the log level is enabled,
+        // take into account the log level set in Cypress.env('LOG_LEVEL') and the log level set in the Log.LEVEL variable.
+        // If the log level is enabled, send the message to Cypress log.
+        if ((Log.levels.includes((_a = Cypress.env('LOG_LEVEL')) === null || _a === void 0 ? void 0 : _a.toUpperCase()) && Log.levels.indexOf(level.toUpperCase()) >= Log.levels.indexOf((_b = Cypress.env('LOG_LEVEL')) === null || _b === void 0 ? void 0 : _b.toUpperCase())) ||
+            Log.levels.indexOf(level.toUpperCase()) >= Log.levels.indexOf(Log.LEVEL)) {
+            // Send the message to Cypress log
+            // use cy.then() to ensure that the log message is sent in the correct order
+            // and use cy.wrap() to return the Cypress chainable object
+            return cy.then(function () {
+                Cypress.log({ displayName: "[ " + level.toUpperCase() + " ]", message: "" + message });
+            }).then(cy.wrap);
+        }
+    };
+    // The default log level is set to 'INFO' and can be changed by setting the Log.LEVEL variable in the code
+    Log.LEVEL = 'INFO';
+    // The log levels are defined in the levels array and are ordered from the lowest to the highest priority
+    Log.levels = ['DEBUG', 'INFO'];
+    return Log;
+}());
+exports.Log = Log;

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

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

package/package.json

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

package/src/support/index.ts

@@ -3,3 +3,4 @@ export * from './provisioning';
 export * from './login';
 export * from './logout';
 export * from './repeatUntil';
+export * from './testStep';

package/src/support/provisioning/index.ts

@@ -1,4 +1,4 @@
 export * from './executeGroovy';
 export * from './runProvisioningScript';
-export * from './installBundle';
-export * from './uninstallBundle';
+export * from './installModule';
+export * from './uninstallModule';

package/src/support/provisioning/installModule.ts

@@ -0,0 +1,34 @@
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
+
+// Load type definitions that come with Cypress module
+/// <reference types="cypress" />
+
+declare global {
+    namespace Cypress {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        interface Chainable<Subject> {
+            installModule(moduleFile: string): Chainable<Cypress.Response<any>>;
+            installAndStartModule(moduleFile: string): Chainable<Cypress.Response<any>>;
+        }
+    }
+}
+
+export const installModule = function (moduleFile: string): void {
+    cy.runProvisioningScript({
+        script: [{installModule: moduleFile}],
+        files: [{
+            fileName: moduleFile,
+            type: 'text/plain'
+        }]
+    });
+};
+
+export const installAndStartModule = function (moduleFile: string): void {
+    cy.runProvisioningScript({
+        script: [{installAndStartModule: moduleFile}],
+        files: [{
+            fileName: moduleFile,
+            type: 'text/plain'
+        }]
+    });
+};

package/src/support/provisioning/{uninstallBundle.ts → uninstallModule.ts}

@@ -7,15 +7,15 @@ declare global {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         interface Chainable<Subject> {
-            uninstallBundle(bundleSymbolicName: string): Chainable<Cypress.Response<any>>
+            uninstallModule(moduleSymbolicName: string): Chainable<Cypress.Response<any>>
         }
     }
 }
 
-export const uninstallBundle = function (bundleSymbolicName: string): void {
+export const uninstallModule = function (moduleSymbolicName: string): void {
     cy.runProvisioningScript({
         script: {
-            fileContent: '- uninstallBundle: "' + bundleSymbolicName + '"\n',
+            fileContent: '- uninstallModule: "' + moduleSymbolicName + '"\n',
             type: 'application/yaml'
         }
     });

package/src/support/registerSupport.ts

@@ -1,9 +1,10 @@
 import {apollo, apolloClient} from './apollo';
-import {executeGroovy, runProvisioningScript, installBundle} from './provisioning';
+import {executeGroovy, runProvisioningScript, installModule, installAndStartModule, uninstallModule} from './provisioning';
 import {login, loginAndStoreSession} from './login';
 import {logout} from './logout';
 import {fixture} from './fixture';
 import {repeatUntil} from './repeatUntil';
+import {step} from './testStep';
 
 export const registerSupport = (): void => {
     Cypress.Commands.add('apolloClient', apolloClient);
@@ -11,7 +12,9 @@ export const registerSupport = (): void => {
 
     Cypress.Commands.add('runProvisioningScript', runProvisioningScript);
     Cypress.Commands.add('executeGroovy', executeGroovy);
-    Cypress.Commands.add('installBundle', installBundle);
+    Cypress.Commands.add('installModule', installModule);
+    Cypress.Commands.add('installAndStartModule', installAndStartModule);
+    Cypress.Commands.add('uninstallModule', uninstallModule);
 
     Cypress.Commands.add('login', login);
     Cypress.Commands.add('loginAndStoreSession', loginAndStoreSession);
@@ -19,4 +22,6 @@ export const registerSupport = (): void => {
     Cypress.Commands.add('repeatUntil', repeatUntil);
 
     Cypress.Commands.overwrite('fixture', fixture);
+
+    Cypress.Commands.add('step', step);
 };

package/src/support/testStep.ts

@@ -0,0 +1,41 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+/**
+ *  Extends global Cypress Chainable interface with custom commands from 'commands.js' to avoid TypeScript errors when using them.
+ */
+declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
+    namespace Cypress {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        interface Chainable<Subject> {
+            /**
+             * Creates a foldable test-case step with corresponding message in Cypress log
+             * @param {string} message - folder's message
+             * @param {() => void} func - function to be executed and wrapped into the folder
+             * @returns void
+             * @example
+             *         cy.step('Navigate to the destination point', () => {
+             *              cy.get('selector').click();
+             *              ...
+             *         });
+             *
+             *        cy.step('Do something', () => {
+             *              cy.get('element').click();
+             *              ...
+             *         });
+             */
+            step (message: string, func: () => void): void;
+        }
+    }
+}
+
+export const step = (message: string, func: () => void): void => {
+    cy.then(() => {
+        // @ts-ignore
+        Cypress.log({groupStart: true, displayName: '[ STEP ]', message: `${message}`});
+    }).then(() => {
+        func();
+    }).then(() => {
+        // @ts-ignore
+        Cypress.log({groupEnd: true, emitOnly: true});
+    });
+};

package/src/utils/Logger.ts

@@ -0,0 +1,78 @@
+/**
+ * Helper class to decorate Cypress log messages with different log levels (INFO and DEBUG at the moment).
+ * Class contains only static methods and should not be instantiated.
+ * @example
+ *      Log.info('This is an info message');
+ *      Log.debug('This is a debug message');
+ *      Log.json('DEBUG', myJSON);
+ *      Log.info('My info message').then(() => { ... });
+ * @note The log level can be set by changing the `Log.LEVEL` variable in the code (default is `INFO`).
+ *       It tells the logger to log only messages with the given level and above.
+ */
+export class Log {
+    // The default log level is set to 'INFO' and can be changed by setting the Log.LEVEL variable in the code
+    static LEVEL = 'INFO';
+    // The log levels are defined in the levels array and are ordered from the lowest to the highest priority
+    private static levels = ['DEBUG', 'INFO'];
+
+    /**
+     * Logs INFO message
+     * @param {string} message - log message
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     */
+    static info(message: string): Cypress.Chainable {
+        return Log._send_('INFO', message);
+    }
+
+    /**
+     * Logs DEBUG message
+     * @param {string} message - log message
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     */
+    static debug(message: string): Cypress.Chainable {
+        return Log._send_('DEBUG', message);
+    }
+
+    /**
+     * Logs JSON object with logging level given
+     * @param {string} level - log level (e.g. 'INFO', 'DEBUG')
+     * @param {string} json - json object to be logged
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     */
+    static json(level: string, json: string): Cypress.Chainable {
+        return Log._send_(level, JSON.stringify(json, null, 2));
+    }
+
+    /**
+     * Private method to send the log message to Cypress log
+     * @param {string} level - log level (e.g. 'INFO', 'DEBUG')
+     * @param {string} message - log message
+     * @note The method checks if the log level is enabled before sending the message to Cypress log
+     *       and uses the Cypress.log method to display the message in the Cypress log
+     * @note The method is private and should not be called directly
+     *       Use the public methods (info, debug, error, warning) to send log messages
+     * @returns {Cypress.Chainable} - Cypress chainable object
+     * @private
+     */
+    private static _send_(level: string, message: string): Cypress.Chainable {
+        // Check if the log level is valid
+        if (!Log.levels.includes(level.toUpperCase())) {
+            throw new Error(`Log level "${level}" is not supported. Supported levels are: ${Log.levels.join(', ')}`);
+        }
+
+        // Check if the log level is enabled,
+        // take into account the log level set in Cypress.env('LOG_LEVEL') and the log level set in the Log.LEVEL variable.
+        // If the log level is enabled, send the message to Cypress log.
+        if (
+            (Log.levels.includes(Cypress.env('LOG_LEVEL')?.toUpperCase()) && Log.levels.indexOf(level.toUpperCase()) >= Log.levels.indexOf(Cypress.env('LOG_LEVEL')?.toUpperCase())) ||
+            Log.levels.indexOf(level.toUpperCase()) >= Log.levels.indexOf(Log.LEVEL)
+        ) {
+            // Send the message to Cypress log
+            // use cy.then() to ensure that the log message is sent in the correct order
+            // and use cy.wrap() to return the Cypress chainable object
+            return cy.then(() => {
+                Cypress.log({displayName: `[ ${level.toUpperCase()} ]`, message: `${message}`});
+            }).then(cy.wrap);
+        }
+    }
+}

package/src/utils/index.ts

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

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

@@ -1,9 +0,0 @@
-/// <reference types="cypress" />
-declare global {
-    namespace Cypress {
-        interface Chainable<Subject> {
-            installBundle(bundleFile: string): Chainable<Cypress.Response<any>>;
-        }
-    }
-}
-export declare const installBundle: (bundleFile: string) => void;

package/dist/support/provisioning/installBundle.js

@@ -1,15 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
-exports.__esModule = true;
-exports.installBundle = void 0;
-/// <reference types="cypress" />
-var installBundle = function (bundleFile) {
-    cy.runProvisioningScript({
-        script: [{ installBundle: bundleFile }],
-        files: [{
-                fileName: bundleFile,
-                type: 'text/plain'
-            }]
-    });
-};
-exports.installBundle = installBundle;

package/src/support/provisioning/installBundle.ts

@@ -1,23 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
-
-// Load type definitions that come with Cypress module
-/// <reference types="cypress" />
-
-declare global {
-    namespace Cypress {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        interface Chainable<Subject> {
-            installBundle(bundleFile: string): Chainable<Cypress.Response<any>>
-        }
-    }
-}
-
-export const installBundle = function (bundleFile: string): void {
-    cy.runProvisioningScript({
-        script: [{installBundle: bundleFile}],
-        files: [{
-            fileName: bundleFile,
-            type: 'text/plain'
-        }]
-    });
-};