@jahia/cypress 2.0.0 → 3.0.0

package/src/support/apollo/apolloClient.ts

@@ -1,7 +1,7 @@
 /* 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, HttpLink, InMemoryCache, NormalizedCacheObject} from '@apollo/client/core';
+import {FormDataHttpLink, uploadLink} from './links';
 
 interface AuthMethod {
     token?: string
@@ -26,44 +26,44 @@ export const apolloClient = function (authMethod?: AuthMethod, options: ApolloCl
     log: true,
     setCurrentApolloClient: true
 }): void {
-    const headers: { authorization?: string } = {}
+    const headers: { authorization?: string } = {};
     if (authMethod === undefined) {
-        headers.authorization = `Basic ${btoa('root:' + Cypress.env('SUPER_USER_PASSWORD'))}`
+        headers.authorization = `Basic ${btoa('root:' + Cypress.env('SUPER_USER_PASSWORD'))}`;
     } else if (authMethod.token !== undefined) {
-        headers.authorization = `APIToken ${authMethod.token}`
+        headers.authorization = `APIToken ${authMethod.token}`;
     } else if (authMethod.username !== undefined && authMethod.password !== undefined) {
-        headers.authorization = `Basic ${btoa(authMethod.username + ':' + authMethod.password)}`
+        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),
         cache: new InMemoryCache(),
         defaultOptions: {
             query: {
-                fetchPolicy: 'no-cache',
-            },
-        },
-    })
+                fetchPolicy: 'no-cache'
+            }
+        }
+    });
 
     if (options.log) {
         Cypress.log({
             name: 'apolloClient',
             displayName: 'apClient',
-            message: `Create new apollo client`,
+            message: 'Create new apollo client',
             consoleProps: () => {
                 return {
                     Auth: authMethod,
                     Yielded: client
-                }
-            },
-        })
+                };
+            }
+        });
     }
 
     if (options.setCurrentApolloClient) {
-        cy.wrap(client, {log: false}).as('currentApolloClient')
+        cy.wrap(client, {log: false}).as('currentApolloClient');
     } else {
-        cy.wrap(client, {log: false})
+        cy.wrap(client, {log: false});
     }
-}
+};

package/src/support/apollo/index.ts

@@ -1,2 +1,2 @@
-export * from './apolloClient'
-export * from './apollo'
+export * from './apolloClient';
+export * from './apollo';

package/src/support/apollo/links.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-import { HttpLink } from '@apollo/client/link/http'
-import fetch from 'cross-fetch'
-import { setContext } from '@apollo/client/link/context'
+import {HttpLink} from '@apollo/client/link/http';
+import fetch from 'cross-fetch';
+import {setContext} from '@apollo/client/link/context';
 
 interface ApolloRequestInit extends RequestInit {
     formData?: FormData
@@ -12,53 +12,54 @@ export const FormDataHttpLink = (baseUrl: string, headers: Object) => {
         uri: `${baseUrl}/modules/graphql`,
         headers,
         fetch: (uri, fetcherOptions) => {
-            const options: ApolloRequestInit = { ...fetcherOptions }
+            const options: ApolloRequestInit = {...fetcherOptions};
             if (options.formData) {
-                const formData = options.formData
-                const body = JSON.parse(options.body.toString())
+                const formData = options.formData;
+                const body = JSON.parse(options.body.toString());
                 if (Array.isArray(body)) {
-                    formData.append('query', options.body.toString())
+                    formData.append('query', options.body.toString());
                 } else {
-                    Object.keys(body).forEach((k) =>
-                        formData.append(k, typeof body[k] === 'string' ? body[k] : JSON.stringify(body[k])),
-                    )
+                    Object.keys(body).forEach(k =>
+                        formData.append(k, typeof body[k] === 'string' ? body[k] : JSON.stringify(body[k]))
+                    );
                 }
 
-                fetcherOptions.body = formData
-                delete fetcherOptions.headers['content-type']
-                return fetch(uri, fetcherOptions)
+                fetcherOptions.body = formData;
+                delete fetcherOptions.headers['content-type'];
+                return fetch(uri, fetcherOptions);
             }
-            return fetch(uri, fetcherOptions)
-        },
-    })
-}
 
-export const uploadLink = setContext((operation, { fetchOptions }) => {
-    const { variables } = operation
-    let fileFound = false
-    const formData = new FormData()
-    const id = Math.random().toString(36)
+            return fetch(uri, fetcherOptions);
+        }
+    });
+};
+
+export const uploadLink = setContext((operation, {fetchOptions}) => {
+    const {variables} = operation;
+    let fileFound = false;
+    const formData = new FormData();
+    const id = Math.random().toString(36);
     // Search for File objects on the request and set it as formData
     Object.keys(variables).forEach(function (k) {
-        const variable = variables[k]
+        const variable = variables[k];
         if (variable instanceof File) {
-            formData.append(id, variable)
-            variables[k] = id
-            fileFound = true
+            formData.append(id, variable);
+            variables[k] = id;
+            fileFound = true;
         }
-    })
+    });
     if (fileFound) {
         return {
             fetchOptions: {
                 ...fetchOptions,
-                formData: formData,
-            },
-        }
-    } else {
-        return {
-            fetchOptions: {
-                ...fetchOptions,
-            },
-        }
+                formData: formData
+            }
+        };
     }
-})
+
+    return {
+        fetchOptions: {
+            ...fetchOptions
+        }
+    };
+});

package/src/support/commands.ts

@@ -0,0 +1 @@
+import 'cypress-wait-until';

package/src/support/fixture.ts

@@ -1,25 +1,25 @@
 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> {
-    return cy.wrap({}, {log:false}).then(() => {
+export const fixture = function (originalCommand: ((...args: any[]) => any), fixture: string, ...args: any[]): Chainable<any> {
+    return cy.wrap({}, {log: false}).then(() => {
         return originalCommand(fixture, ...args).then(f => {
-            return f
-        }).catch((err) => {
+            return f;
+        }).catch(() => {
             return null;
         });
     }).then(file => {
         if (!file) {
             let encoding;
             if (typeof args[0] === 'string') {
-                encoding = args[0]
+                encoding = args[0];
             }
 
             try {
-                cy.readFile('./node_modules/@jahia/cypress/fixtures/' + fixture, encoding, {log: false, timeout: 200})
+                cy.readFile('./node_modules/@jahia/cypress/fixtures/' + fixture, encoding, {log: false, timeout: 200});
             } catch (e) {
-                console.log(e)
+                console.log(e);
             }
         }
-    })
+    });
 };

package/src/support/index.ts

@@ -1,5 +1,5 @@
-export * from './apollo'
-export * from './provisioning'
-export * from './login'
-export * from './logout'
-export * from './repeatUntil'
+export * from './apollo';
+export * from './provisioning';
+export * from './login';
+export * from './logout';
+export * from './repeatUntil';

package/src/support/login.ts

@@ -3,8 +3,6 @@
 // Load type definitions that come with Cypress module
 /// <reference types="cypress" />
 
-
-
 declare global {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -14,16 +12,16 @@ 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')): void => {
     Cypress.log({
         name: 'login',
         message: `Login with ${username}`,
         consoleProps: () => {
             return {
-                User: username,
-            }
-        },
-    })
+                User: username
+            };
+        }
+    });
 
     cy.request({
         method: 'POST',
@@ -33,7 +31,7 @@ export const login = (username = 'root', password: string = Cypress.env('SUPER_U
         followRedirect: false,
         log: false
     }).then(res => {
-        expect(res.status, 'Login result').to.eq(302)
-    })
-}
+        expect(res.status, 'Login result').to.eq(302);
+    });
+};
 

package/src/support/logout.ts

@@ -3,7 +3,6 @@
 // Load type definitions that come with Cypress module
 /// <reference types="cypress" />
 
-
 declare global {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -16,11 +15,11 @@ declare global {
 export const logout = (): void => {
     Cypress.log({
         name: 'logout',
-        message: `Logout`,
+        message: 'Logout',
         consoleProps: () => {
-            return {}
-        },
-    })
+            return {};
+        }
+    });
 
     cy.request({
         method: 'POST',
@@ -28,7 +27,7 @@ export const logout = (): void => {
         followRedirect: false,
         log: false
     }).then(res => {
-        expect(res.status, 'Logout result').to.eq(302)
-    })
-}
+        expect(res.status, 'Logout result').to.eq(302);
+    });
+};
 

package/src/support/provisioning/executeGroovy.ts

@@ -3,8 +3,6 @@
 // Load type definitions that come with Cypress module
 /// <reference types="cypress" />
 
-
-
 declare global {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -24,7 +22,7 @@ const serverDefaults = {
     url: Cypress.config().baseUrl,
     username: 'root',
     password: Cypress.env('SUPER_USER_PASSWORD')
-}
+};
 
 export const executeGroovy = function (scriptFile: string, replacements?: { [key: string]: string }, jahiaServer: JahiaServer = serverDefaults): void {
     cy.runProvisioningScript({
@@ -34,5 +32,5 @@ export const executeGroovy = function (scriptFile: string, replacements?: { [key
         fileName: scriptFile,
         replacements,
         type: 'text/plain'
-    }], jahiaServer).then(r => r[0])
-}
+    }], jahiaServer).then(r => r[0]);
+};

package/src/support/provisioning/index.ts

@@ -1,3 +1,3 @@
-export * from './executeGroovy'
-export * from './runProvisioningScript'
-export * from './installBundle'
+export * from './executeGroovy';
+export * from './runProvisioningScript';
+export * from './installBundle';

package/src/support/provisioning/installBundle.ts

@@ -3,8 +3,6 @@
 // Load type definitions that come with Cypress module
 /// <reference types="cypress" />
 
-
-
 declare global {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -15,8 +13,8 @@ declare global {
 }
 
 export const installBundle = function (bundleFile: string): void {
-    cy.runProvisioningScript([{ installBundle: bundleFile }], [{
+    cy.runProvisioningScript([{installBundle: bundleFile}], [{
         fileName: bundleFile,
         type: 'text/plain'
-    }])
-}
+    }]);
+};

package/src/support/provisioning/runProvisioningScript.ts

@@ -1,12 +1,9 @@
 /* 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 {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -35,9 +32,12 @@ export type JahiaServer = {
 function processContent(formFile: FormFile) {
     let content = formFile.fileContent;
     if (formFile.replacements) {
-        Object.keys(formFile.replacements).forEach(k => content = content.replaceAll(k, formFile.replacements[k]))
+        Object.keys(formFile.replacements).forEach(k => {
+            content = content.replaceAll(k, formFile.replacements[k]);
+        });
     }
-    formFile.fileContent = content
+
+    formFile.fileContent = content;
     return Cypress.Blob.binaryStringToBlob(content, formFile.type);
 }
 
@@ -51,8 +51,9 @@ function append(formFile: FormFile, formData: FormData, key: string) {
             } else {
                 formFile.fileContent = content;
             }
+
             formData.append(key, processContent(formFile), formFile.fileName);
-        })
+        });
     }
 }
 
@@ -60,33 +61,33 @@ const serverDefaults: JahiaServer = {
     url: Cypress.config().baseUrl,
     username: 'root',
     password: Cypress.env('SUPER_USER_PASSWORD')
-}
+};
 
 function isFormFile(script: FormFile | StringDictionary[]): script is FormFile {
     return Boolean((script as FormFile).fileContent || (script as FormFile).fileName);
 }
 
-export const runProvisioningScript = (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer: JahiaServer = serverDefaults, options: Cypress.Loggable = {log:true}, timeout?: number): void => {
-    const formData = new FormData()
+export const runProvisioningScript = (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer: JahiaServer = serverDefaults, options: Cypress.Loggable = {log: true}, timeout?: number): void => {
+    const formData = new FormData();
 
     if (isFormFile(script)) {
-        append(script, formData, "script")
+        append(script, formData, 'script');
     } else {
         append({
             fileContent: JSON.stringify(script),
             type: 'application/json'
-        }, formData, "script");
+        }, formData, 'script');
     }
 
     if (files) {
-        files.forEach((f) => {
-            append(f, formData, "file")
-        })
+        files.forEach(f => {
+            append(f, formData, 'file');
+        });
     }
 
-    let response: Cypress.Response<any>
-    let result: any
-    let logger: Cypress.Log
+    let response: Cypress.Response<any>;
+    let result: any;
+    let logger: Cypress.Log;
 
     if (options.log) {
         logger = Cypress.log({
@@ -100,9 +101,9 @@ export const runProvisioningScript = (script: FormFile | StringDictionary[], fil
                     Files: files,
                     Response: response,
                     Yielded: result
-                }
-            },
-        })
+                };
+            }
+        });
     }
 
     const request: Partial<RequestOptions> = {
@@ -111,28 +112,28 @@ export const runProvisioningScript = (script: FormFile | StringDictionary[], fil
         auth: {
             user: jahiaServer.username,
             pass: jahiaServer.password,
-            sendImmediately: true,
+            sendImmediately: true
         },
         body: formData,
         log: false
-    }
+    };
 
-    if(typeof timeout !== 'undefined'){
-        request.timeout = timeout
+    if (typeof timeout !== 'undefined') {
+        request.timeout = timeout;
     }
 
     cy.request(request).then(res => {
-        response = res
-        expect(res.status, 'Script result').to.eq(200)
+        response = res;
+        expect(res.status, 'Script result').to.eq(200);
         try {
-            const decoder = new TextDecoder()
-            result = JSON.parse(decoder.decode(response.body))
+            const decoder = new TextDecoder();
+            result = JSON.parse(decoder.decode(response.body));
         } catch (e) {
-            result = e
+            result = e;
         }
 
-        logger?.end()
-        return result
-    })
-}
+        logger?.end();
+        return result;
+    });
+};
 

package/src/support/registerSupport.ts

@@ -1,21 +1,21 @@
-import {apollo, apolloClient} from "./apollo"
-import {executeGroovy, runProvisioningScript, installBundle} from "./provisioning"
-import {login} from "./login"
-import {logout} from "./logout"
-import {fixture} from "./fixture";
-import {repeatUntil} from "./repeatUntil";
+import {apollo, apolloClient} from './apollo';
+import {executeGroovy, runProvisioningScript, installBundle} from './provisioning';
+import {login} from './login';
+import {logout} from './logout';
+import {fixture} from './fixture';
+import {repeatUntil} from './repeatUntil';
 
 export const registerSupport = (): void => {
-    Cypress.Commands.add('apolloClient', apolloClient)
-    Cypress.Commands.add('apollo', {prevSubject: 'optional'}, apollo)
+    Cypress.Commands.add('apolloClient', apolloClient);
+    Cypress.Commands.add('apollo', {prevSubject: 'optional'}, apollo);
 
-    Cypress.Commands.add('runProvisioningScript', runProvisioningScript)
-    Cypress.Commands.add('executeGroovy', executeGroovy)
-    Cypress.Commands.add('installBundle', installBundle)
+    Cypress.Commands.add('runProvisioningScript', runProvisioningScript);
+    Cypress.Commands.add('executeGroovy', executeGroovy);
+    Cypress.Commands.add('installBundle', installBundle);
 
-    Cypress.Commands.add('login', login)
-    Cypress.Commands.add('logout', logout)
-    Cypress.Commands.add('repeatUntil', repeatUntil)
+    Cypress.Commands.add('login', login);
+    Cypress.Commands.add('logout', logout);
+    Cypress.Commands.add('repeatUntil', repeatUntil);
 
-    Cypress.Commands.overwrite('fixture', fixture)
-}
+    Cypress.Commands.overwrite('fixture', fixture);
+};

package/src/support/repeatUntil.ts

@@ -11,9 +11,9 @@ export type RepeatUntilOptions = {
 
 const defaultOptions: RepeatUntilOptions = {
     attempts: 10,
-    callback: () => cy.reload({log:false}),
+    callback: () => cy.reload({log: false}),
     delay: 1000
-}
+};
 
 declare global {
     namespace Cypress {
@@ -25,35 +25,35 @@ declare global {
 }
 
 export const repeatUntil = (selector: string, options: Partial<RepeatUntilOptions> = {}): void => {
-    options = { ...defaultOptions, ...options }
+    options = {...defaultOptions, ...options};
 
     const log = Cypress.log({
         name: 'repeatUntil',
         message: `Reload until ${selector}, remaining attempts : ${options.attempts}`,
         consoleProps: () => {
             return {
-                attempts: options.attempts,
-            }
-        },
-    })
+                attempts: options.attempts
+            };
+        }
+    });
 
-    const items = Cypress.$(selector)
+    const items = Cypress.$(selector);
     if (items.length) {
-        log.set({ $el: items })
-        cy.wrap(items, {log: false})
-        return
+        log.set({$el: items});
+        cy.wrap(items, {log: false});
+        return;
     }
 
     if (options.attempts > 1) {
-        log.end()
-        options.callback()
+        log.end();
+        options.callback();
 
         // eslint-disable-next-line cypress/no-unnecessary-waiting
-        cy.wait(options.delay)
-        cy.repeatUntil(selector, {...options, attempts: options.attempts - 1})
+        cy.wait(options.delay);
+        cy.repeatUntil(selector, {...options, attempts: options.attempts - 1});
     } else {
-        const err = Error('Items not found.')
-        log.error(err)
-        throw err
+        const err = Error('Items not found.');
+        log.error(err);
+        throw err;
     }
-}
+};