@jahia/cypress 4.4.0 → 5.1.0

package/dist/support/provisioning/executeGroovy.js

@@ -11,12 +11,16 @@ var serverDefaults = {
 var executeGroovy = function (scriptFile, replacements, jahiaServer) {
     if (jahiaServer === void 0) { jahiaServer = serverDefaults; }
     cy.runProvisioningScript({
-        fileContent: '- executeScript: "' + scriptFile + '"',
-        type: 'application/yaml'
-    }, [{
-            fileName: scriptFile,
-            replacements: replacements,
-            type: 'text/plain'
-        }], jahiaServer).then(function (r) { return r[0]; });
+        script: {
+            fileContent: '- executeScript: "' + scriptFile + '"',
+            type: 'application/yaml'
+        },
+        files: [{
+                fileName: scriptFile,
+                replacements: replacements,
+                type: 'text/plain'
+            }],
+        jahiaServer: jahiaServer
+    }).then(function (r) { return r[0]; });
 };
 exports.executeGroovy = executeGroovy;

package/dist/support/provisioning/installBundle.js

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

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

@@ -3,10 +3,18 @@ import RequestOptions = Cypress.RequestOptions;
 declare global {
     namespace Cypress {
         interface Chainable<Subject> {
-            runProvisioningScript(script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer): Chainable<any>;
+            runProvisioningScript(params: RunProvisioningScriptParams): Chainable<void>;
         }
     }
 }
+export interface RunProvisioningScriptParams {
+    script: FormFile | StringDictionary[];
+    files?: FormFile[];
+    /** Optional, defaults to serverDefaults */
+    jahiaServer?: JahiaServer;
+    options?: Cypress.Loggable;
+    requestOptions?: Partial<RequestOptions>;
+}
 export declare type StringDictionary = {
     [key: string]: string;
 };
@@ -22,4 +30,4 @@ export declare type JahiaServer = {
     username: string;
     password: string;
 };
-export declare const runProvisioningScript: (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer, options?: Cypress.Loggable, timeout?: number, requestOptions?: Partial<RequestOptions>) => void;
+export declare const runProvisioningScript: ({ script, files, jahiaServer, options, requestOptions }: RunProvisioningScriptParams) => void;

package/dist/support/provisioning/runProvisioningScript.js

@@ -46,11 +46,8 @@ var serverDefaults = {
 function isFormFile(script) {
     return Boolean(script.fileContent || script.fileName);
 }
-// eslint-disable-next-line default-param-last, max-params
-var runProvisioningScript = function (script, files, jahiaServer, options, timeout, requestOptions) {
-    if (jahiaServer === void 0) { jahiaServer = serverDefaults; }
-    if (options === void 0) { options = { log: true }; }
-    if (requestOptions === void 0) { requestOptions = {}; }
+var runProvisioningScript = function (_a) {
+    var script = _a.script, files = _a.files, _b = _a.jahiaServer, jahiaServer = _b === void 0 ? serverDefaults : _b, _c = _a.options, options = _c === void 0 ? { log: true } : _c, _d = _a.requestOptions, requestOptions = _d === void 0 ? {} : _d;
     var formData = new FormData();
     if (isFormFile(script)) {
         append(script, formData, 'script');
@@ -92,18 +89,20 @@ var runProvisioningScript = function (script, files, jahiaServer, options, timeo
             pass: jahiaServer.password,
             sendImmediately: true
         }, body: formData, log: false }, requestOptions);
-    if (typeof timeout !== 'undefined') {
-        request.timeout = timeout;
-    }
     cy.request(request).then(function (res) {
         response = res;
-        expect(res.status, 'Script result').to.eq(200);
-        try {
-            var decoder = new TextDecoder();
-            result = JSON.parse(decoder.decode(response.body));
+        // If the response status is 200, decode the response, otherwise return the response as is
+        if (res.status === 200) {
+            try {
+                var decoder = new TextDecoder();
+                result = JSON.parse(decoder.decode(response.body));
+            }
+            catch (e) {
+                result = e;
+            }
         }
-        catch (e) {
-            result = e;
+        else {
+            result = res;
         }
         logger === null || logger === void 0 ? void 0 : logger.end();
         return result;

package/dist/support/provisioning/uninstallBundle.js

@@ -5,8 +5,10 @@ exports.uninstallBundle = void 0;
 /// <reference types="cypress" />
 var uninstallBundle = function (bundleSymbolicName) {
     cy.runProvisioningScript({
-        fileContent: '- uninstallBundle: "' + bundleSymbolicName + '"\n',
-        type: 'application/yaml'
+        script: {
+            fileContent: '- uninstallBundle: "' + bundleSymbolicName + '"\n',
+            type: 'application/yaml'
+        }
     });
 };
 exports.uninstallBundle = uninstallBundle;

package/dist/utils/SiteHelper.js

@@ -21,9 +21,12 @@ var deleteSite = function (siteKey, jahiaServer) {
 exports.deleteSite = deleteSite;
 var enableModule = function (moduleName, siteKey, jahiaServer) {
     cy.runProvisioningScript({
-        fileContent: '- enable: "' + moduleName + '"\n  site: "' + siteKey + '"',
-        type: 'application/yaml'
-    }, undefined, jahiaServer);
+        script: {
+            fileContent: '- enable: "' + moduleName + '"\n  site: "' + siteKey + '"',
+            type: 'application/yaml'
+        },
+        jahiaServer: jahiaServer
+    });
 };
 exports.enableModule = enableModule;
 var disableModule = function (moduleName, siteKey) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/cypress",
-  "version": "4.4.0",
+  "version": "5.1.0",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts --max-warnings=0"

package/src/support/provisioning/executeGroovy.ts

@@ -26,11 +26,15 @@ const serverDefaults = {
 
 export const executeGroovy = function (scriptFile: string, replacements?: { [key: string]: string }, jahiaServer: JahiaServer = serverDefaults): void {
     cy.runProvisioningScript({
-        fileContent: '- executeScript: "' + scriptFile + '"',
-        type: 'application/yaml'
-    }, [{
-        fileName: scriptFile,
-        replacements,
-        type: 'text/plain'
-    }], jahiaServer).then(r => r[0]);
+        script: {
+            fileContent: '- executeScript: "' + scriptFile + '"',
+            type: 'application/yaml'
+        },
+        files: [{
+            fileName: scriptFile,
+            replacements,
+            type: 'text/plain'
+        }],
+        jahiaServer
+    }).then(r => r[0]);
 };

package/src/support/provisioning/installBundle.ts

@@ -13,8 +13,11 @@ declare global {
 }
 
 export const installBundle = function (bundleFile: string): void {
-    cy.runProvisioningScript([{installBundle: bundleFile}], [{
-        fileName: bundleFile,
-        type: 'text/plain'
-    }]);
+    cy.runProvisioningScript({
+        script: [{installBundle: bundleFile}],
+        files: [{
+            fileName: bundleFile,
+            type: 'text/plain'
+        }]
+    });
 };

package/src/support/provisioning/runProvisioningScript.md

@@ -1,101 +1,123 @@
 # runProvisioningScript
 
-This commands execute a provisioning script
+This command executes a provisioning script.
 
-> This can be used to install modules, import sites, execute groovy/graphql/sql script with the help of the provisioning REST API
+> This can be used to install modules, import sites, execute Groovy/GraphQL/SQL scripts with the help of the provisioning REST API.
 
 ## Syntax
 
 ### Usage
 
-```
-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'})
+```javascript
+cy.runProvisioningScript({
+    script: { fileName: 'prov.yaml', type: 'application/yaml' }
+});
+
+cy.runProvisioningScript({
+    script: { fileName: 'prov.yaml', type: 'application/yaml' },
+    files: [{ fileName: 'file1.zip' }]
+});
+
+cy.runProvisioningScript({
+    script: { fileContent: '- startBundle: "module"', type: 'application/yaml' }
+});
+
+cy.runProvisioningScript({
+    script: { fileContent: '- startBundle: "module"', type: 'application/yaml' },
+    jahiaServer: { url: 'http://jahia-processing.jahia.net:8080', username: 'root', password: 'root1234' }
+});
 ```
 
 ### Arguments
 
-#### > script (`FormFile`)
+#### `script` (`FormFile`)
 
-The script can be specified either from an external file (using fileName) or inline (using fileContent)
+The script can be specified either from an external file (using `fileName`) or inline (using `fileContent`).
 
-- fileName: (`string`) : The name of the script file, in fixtures folder
-- fileContent: (`string`) : The content of the script. If specified, fileName is ignored.
-- type: (`string`) : Content type, either `application/yaml` or `application/json`
+- **fileName**: (`string`) - The name of the script file, located in the `fixtures` folder.
+- **fileContent**: (`string`) - The content of the script. If specified, `fileName` is ignored.
+- **type**: (`string`) - Content type, either `application/yaml` or `application/json`.
 
-#### > jahiaServer (`JahiaServer`)
+#### `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).
+A Jahia server can be specified if there is a need to use something other than the default. This is useful when using Jahia in a cluster, or if there is a need to redirect a provisioning script to a specific Jahia server (e.g., a processing 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
+- **url**: (`string`) - The URL of the server (e.g., `http://processing.jahia.net:8080`).
+- **username**: (`string`) - The root username.
+- **password**: (`string`) - The password for the root user.
 
-#### > files (`FormFile[]`)
+#### `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
+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 of these files.
 
-- fileName: (`string`) : The name of the file, in fixtures folder
-- fileContent: (`string`) : The content of the file. If specified, fileName is ignored.
-- type: (`string`) : Content type
+- **fileName**: (`string`) - The name of the file, located in the `fixtures` folder.
+- **fileContent**: (`string`) - The content of the file. If specified, `fileName` is ignored.
+- **type**: (`string`) - The content type of the file.
 
-#### > options (`Loggable`)
+#### `options` (`Cypress.Loggable`)
 
-- `log` : should the command be logged or not
+Options for the Cypress command.
 
-#### > timeout (`number`)
+- **log**: (`boolean`) - Indicates whether the command should be logged or not.
 
-the timeout in milliseconds
+#### `requestOptions` (`RequestOptions`)
 
-#### > requestOptions (`RequestOptions`)
+Additional options for the Cypress request object. Some useful ones include:
 
-Addition options for the cypress request object, some useful ones are:
-- `failOnStatusCode` : useful when you expect a 4xx or 5xx error and need to test it
+- **failOnStatusCode**: (`boolean`) - Useful when you expect a 4xx or 5xx error and need to test it.
+- **timeout**: (`number`) - Useful when you need control over the timeout of the request.
 
 ### Yields
 
-The provisioning script result, as JSON object
+The provisioning script result, as a JSON object.
 
 ## Examples
 
-### Execute a script
+### Execute a Script
 
-Will run the script in `fixtures/provisioning/test.yaml` :
+Will run the script in `fixtures/provisioning/test.yaml`:
 
-```
-cy.runProvisioningScript({fileName:'provisioning/test.yaml', type:'application/yaml'})
+```javascript
+cy.runProvisioningScript({
+    script: { fileName: 'provisioning/test.yaml', type: 'application/yaml' }
+});
 ```
 
-### Inline script with additional file
+### Inline Script with Additional File
 
-Will install the bundle in `fixtures/bundle.jar` :
+Will install the bundle in `fixtures/bundle.jar`:
 
-```
-cy.runProvisioningScript(
-    {fileContent: '- installBundle: "bundle.jar"',type: 'application/yaml'}, 
-    [
-        { fileName: "bundle.jar", type: 'application/java-archive' }
+```javascript
+cy.runProvisioningScript({
+    script: { fileContent: '- installBundle: "bundle.jar"', type: 'application/yaml' },
+    files: [
+        { fileName: 'bundle.jar', type: 'application/java-archive' }
     ]
-)
+});
 ```
 
-## Rules
+### Use a Custom Jahia Server
 
-### Requirements
+Will run the script on a specific Jahia server:
+
+```javascript
+cy.runProvisioningScript({
+    script: { fileName: 'prov.yaml', type: 'application/yaml' },
+    jahiaServer: { url: 'http://custom-server.jahia.net:8080', username: 'admin', password: 'admin123' }
+});
+```
 
-- `cy.useProvisioningScript()` requires being chained off of `cy`.
+## Rules
 
-### Assertions
+### Requirements
 
-### Timeouts
+- `cy.runProvisioningScript()` must be chained off of `cy`.
 
 ## Command Log
 
-When clicking on `provScript` within the command log, the console outputs the following:
+When clicking on `runProvisioningScript` within the command log, the console outputs the following:
 
-- `Script`: the name and content of the script sent
-- `Files`: the name and content of every additional files sent
-- `Response`: the response from the REST call
-- `Yielded`: the JSON result yielded
+- **Script**: The name and content of the script sent.
+- **Files**: The name and content of every additional file sent.
+- **Response**: The response from the REST call.
+- **Yielded**: The JSON result yielded.

package/src/support/provisioning/runProvisioningScript.ts

@@ -8,12 +8,20 @@ declare global {
     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>
+            runProvisioningScript(params: RunProvisioningScriptParams): Chainable<void>;
         }
     }
 }
 
+export interface RunProvisioningScriptParams {
+    script: FormFile | StringDictionary[];
+    files?: FormFile[];
+    /** Optional, defaults to serverDefaults */
+    jahiaServer?: JahiaServer;
+    options?: Cypress.Loggable; // Optional, defaults to { log: true }
+    requestOptions?: Partial<RequestOptions>; // Optional, defaults to {}
+}
+
 export type StringDictionary = { [key: string]: string }
 
 export type FormFile = {
@@ -68,8 +76,13 @@ 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, requestOptions: Partial<RequestOptions> = {}): void => {
+export const runProvisioningScript = ({
+    script,
+    files,
+    jahiaServer = serverDefaults,
+    options = {log: true},
+    requestOptions = {}
+}: RunProvisioningScriptParams): void => {
     const formData = new FormData();
 
     if (isFormFile(script)) {
@@ -123,18 +136,19 @@ export const runProvisioningScript = (script: FormFile | StringDictionary[], fil
         ...requestOptions
     };
 
-    if (typeof timeout !== 'undefined') {
-        request.timeout = timeout;
-    }
-
     cy.request(request).then(res => {
         response = res;
-        expect(res.status, 'Script result').to.eq(200);
-        try {
-            const decoder = new TextDecoder();
-            result = JSON.parse(decoder.decode(response.body));
-        } catch (e) {
-            result = e;
+
+        // If the response status is 200, decode the response, otherwise return the response as is
+        if (res.status === 200) {
+            try {
+                const decoder = new TextDecoder();
+                result = JSON.parse(decoder.decode(response.body));
+            } catch (e) {
+                result = e;
+            }
+        } else {
+            result = res;
         }
 
         logger?.end();

package/src/support/provisioning/uninstallBundle.ts

@@ -14,7 +14,9 @@ declare global {
 
 export const uninstallBundle = function (bundleSymbolicName: string): void {
     cy.runProvisioningScript({
-        fileContent: '- uninstallBundle: "' + bundleSymbolicName + '"\n',
-        type: 'application/yaml'
+        script: {
+            fileContent: '- uninstallBundle: "' + bundleSymbolicName + '"\n',
+            type: 'application/yaml'
+        }
     });
 };

package/src/utils/SiteHelper.ts

@@ -19,9 +19,12 @@ export const deleteSite = (siteKey: string, jahiaServer?: JahiaServer): void =>
 
 export const enableModule = (moduleName: string, siteKey: string, jahiaServer?: JahiaServer): void => {
     cy.runProvisioningScript({
-        fileContent: '- enable: "' + moduleName + '"\n  site: "' + siteKey + '"',
-        type: 'application/yaml'
-    }, undefined, jahiaServer);
+        script: {
+            fileContent: '- enable: "' + moduleName + '"\n  site: "' + siteKey + '"',
+            type: 'application/yaml'
+        },
+        jahiaServer
+    });
 };
 
 export const disableModule = (moduleName: string, siteKey: string): void => {