@jahia/cypress 1.0.10 → 1.1.2

package/.github/workflows/npm_publish.yml

@@ -0,0 +1,18 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPMJS_TOKEN }}

package/.idea/runConfigurations.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="RunConfigurationProducerService">
+    <option name="ignoredProducers">
+      <set>
+        <option value="com.android.tools.idea.compose.preview.runconfiguration.ComposePreviewRunConfigurationProducer" />
+      </set>
+    </option>
+  </component>
+</project>

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

@@ -7,12 +7,11 @@ declare global {
         }
     }
 }
-declare type FileQueryOptions = Partial<QueryOptions> & {
+export declare type FileQueryOptions = Partial<QueryOptions> & {
     queryFile?: string;
 };
-declare type FileMutationOptions = Partial<MutationOptions> & {
+export declare type FileMutationOptions = Partial<MutationOptions> & {
     mutationFile?: string;
 };
-declare type ApolloOptions = (QueryOptions | MutationOptions | FileQueryOptions | FileMutationOptions) & Partial<Cypress.Loggable>;
+export declare type ApolloOptions = (QueryOptions | MutationOptions | FileQueryOptions | FileMutationOptions) & Partial<Cypress.Loggable>;
 export declare const apollo: (apollo: ApolloClient<any>, options: ApolloOptions) => void;
-export {};

package/dist/support/provisioning/executeGroovy.d.ts

@@ -3,10 +3,16 @@ declare global {
         interface Chainable<Subject> {
             executeGroovy(scriptFile: string, replacements?: {
                 [key: string]: string;
-            }): Chainable<any>;
+            }, jahiaServer?: JahiaServer): Chainable<any>;
         }
     }
 }
+declare type JahiaServer = {
+    url: string;
+    username: string;
+    password: string;
+};
 export declare const executeGroovy: (scriptFile: string, replacements?: {
     [key: string]: string;
-}) => void;
+}, jahiaServer?: JahiaServer) => void;
+export {};

package/dist/support/provisioning/executeGroovy.js

@@ -3,7 +3,13 @@
 exports.__esModule = true;
 exports.executeGroovy = void 0;
 /// <reference types="cypress" />
-var executeGroovy = function (scriptFile, replacements) {
+var serverDefaults = {
+    url: Cypress.config().baseUrl,
+    username: 'root',
+    password: Cypress.env('SUPER_USER_PASSWORD')
+};
+var executeGroovy = function (scriptFile, replacements, jahiaServer) {
+    if (jahiaServer === void 0) { jahiaServer = serverDefaults; }
     cy.runProvisioningScript({
         fileContent: '- executeScript: "' + scriptFile + '"',
         type: 'application/yaml'
@@ -11,6 +17,6 @@ var executeGroovy = function (scriptFile, replacements) {
             fileName: scriptFile,
             replacements: replacements,
             type: 'text/plain'
-        }]).then(function (r) { return r[0]; });
+        }], jahiaServer).then(function (r) { return r[0]; });
 };
 exports.executeGroovy = executeGroovy;

package/dist/support/provisioning/index.d.ts

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

package/dist/support/provisioning/index.js

@@ -12,3 +12,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 exports.__esModule = true;
 __exportStar(require("./executeGroovy"), exports);
 __exportStar(require("./runProvisioningScript"), exports);
+__exportStar(require("./installBundle"), exports);

package/dist/support/provisioning/installBundle.js

@@ -4,10 +4,7 @@ exports.__esModule = true;
 exports.installBundle = void 0;
 /// <reference types="cypress" />
 var installBundle = function (bundleFile) {
-    cy.runProvisioningScript({
-        fileContent: '- installBundle: "' + bundleFile + '"',
-        type: 'application/yaml'
-    }, [{
+    cy.runProvisioningScript([{ installBundle: bundleFile }], [{
             fileName: bundleFile,
             type: 'text/plain'
         }]);

package/dist/support/provisioning/runProvisioningScript.d.ts

@@ -2,18 +2,23 @@
 declare global {
     namespace Cypress {
         interface Chainable<Subject> {
-            runProvisioningScript(script: FormFile, files?: FormFile[]): Chainable<any>;
+            runProvisioningScript(script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer): Chainable<any>;
         }
     }
 }
-declare type FormFile = {
+export declare type StringDictionary = {
+    [key: string]: string;
+};
+export declare type FormFile = {
     fileName?: string;
     fileContent?: string;
     type?: string;
     encoding?: Cypress.Encodings;
-    replacements?: {
-        [key: string]: string;
-    };
+    replacements?: StringDictionary;
+};
+export declare type JahiaServer = {
+    url: string;
+    username: string;
+    password: string;
 };
-export declare const runProvisioningScript: (script: FormFile, files?: FormFile[], options?: Cypress.Loggable) => void;
-export {};
+export declare const runProvisioningScript: (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer, options?: Cypress.Loggable) => void;

package/dist/support/provisioning/runProvisioningScript.js

@@ -15,7 +15,7 @@ function append(formFile, formData, key) {
     if (formFile.fileContent) {
         formData.append(key, processContent(formFile), formFile.fileName);
     }
-    else {
+    else if (formFile.fileName) {
         cy.fixture(formFile.fileName, (formFile.encoding ? formFile.encoding : 'binary')).then(function (content) {
             if (typeof content === 'object') {
                 formFile.fileContent = JSON.stringify(content);
@@ -27,10 +27,27 @@ function append(formFile, formData, key) {
         });
     }
 }
-var runProvisioningScript = function (script, files, options) {
+var serverDefaults = {
+    url: Cypress.config().baseUrl,
+    username: 'root',
+    password: Cypress.env('SUPER_USER_PASSWORD')
+};
+function isFormFile(script) {
+    return Boolean(script.fileContent || script.fileName);
+}
+var runProvisioningScript = function (script, files, jahiaServer, options) {
+    if (jahiaServer === void 0) { jahiaServer = serverDefaults; }
     if (options === void 0) { options = { log: true }; }
     var formData = new FormData();
-    append(script, formData, "script");
+    if (isFormFile(script)) {
+        append(script, formData, "script");
+    }
+    else {
+        append({
+            fileContent: JSON.stringify(script),
+            type: 'application/json'
+        }, formData, "script");
+    }
     if (files) {
         files.forEach(function (f) {
             append(f, formData, "file");
@@ -44,7 +61,7 @@ var runProvisioningScript = function (script, files, options) {
             autoEnd: false,
             name: 'runProvisioningScript',
             displayName: 'provScript',
-            message: "Run " + (script.fileName ? script.fileName : 'inline script'),
+            message: "Run " + (isFormFile(script) && script.fileName ? script.fileName : 'inline script') + " towards server: " + jahiaServer.url,
             consoleProps: function () {
                 return {
                     Script: script,
@@ -56,11 +73,11 @@ var runProvisioningScript = function (script, files, options) {
         });
     }
     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/dist/support/registerSupport.js

@@ -16,6 +16,7 @@ var registerSupport = function () {
     Cypress.Commands.add('apollo', { prevSubject: 'optional' }, apollo_1.apollo);
     Cypress.Commands.add('runProvisioningScript', provisioning_1.runProvisioningScript);
     Cypress.Commands.add('executeGroovy', provisioning_1.executeGroovy);
+    Cypress.Commands.add('installBundle', provisioning_1.installBundle);
     Cypress.Commands.add('login', login_1.login);
     Cypress.Commands.add('logout', logout_1.logout);
     Cypress.Commands.add('repeatUntil', repeatUntil_1.repeatUntil);

package/dist/support/repeatUntil.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="cypress" />
-declare type RepeatUntilOptions = {
+export declare type RepeatUntilOptions = {
     attempts: number;
     callback: () => void;
     delay: number;
@@ -12,4 +12,3 @@ declare global {
     }
 }
 export declare const repeatUntil: (selector: string, options?: Partial<RepeatUntilOptions>) => void;
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/cypress",
-  "version": "1.0.10",
+  "version": "1.1.2",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts"
@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "@apollo/client": "^3.4.9",
-    "cypress-terminal-report": "^3.3.2",
+    "cypress-terminal-report": "^3.4.2",
     "graphql": "^15.5.0",
     "graphql-tag": "^2.11.0"
   }

package/src/support/apollo/apollo.ts

@@ -15,9 +15,9 @@ declare global {
     }
 }
 
-type FileQueryOptions = Partial<QueryOptions> & { queryFile?: string }
-type FileMutationOptions = Partial<MutationOptions> & { mutationFile?: string }
-type ApolloOptions = (QueryOptions | MutationOptions | FileQueryOptions | FileMutationOptions) & Partial<Cypress.Loggable>;
+export type FileQueryOptions = Partial<QueryOptions> & { queryFile?: string }
+export type FileMutationOptions = Partial<MutationOptions> & { mutationFile?: string }
+export type ApolloOptions = (QueryOptions | MutationOptions | FileQueryOptions | FileMutationOptions) & Partial<Cypress.Loggable>;
 
 function isQuery(options: ApolloOptions): options is QueryOptions {
     return (<QueryOptions>options).query !== undefined;

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/index.ts

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

package/src/support/provisioning/installBundle.ts

@@ -15,11 +15,8 @@ declare global {
 }
 
 export const installBundle = function (bundleFile: string): void {
-    cy.runProvisioningScript({
-        fileContent: '- installBundle: "' + bundleFile + '"',
-        type: 'application/yaml'
-    }, [{
+    cy.runProvisioningScript([{ installBundle: bundleFile }], [{
         fileName: bundleFile,
         type: 'text/plain'
     }])
-}
+}

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,17 +9,25 @@ 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 | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer): Chainable<any>
         }
     }
 }
 
-type FormFile = {
+export type StringDictionary = { [key: string]: string }
+
+export type FormFile = {
     fileName?: string,
     fileContent?: string,
     type?: string,
     encoding?: Cypress.Encodings
-    replacements?: { [key: string]: string }
+    replacements?: StringDictionary
+}
+
+export type JahiaServer = {
+    url: string;
+    username: string;
+    password: string
 }
 
 function processContent(formFile: FormFile) {
@@ -34,7 +42,7 @@ function processContent(formFile: FormFile) {
 function append(formFile: FormFile, formData: FormData, key: string) {
     if (formFile.fileContent) {
         formData.append(key, processContent(formFile), formFile.fileName);
-    } else {
+    } else if (formFile.fileName) {
         cy.fixture(formFile.fileName, (formFile.encoding ? formFile.encoding : 'binary')).then(content => {
             if (typeof content === 'object') {
                 formFile.fileContent = JSON.stringify(content);
@@ -46,10 +54,28 @@ 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')
+}
+
+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}): void => {
     const formData = new FormData()
 
-    append(script, formData, "script")
+    if (isFormFile(script)) {
+        append(script, formData, "script")
+    } else {
+        append({
+            fileContent: JSON.stringify(script),
+            type: 'application/json'
+        }, formData, "script");
+    }
+
     if (files) {
         files.forEach((f) => {
             append(f, formData, "file")
@@ -65,7 +91,7 @@ export const runProvisioningScript = (script: FormFile, files?: FormFile[], opti
             autoEnd: false,
             name: 'runProvisioningScript',
             displayName: 'provScript',
-            message: `Run ${script.fileName ? script.fileName : 'inline script'}`,
+            message: `Run ${isFormFile(script) && script.fileName ? script.fileName : 'inline script'} towards server: ${jahiaServer.url}`,
             consoleProps: () => {
                 return {
                     Script: script,
@@ -78,11 +104,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

@@ -1,5 +1,5 @@
 import {apollo, apolloClient} from "./apollo"
-import {executeGroovy, runProvisioningScript} from "./provisioning"
+import {executeGroovy, runProvisioningScript, installBundle} from "./provisioning"
 import {login} from "./login"
 import {logout} from "./logout"
 import installLogsCollector from 'cypress-terminal-report/src/installLogsCollector'
@@ -12,6 +12,7 @@ export const registerSupport = (): void => {
 
     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)
@@ -20,4 +21,4 @@ export const registerSupport = (): void => {
     Cypress.Commands.overwrite('fixture', fixture)
 
     installLogsCollector()
-}
+}

package/src/support/repeatUntil.ts

@@ -3,7 +3,7 @@
 // Load type definitions that come with Cypress module
 /// <reference types="cypress" />
 
-type RepeatUntilOptions = {
+export type RepeatUntilOptions = {
     attempts: number,
     callback: () => void,
     delay: number,