@jahia/cypress 3.30.0 → 3.32.0

package/dist/utils/SAMHelper.d.ts

@@ -2,22 +2,25 @@ 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
+ * @param probeHealthFilter return only probes with health status matching or above, default is null
+ * @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?: string) => Chainable<any>;
+export declare const healthCheck: (severity?: string, probeHealthFilter?: any, probeNamesFilter?: 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 probeHealthFilter return only probes with health status matching or above, default is null
+ * @param probeNamesFilter return and calculate health status only for the probes with the given names, default is null
  * @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 3
  */
-export declare const waitUntilSAMStatus: ({ expectedHealth, severity, probeHealthFilter, timeout, interval, statusMatchCount }: {
+export declare const waitUntilSAMStatus: ({ expectedHealth, severity, probeHealthFilter, probeNamesFilter, timeout, interval, statusMatchCount }: {
     expectedHealth: any;
     severity?: string;
-    probeHealthFilter?: string;
+    probeHealthFilter?: any;
+    probeNamesFilter?: any;
     timeout?: number;
     interval?: number;
     statusMatchCount?: number;

package/dist/utils/SAMHelper.js

@@ -4,18 +4,21 @@ exports.waitUntilSAMStatusGreen = exports.waitUntilSAMStatus = exports.healthChe
 /**
  * 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
+ * @param probeHealthFilter return only probes with health status matching or above, default is null
+ * @param probeNamesFilter return and calculate health status only for the probes with the given names, default is null
  */
-var healthCheck = function (severity, probeHealthFilter) {
+var healthCheck = function (severity, probeHealthFilter, probeNamesFilter) {
     if (severity === void 0) { severity = 'MEDIUM'; }
-    if (probeHealthFilter === void 0) { probeHealthFilter = 'GREEN'; }
+    if (probeHealthFilter === void 0) { probeHealthFilter = null; }
+    if (probeNamesFilter === void 0) { probeNamesFilter = null; }
     return cy
         .apollo({
         fetchPolicy: 'no-cache',
         queryFile: 'graphql/sam/healthStatus.graphql',
         variables: {
             severity: severity,
-            probeHealthFilter: probeHealthFilter
+            probeHealthFilter: probeHealthFilter,
+            probeNamesFilter: probeNamesFilter
         }
     })
         .then(function (response) {
@@ -28,17 +31,18 @@ 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 probeHealthFilter return only probes with health status matching or above, default is null
+ * @param probeNamesFilter return and calculate health status only for the probes with the given names, default is null
  * @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 3
  */
 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 ? 3 : _f;
+    var expectedHealth = _a.expectedHealth, _b = _a.severity, severity = _b === void 0 ? 'MEDIUM' : _b, _c = _a.probeHealthFilter, probeHealthFilter = _c === void 0 ? null : _c, _d = _a.probeNamesFilter, probeNamesFilter = _d === void 0 ? null : _d, _e = _a.timeout, timeout = _e === void 0 ? 60000 : _e, _f = _a.interval, interval = _f === void 0 ? 500 : _f, _g = _a.statusMatchCount, statusMatchCount = _g === void 0 ? 3 : _g;
     var statusCount = 0;
     var lastGraphqlResponse = {};
     cy.waitUntil(function () {
-        return exports.healthCheck(severity, probeHealthFilter).then(function (result) {
+        return exports.healthCheck(severity, probeHealthFilter, probeNamesFilter).then(function (result) {
             lastGraphqlResponse = result;
             var healthStatus = result === null || result === void 0 ? void 0 : result.status;
             if (healthStatus) {
@@ -47,7 +51,9 @@ var waitUntilSAMStatus = function (_a) {
             }
         });
     }, {
-        errorMsg: "Timeout waiting for SAM to be " + expectedHealth + " for severity: " + severity + " and probeHealthFilter: " + probeHealthFilter + ". Last GraphQL response: " + JSON.stringify(lastGraphqlResponse),
+        errorMsg: function () {
+            return "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

package/env.run.sh

@@ -48,7 +48,7 @@ fi
 
 echo "$(date +'%d %B %Y - %k:%M') == Running Cypress with configuration file ${CYPRESS_CONFIGURATION_FILE} =="
 
-yarn e2e:ci --config-file "${CYPRESS_CONFIGURATION_FILE}"
+NO_COLOR=1 yarn e2e:ci --config-file "${CYPRESS_CONFIGURATION_FILE}"
 
 if [[ $? -eq 0 ]]; then
   echo "$(date +'%d %B %Y - %k:%M') == Full execution successful =="

package/fixtures/graphql/sam/healthStatus.graphql

@@ -1,7 +1,7 @@
-query($severity: GqlProbeSeverity, $probeHealthFilter: GqlProbeHealth) {
+query($severity: GqlProbeSeverity, $probeHealthFilter: GqlProbeHealth, $probeNamesFilter: [String!]) {
     admin {
         jahia {
-            healthCheck(severity: $severity) {
+            healthCheck(severity: $severity, includes: $probeNamesFilter) {
                 status {
                     health
                     message

package/package.json

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

package/src/utils/SAMHelper.ts

@@ -4,16 +4,18 @@ 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
+ * @param probeHealthFilter return only probes with health status matching or above, default is null
+ * @param probeNamesFilter return and calculate health status only for the probes with the given names, default is null
  */
-export const healthCheck = (severity = 'MEDIUM', probeHealthFilter = 'GREEN'): Chainable<any> => {
+export const healthCheck = (severity = 'MEDIUM', probeHealthFilter = null, probeNamesFilter: string[] = null): Chainable<any> => {
     return cy
         .apollo({
             fetchPolicy: 'no-cache',
             queryFile: 'graphql/sam/healthStatus.graphql',
             variables: {
                 severity,
-                probeHealthFilter
+                probeHealthFilter,
+                probeNamesFilter
             }
         })
         .then((response: any) => {
@@ -25,16 +27,17 @@ export const healthCheck = (severity = 'MEDIUM', probeHealthFilter = 'GREEN'): C
  * 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 probeHealthFilter return only probes with health status matching or above, default is null
+ * @param probeNamesFilter return and calculate health status only for the probes with the given names, default is null
  * @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 3
  */
-export const waitUntilSAMStatus = ({expectedHealth, severity = 'MEDIUM', probeHealthFilter = 'GREEN', timeout = 60000, interval = 500, statusMatchCount = 3}) : void => {
+export const waitUntilSAMStatus = ({expectedHealth, severity = 'MEDIUM', probeHealthFilter = null, probeNamesFilter = null, timeout = 60000, interval = 500, statusMatchCount = 3}) : void => {
     let statusCount = 0;
     let lastGraphqlResponse = {};
     cy.waitUntil(() =>
-        healthCheck(severity, probeHealthFilter).then(result => {
+        healthCheck(severity, probeHealthFilter, probeNamesFilter).then(result => {
             lastGraphqlResponse = result;
             const healthStatus = result?.status;
             if (healthStatus) {
@@ -43,7 +46,9 @@ export const waitUntilSAMStatus = ({expectedHealth, severity = 'MEDIUM', probeHe
             }
         }),
     {
-        errorMsg: `Timeout waiting for SAM to be ${expectedHealth} for severity: ${severity} and probeHealthFilter: ${probeHealthFilter}. Last GraphQL response: ${JSON.stringify(lastGraphqlResponse)}`,
+        errorMsg: () => {
+            return `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