@jahia/cypress 1.0.8 → 1.1.0

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/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/executeGroovy.md

@@ -10,6 +10,7 @@ This commands execute a groovy script from fixtures folder
 
 ```
 cy.executeGroovy('script.groovy')
+cy.executeGroovy('script.groovy', null, {url: 'http://jahia-processing.jahia.net:8080', username: 'root', password: 'root1234'})
 ```
 
 ### Arguments
@@ -18,6 +19,14 @@ cy.executeGroovy('script.groovy')
 
 The name of the script file, in fixtures folder
 
+#### > jahiaServer (`JahiaServer`)
+
+A Jahia server can be specified if there is a need to use something other than default. This is useful when using Jahia in cluster, if there is a need to redirect a provisioning script to a specific Jahia server (for example a processig node).
+
+- url: (`string`) : The url of the server (for example: http://processing.jahia.net:8080)
+- username: (`string`) : Root user
+- password: (`string`) : Password for the root user
+
 ### Yields
 
 The groovy script result (set with `setResult()` within groovy code)

package/src/support/provisioning/executeGroovy.ts

@@ -9,12 +9,24 @@ declare global {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         interface Chainable<Subject> {
-            executeGroovy(scriptFile: string, replacements?: { [key: string]: string }): Chainable<any>
+            executeGroovy(scriptFile: string, replacements?: { [key: string]: string }, jahiaServer?: JahiaServer): Chainable<any>
         }
     }
 }
 
-export const executeGroovy = function (scriptFile: string, replacements?: { [key: string]: string }): void {
+type JahiaServer = {
+    url: string;
+    username: string;
+    password: string
+}
+
+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({
         fileContent: '- executeScript: "' + scriptFile + '"',
         type: 'application/yaml'
@@ -22,5 +34,5 @@ export const executeGroovy = function (scriptFile: string, replacements?: { [key
         fileName: scriptFile,
         replacements,
         type: 'text/plain'
-    }]).then(r => r[0])
+    }], jahiaServer).then(r => r[0])
 }

package/src/support/provisioning/runProvisioningScript.md

@@ -12,6 +12,7 @@ This commands execute a provisioning script
 cy.runProvisioningScript({fileName:'prov.yaml', type:'application/yaml'})
 cy.runProvisioningScript({fileName:'prov.yaml', type:'application/yaml'}, [{fileName: 'file1.zip'}])
 cy.runProvisioningScript({fileContent:'- startBundle: "module"', type:'application/yaml'})
+cy.runProvisioningScript({fileContent:'- startBundle: "module"', type:'application/yaml'}, null, {url: 'http://jahia-processing.jahia.net:8080', username: 'root', password: 'root1234'})
 ```
 
 ### Arguments
@@ -24,6 +25,14 @@ The script can be specified either from an external file (using fileName) or inl
 - fileContent: (`string`) : The content of the script. If specified, fileName is ignored.
 - type: (`string`) : Content type, either `application/yaml` or `application/json`
 
+#### > jahiaServer (`JahiaServer`)
+
+A Jahia server can be specified if there is a need to use something other than default. This is useful when using Jahia in cluster, if there is a need to redirect a provisioning script to a specific Jahia server (for example a processig node).
+
+- url: (`string`) : The url of the server (for example: http://processing.jahia.net:8080)
+- username: (`string`) : Root user
+- password: (`string`) : Password for the root user
+
 #### > files (`FormFile[]`)
 
 Additional files that can be referenced in the script. When an operation requires a URL, directly specify the file name (without protocol) to use one these files

package/src/support/provisioning/runProvisioningScript.ts

@@ -9,7 +9,7 @@ declare global {
     namespace Cypress {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         interface Chainable<Subject> {
-            runProvisioningScript(script: FormFile, files?: FormFile[]): Chainable<any>
+            runProvisioningScript(script: FormFile, files?: FormFile[], jahiaServer?: JahiaServer): Chainable<any>
         }
     }
 }
@@ -22,6 +22,12 @@ type FormFile = {
     replacements?: { [key: string]: string }
 }
 
+type JahiaServer = {
+    url: string;
+    username: string;
+    password: string
+}
+
 function processContent(formFile: FormFile) {
     let content = formFile.fileContent;
     if (formFile.replacements) {
@@ -46,7 +52,13 @@ function append(formFile: FormFile, formData: FormData, key: string) {
     }
 }
 
-export const runProvisioningScript = (script: FormFile, files?: FormFile[], options: Cypress.Loggable = {log:true}): void => {
+const serverDefaults: JahiaServer = {
+    url: Cypress.config().baseUrl,
+    username: 'root',
+    password: Cypress.env('SUPER_USER_PASSWORD')
+}
+
+export const runProvisioningScript = (script: FormFile, files?: FormFile[], jahiaServer: JahiaServer = serverDefaults, options: Cypress.Loggable = {log:true}): void => {
     const formData = new FormData()
 
     append(script, formData, "script")
@@ -78,11 +90,11 @@ export const runProvisioningScript = (script: FormFile, files?: FormFile[], opti
     }
 
     cy.request({
-        url: `${Cypress.config().baseUrl}/modules/api/provisioning`,
+        url: `${jahiaServer.url}/modules/api/provisioning`,
         method: 'POST',
         auth: {
-            user: 'root',
-            pass: Cypress.env('SUPER_USER_PASSWORD'),
+            user: jahiaServer.username,
+            pass: jahiaServer.password,
             sendImmediately: true,
         },
         body: formData,

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
+    }
+}

package/.idea/jahia-cypress.iml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/jahia-cypress.iml" filepath="$PROJECT_DIR$/.idea/jahia-cypress.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/sonarlint/issuestore/8/9/8995cd54601f633e8bca96b4e0b06ae4272afe02

@@ -1,3 +0,0 @@
-
-Otypescript:S1117".'args' is already declared in the upper scope.(��������

-Rtypescript:S1117"1'fixture' is already declared in the upper scope.(��������

package/.idea/sonarlint/issuestore/index.pb

@@ -1,3 +0,0 @@
-
-F
-src/support/fixture.ts,8/9/8995cd54601f633e8bca96b4e0b06ae4272afe02

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

package/dist/page-object/iframe.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="cypress" />
-import { BaseComponent } from "./baseComponent";
-import Chainable = Cypress.Chainable;
-export declare class IFrame extends BaseComponent {
-    static defaultSelector: string;
-    private body;
-    constructor(element: Chainable<JQuery>, assertion?: (s: JQuery) => void);
-    getBody(): Chainable<JQuery>;
-    enter(): void;
-}

package/dist/page-object/iframe.js

@@ -1,46 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-exports.__esModule = true;
-exports.IFrame = void 0;
-var baseComponent_1 = require("./baseComponent");
-var IFrame = /** @class */ (function (_super) {
-    __extends(IFrame, _super);
-    function IFrame(element, assertion) {
-        var _this = _super.call(this, element, assertion) || this;
-        _this.get()
-            .should(function (f) {
-            var fr = f[0];
-            expect(fr.contentWindow.location.href).not.equals('about:blank');
-            expect(fr.contentWindow.document.readyState).equals('complete');
-            expect(fr.contentDocument.body).not.be.empty;
-        })
-            .its('0.contentDocument.body').as('framebody' + _this.id);
-        return _this;
-    }
-    IFrame.prototype.getBody = function () {
-        return cy.get('@framebody' + this.id);
-    };
-    IFrame.prototype.enter = function () {
-        this.get().then(function (f) {
-            var fr = f[0];
-            cy.visit(fr.contentWindow.location.href);
-        });
-    };
-    IFrame.defaultSelector = 'iframe';
-    return IFrame;
-}(baseComponent_1.BaseComponent));
-exports.IFrame = IFrame;

package/dist/page-object/moonstone/muiinput.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="cypress" />
-import { BaseComponent } from "../baseComponent";
-import TypeOptions = Cypress.TypeOptions;
-export declare class MUIInput extends BaseComponent {
-    static defaultSelector: string;
-    clear(): MUIInput;
-    type(text: string, options?: Partial<TypeOptions>): MUIInput;
-}

package/dist/page-object/moonstone/muiinput.js

@@ -1,36 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-exports.__esModule = true;
-exports.MUIInput = void 0;
-var baseComponent_1 = require("../baseComponent");
-var MUIInput = /** @class */ (function (_super) {
-    __extends(MUIInput, _super);
-    function MUIInput() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    MUIInput.prototype.clear = function () {
-        this.get().clear();
-        return this;
-    };
-    MUIInput.prototype.type = function (text, options) {
-        this.get().type(text, options);
-        return this;
-    };
-    MUIInput.defaultSelector = 'div';
-    return MUIInput;
-}(baseComponent_1.BaseComponent));
-exports.MUIInput = MUIInput;

package/dist/page-object/moonstone/muiradio.d.ts

@@ -1,5 +0,0 @@
-import { BaseComponent } from "../baseComponent";
-export declare class MUIRadio extends BaseComponent {
-    static defaultSelector: string;
-    click(): MUIRadio;
-}

package/dist/page-object/moonstone/muiradio.js

@@ -1,32 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-exports.__esModule = true;
-exports.MUIRadio = void 0;
-var baseComponent_1 = require("../baseComponent");
-var MUIRadio = /** @class */ (function (_super) {
-    __extends(MUIRadio, _super);
-    function MUIRadio() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    MUIRadio.prototype.click = function () {
-        this.get().click();
-        return this;
-    };
-    MUIRadio.defaultSelector = 'label';
-    return MUIRadio;
-}(baseComponent_1.BaseComponent));
-exports.MUIRadio = MUIRadio;

package/yalc.lock

@@ -1,9 +0,0 @@
-{
-  "version": "v1",
-  "packages": {
-    "@jahia/cypress": {
-      "signature": "1028ca2fa2d0700a1ab74a8ede774e57",
-      "file": true
-    }
-  }
-}