@globisnv/cypress-core 1.1.4 → 1.2.0

package/dist/commands/GLO_commands.d.ts

@@ -605,6 +605,36 @@ declare global {
              * @param {number} [interval] - use this TOGETHER with timeOut for slow-running updates (e.g. batch process) (default: 15s)
              */
             GLO_validateGridOrFail(waitValue: string, failValue: string, rowNumber?: number, columnId?: string, timeOut?: number, interval?: number): void;
+            /**
+             * Command to wait until a field shows a value, and to fail instantly when it shows a fail value.
+             * The field counterpart of GLO_validateGridOrFail, e.g. for a status that is updated by a running process.
+             * The displayed value is checked, as in GLO_checkField (the text of a valuelist, not its stored code).
+             *
+             * @param {selectorType} selector - [formName, elementName] of the field.
+             * @param {string} waitValue - The value to wait for.
+             * @param {string | string[]} failValue - The value(s) that stop the waiting and fail instantly.
+             * @param {number} [timeOut] - how long it should wait for the field to update, default: 10m
+             * @param {number} [interval] - how often the field is checked, default: 15s
+             * @example - cy.GLO_validateFieldOrFail(['ng$billing_task_dtl', 'status'], 'Finished', ['Error', 'Finished with error'], 300000, 2000);
+             */
+            GLO_validateFieldOrFail(selector: selectorType, waitValue: string, failValue: string | string[], timeOut?: number, interval?: number): void;
+            /**
+             * Executes a batch processing type and waits until the run it started has finished.
+             * The last run of the type is remembered before Execute, so a run that finished earlier is never taken for
+             * the new one (row 0 of the 'Batch processing' tab is still the previous run right after Execute).
+             * The command opens 'Batch processing type' itself and closes it again when the run has finished.
+             *
+             * @param {string} batchType - The value to filter the batch processing type list on.
+             * @param {string} [columnId='description'] - The column of the batch processing type list to filter on (e.g. 'description', 'transaction_type_text', 'batch_module').
+             * @param {string | null} [waitValue='Completed'] - The status the new run must end with. Use null to only wait until the run has finished, whatever its status,
+             * e.g. for a batch that processes the records of the whole environment, where one record of a parallel test can turn the run into Error.
+             * @param {string} [failValue='Error'] - The status that stops the waiting and fails instantly (not used when waitValue is null).
+             * @param {number} [timeOut] - how long it should wait for the run to finish, default: 20m
+             * @param {number} [interval] - how often the 'Batch processing' tab is checked, default: 15s
+             * @returns {Chainable<batchRunType>} - Yields the new run (submitted, completed, status, error message).
+             * @example - cy.GLO_executeBatchProcess('Batch processor accountancy SALES', 'batch_module', null);
+             */
+            GLO_executeBatchProcess(batchType: string, columnId?: string, waitValue?: string | null, failValue?: string, timeOut?: number, interval?: number): Chainable<batchRunType>;
             /**
              * Store the value(s) of one or more fields into the nested '@saveData' alias:
              *   saveData[formName][elementName] = value

package/dist/commands/GLO_commands.js

@@ -1,4 +1,4 @@
-import { bottom, buttonSearch, check, contains, cypressWebsocketLoader, defaultTimeout, enabled, equal, greaterEqual, gridDropDown, gridInput, gridInputWithoutEnter, gridSelect, hideInCommandLog, input, isInvalid, noEqualBool, noSkipCheck, notEqual, parseLocalizedNumber, row, select, skipCheck, span, top, unCheck } from '../tsHelper.js';
+import { bottom, buttonSearch, check, contains, cypressWebsocketLoader, defaultTimeout, enabled, equal, greaterEqual, gridDropDown, gridInput, gridInputWithoutEnter, gridSelect, hideInCommandLog, input, isInvalid, noEqualBool, noSkipCheck, notEqual, open, parseLocalizedNumber, row, select, skipCheck, span, top, unCheck } from '../tsHelper.js';
 import { attachWebSocketSpy } from '../websocketDetector.js';
 //! File-specific helpers
 const monthNames = ['januari', 'februari', 'maart', 'april', 'mei', 'juni', 'juli', 'augustus', 'september', 'oktober', 'november', 'december'];
@@ -2008,6 +2008,111 @@ Cypress.Commands.add('GLO_getAllRowsInGrid', (selector, timeOut = defaultTimeout
 Cypress.Commands.add('GLO_validateGridOrFail', (waitValue, failValue, rowNumber, columnId, timeOut = 600000, interval = 15000) => {
     validateGridValue(waitValue, failValue, rowNumber, columnId, timeOut, interval);
 });
+Cypress.Commands.add('GLO_validateFieldOrFail', (selector, waitValue, failValue, timeOut = 600000, interval = 15000) => {
+    const failValues = Array.isArray(failValue) ? failValue : [failValue];
+    const maxAttempts = Math.max(1, Math.ceil(timeOut / interval));
+    const fieldName = selector.join('.');
+    const checkField = (attempt = 1) => {
+        // Same value as GLO_checkField reads: the displayed text, with html and other unicode spaces normalized
+        cy.GLO_getElement(selector).then(($field) => {
+            const fieldValue = String($field.find('.dx-texteditor-input').val()).replace(/\s+/g, ' ').trim();
+            if (fieldValue === waitValue) {
+                cy.log(`${fieldName} is "${waitValue}"`);
+                return;
+            }
+            if (failValues.includes(fieldValue)) {
+                throw new Error(`${fieldName} is "${fieldValue}" (waited for "${waitValue}")`);
+            }
+            if (attempt >= maxAttempts) {
+                throw new Error(`${fieldName} is still "${fieldValue}" after ${timeOut / 1000}s (waited for "${waitValue}")`);
+            }
+            // biome-ignore lint/plugin/noUnnecessaryWaiting: wait for next poll interval before checking again
+            cy.wait(interval, { log: false }).then(() => {
+                checkField(attempt + 1);
+            });
+        });
+    };
+    checkField();
+});
+Cypress.Commands.add('GLO_executeBatchProcess', (batchType, columnId = 'description', waitValue = 'Completed', failValue = 'Error', timeOut = 1200000, interval = 15000) => {
+    const formNameTypeList = 'ng$batch_execution_type_lst';
+    const formNameTypeTab = 'ng$batch_execution_type_tab';
+    const formNameRunList = 'ng$batch_execution_lst';
+    const maxAttempts = Math.max(1, Math.ceil(timeOut / interval));
+    // Row 0 of the run list is the most recent run (sorted on process_submitted desc); an empty list has no run yet.
+    // Without these columns (hidden in a custom view) a new run can never be recognised, so that fails at once.
+    const requiredColumns = ['process_submitted', 'process_completed', 'process_status'];
+    const readLastRun = () => {
+        const noRun = { submitted: '', completed: '', status: '', errorMessage: '' };
+        return cy.GLO_getElement([formNameRunList, 'grid']).then(($grid) => {
+            if ($grid.find('.ag-center-cols-container [row-index]').length === 0) {
+                return cy.wrap(noRun, { log: false });
+            }
+            return cy
+                .wrap($grid, { log: false })
+                .within(() => {
+                cy.GLO_getRowInGrid(0).then(($row) => {
+                    const missingColumns = requiredColumns.filter((requiredColumnId) => $row.find(`[col-id="${requiredColumnId}"]`).length === 0);
+                    if (missingColumns.length) {
+                        throw new Error(`The 'Batch processing' tab of ${batchType} does not show the column(s) ${missingColumns.join(', ')}`);
+                    }
+                    const cellText = (cellColumnId) => $row.find(`[col-id="${cellColumnId}"]`).text().trim();
+                    cy.wrap({
+                        submitted: cellText('process_submitted'),
+                        completed: cellText('process_completed'),
+                        status: cellText('process_status'),
+                        errorMessage: cellText('last_error_message')
+                    }, { log: false }).as('COM_batchRun');
+                });
+            })
+                .then(() => cy.get('@COM_batchRun', { log: false }));
+        });
+    };
+    // The completion time (process_completed) is stamped for every final status, Completed as well as Error
+    const waitForNewRun = (previousSubmitted, attempt = 1) => {
+        cy.GLO_checkAGLoader();
+        return readLastRun().then((run) => {
+            const isNewRun = run.submitted !== '' && run.submitted !== previousSubmitted;
+            const hasFailed = waitValue !== null && run.status === failValue;
+            if (isNewRun && (run.completed !== '' || hasFailed)) {
+                cy.GLO_log(`Batch run of ${run.submitted} (${batchType}) finished with status "${run.status}" ${run.errorMessage}`);
+                if (hasFailed) {
+                    throw new Error(`Batch run of ${run.submitted} (${batchType}) ended with status "${run.status}": ${run.errorMessage}`);
+                }
+                if (waitValue !== null) {
+                    expect(run.status, `status of the batch run of ${run.submitted} (${batchType})`).to.equal(waitValue);
+                }
+                return cy.wrap(run, { log: false });
+            }
+            if (attempt >= maxAttempts) {
+                throw new Error(`No finished run of ${batchType} after ${timeOut / 1000}s (last run submitted: ${run.submitted})`);
+            }
+            // biome-ignore lint/plugin/noUnnecessaryWaiting: wait for next poll interval before checking again
+            return cy.wait(interval, { log: false }).then(() => waitForNewRun(previousSubmitted, attempt + 1));
+        });
+    };
+    cy.GLO_searchHeader('Batch processes', 'Batch processes', 'Batch processing type');
+    cy.GLO_clickDatacontrolBrowserButton('btnAll');
+    // A filter typed while the list is still loading is lost
+    cy.GLO_checkAGLoader();
+    // Equals, not contains: 'CALCULATE INVOICE' must not select 'CALCULATE INVOICE RETOUR'
+    cy.GLO_filterGrid(columnId, [formNameTypeList, 'grid'], batchType, undefined, 'Equals');
+    cy.GLO_getElement([formNameTypeList, 'grid']).within(() => {
+        cy.GLO_checkValueGrid(batchType, 0, columnId, undefined, undefined, equal);
+    });
+    cy.GLO_selectTab([formNameTypeTab, 'tabs'], 'Batch processing', open);
+    cy.GLO_checkAGLoader();
+    return readLastRun().then((previousRun) => {
+        cy.GLO_selectMenuButton('Execute');
+        cy.GLO_log(`Executed batch processing type ${batchType}`);
+        return waitForNewRun(previousRun.submitted).then((run) => {
+            // Every call opens the program, so it is closed again: a second instance would keep a hidden run list in
+            // the page, and the caller gets back the programs it had open
+            cy.GLO_closeProgram(top, 'Batch processing type');
+            return cy.wrap(run, { log: false });
+        });
+    });
+});
 const validateGridValue = (value, failValue, rowFilter, columnId, timeOut = 10000, interval, operator = contains) => {
     const assertOrCheckCellValue = ($cells, toCheck, doAssert) => {
         const compare = (cellText) => {

package/dist/types.d.ts

@@ -12,6 +12,12 @@ type deleteRecordsType = 'DELETE_CYPRESS_RECORDS' | 'DELETE_LEAPWORK_RECORDS';
 type viewModeButtonType = 'btnList' | 'btnDetail';
 type datacontrolbuttonType = baseDatacontrolViewerButtonType | viewModeButtonType | 'btnPrev' | 'btnNext' | 'btnAll' | 'btnPivot' | 'btnAttachment' | 'btnAddMode' | 'btnEditMode' | 'btnDeleteMode' | 'btnDeeplink' | 'btnExtendedSearch' | 'btnCustomViews' | 'btnFilter' | 'btnClearAllFilters';
 type checkValueInGridType = string | string[] | number;
+type batchRunType = {
+    submitted: string;
+    completed: string;
+    status: string;
+    errorMessage: string;
+};
 type selectMenuButtonLeftType = 'home' | 'settings' | 'help' | 'support' | 'excel' | 'info' | 'refresh' | 'query' | 'clients' | 'users' | 'theme';
 type urlTypeType = 'online' | 'pos' | 'globgate' | 'globjob' | 'globscan' | 'portal' | 'carrier' | 'globtrace' | 'external_portal' | 'globtake' | 'globis_external_portal';
 type customValueType = JQuery | string | number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@globisnv/cypress-core",
-    "version": "1.1.4",
+    "version": "1.2.0",
     "description": "Core building blocks for Globis Cypress E2E tests",
     "license": "UNLICENSED",
     "type": "module",