@jahia/cypress 3.2.0 → 3.4.0

package/src/support/apollo/apollo.ts

@@ -31,11 +31,8 @@ function isMutationFile(options: ApolloOptions): options is FileMutationOptions
     return (<FileMutationOptions>options).mutationFile !== undefined;
 }
 
-export const apollo = function (apollo: ApolloClient<any>, options: ApolloOptions): void {
-    if (!apollo) {
-        apollo = this.currentApolloClient;
-    }
-
+// eslint-disable-next-line default-param-last, @typescript-eslint/no-shadow
+export const apollo = function (apollo: ApolloClient<any> = this.currentApolloClient, options: ApolloOptions): void {
     let result : ApolloQueryResult<any> | FetchResult;
     let logger : Cypress.Log;
     const optionsWithDefaultCache: ApolloOptions = {fetchPolicy: 'no-cache', ...options};

package/src/support/apollo/apolloClient.ts

@@ -1,7 +1,5 @@
-/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
-
-import {ApolloClient, from, HttpLink, InMemoryCache, NormalizedCacheObject} from '@apollo/client/core';
-import {FormDataHttpLink, uploadLink} from './links';
+import {ApolloClient, from, InMemoryCache, NormalizedCacheObject} from '@apollo/client/core';
+import {formDataHttpLink, uploadLink} from './links';
 
 interface AuthMethod {
     token?: string
@@ -10,6 +8,7 @@ interface AuthMethod {
 }
 
 declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         interface Chainable<Subject> {
@@ -35,7 +34,7 @@ export const apolloClient = function (authMethod?: AuthMethod, options: ApolloCl
         headers.authorization = `Basic ${btoa(authMethod.username + ':' + authMethod.password)}`;
     }
 
-    const links = [uploadLink, FormDataHttpLink(Cypress.config().baseUrl, headers)];
+    const links = [uploadLink, formDataHttpLink(Cypress.config().baseUrl, headers)];
 
     const client = new ApolloClient({
         link: from(links),

package/src/support/apollo/links.ts

@@ -7,7 +7,7 @@ interface ApolloRequestInit extends RequestInit {
     formData?: FormData
 }
 
-export const FormDataHttpLink = (baseUrl: string, headers: Object) => {
+export const formDataHttpLink = (baseUrl: string, headers: unknown) => {
     return new HttpLink({
         uri: `${baseUrl}/modules/graphql`,
         headers,

package/src/support/fixture.ts

@@ -1,9 +1,9 @@
 import Chainable = Cypress.Chainable;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const fixture = function (originalCommand: ((...args: any[]) => any), fixture: string, ...args: any[]): Chainable<any> {
+export const fixture = function (originalCommand: ((...args: any[]) => any), fixtureParam: string, ...args: any[]): Chainable<any> {
     return cy.wrap({}, {log: false}).then(() => {
-        return originalCommand(fixture, ...args).then(f => {
+        return originalCommand(fixtureParam, ...args).then(f => {
             return f;
         }).catch(() => {
             return null;
@@ -16,7 +16,7 @@ export const fixture = function (originalCommand: ((...args: any[]) => any), fix
             }
 
             try {
-                cy.readFile('./node_modules/@jahia/cypress/fixtures/' + fixture, encoding, {log: false, timeout: 200});
+                cy.readFile('./node_modules/@jahia/cypress/fixtures/' + fixtureParam, encoding, {log: false, timeout: 200});
             } catch (e) {
                 console.log(e);
             }

package/src/support/provisioning/runProvisioningScript.ts

@@ -1,13 +1,14 @@
-/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
 import RequestOptions = Cypress.RequestOptions;
 
 // Load type definitions that come with Cypress module
 /// <reference types="cypress" />
 
 declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         interface Chainable<Subject> {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             runProvisioningScript(script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer): Chainable<any>
         }
     }
@@ -67,6 +68,7 @@ function isFormFile(script: FormFile | StringDictionary[]): script is FormFile {
     return Boolean((script as FormFile).fileContent || (script as FormFile).fileName);
 }
 
+// eslint-disable-next-line default-param-last, max-params
 export const runProvisioningScript = (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer: JahiaServer = serverDefaults, options: Cypress.Loggable = {log: true}, timeout?: number): void => {
     const formData = new FormData();
 
@@ -85,7 +87,9 @@ export const runProvisioningScript = (script: FormFile | StringDictionary[], fil
         });
     }
 
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
     let response: Cypress.Response<any>;
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
     let result: any;
     let logger: Cypress.Log;
 

package/src/support/repeatUntil.ts

@@ -1,7 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
-
-// Load type definitions that come with Cypress module
-/// <reference types="cypress" />
+// Load type definitions that come with Cypress module <reference types="cypress" />
 
 export type RepeatUntilOptions = {
     attempts: number,
@@ -16,6 +13,7 @@ const defaultOptions: RepeatUntilOptions = {
 };
 
 declare global {
+    // eslint-disable-next-line @typescript-eslint/no-namespace
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         interface Chainable<Subject> {
@@ -48,7 +46,6 @@ export const repeatUntil = (selector: string, options: Partial<RepeatUntilOption
         log.end();
         options.callback();
 
-        // eslint-disable-next-line cypress/no-unnecessary-waiting
         cy.wait(options.delay);
         cy.repeatUntil(selector, {...options, attempts: options.attempts - 1});
     } else {

package/src/utils/JCRHelper.ts

@@ -0,0 +1,55 @@
+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) {
+        mutationFile = 'graphql/jcr/mutation/setPropertyValues.graphql';
+    }
+
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId,
+            property: property,
+            language: language,
+            value: value
+        },
+        mutationFile
+    });
+};
+
+export const deleteNode = (pathOrId: string): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId
+        },
+        mutationFile: 'graphql/jcr/mutation/deleteNode.graphql'
+    });
+};
+
+export const deleteNodeProperty = (pathOrId: string, property: string, language: string): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId,
+            property: property,
+            language: language
+        },
+        mutationFile: 'graphql/jcr/mutation/deleteNodeProperty.graphql'
+    });
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const addNode = (variables: { parentPathOrId: string, primaryNodeType: string, name: string, properties?: any[], children?: any[] }): Cypress.Chainable => {
+    return cy.apollo({
+        variables: variables,
+        mutationFile: 'graphql/jcr/mutation/addNode.graphql'
+    });
+};
+
+export const getNodeByPath = (path: string, properties?: string[], language?:string): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {
+            path: path,
+            properties: properties,
+            language: language
+        },
+        queryFile: 'graphql/jcr/query/getNodeByPath.graphql'
+    });
+};

package/src/utils/PublicationAndWorkflowHelper.ts

@@ -0,0 +1,55 @@
+
+export const publishAndWaitJobEnding = (path: string, languages: string[] = ['en']): void => {
+    cy.apollo({
+        variables: {
+            pathOrId: path,
+            languages: languages,
+            publishSubNodes: true,
+            includeSubTree: true
+        },
+        mutationFile: 'graphql/jcr/mutation/publishNode.graphql'
+    });
+    waitAllJobsFinished('Publication timeout for node: ' + path, 60000);
+};
+
+export const startWorkflow = (pathOrId: string, definition: string, language: string): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {
+            pathOrId,
+            definition,
+            language
+        },
+        mutationFile: 'graphql/jcr/mutation/startWorkflow.graphql'
+    });
+};
+
+export const validateAllWorkflows = (): void => {
+    cy.executeGroovy('groovy/admin/completeWorkflows.groovy');
+    waitAllJobsFinished('All workflows validated but some jobs are still running after a minute', 60000);
+};
+
+export const waitAllJobsFinished = (errorMessage?: string, timeout = 60000): void => {
+    cy.waitUntil(
+        () =>
+            cy
+                .apollo({
+                    fetchPolicy: 'no-cache',
+                    queryFile: 'graphql/jcr/query/getJobsWithStatus.graphql'
+                })
+                .then(response => {
+                    const jobs = response?.data?.admin?.jahia?.scheduler?.jobs;
+                    const publicationJobs = jobs.filter(job => job.group === 'PublicationJob');
+                    const hasActivePublicationJobs = publicationJobs.some(job => job.jobStatus === 'EXECUTING');
+                    return !hasActivePublicationJobs;
+                }),
+        {
+            errorMsg: errorMessage ? errorMessage : 'Jobs are still running before the end of timeout',
+            timeout: timeout,
+            verbose: true,
+            interval: 500
+        }
+    );
+    // Wait 0.5 seconds for server sync after publication
+    // eslint-disable-next-line cypress/no-unnecessary-waiting
+    cy.wait(500);
+};

package/src/utils/SiteHelper.ts

@@ -0,0 +1,16 @@
+
+export const createSite = (siteKey: string, config: {languages?: string, templateSet: string, serverName: string, locale: string} = {templateSet: 'dx-base-demo-templates', serverName: 'localhost', locale: 'en'}): void => {
+    cy.executeGroovy('groovy/admin/createSite.groovy', {
+        SITEKEY: siteKey,
+        TEMPLATES_SET: config.templateSet,
+        SERVERNAME: config.serverName,
+        LOCALE: config.locale,
+        LANGUAGES: config.languages || config.locale
+    });
+};
+
+export const deleteSite = (siteKey: string): void => {
+    cy.executeGroovy('groovy/admin/deleteSite.groovy', {
+        SITEKEY: siteKey
+    });
+};

package/src/utils/UsersHelper.ts

@@ -0,0 +1,30 @@
+
+export const grantRoles = (pathOrId: string, roleNames: Array<string>, principalName: string, principalType: string): Cypress.Chainable => {
+    cy.log('Grant role(s) ' + roleNames + ' with principal type ' + principalType + ' to ' + principalName + ' on node ' + pathOrId);
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId,
+            roleNames: roleNames,
+            principalName: principalName,
+            principalType: principalType
+        },
+        mutationFile: 'graphql/jcr/mutation/grantRoles.graphql'
+    });
+};
+
+export const createUser = (userName: string, password: string, properties: { name: string, value: string }[] = []): void => {
+    const userProperties = properties.map(property => {
+        return 'properties.setProperty("' + property.name + '", "' + property.value + '")';
+    });
+    cy.executeGroovy('groovy/admin/createUser.groovy', {
+        USER_NAME: userName,
+        PASSWORD: password ? password : 'password',
+        USER_PROPERTIES: userProperties ? userProperties.join('\n') : ''
+    });
+};
+
+export const deleteUser = (userName: string): void => {
+    cy.executeGroovy('groovy/admin/deleteUser.groovy', {
+        USER_NAME: userName
+    });
+};

package/src/utils/VanityUrlHelper.ts

@@ -0,0 +1,30 @@
+export const addVanityUrl = (pathOrId: string, language: string, url: string): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId,
+            language: language,
+            url: url
+        },
+        mutationFile: 'graphql/jcr/mutation/addVanityUrl.graphql'
+    });
+};
+
+export const getVanityUrl = (path: string, languages: Array<string>): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {
+            path: path,
+            languages: languages
+        },
+        queryFile: 'graphql/jcr/query/getVanityUrls.graphql'
+    });
+};
+
+export const removeVanityUrl = (pathOrId: string, url: string): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId,
+            url: url
+        },
+        mutationFile: 'graphql/jcr/mutation/removeVanityUrl.graphql'
+    });
+};

package/src/utils/index.ts

@@ -1 +1,5 @@
-export * from './Utils';
+export * from './JCRHelper';
+export * from './PublicationAndWorkflowHelper';
+export * from './SiteHelper';
+export * from './UsersHelper';
+export * from './VanityUrlHelper';

package/dist/utils/Utils.d.ts

@@ -1,20 +0,0 @@
-export declare const setNodeProperty: (pathOrId: string, property: string, value: string, language: string) => Cypress.Chainable;
-export declare const deleteNode: (pathOrId: string) => Cypress.Chainable;
-export declare const grantRoles: (pathOrId: string, roleNames: Array<string>, principalName: string, principalType: string) => Cypress.Chainable;
-export declare const publishAndWaitJobEnding: (path: string, languages?: string[]) => void;
-export declare const waitAllJobsFinished: (errorMessage?: string, timeout?: number) => void;
-export declare const addNode: (variables: {
-    parentPathOrId: string;
-    primaryNodeType: string;
-    name: string;
-    properties?: any[];
-    children?: any[];
-}) => Cypress.Chainable;
-export declare const getNodeByPath: (path: string) => Cypress.Chainable;
-export declare const createSite: (siteKey: string, templateSet?: string, serverName?: string, locale?: string, languages?: string) => void;
-export declare const deleteSite: (siteKey: string) => void;
-export declare const createUser: (userName: string, password: string, properties?: {
-    name: string;
-    value: string;
-}[]) => void;
-export declare const deleteUser: (userName: string) => void;

package/dist/utils/Utils.js

@@ -1,128 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.deleteUser = exports.createUser = exports.deleteSite = exports.createSite = exports.getNodeByPath = exports.addNode = exports.waitAllJobsFinished = exports.publishAndWaitJobEnding = exports.grantRoles = exports.deleteNode = exports.setNodeProperty = void 0;
-var setNodeProperty = function (pathOrId, property, value, language) {
-    return cy.apollo({
-        variables: {
-            pathOrId: pathOrId,
-            property: property,
-            value: value,
-            language: language
-        },
-        mutationFile: 'graphql/jcr/mutation/setProperty.graphql'
-    });
-};
-exports.setNodeProperty = setNodeProperty;
-var deleteNode = function (pathOrId) {
-    return cy.apollo({
-        variables: {
-            pathOrId: pathOrId
-        },
-        mutationFile: 'graphql/jcr/mutation/deleteNode.graphql'
-    });
-};
-exports.deleteNode = deleteNode;
-var grantRoles = function (pathOrId, roleNames, principalName, principalType) {
-    cy.log('Grant role(s) ' + roleNames + ' with principal type ' + principalType + ' to ' + principalName + ' on node ' + pathOrId);
-    return cy.apollo({
-        variables: {
-            pathOrId: pathOrId,
-            roleNames: roleNames,
-            principalName: principalName,
-            principalType: principalType
-        },
-        mutationFile: 'graphql/jcr/mutation/grantRoles.graphql'
-    });
-};
-exports.grantRoles = grantRoles;
-var publishAndWaitJobEnding = function (path, languages) {
-    if (languages === void 0) { languages = ['en']; }
-    cy.apollo({
-        variables: {
-            pathOrId: path,
-            languages: languages,
-            publishSubNodes: true,
-            includeSubTree: true
-        },
-        mutationFile: 'graphql/jcr/mutation/publishNode.graphql'
-    });
-    exports.waitAllJobsFinished('Publication timeout for node: ' + path, 60000);
-};
-exports.publishAndWaitJobEnding = publishAndWaitJobEnding;
-var waitAllJobsFinished = function (errorMessage, timeout) {
-    if (timeout === void 0) { timeout = 60000; }
-    cy.waitUntil(function () {
-        return cy
-            .apollo({
-            fetchPolicy: 'no-cache',
-            queryFile: 'graphql/jcr/query/getJobsWithStatus.graphql'
-        })
-            .then(function (response) {
-            var _a, _b, _c, _d;
-            var jobs = (_d = (_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.scheduler) === null || _d === void 0 ? void 0 : _d.jobs;
-            var publicationJobs = jobs.filter(function (job) { return job.group === 'PublicationJob'; });
-            var hasActivePublicationJobs = publicationJobs.some(function (job) { return job.jobStatus === 'EXECUTING'; });
-            return !hasActivePublicationJobs;
-        });
-    }, {
-        errorMsg: errorMessage ? errorMessage : 'Jobs are still running before the end of timeout',
-        timeout: timeout,
-        verbose: true,
-        interval: 1000
-    });
-    // Wait 2 seconds for server sync after publication
-    // eslint-disable-next-line cypress/no-unnecessary-waiting
-    cy.wait(2000);
-};
-exports.waitAllJobsFinished = waitAllJobsFinished;
-var addNode = function (variables) {
-    return cy.apollo({
-        variables: variables,
-        mutationFile: 'graphql/jcr/mutation/addNode.graphql'
-    });
-};
-exports.addNode = addNode;
-var getNodeByPath = function (path) {
-    return cy.apollo({
-        variables: {
-            path: path
-        },
-        queryFile: 'graphql/jcr/query/getNodeByPath.graphql'
-    });
-};
-exports.getNodeByPath = getNodeByPath;
-var createSite = function (siteKey, templateSet, serverName, locale, languages) {
-    var definedLocale = locale ? locale : 'en';
-    cy.executeGroovy('groovy/admin/createSite.groovy', {
-        SITEKEY: siteKey,
-        TEMPLATES_SET: templateSet ? templateSet : 'dx-base-demo-templates',
-        SERVERNAME: serverName ? serverName : 'localhost',
-        LOCALE: definedLocale,
-        LANGUAGES: languages ? "Arrays.asList(" + languages + ")" : "Arrays.asList(\"" + definedLocale + "\")"
-    });
-};
-exports.createSite = createSite;
-var deleteSite = function (siteKey) {
-    cy.executeGroovy('groovy/admin/deleteSite.groovy', {
-        SITEKEY: siteKey
-    });
-};
-exports.deleteSite = deleteSite;
-var createUser = function (userName, password, properties) {
-    if (properties === void 0) { properties = []; }
-    var userProperties = properties.map(function (property) {
-        return 'properties.setProperty("' + property.name + '", "' + property.value + '")';
-    });
-    cy.executeGroovy('groovy/admin/createUser.groovy', {
-        USER_NAME: userName,
-        PASSWORD: password ? password : 'password',
-        USER_PROPERTIES: userProperties ? userProperties.join('\n') : ''
-    });
-};
-exports.createUser = createUser;
-var deleteUser = function (userName) {
-    cy.executeGroovy('groovy/admin/deleteUser.groovy', {
-        USER_NAME: userName
-    });
-};
-exports.deleteUser = deleteUser;

package/src/utils/Utils.ts

@@ -1,122 +0,0 @@
-export const setNodeProperty = (pathOrId: string, property: string, value: string, language: string): Cypress.Chainable => {
-    return cy.apollo({
-        variables: {
-            pathOrId: pathOrId,
-            property: property,
-            value: value,
-            language: language
-        },
-        mutationFile: 'graphql/jcr/mutation/setProperty.graphql'
-    });
-};
-
-export const deleteNode = (pathOrId: string): Cypress.Chainable => {
-    return cy.apollo({
-        variables: {
-            pathOrId: pathOrId
-        },
-        mutationFile: 'graphql/jcr/mutation/deleteNode.graphql'
-    });
-};
-
-export const grantRoles = (pathOrId: string, roleNames: Array<string>, principalName: string, principalType: string): Cypress.Chainable => {
-    cy.log('Grant role(s) ' + roleNames + ' with principal type ' + principalType + ' to ' + principalName + ' on node ' + pathOrId);
-    return cy.apollo({
-        variables: {
-            pathOrId: pathOrId,
-            roleNames: roleNames,
-            principalName: principalName,
-            principalType: principalType
-        },
-        mutationFile: 'graphql/jcr/mutation/grantRoles.graphql'
-    });
-};
-
-export const publishAndWaitJobEnding = (path: string, languages: string[] = ['en']): void => {
-    cy.apollo({
-        variables: {
-            pathOrId: path,
-            languages: languages,
-            publishSubNodes: true,
-            includeSubTree: true
-        },
-        mutationFile: 'graphql/jcr/mutation/publishNode.graphql'
-    });
-    waitAllJobsFinished('Publication timeout for node: ' + path, 60000);
-};
-
-export const waitAllJobsFinished = (errorMessage?: string, timeout = 60000): void => {
-    cy.waitUntil(
-        () =>
-            cy
-                .apollo({
-                    fetchPolicy: 'no-cache',
-                    queryFile: 'graphql/jcr/query/getJobsWithStatus.graphql'
-                })
-                .then(response => {
-                    const jobs = response?.data?.admin?.jahia?.scheduler?.jobs;
-                    const publicationJobs = jobs.filter(job => job.group === 'PublicationJob');
-                    const hasActivePublicationJobs = publicationJobs.some(job => job.jobStatus === 'EXECUTING');
-                    return !hasActivePublicationJobs;
-                }),
-        {
-            errorMsg: errorMessage ? errorMessage : 'Jobs are still running before the end of timeout',
-            timeout: timeout,
-            verbose: true,
-            interval: 1000
-        }
-    );
-    // Wait 2 seconds for server sync after publication
-    // eslint-disable-next-line cypress/no-unnecessary-waiting
-    cy.wait(2000);
-};
-
-export const addNode = (variables: { parentPathOrId: string, primaryNodeType: string, name: string, properties?: any[], children?: any[] }): Cypress.Chainable => {
-    return cy.apollo({
-        variables: variables,
-        mutationFile: 'graphql/jcr/mutation/addNode.graphql'
-    });
-};
-
-export const getNodeByPath = (path: string): Cypress.Chainable => {
-    return cy.apollo({
-        variables: {
-            path: path
-        },
-        queryFile: 'graphql/jcr/query/getNodeByPath.graphql'
-    });
-};
-
-export const createSite = (siteKey: string, templateSet?: string, serverName?: string, locale?: string, languages?: string): void => {
-    const definedLocale = locale ? locale : 'en';
-    cy.executeGroovy('groovy/admin/createSite.groovy', {
-        SITEKEY: siteKey,
-        TEMPLATES_SET: templateSet ? templateSet : 'dx-base-demo-templates',
-        SERVERNAME: serverName ? serverName : 'localhost',
-        LOCALE: definedLocale,
-        LANGUAGES: languages ? `Arrays.asList(${languages})` : `Arrays.asList("${definedLocale}")`
-    });
-};
-
-export const deleteSite = (siteKey: string): void => {
-    cy.executeGroovy('groovy/admin/deleteSite.groovy', {
-        SITEKEY: siteKey
-    });
-};
-
-export const createUser = (userName: string, password: string, properties: { name: string, value: string }[] = []): void => {
-    const userProperties = properties.map(property => {
-        return 'properties.setProperty("' + property.name + '", "' + property.value + '")';
-    });
-    cy.executeGroovy('groovy/admin/createUser.groovy', {
-        USER_NAME: userName,
-        PASSWORD: password ? password : 'password',
-        USER_PROPERTIES: userProperties ? userProperties.join('\n') : ''
-    });
-};
-
-export const deleteUser = (userName: string): void => {
-    cy.executeGroovy('groovy/admin/deleteUser.groovy', {
-        USER_NAME: userName
-    });
-};