@jahia/cypress 1.0.6 → 1.0.10

package/src/page-object/baseComponent.ts

@@ -3,6 +3,7 @@ import Chainable = Cypress.Chainable;
 export type ComponentType<Component> = { new(p: Chainable<JQuery>, assertion?: (s: JQuery) => void): Component, defaultSelector: string };
 
 export class BaseComponent {
+    static defaultSelector = ''
     static count = 0
 
     element: Chainable<JQuery>
@@ -22,4 +23,8 @@ export class BaseComponent {
 
         return cy.get('@component' + this.id, {log: false})
     }
+
+    should(arg, ...others) {
+        return cy.get('@component' + this.id, {log: false}).should(arg, ...others)
+    }
 }

package/src/page-object/moonstone/menu.ts

@@ -1,14 +1,18 @@
 import {BaseComponent} from "../baseComponent"
 
 export class Menu extends BaseComponent {
-    static defaultSelector = '.moonstone-menu'
+    static defaultSelector = '.moonstone-menu:visible'
 
     select(item: string): Menu {
+        // eslint-disable-next-line cypress/no-unnecessary-waiting
+        cy.wait(500)
         this.get().find(`.moonstone-menuItem`).should("contain", item).contains(item).trigger('click')
         return this
     }
 
     selectByRole(item: string): Menu {
+        // eslint-disable-next-line cypress/no-unnecessary-waiting
+        cy.wait(500)
         this.get().find(`.moonstone-menuItem[data-sel-role="${item}"]`).trigger('click')
         return this
     }

package/src/plugins/env.ts

@@ -1,8 +1,17 @@
 const env = (on:Cypress.PluginEvents, config: Cypress.PluginConfigOptions):Cypress.PluginConfigOptions => {
-    console.log('Setting env', process.env.JAHIA_URL)
-    config.baseUrl = process.env.JAHIA_URL
-    config.env.JAHIA_URL = process.env.JAHIA_URL
-    config.env.SUPER_USER_PASSWORD = process.env.SUPER_USER_PASSWORD
+    if (!process.env.JAHIA_URL && !process.env.SUPER_USER_PASSWORD) {
+        console.warn('No environment set, will use default values')
+        config.baseUrl = 'http://localhost:8080'
+        config.env.JAHIA_URL = 'http://localhost:8080'
+        config.env.SUPER_USER_PASSWORD = 'root1234'
+    } else {
+        console.log('Setting environment');
+        config.baseUrl = process.env.JAHIA_URL
+        config.env.JAHIA_URL = process.env.JAHIA_URL
+        config.env.SUPER_USER_PASSWORD = process.env.SUPER_USER_PASSWORD
+    }
+    console.log('JAHIA_URL =', config.env.JAHIA_URL)
+    console.log('SUPER_USER_PASSWORD =', config.env.SUPER_USER_PASSWORD)
 
     return config
 }

package/src/support/fixture.ts

@@ -6,7 +6,6 @@ export const fixture = function(originalCommand: ((...args: any[]) => any), fixt
         return originalCommand(fixture, ...args).then(f => {
             return f
         }).catch((err) => {
-            console.log(err)
             return null;
         });
     }).then(file => {
@@ -16,7 +15,11 @@ export const fixture = function(originalCommand: ((...args: any[]) => any), fixt
                 encoding = args[0]
             }
 
-            cy.readFile('./node_modules/@jahia/cypress/fixtures/' + fixture, encoding, {log:false, timeout:0})
+            try {
+                cy.readFile('./node_modules/@jahia/cypress/fixtures/' + fixture, encoding, {log: false, timeout: 0})
+            } catch (e) {
+                console.log(e)
+            }
         }
     })
 };

package/src/support/index.ts

@@ -2,3 +2,4 @@ export * from './apollo'
 export * from './provisioning'
 export * from './login'
 export * from './logout'
+export * from './repeatUntil'

package/src/support/provisioning/runProvisioningScript.ts

@@ -31,32 +31,28 @@ function processContent(formFile: FormFile) {
     return Cypress.Blob.binaryStringToBlob(content, formFile.type);
 }
 
-function getBlob(formFile: FormFile): Promise<Blob> {
-    return new Promise(resolve => {
-        if (formFile.fileContent) {
-            resolve(processContent(formFile))
-        } else {
-            cy.fixture(formFile.fileName, (formFile.encoding ? formFile.encoding : 'binary')).then(content => {
-                if (typeof content === 'object') {
-                    formFile.fileContent = JSON.stringify(content);
-                } else {
-                    formFile.fileContent = content;
-                }
-                resolve(processContent(formFile))
-            })
-        }
-    })
+function append(formFile: FormFile, formData: FormData, key: string) {
+    if (formFile.fileContent) {
+        formData.append(key, processContent(formFile), formFile.fileName);
+    } else {
+        cy.fixture(formFile.fileName, (formFile.encoding ? formFile.encoding : 'binary')).then(content => {
+            if (typeof content === 'object') {
+                formFile.fileContent = JSON.stringify(content);
+            } else {
+                formFile.fileContent = content;
+            }
+            formData.append(key, processContent(formFile), formFile.fileName);
+        })
+    }
 }
 
 export const runProvisioningScript = (script: FormFile, files?: FormFile[], options: Cypress.Loggable = {log:true}): void => {
     const formData = new FormData()
 
-    getBlob(script).then(blob => formData.append("script", blob))
+    append(script, formData, "script")
     if (files) {
         files.forEach((f) => {
-            getBlob(f).then(blob => {
-                formData.append("file", blob, f.fileName)
-            })
+            append(f, formData, "file")
         })
     }
 

package/src/support/registerSupport.ts

@@ -4,6 +4,7 @@ import {login} from "./login"
 import {logout} from "./logout"
 import installLogsCollector from 'cypress-terminal-report/src/installLogsCollector'
 import {fixture} from "./fixture";
+import {repeatUntil} from "./repeatUntil";
 
 export const registerSupport = (): void => {
     Cypress.Commands.add('apolloClient', apolloClient)
@@ -14,6 +15,7 @@ export const registerSupport = (): void => {
 
     Cypress.Commands.add('login', login)
     Cypress.Commands.add('logout', logout)
+    Cypress.Commands.add('repeatUntil', repeatUntil)
 
     Cypress.Commands.overwrite('fixture', fixture)
 

package/src/support/repeatUntil.md

@@ -0,0 +1,40 @@
+# repeatUntil
+
+This commands reload or repeat a function until an item is visible in the page
+
+## Syntax
+
+### Usage
+
+```
+cy.repeatUntil('div:contains("some text")')
+cy.repeatUntil('div:contains("some text")', {attempts: 10, reloadCallback: () => { cy.reload() }, delay: 1000})
+```
+
+### Arguments
+
+#### > selector (`string`)
+
+The selector that is being searched in the page
+
+#### > options (`RepeatUntilOptions`)
+
+- `attempts`: max number of attempts
+- `callback`: the callback to execute if the item is not found. By default, do a `cy.reload()`
+- `delay`: time to wait between each attemps (ms)
+
+### Yields
+
+The found element
+
+## Rules
+
+### Requirements
+
+- `cy.repeatUntil()` requires being chained off of `cy`.
+
+### Assertions
+
+### Timeouts
+
+## Command Log

package/src/support/repeatUntil.ts

@@ -0,0 +1,59 @@
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
+
+// Load type definitions that come with Cypress module
+/// <reference types="cypress" />
+
+type RepeatUntilOptions = {
+    attempts: number,
+    callback: () => void,
+    delay: number,
+}
+
+const defaultOptions: RepeatUntilOptions = {
+    attempts: 10,
+    callback: () => cy.reload({log:false}),
+    delay: 1000
+}
+
+declare global {
+    namespace Cypress {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        interface Chainable<Subject> {
+            repeatUntil(selector: string, options?: Partial<RepeatUntilOptions>): Chainable<JQuery>
+        }
+    }
+}
+
+export const repeatUntil = (selector: string, options: Partial<RepeatUntilOptions> = {}): void => {
+    options = { ...defaultOptions, ...options }
+
+    const log = Cypress.log({
+        name: 'repeatUntil',
+        message: `Reload until ${selector}, remaining attempts : ${options.attempts}`,
+        consoleProps: () => {
+            return {
+                attempts: options.attempts,
+            }
+        },
+    })
+
+    const items = Cypress.$(selector)
+    if (items.length) {
+        log.set({ $el: items })
+        cy.wrap(items, {log: false})
+        return
+    }
+
+    if (options.attempts > 1) {
+        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 {
+        const err = Error('Items not found.')
+        log.error(err)
+        throw err
+    }
+}