@jahia/cypress 3.20.0 → 3.21.0

package/dist/support/apollo/apolloClient.d.ts

@@ -1,19 +1,21 @@
 /// <reference types="cypress" />
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
-interface AuthMethod {
+interface HostConfig {
     token?: string;
     username?: string;
     password?: string;
+    url?: string;
 }
 declare global {
     namespace Cypress {
         interface Chainable<Subject> {
-            apolloClient(authMethod?: AuthMethod): Chainable<ApolloClient<NormalizedCacheObject>>;
+            apolloClient(config?: HostConfig): Chainable<ApolloClient<NormalizedCacheObject>>;
         }
     }
 }
 export declare type ApolloClientOptions = Cypress.Loggable & {
     setCurrentApolloClient: boolean;
 };
-export declare const apolloClient: (authMethod?: AuthMethod, options?: ApolloClientOptions) => void;
+export declare const switchApolloClient: (config?: HostConfig, options?: ApolloClientOptions) => void;
+export declare const apolloClient: (config?: HostConfig, options?: ApolloClientOptions) => void;
 export {};

package/dist/support/apollo/apolloClient.js

@@ -1,24 +1,36 @@
 "use strict";
 exports.__esModule = true;
-exports.apolloClient = void 0;
+exports.apolloClient = exports.switchApolloClient = void 0;
 var core_1 = require("@apollo/client/core");
 var links_1 = require("./links");
-var apolloClient = function (authMethod, options) {
+var switchApolloClient = function (config, options) {
+    if (config === void 0) { config = { url: Cypress.config().baseUrl }; }
+    if (options === void 0) { options = {
+        log: true,
+        setCurrentApolloClient: true
+    }; }
+    // Switch context to apollo client
+    cy.visit(config.url, { failOnStatusCode: false });
+    return exports.apolloClient(config, options);
+};
+exports.switchApolloClient = switchApolloClient;
+var apolloClient = function (config, options) {
+    if (config === void 0) { config = { url: Cypress.config().baseUrl }; }
     if (options === void 0) { options = {
         log: true,
         setCurrentApolloClient: true
     }; }
     var headers = {};
-    if (authMethod === undefined) {
-        headers.authorization = "Basic " + btoa('root:' + Cypress.env('SUPER_USER_PASSWORD'));
+    if (config.token !== undefined) {
+        headers.authorization = "APIToken " + config.token;
     }
-    else if (authMethod.token !== undefined) {
-        headers.authorization = "APIToken " + authMethod.token;
+    else if (config.username !== undefined && config.password !== undefined) {
+        headers.authorization = "Basic " + btoa(config.username + ':' + config.password);
     }
-    else if (authMethod.username !== undefined && authMethod.password !== undefined) {
-        headers.authorization = "Basic " + btoa(authMethod.username + ':' + authMethod.password);
+    else {
+        headers.authorization = "Basic " + btoa('root:' + Cypress.env('SUPER_USER_PASSWORD'));
     }
-    var links = [links_1.uploadLink, links_1.formDataHttpLink(Cypress.config().baseUrl, headers)];
+    var links = [links_1.uploadLink, links_1.formDataHttpLink(config.url, headers)];
     var client = new core_1.ApolloClient({
         link: core_1.from(links),
         cache: new core_1.InMemoryCache(),
@@ -35,7 +47,7 @@ var apolloClient = function (authMethod, options) {
             message: 'Create new apollo client',
             consoleProps: function () {
                 return {
-                    Auth: authMethod,
+                    Config: config,
                     Yielded: client
                 };
             }

package/dist/support/login.d.ts

@@ -7,5 +7,5 @@ declare global {
         }
     }
 }
-export declare const login: (username?: string, password?: string) => void;
+export declare const login: (username?: string, password?: string, url?: string) => void;
 export declare const loginAndStoreSession: (username?: string, password?: string) => void;

package/dist/support/login.js

@@ -3,9 +3,10 @@
 exports.__esModule = true;
 exports.loginAndStoreSession = exports.login = void 0;
 /// <reference types="cypress" />
-var login = function (username, password) {
+var login = function (username, password, url) {
     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,
@@ -17,11 +18,11 @@ var login = function (username, password) {
     });
     cy.request({
         method: 'POST',
-        url: '/cms/login',
         form: true,
         body: { username: username, password: password },
         followRedirect: false,
-        log: false
+        log: false,
+        url: url
     }).then(function (res) {
         expect(res.status, 'Login result').to.eq(302);
     });

package/dist/utils/SAMHelper.d.ts

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

package/dist/utils/SAMHelper.js

@@ -1,10 +1,22 @@
 "use strict";
 exports.__esModule = true;
 exports.waitUntilSAMStatusGreen = void 0;
-var waitUntilSAMStatusGreen = function (severity, timeout, interval) {
+/*
+    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 = 1000; }
+    if (interval === void 0) { interval = 500; }
+    if (greenMatchCount === void 0) { greenMatchCount = 10; }
+    var greenCount = 0;
     cy.waitUntil(function () {
         return cy.apollo({
             fetchPolicy: 'no-cache',
@@ -16,7 +28,8 @@ var waitUntilSAMStatusGreen = function (severity, timeout, interval) {
             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) {
-                return healthStatus.health === 'GREEN';
+                greenCount = healthStatus.health === 'GREEN' ? greenCount + 1 : 0;
+                return greenCount >= greenMatchCount;
             }
         });
     }, {

package/dist/utils/SiteHelper.d.ts

@@ -1,12 +1,13 @@
+import { JahiaServer } from '../support';
 export declare const createSite: (siteKey: string, config?: {
     languages?: string;
     templateSet: string;
     serverName: string;
     locale: string;
-}) => void;
-export declare const deleteSite: (siteKey: string) => void;
-export declare const enableModule: (moduleName: string, siteKey: string) => void;
+}, jahiaServer?: JahiaServer) => void;
+export declare const deleteSite: (siteKey: string, jahiaServer?: JahiaServer) => void;
+export declare const enableModule: (moduleName: string, siteKey: string, jahiaServer?: JahiaServer) => void;
 export declare const disableModule: (moduleName: string, siteKey: string) => void;
 export declare const editSite: (siteKey: string, config?: {
     serverName: string;
-}) => void;
+}, jahiaServer?: JahiaServer) => void;

package/dist/utils/SiteHelper.js

@@ -1,7 +1,8 @@
 "use strict";
 exports.__esModule = true;
 exports.editSite = exports.disableModule = exports.enableModule = exports.deleteSite = exports.createSite = void 0;
-var createSite = function (siteKey, config) {
+// eslint-disable-next-line default-param-last
+var createSite = function (siteKey, config, jahiaServer) {
     if (config === void 0) { config = { templateSet: 'dx-base-demo-templates', serverName: 'localhost', locale: 'en' }; }
     cy.executeGroovy('groovy/admin/createSite.groovy', {
         SITEKEY: siteKey,
@@ -9,20 +10,20 @@ var createSite = function (siteKey, config) {
         SERVERNAME: config.serverName,
         LOCALE: config.locale,
         LANGUAGES: config.languages || config.locale
-    });
+    }, jahiaServer);
 };
 exports.createSite = createSite;
-var deleteSite = function (siteKey) {
+var deleteSite = function (siteKey, jahiaServer) {
     cy.executeGroovy('groovy/admin/deleteSite.groovy', {
         SITEKEY: siteKey
-    });
+    }, jahiaServer);
 };
 exports.deleteSite = deleteSite;
-var enableModule = function (moduleName, siteKey) {
+var enableModule = function (moduleName, siteKey, jahiaServer) {
     cy.runProvisioningScript({
         fileContent: '- enable: "' + moduleName + '"\n  site: "' + siteKey + '"',
         type: 'application/yaml'
-    });
+    }, undefined, jahiaServer);
 };
 exports.enableModule = enableModule;
 var disableModule = function (moduleName, siteKey) {
@@ -32,11 +33,12 @@ var disableModule = function (moduleName, siteKey) {
     });
 };
 exports.disableModule = disableModule;
-var editSite = function (siteKey, config) {
+// eslint-disable-next-line default-param-last
+var editSite = function (siteKey, config, jahiaServer) {
     if (config === void 0) { config = { serverName: 'localhost' }; }
     cy.executeGroovy('groovy/admin/editSite.groovy', {
         SITEKEY: siteKey,
         SERVERNAME: config.serverName
-    });
+    }, jahiaServer);
 };
 exports.editSite = editSite;

package/package.json

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

package/src/support/apollo/apolloClient.md

@@ -13,13 +13,14 @@ cy.apolloClient()
 
 ### Arguments
 
-#### > auth (`AuthMethod`) 
+#### > config (`HostConfig`)
 
-If no authorization is passed, will use root credentials. Otherwise :
+If no authorization is passed, will use root credentials and cypress base url. Otherwise :
 
 - token: An API token
 - username
 - password 
+- url
 
 #### > options (`ApolloClientOptions`)
 

package/src/support/apollo/apolloClient.ts

@@ -1,10 +1,11 @@
 import {ApolloClient, from, InMemoryCache, NormalizedCacheObject} from '@apollo/client/core';
 import {formDataHttpLink, uploadLink} from './links';
 
-interface AuthMethod {
+interface HostConfig {
     token?: string
     username?: string
-    password?: string
+    password?: string,
+    url?: string
 }
 
 declare global {
@@ -12,7 +13,7 @@ declare global {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         interface Chainable<Subject> {
-            apolloClient(authMethod?: AuthMethod): Chainable<ApolloClient<NormalizedCacheObject>>
+            apolloClient(config?: HostConfig): Chainable<ApolloClient<NormalizedCacheObject>>
         }
     }
 }
@@ -21,20 +22,29 @@ export type ApolloClientOptions = Cypress.Loggable & {
     setCurrentApolloClient: boolean
 }
 
-export const apolloClient = function (authMethod?: AuthMethod, options: ApolloClientOptions = {
+export const switchApolloClient = function (config: HostConfig = {url: Cypress.config().baseUrl}, options: ApolloClientOptions = {
+    log: true,
+    setCurrentApolloClient: true
+}): void {
+    // Switch context to apollo client
+    cy.visit(config.url, {failOnStatusCode: false});
+    return apolloClient(config, options);
+};
+
+export const apolloClient = function (config: HostConfig = {url: Cypress.config().baseUrl}, options: ApolloClientOptions = {
     log: true,
     setCurrentApolloClient: true
 }): void {
     const headers: { authorization?: string } = {};
-    if (authMethod === undefined) {
+    if (config.token !== undefined) {
+        headers.authorization = `APIToken ${config.token}`;
+    } else if (config.username !== undefined && config.password !== undefined) {
+        headers.authorization = `Basic ${btoa(config.username + ':' + config.password)}`;
+    } else {
         headers.authorization = `Basic ${btoa('root:' + Cypress.env('SUPER_USER_PASSWORD'))}`;
-    } else if (authMethod.token !== undefined) {
-        headers.authorization = `APIToken ${authMethod.token}`;
-    } else if (authMethod.username !== undefined && authMethod.password !== undefined) {
-        headers.authorization = `Basic ${btoa(authMethod.username + ':' + authMethod.password)}`;
     }
 
-    const links = [uploadLink, formDataHttpLink(Cypress.config().baseUrl, headers)];
+    const links = [uploadLink, formDataHttpLink(config.url, headers)];
 
     const client = new ApolloClient({
         link: from(links),
@@ -53,7 +63,7 @@ export const apolloClient = function (authMethod?: AuthMethod, options: ApolloCl
             message: 'Create new apollo client',
             consoleProps: () => {
                 return {
-                    Auth: authMethod,
+                    Config: config,
                     Yielded: client
                 };
             }

package/src/support/login.ts

@@ -13,7 +13,7 @@ declare global {
     }
 }
 
-export const login = (username = 'root', password: string = Cypress.env('SUPER_USER_PASSWORD')): void => {
+export const login = (username = 'root', password: string = Cypress.env('SUPER_USER_PASSWORD'), url = '/cms/login'): void => {
     Cypress.log({
         name: 'login',
         message: `Login with ${username}`,
@@ -26,11 +26,11 @@ export const login = (username = 'root', password: string = Cypress.env('SUPER_U
 
     cy.request({
         method: 'POST',
-        url: '/cms/login',
         form: true,
         body: {username, password},
         followRedirect: false,
-        log: false
+        log: false,
+        url
     }).then(res => {
         expect(res.status, 'Login result').to.eq(302);
     });

package/src/utils/SAMHelper.ts

@@ -1,4 +1,15 @@
-export const waitUntilSAMStatusGreen = (severity = 'MEDIUM', timeout = 60000, interval = 1000) : 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 const waitUntilSAMStatusGreen = (severity = 'MEDIUM', timeout = 60000, interval = 500, greenMatchCount = 10) : void => {
+    let greenCount = 0;
     cy.waitUntil(() =>
         cy.apollo({
             fetchPolicy: 'no-cache',
@@ -9,7 +20,8 @@ export const waitUntilSAMStatusGreen = (severity = 'MEDIUM', timeout = 60000, in
         }).then(result => {
             const healthStatus = result?.data?.admin?.jahia?.healthCheck?.status;
             if (healthStatus) {
-                return healthStatus.health === 'GREEN';
+                greenCount = healthStatus.health === 'GREEN' ? greenCount + 1 : 0;
+                return greenCount >= greenMatchCount;
             }
         }),
     {

package/src/utils/SiteHelper.ts

@@ -1,25 +1,27 @@
+import {JahiaServer} from '../support';
 
-export const createSite = (siteKey: string, config: {languages?: string, templateSet: string, serverName: string, locale: string} = {templateSet: 'dx-base-demo-templates', serverName: 'localhost', locale: 'en'}): void => {
+// eslint-disable-next-line default-param-last
+export const createSite = (siteKey: string, config: {languages?: string, templateSet: string, serverName: string, locale: string} = {templateSet: 'dx-base-demo-templates', serverName: 'localhost', locale: 'en'}, jahiaServer?: JahiaServer): void => {
     cy.executeGroovy('groovy/admin/createSite.groovy', {
         SITEKEY: siteKey,
         TEMPLATES_SET: config.templateSet,
         SERVERNAME: config.serverName,
         LOCALE: config.locale,
         LANGUAGES: config.languages || config.locale
-    });
+    }, jahiaServer);
 };
 
-export const deleteSite = (siteKey: string): void => {
+export const deleteSite = (siteKey: string, jahiaServer?: JahiaServer): void => {
     cy.executeGroovy('groovy/admin/deleteSite.groovy', {
         SITEKEY: siteKey
-    });
+    }, jahiaServer);
 };
 
-export const enableModule = (moduleName: string, siteKey: string): void => {
+export const enableModule = (moduleName: string, siteKey: string, jahiaServer?: JahiaServer): void => {
     cy.runProvisioningScript({
         fileContent: '- enable: "' + moduleName + '"\n  site: "' + siteKey + '"',
         type: 'application/yaml'
-    });
+    }, undefined, jahiaServer);
 };
 
 export const disableModule = (moduleName: string, siteKey: string): void => {
@@ -29,9 +31,10 @@ export const disableModule = (moduleName: string, siteKey: string): void => {
     });
 };
 
-export const editSite = (siteKey: string, config: {serverName: string} = {serverName: 'localhost'}): void => {
+// eslint-disable-next-line default-param-last
+export const editSite = (siteKey: string, config: {serverName: string} = {serverName: 'localhost'}, jahiaServer?: JahiaServer): void => {
     cy.executeGroovy('groovy/admin/editSite.groovy', {
         SITEKEY: siteKey,
         SERVERNAME: config.serverName
-    });
+    }, jahiaServer);
 };