@jahia/cypress 3.25.0 → 3.27.0

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

@@ -1,9 +1,12 @@
 import { BaseComponent } from '../baseComponent';
+import Chainable = Cypress.Chainable;
 export declare class Menu extends BaseComponent {
     static defaultSelector: string;
+    static overlaySelector: string;
     submenu(item: string, menu: string): Menu;
     shouldHaveItem(item: string): void;
     shouldNotHaveItem(item: string): void;
     select(item: string): Menu;
     selectByRole(item: string): Menu;
+    close(): Chainable<unknown>;
 }

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

@@ -44,7 +44,11 @@ var Menu = /** @class */ (function (_super) {
         this.get().find(".moonstone-menuItem[data-sel-role=\"" + item + "\"]").trigger('click');
         return this;
     };
+    Menu.prototype.close = function () {
+        return cy.get(Menu.overlaySelector).click('topRight');
+    };
     Menu.defaultSelector = '.moonstone-menu:not(.moonstone-hidden)';
+    Menu.overlaySelector = '.moonstone-menu_overlay';
     return Menu;
 }(baseComponent_1.BaseComponent));
 exports.Menu = Menu;

package/dist/utils/JCRHelper.d.ts

@@ -14,4 +14,5 @@ export declare const getNodeByPath: (path: string, properties?: string[], langua
 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 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.getNodeTypes = exports.moveNode = exports.getNodeAcl = exports.getNodeByPath = exports.addNode = exports.deleteNodeProperty = exports.deleteNode = exports.setNodeProperty = void 0;
+exports.uploadFile = exports.getNodeTypes = exports.moveNode = exports.getNodeAcl = exports.getNodeByPath = 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) {
@@ -92,3 +92,20 @@ var getNodeTypes = function (filter) {
     });
 };
 exports.getNodeTypes = getNodeTypes;
+var uploadFile = function (fixturePath, parentPathOrId, name, mimeType) {
+    return cy.fixture(fixturePath, 'binary')
+        .then(function (image) {
+        var blob = Cypress.Blob.binaryStringToBlob(image, mimeType);
+        var file = new File([blob], name, { type: blob.type });
+        return cy.apollo({
+            mutationFile: 'graphql/jcr/mutation/uploadFile.graphql',
+            variables: {
+                parentPathOrId: parentPathOrId,
+                name: name,
+                mimeType: mimeType,
+                file: file
+            }
+        });
+    });
+};
+exports.uploadFile = uploadFile;

package/dist/utils/SAMHelper.d.ts

@@ -1 +1,35 @@
+import Chainable = Cypress.Chainable;
+/**
+ * Simple health check query
+ * @param severity the severity of the health check, default is MEDIUM
+ * @param probeHealthFilter the filter for the health check probes, default is GREEN
+ */
+export declare const healthCheck: (severity?: string, probeHealthFilter?: string) => Chainable<any>;
+/**
+ * Wait until the health check returns the expected health
+ * @param expectedHealth the expected health status
+ * @param severity the severity of the health check, default is MEDIUM
+ * @param probeHealthFilter the filter for the health check probes, default is GREEN
+ * @param timeout the timeout in milliseconds, default is 60000
+ * @param interval the interval in milliseconds, default is 500
+ * @param statusMatchCount the number of consecutive status matches before the waitUntil resolves, default is 1
+ */
+export declare const waitUntilSAMStatus: ({ expectedHealth, severity, probeHealthFilter, timeout, interval, statusMatchCount }: {
+    expectedHealth: any;
+    severity?: string;
+    probeHealthFilter?: string;
+    timeout?: number;
+    interval?: number;
+    statusMatchCount?: number;
+}) => void;
+/**
+ When Jahia is starting or performing provisioning operations
+ it is expected for the SAM probe to alternate beween GREEN, YELLOW and RED statuses.
+
+ The primary use of this method is to wait until a Jahia platform stabilizes after a startup or
+ provisioning operation.
+
+ Instead of waiting only for one occurence of a GREEN status, this function will wait until the a
+ GREEN status was returned a number of consecutive times (greenMatchCount).
+ */
 export declare const waitUntilSAMStatusGreen: (severity?: string, timeout?: number, interval?: number, greenMatchCount?: number) => void;

package/dist/utils/SAMHelper.js

@@ -1,44 +1,75 @@
 "use strict";
 exports.__esModule = true;
-exports.waitUntilSAMStatusGreen = void 0;
-/*
-    When Jahia is starting or performing provisioning operations
-    it is expected for the SAM probe to alternate beween GREEN, YELLOW and RED statuses.
-
-    The primary use of this method is to wait until a Jahia platform stabilizes after a startup or
-    provisioning operation.
-
-    Instead of waiting only for one occurence of a GREEN status, this function will wait until the a
-    GREEN status was returned a number of consecutive times (greenMatchCount).
-*/
-var waitUntilSAMStatusGreen = function (severity, timeout, interval, greenMatchCount) {
+exports.waitUntilSAMStatusGreen = exports.waitUntilSAMStatus = exports.healthCheck = void 0;
+/**
+ * Simple health check query
+ * @param severity the severity of the health check, default is MEDIUM
+ * @param probeHealthFilter the filter for the health check probes, default is GREEN
+ */
+var healthCheck = function (severity, probeHealthFilter) {
     if (severity === void 0) { severity = 'MEDIUM'; }
-    if (timeout === void 0) { timeout = 60000; }
-    if (interval === void 0) { interval = 500; }
-    if (greenMatchCount === void 0) { greenMatchCount = 10; }
-    var greenCount = 0;
+    if (probeHealthFilter === void 0) { probeHealthFilter = 'GREEN'; }
+    return cy
+        .apollo({
+        fetchPolicy: 'no-cache',
+        queryFile: 'graphql/sam/healthStatus.graphql',
+        variables: {
+            severity: severity,
+            probeHealthFilter: probeHealthFilter
+        }
+    })
+        .then(function (response) {
+        var _a, _b, _c;
+        return (_c = (_b = (_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.admin) === null || _b === void 0 ? void 0 : _b.jahia) === null || _c === void 0 ? void 0 : _c.healthCheck;
+    });
+};
+exports.healthCheck = healthCheck;
+/**
+ * Wait until the health check returns the expected health
+ * @param expectedHealth the expected health status
+ * @param severity the severity of the health check, default is MEDIUM
+ * @param probeHealthFilter the filter for the health check probes, default is GREEN
+ * @param timeout the timeout in milliseconds, default is 60000
+ * @param interval the interval in milliseconds, default is 500
+ * @param statusMatchCount the number of consecutive status matches before the waitUntil resolves, default is 1
+ */
+var waitUntilSAMStatus = function (_a) {
+    var expectedHealth = _a.expectedHealth, _b = _a.severity, severity = _b === void 0 ? 'MEDIUM' : _b, _c = _a.probeHealthFilter, probeHealthFilter = _c === void 0 ? 'GREEN' : _c, _d = _a.timeout, timeout = _d === void 0 ? 60000 : _d, _e = _a.interval, interval = _e === void 0 ? 500 : _e, _f = _a.statusMatchCount, statusMatchCount = _f === void 0 ? 1 : _f;
+    var statusCount = 0;
     var lastGraphqlResponse = {};
     cy.waitUntil(function () {
-        return cy.apollo({
-            fetchPolicy: 'no-cache',
-            queryFile: 'graphql/sam/healthStatus.graphql',
-            variables: {
-                severity: severity
-            }
-        }).then(function (result) {
-            var _a, _b, _c, _d, _e, _f, _g;
-            var healthStatus = (_d = (_c = (_b = (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.admin) === null || _b === void 0 ? void 0 : _b.jahia) === null || _c === void 0 ? void 0 : _c.healthCheck) === null || _d === void 0 ? void 0 : _d.status;
-            lastGraphqlResponse = (_g = (_f = (_e = result === null || result === void 0 ? void 0 : result.data) === null || _e === void 0 ? void 0 : _e.admin) === null || _f === void 0 ? void 0 : _f.jahia) === null || _g === void 0 ? void 0 : _g.healthCheck;
+        return exports.healthCheck(severity, probeHealthFilter).then(function (result) {
+            lastGraphqlResponse = result;
+            var healthStatus = result === null || result === void 0 ? void 0 : result.status;
             if (healthStatus) {
-                greenCount = healthStatus.health === 'GREEN' ? greenCount + 1 : 0;
-                return greenCount >= greenMatchCount;
+                statusCount = healthStatus.health === expectedHealth ? statusCount + 1 : 0;
+                return statusCount >= statusMatchCount;
             }
         });
     }, {
-        errorMsg: "Timeout waiting for SAM to be green for severity: " + severity + ". Last GraphQL response: " + JSON.stringify(lastGraphqlResponse),
+        errorMsg: "Timeout waiting for SAM to be " + expectedHealth + " for severity: " + severity + " and probeHealthFilter: " + probeHealthFilter + ". Last GraphQL response: " + JSON.stringify(lastGraphqlResponse),
         timeout: timeout,
         verbose: true,
         interval: interval
     });
 };
+exports.waitUntilSAMStatus = waitUntilSAMStatus;
+/**
+ When Jahia is starting or performing provisioning operations
+ it is expected for the SAM probe to alternate beween GREEN, YELLOW and RED statuses.
+
+ The primary use of this method is to wait until a Jahia platform stabilizes after a startup or
+ provisioning operation.
+
+ Instead of waiting only for one occurence of a GREEN status, this function will wait until the a
+ GREEN status was returned a number of consecutive times (greenMatchCount).
+ */
+var waitUntilSAMStatusGreen = function (severity, timeout, interval, greenMatchCount) {
+    if (severity === void 0) { severity = 'MEDIUM'; }
+    if (timeout === void 0) { timeout = 60000; }
+    if (interval === void 0) { interval = 500; }
+    if (greenMatchCount === void 0) { greenMatchCount = 10; }
+    // We use YELLOW as the probeHealthFilter because we are not interested in potential GREEN probes in the response
+    exports.waitUntilSAMStatus({ expectedHealth: 'GREEN', severity: severity, probeHealthFilter: 'YELLOW', timeout: timeout, interval: interval, statusMatchCount: greenMatchCount });
+};
 exports.waitUntilSAMStatusGreen = waitUntilSAMStatusGreen;

package/dist/utils/SSHHelper.d.ts

@@ -0,0 +1,15 @@
+import { SSHExecCommandResponse } from 'node-ssh';
+interface connection {
+    hostname: string;
+    port: string;
+    username: string;
+    password: string;
+}
+/**
+ * Execute SSH commands on a specific host. Returns a promise that resolves to the command result.
+ * Rejects if the commands fail (exit code is not 0).
+ * @param commands Array of SSH commands to execute
+ * @param connection Connection details
+ */
+export declare const sshCommands: (commands: Array<string>, connection: connection) => Promise<SSHExecCommandResponse>;
+export {};

package/dist/utils/SSHHelper.js

@@ -0,0 +1,44 @@
+"use strict";
+exports.__esModule = true;
+exports.sshCommands = void 0;
+var node_ssh_1 = require("node-ssh");
+/**
+ * Execute SSH commands on a specific host. Returns a promise that resolves to the command result.
+ * Rejects if the commands fail (exit code is not 0).
+ * @param commands Array of SSH commands to execute
+ * @param connection Connection details
+ */
+var sshCommands = function (commands, connection) {
+    return new Promise(function (resolve, reject) {
+        var ssh = new node_ssh_1.NodeSSH();
+        console.info('[SSH] connection to:', connection.hostname, ' (port: ', connection.port, ')');
+        console.info('[SSH] commands:', commands);
+        console.info('[SSH] ', connection);
+        ssh.connect({
+            host: connection.hostname,
+            port: parseInt(connection.port, 10),
+            username: connection.username,
+            password: connection.password
+        })
+            .then(function () {
+            ssh.exec(commands.join(';'), [], { stream: 'both' })
+                .then(function (result) {
+                console.info('[SSH] Successfully executed commands: ', commands);
+                console.info('[SSH] Result: ', result);
+                if (result.code === 0) {
+                    resolve(result); // Resolve to command result
+                }
+                else {
+                    reject(new Error("Commands \"" + commands + "\" failed with exit code " + result.code + " on host " + connection.hostname + ". Stdout:" + result.stdout + ", Stderr: " + result.stderr));
+                }
+            })["catch"](function (reason) {
+                console.error('[SSH] Failed to execute commands: ', commands);
+                reject(reason);
+            });
+        })["catch"](function (reason) {
+            console.error('[SSH] Failed to connect to: ', connection.hostname);
+            reject(reason);
+        });
+    });
+};
+exports.sshCommands = sshCommands;

package/dist/utils/index.d.ts

@@ -1,9 +1,10 @@
+export * from './ClusterHelper';
+export * from './GraphQLHelper';
+export * from './JahiaPlatformHelper';
 export * from './JCRHelper';
 export * from './PublicationAndWorkflowHelper';
+export * from './SAMHelper';
 export * from './SiteHelper';
+export * from './SSHHelper';
 export * from './UsersHelper';
 export * from './VanityUrlHelper';
-export * from './ClusterHelper';
-export * from './JahiaPlatformHelper';
-export * from './GraphQLHelper';
-export * from './SAMHelper';

package/dist/utils/index.js

@@ -10,12 +10,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 exports.__esModule = true;
+__exportStar(require("./ClusterHelper"), exports);
+__exportStar(require("./GraphQLHelper"), exports);
+__exportStar(require("./JahiaPlatformHelper"), exports);
 __exportStar(require("./JCRHelper"), exports);
 __exportStar(require("./PublicationAndWorkflowHelper"), exports);
+__exportStar(require("./SAMHelper"), exports);
 __exportStar(require("./SiteHelper"), exports);
+__exportStar(require("./SSHHelper"), exports);
 __exportStar(require("./UsersHelper"), exports);
 __exportStar(require("./VanityUrlHelper"), exports);
-__exportStar(require("./ClusterHelper"), exports);
-__exportStar(require("./JahiaPlatformHelper"), exports);
-__exportStar(require("./GraphQLHelper"), exports);
-__exportStar(require("./SAMHelper"), exports);

package/fixtures/graphql/jcr/mutation/uploadFile.graphql

@@ -0,0 +1,11 @@
+mutation uploadFile($name: String!, $parentPathOrId: String!, $mimeType: String!, $file: String!) {
+    jcr {
+        addNode(name: $name, parentPathOrId: $parentPathOrId, primaryNodeType: "jnt:file") {
+            addChild(name: "jcr:content", primaryNodeType: "jnt:resource") {
+                content: mutateProperty(name: "jcr:data") { setValue(type: BINARY, value: $file)}
+                contentType: mutateProperty(name: "jcr:mimeType") { setValue(value: $mimeType)}
+            }
+            uuid
+        }
+    }
+}

package/fixtures/graphql/sam/healthStatus.graphql

@@ -1,4 +1,4 @@
-query($severity: GqlProbeSeverity) {
+query($severity: GqlProbeSeverity, $probeHealthFilter: GqlProbeHealth) {
     admin {
         jahia {
             healthCheck(severity: $severity) {
@@ -6,13 +6,15 @@ query($severity: GqlProbeSeverity) {
                     health
                     message
                 }
-                probes(health: YELLOW) {
+                probes(health: $probeHealthFilter) {
                     name
+                    severity
+                    description
                     status {
                         health
                         message
                     }
-                }                
+                }
             }
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/cypress",
-  "version": "3.25.0",
+  "version": "3.27.0",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts"
@@ -8,8 +8,8 @@
   "bin": {
     "ci.build": "./ci.build.sh",
     "ci.startup": "./ci.startup.sh",
-    "env.run": "./env.run.sh",
-    "env.debug": "./env.debug.sh"
+    "env.debug": "./env.debug.sh",
+    "env.run": "./env.run.sh"
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,6 +26,7 @@
     "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
+    "node-ssh": "^13.2.0",
     "typescript": "^4.3.5"
   },
   "dependencies": {
@@ -33,5 +34,6 @@
     "cypress-real-events": "^1.11.0",
     "graphql": "^15.5.0",
     "graphql-tag": "^2.11.0"
-  }
+  },
+  "packageManager": "yarn@4.5.0"
 }