@jahia/cypress 3.19.4 → 3.20.1

package/dist/utils/JCRHelper.d.ts

@@ -1,5 +1,6 @@
+declare type Workspace = 'EDIT' | 'LIVE';
 export declare const setNodeProperty: (pathOrId: string, property: string, value: string | Array<string>, language: string) => Cypress.Chainable;
-export declare const deleteNode: (pathOrId: string) => Cypress.Chainable;
+export declare const deleteNode: (pathOrId: string, workspace?: Workspace) => Cypress.Chainable;
 export declare const deleteNodeProperty: (pathOrId: string, property: string, language: string) => Cypress.Chainable;
 export declare const addNode: (variables: {
     parentPathOrId: string;
@@ -9,7 +10,8 @@ export declare const addNode: (variables: {
     children?: any[];
     mixins?: any[];
 }) => Cypress.Chainable;
-export declare const getNodeByPath: (path: string, properties?: string[], language?: string, childrenTypes?: string[], workspace?: 'EDIT' | 'LIVE') => 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 {};

package/dist/utils/JCRHelper.js

@@ -17,10 +17,12 @@ var setNodeProperty = function (pathOrId, property, value, language) {
     });
 };
 exports.setNodeProperty = setNodeProperty;
-var deleteNode = function (pathOrId) {
+var deleteNode = function (pathOrId, workspace) {
+    if (workspace === void 0) { workspace = 'EDIT'; }
     return cy.apollo({
         variables: {
-            pathOrId: pathOrId
+            pathOrId: pathOrId,
+            workspace: workspace
         },
         mutationFile: 'graphql/jcr/mutation/deleteNode.graphql'
     });

package/dist/utils/SAMHelper.d.ts

@@ -0,0 +1 @@
+export declare const waitUntilSAMStatusGreen: (severity?: string, timeout?: number, interval?: number, greenMatchCount?: number) => void;

package/dist/utils/SAMHelper.js

@@ -0,0 +1,42 @@
+"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) {
+    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;
+    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;
+            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;
+            if (healthStatus) {
+                greenCount = healthStatus.health === 'GREEN' ? greenCount + 1 : 0;
+                return greenCount >= greenMatchCount;
+            }
+        });
+    }, {
+        errorMsg: "Timeout waiting for SAM to be green for severity: " + severity,
+        timeout: timeout,
+        verbose: true,
+        interval: interval
+    });
+};
+exports.waitUntilSAMStatusGreen = waitUntilSAMStatusGreen;

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

@@ -18,3 +18,4 @@ __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/deleteNode.graphql

@@ -1,5 +1,5 @@
-mutation deleteNode($pathOrId: String!) {
-    jcr(workspace: EDIT) {
+mutation deleteNode($pathOrId: String!, $workspace: Workspace!) {
+    jcr(workspace: $workspace) {
         deleteNode(pathOrId: $pathOrId)
     }
 }

package/fixtures/graphql/sam/healthStatus.graphql

@@ -0,0 +1,12 @@
+query($severity: GqlProbeSeverity) {
+    admin {
+        jahia {
+            healthCheck(severity: $severity) {
+                status {
+                    health
+                    message
+                }
+            }
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/cypress",
-  "version": "3.19.4",
+  "version": "3.20.1",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts"

package/src/utils/JCRHelper.ts

@@ -1,3 +1,5 @@
+type Workspace = 'EDIT' | 'LIVE';
+
 export const setNodeProperty = (pathOrId: string, property: string, value: string | Array<string>, language: string): Cypress.Chainable => {
     let mutationFile = 'graphql/jcr/mutation/setProperty.graphql';
     if (value instanceof Array) {
@@ -15,10 +17,11 @@ export const setNodeProperty = (pathOrId: string, property: string, value: strin
     });
 };
 
-export const deleteNode = (pathOrId: string): Cypress.Chainable => {
+export const deleteNode = (pathOrId: string, workspace: Workspace = 'EDIT'): Cypress.Chainable => {
     return cy.apollo({
         variables: {
-            pathOrId: pathOrId
+            pathOrId: pathOrId,
+            workspace
         },
         mutationFile: 'graphql/jcr/mutation/deleteNode.graphql'
     });
@@ -43,7 +46,7 @@ export const addNode = (variables: { parentPathOrId: string, primaryNodeType: st
     });
 };
 
-export const getNodeByPath = (path: string, properties?: string[], language?: string, childrenTypes: string[] = [], workspace: 'EDIT' | 'LIVE' = 'EDIT'): Cypress.Chainable => {
+export const getNodeByPath = (path: string, properties?: string[], language?: string, childrenTypes: string[] = [], workspace: Workspace = 'EDIT'): Cypress.Chainable => {
     return cy.apollo({
         variables: {
             path: path,

package/src/utils/SAMHelper.ts

@@ -0,0 +1,34 @@
+/*
+    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 const waitUntilSAMStatusGreen = (severity = 'MEDIUM', timeout = 60000, interval = 500, greenMatchCount = 10) : void => {
+    let greenCount = 0;
+    cy.waitUntil(() =>
+        cy.apollo({
+            fetchPolicy: 'no-cache',
+            queryFile: 'graphql/sam/healthStatus.graphql',
+            variables: {
+                severity: severity
+            }
+        }).then(result => {
+            const healthStatus = result?.data?.admin?.jahia?.healthCheck?.status;
+            if (healthStatus) {
+                greenCount = healthStatus.health === 'GREEN' ? greenCount + 1 : 0;
+                return greenCount >= greenMatchCount;
+            }
+        }),
+    {
+        errorMsg: `Timeout waiting for SAM to be green for severity: ${severity}`,
+        timeout: timeout,
+        verbose: true,
+        interval: interval
+    });
+};
+

package/src/utils/index.ts

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