@sap_oss/wdio-qmate-service
Version:
[](https://api.reuse.software/info/github.com/SAP/wdio-qmate-service)[](http
902 lines (900 loc) • 43.5 kB
JavaScript
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Table = void 0;
const verboseLogger_1 = require("../../helper/verboseLogger");
const errorHandler_1 = __importDefault(require("../../helper/errorHandler"));
const constants_1 = require("../constants");
const tableHelper_1 = require("../../helper/tableHelper");
/**
* @class table
* @memberof ui5
*/
class Table {
vlf = new verboseLogger_1.VerboseLoggerFactory("ui5", "table");
ErrorHandler = new errorHandler_1.default();
// =================================== CONSTANTS ===================================
static SMART_TABLE_METADATA = "sap.ui.comp.smarttable.SmartTable";
static TABLE_METADATA = "sap.m.Table";
static UI_TABLE_METADATA = "sap.ui.table.Table";
static TREE_TABLE_METADATA = "sap.ui.table.TreeTable";
static MDC_TABLE_METADATA = "sap.ui.mdc.Table";
static COLUMN_LIST_ITEM_METADATA = "sap.m.ColumnListItem";
static TABLE_ROW_METADATA = "sap.ui.table.Row";
static CHECKBOX_METADATA = "sap.m.CheckBox";
static SUPPORTED_TABLES_METADATA = [Table.SMART_TABLE_METADATA, Table.TABLE_METADATA, Table.UI_TABLE_METADATA, Table.TREE_TABLE_METADATA, Table.MDC_TABLE_METADATA];
// =================================== SORTING ===================================
/**
* @function sortColumnAscending
* @memberOf ui5.table
* @description Sorts the given column "Ascending".
* @param {String} columnName - The name of the column to sort.
* @param {Ui5Selector} tableSelector - The selector describing the table element (in case there are more then one).
* @example await ui5.table.sortColumnAscending("Supplier");
* @example const glAccountItemsTable = {
* "elementProperties": {
* "viewName": "ui.s2p.mm.supplinvoice.manage.s1.view.S1",
* "metadata": "sap.m.Table",
* "id": "*idS2P.MM.MSI.TableGLAccountItems"
* }
* };
* await ui5.table.sortColumnAscending("Amount", glAccountItemsTable);
*/
async sortColumnAscending(columnName, tableSelector, timeout = parseFloat(process.env.QMATE_CUSTOM_TIMEOUT) || constants_1.GLOBAL_DEFAULT_WAIT_TIMEOUT) {
const oldSortButtonSelector = {
elementProperties: {
metadata: "sap.m.Button",
icon: "sap-icon://sort-ascending"
},
ancestorProperties: {
metadata: "sap.m.Toolbar"
}
};
const newSortButtonSelector = {
elementProperties: {
metadata: "sap.m.ToggleButton",
text: "Ascending"
}
};
const newerSortButtonSelector = {
elementProperties: {
metadata: "sap.ui.core.Icon",
src: "sap-icon://sort-ascending"
},
ancestorProperties: {
metadata: "sap.m.InputListItem"
}
};
const sort = await this._getSortIndicatorValue(columnName, tableSelector);
if (sort !== "Ascending") {
await this._clickColumn(columnName, tableSelector);
await browser.waitUntil(async () => {
try {
await Promise.any([ui5.userInteraction.click(oldSortButtonSelector, 0, 500), ui5.userInteraction.click(newSortButtonSelector, 0, 500), ui5.userInteraction.click(newerSortButtonSelector, 0, 500)]);
return true;
}
catch (error) {
// Ignore error and continue to next promise
return false;
}
}, {
timeout: timeout,
timeoutMsg: "Sort button not clickable",
interval: constants_1.GLOBAL_DEFAULT_WAIT_INTERVAL
});
}
}
/**
* @function sortColumnDescending
* @memberOf ui5.table
* @description Sorts the given column "Descending".
* @param {String} columnName The name of the column to sort.
* @param {Ui5Selector} tableSelector - The selector describing the table element (in case there are more then one).
* @example await ui5.table.sortColumnDescending("Supplier");
* @example const glAccountItemsTable = {
* "elementProperties": {
* "viewName": "ui.s2p.mm.supplinvoice.manage.s1.view.S1",
* "metadata": "sap.m.Table",
* "id": "*idS2P.MM.MSI.TableGLAccountItems"
* }
* };
* await ui5.table.sortColumnDescending("Amount", glAccountItemsTable);
*/
async sortColumnDescending(columnName, tableSelector, timeout = parseFloat(process.env.QMATE_CUSTOM_TIMEOUT) || constants_1.GLOBAL_DEFAULT_WAIT_TIMEOUT) {
const oldSortButtonSelector = {
elementProperties: {
metadata: "sap.m.Button",
icon: "sap-icon://sort-descending"
},
ancestorProperties: {
metadata: "sap.m.Toolbar"
}
};
const newSortButtonSelector = {
elementProperties: {
metadata: "sap.m.ToggleButton",
text: "Descending"
}
};
const newerSortButtonSelector = {
elementProperties: {
metadata: "sap.ui.core.Icon",
src: "sap-icon://sort-descending"
},
ancestorProperties: {
metadata: "sap.m.InputListItem"
}
};
const sort = await this._getSortIndicatorValue(columnName, tableSelector);
if (sort !== "Descending") {
await this._clickColumn(columnName, tableSelector);
await browser.waitUntil(async () => {
try {
await Promise.any([ui5.userInteraction.click(oldSortButtonSelector, 0, 500), ui5.userInteraction.click(newSortButtonSelector, 0, 500), ui5.userInteraction.click(newerSortButtonSelector, 0, 500)]);
return true;
}
catch (error) {
// Ignore error and continue to next promise
return false;
}
}, {
timeout: timeout,
timeoutMsg: "Sort button not clickable",
interval: constants_1.GLOBAL_DEFAULT_WAIT_INTERVAL
});
}
}
// =================================== SETTINGS ===================================
/**
* @function clickSettingsButton
* @memberOf ui5.table
* @description Opens the user Settings.
* @param {Ui5Selector} tableSelector - The selector describing the table element (in case there are more then one).
* @example await ui5.table.clickSettingsButton();
* @example const glAccountItemsTable = {
* "elementProperties": {
* "viewName": "ui.s2p.mm.supplinvoice.manage.s1.view.S1",
* "metadata": "sap.m.Table",
* "id": "*idS2P.MM.MSI.TableGLAccountItems"
* }
* };
* await ui5.table.clickSettingsButton(glAccountItemsTable);
*/
async clickSettingsButton(tableSelector) {
this.vlf.initLog(this.clickSettingsButton);
const settingsButtonSelector = {
elementProperties: {
metadata: "sap.m.OverflowToolbarButton",
id: "*btnPersonalisation"
}
};
if (!tableSelector) {
await ui5.userInteraction.click(settingsButtonSelector);
}
else {
const selector = this._prepareAncestorSelector(settingsButtonSelector, tableSelector);
await ui5.userInteraction.click(selector);
}
}
// =================================== GET OPERATIONS ===================================
/**
* @function getTotalNumberOfRows
* @memberOf ui5.table
* @description Returns the total number of rows in the table.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @returns {Number} The total number of rows in the table.
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* const numberOfRows = await ui5.table.getTotalNumberOfRows(selector);
*/
async getTotalNumberOfRows(tableSelectorOrId) {
this.vlf.initLog(this.getTotalNumberOfRows);
const ancestorSelector = await Table._resolveTableSelectorOrId(tableSelectorOrId);
const tableTitleSelector = {
elementProperties: {
metadata: "sap.m.Title"
},
ancestorProperties: {
metadata: "sap.m.*Toolbar",
ancestorProperties: ancestorSelector.elementProperties
}
};
const tableTitleText = await ui5.element.getPropertyValue(tableTitleSelector, "text");
return this._extractRowCountFromTitle(tableTitleText);
}
/**
* @function getTotalNumberOfRowsByValues
* @memberOf ui5.table
* @description Returns the total number of rows in the table that match the given values.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @param {String | Array<String>} values - The value(s) to match in the table rows.
* @param {Boolean} [enableHighlighting=true] - Enable or disable highlighting of found elements.
* @param {String} [matchMode="contains"] - The match mode for the values. Can be "contains", "exact" or "wordBoundary".
* @returns {Number} The total number of matching rows in the table.
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* const numberOfRows = await ui5.table.getTotalNumberOfRowsByValues(selector, ["value1", "value2"]);
* const numberOfRows = await ui5.table.getTotalNumberOfRowsByValues(selector, "value");
**/
async getTotalNumberOfRowsByValues(tableSelectorOrId, values, enableHighlighting = true, matchMode = "contains") {
this.vlf.initLog(this.getTotalNumberOfRowsByValues);
const rowSelectors = await this.getSelectorsForRowsByValues(tableSelectorOrId, values, enableHighlighting, matchMode);
return rowSelectors.length;
}
/**
* @function getSelectorsForRowsByValues
* @memberOf ui5.table
* @description Gets the selectors of rows in the table that contain the given values. If multiple values are provided, it only returns the selectors of rows that contain all of them.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @param {String | Array<String>} values - The value(s) to match in the table rows.
* @param {Boolean} [enableHighlighting=true] - Enable or disable highlighting of found elements.
* @param {String} [matchMode="contains"] - The match mode for the values. Can be "contains", "exact" or "wordBoundary".
* @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable"
* await ui5.table.getSelectorsForRowsByValues(id, "February");
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* await ui5.table.getSelectorsForRowsByValues(selector, ["January", "2022"]);
* @example
* await ui5.table.getSelectorsForRowsByValues(selector, ["January", "2022"], true, "exact");
*/
async getSelectorsForRowsByValues(tableSelectorOrId, values, enableHighlighting = true, matchMode = "contains") {
this.vlf.initLog(this.getSelectorsForRowsByValues);
if (typeof values === "string") {
values = [values];
}
else if (!Array.isArray(values)) {
this.ErrorHandler.logException(new Error("Invalid values provided. It should be either a string or an array of strings."));
}
const constructedTableSelector = await this._constructTableSelector(tableSelectorOrId);
const tableMetadata = constructedTableSelector.elementProperties.metadata;
const classCode = tableHelper_1.TableHelper.serializeClass();
let filteredRowIds, filteredTableMetadata = null;
try {
// =========================== BROWSER COMMAND ===========================
const browserCommand = `
${classCode}
const table = TableHelper.filterTableByMetadata("${constructedTableSelector.elementProperties.id}", "${tableMetadata}", ${JSON.stringify(Table.SUPPORTED_TABLES_METADATA)});
const filteredTableMetadata = table.getMetadata().getName();
const items = TableHelper.getItems(table);
const filteredItems = TableHelper.filterItemsWithoutTitle(items);
const itemsIds = await TableHelper.getIdsForItemsByCellValues(filteredItems, ${JSON.stringify(values)}, ${enableHighlighting}, "${matchMode}");
return [itemsIds, filteredTableMetadata];
`;
[filteredRowIds, filteredTableMetadata] = await util.browser.executeScript(browserCommand);
// ========================================================================
}
catch (error) {
return this.ErrorHandler.logException(new Error(`Error while executing browser command: ${error}`));
}
if (filteredRowIds && filteredRowIds.length > 0) {
return this._constructRowSelector(filteredRowIds, filteredTableMetadata);
}
else {
return [];
}
}
/**
* @function getSelectorForRowByIndex
* @memberOf ui5.table
* @description Gets the selector of a row in the table by its index.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @param {Number} index - The index of the item to open.
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* const rowSelector = await ui5.table.getSelectorForRowByIndex(selector, 0);
* @example id = "application-ReportingTask-run-component---ReportList--ReportingTable"
* const rowSelector = await ui5.table.getSelectorForRowByIndex(id, 0);
*/
async getSelectorForRowByIndex(tableSelectorOrId, index) {
this.vlf.initLog(this.getSelectorForRowByIndex);
const constructedTableSelector = await this._constructTableSelector(tableSelectorOrId);
let filteredRowId, filteredTableMetadata;
const tableMetadata = constructedTableSelector.elementProperties.metadata;
const classCode = tableHelper_1.TableHelper.serializeClass();
try {
// =========================== BROWSER COMMAND ===========================
const browserCommand = `
${classCode}
const table = TableHelper.filterTableByMetadata("${constructedTableSelector.elementProperties.id}", "${tableMetadata}", ${JSON.stringify(Table.SUPPORTED_TABLES_METADATA)});
const items = TableHelper.getItems(table);
const filteredTableMetadata = table.getMetadata().getName();
let item = undefined
if (items && items[${index}]) item = TableHelper.filterItemsWithoutTitle(items)[${index}];
return [item?.getId(), filteredTableMetadata];
`;
[filteredRowId = null, filteredTableMetadata] = await util.browser.executeScript(browserCommand);
// ========================================================================
}
catch (error) {
return this.ErrorHandler.logException(new Error(`Error while executing browser command: ${error}`));
}
if (!filteredRowId) {
return this.ErrorHandler.logException(new Error(`No item found with index ${index}.`));
}
const rowSelector = this._constructRowSelector([filteredRowId], filteredTableMetadata);
return rowSelector[0]; // Return the first selector as we expect only one row to match the index
}
async getAllColumnValuesByName(tableSelectorOrId, columnName, scrollingEnabled) {
this.vlf.initLog(this.getAllColumnValuesByName);
const constructedTableSelector = await Table._resolveTableSelectorOrId(tableSelectorOrId);
const tableMetadata = constructedTableSelector.elementProperties.metadata;
const classCode = tableHelper_1.TableHelper.serializeClass();
let values = [];
try {
// =========================== BROWSER COMMAND ===========================
const browserCommand = `
${classCode}
const table = TableHelper.filterTableByMetadata("${constructedTableSelector.elementProperties.id}", "${tableMetadata}", ${JSON.stringify(Table.SUPPORTED_TABLES_METADATA)});
return await TableHelper.getAllColumnValuesByScrolling(table, "${columnName}", ${scrollingEnabled});
`;
values = await util.browser.executeScript(browserCommand);
// ========================================================================
}
catch (error) {
return this.ErrorHandler.logException(new Error(`Error while executing browser command: ${error}`));
}
return values;
}
// =================================== SELECT OPERATIONS ===================================
/**
* @function selectRowByIndex
* @memberOf ui5.table
* @description Selects a row in the table by its index.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @param {Number} index - The index of the row to select.
* @example await ui5.table.selectRowByIndex("application-ReportingTask-run-component---ReportList--ReportingTable", 0);
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* await ui5.table.selectRowByIndex(selector, 0);
*/
async selectRowByIndex(tableSelectorOrId, index) {
this.vlf.initLog(this.selectRowByIndex);
const rowSelector = await this.getSelectorForRowByIndex(tableSelectorOrId, index);
await this._selectRow(rowSelector);
}
/**
* @function selectAllRows
* @memberOf ui5.table
* @description Selects all rows in the table.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @example await ui5.table.selectAllRows("application-ReportingTask-run-component---ReportList--ReportingTable");
* await ui5.table.selectAllRows(selector);
*/
async selectAllRows(tableSelectorOrId) {
this.vlf.initLog(this.selectAllRows);
const ancestorSelector = await Table._resolveTableSelectorOrId(tableSelectorOrId);
const checkBoxSelector = {
elementProperties: {
metadata: Table.CHECKBOX_METADATA
},
ancestorProperties: ancestorSelector.elementProperties
};
await ui5.userInteraction.check(checkBoxSelector);
}
/**
* @function deselectRowByIndex
* @memberOf ui5.table
* @description Deselects a row in the table by its index.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* await ui5.table.deselectRowByIndex(selector, 0);
* @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
* await ui5.table.deselectRowByIndex(id, 0);
*/
async deselectRowByIndex(tableSelectorOrId, index) {
this.vlf.initLog(this.deselectRowByIndex);
const rowSelector = await this.getSelectorForRowByIndex(tableSelectorOrId, index);
await this._selectRow(rowSelector, false);
}
/**
* @function deselectAllRows
* @memberOf ui5.table
* @description Deselects all rows in the table.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @example await ui5.table.deselectAllRows("application-ReportingTask-run-component---ReportList--ReportingTable");
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* await ui5.table.deselectAllRows(selector);
*/
async deselectAllRows(tableSelectorOrId) {
this.vlf.initLog(this.selectAllRows);
const ancestorSelector = await Table._resolveTableSelectorOrId(tableSelectorOrId);
const checkBoxSelector = {
elementProperties: {
metadata: Table.CHECKBOX_METADATA
},
ancestorProperties: ancestorSelector.elementProperties
};
await ui5.userInteraction.uncheck(checkBoxSelector);
}
/**
* @function selectRowByValues
* @memberOf ui5.table
* @description Selects a row in the table by matching value(s). First, all rows containing the given value(s) are collected.
* Then, the row at the given index within that list of matching rows is selected.
* This is useful when multiple rows match the same value(s) and you need to target a specific one.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table.
* @param {String | Array<String>} values - The value(s) to match in the table rows. If multiple values are provided, only rows containing all of them will match.
* @param {Number} [index=0] - The index within the list of matching rows (not the table row index). Defaults to 0 (first match). For example, if 3 rows match the given values, use index 1 to select the second match.
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* await ui5.table.selectRowByValues(selector, ["value1", "value2"]);
* @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
* // Selects the second row that contains "value" (index 1 among matches, not table row index 1)
* await ui5.table.selectRowByValues(id, "value", 1);
*/
async selectRowByValues(tableSelectorOrId, values, index = 0) {
const vl = this.vlf.initLog(this.selectRowByValues);
if (typeof values === "string")
values = [values];
const constructedTableSelector = await this._constructTableSelector(tableSelectorOrId);
const visibleRowSelectors = await this.getSelectorsForRowsByValues(constructedTableSelector, values);
if (visibleRowSelectors.length === 0) {
return this.ErrorHandler.logException(new Error(`No row found with the provided values: ${values} at global index ${index}.`));
}
await this._selectRow(visibleRowSelectors[index]);
}
// =================================== OPEN OPERATIONS ===================================
/**
* @function openItemByIndex
* @memberOf ui5.table
* @description Opens the item in the table by its index via right arrow icon or direct click.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @param {Number} index - The index of the item to open.
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* await ui5.table.openItemByIndex(selector, 0);
* @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
* await ui5.table.openItemByIndex(id, 0);
*/
async openItemByIndex(tableSelectorOrId, index) {
this.vlf.initLog(this.openItemByIndex);
const rowSelector = await this.getSelectorForRowByIndex(tableSelectorOrId, index);
await this._clickRowOrArrowIcon(rowSelector);
}
/**
* @function openItemByValues
* @memberOf ui5.table
* @description Opens the item in the table containing the given values. First, all rows containing the given value(s) are collected.
* Then, the row at the given index within that list of matching rows is opened.
* This is useful when multiple rows match the same value(s) and you need to target a specific one.
* @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
* @param {String | Array<String>} values - The value(s) to match in the table rows. If multiple values are provided, only rows containing all of them will match.
* @param {Number} [index=0] - The index within the list of matching rows (not the table row index). Defaults to 0 (first match). For example, if 3 rows match the given values, use index 1 to open the second match.
* @param {Boolean} [enableHighlighting=true] - Enable or disable highlighting of found elements.
* @param {String} [matchMode="contains"] - The match mode for the values. Can be "contains", "exact" or "wordBoundary".
* @example const selector = {
* elementProperties: {
* viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
* metadata: "sap.ui.comp.smarttable.SmartTable",
* id: "application-ReportingTask-run-component---ReportList--ReportingTable"
* }
* };
* await ui5.table.openItemByValues(selector, ["value1", "value2"]);
* @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
* await ui5.table.openItemByValues(id, "value");
* @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
* await ui5.table.openItemByValues(id, "value", 0, false, "exact");
*/
async openItemByValues(tableSelectorOrId, values, index = 0, enableHighlighting = true, matchMode = "contains") {
this.vlf.initLog(this.openItemByValues);
const rowSelectors = await this.getSelectorsForRowsByValues(tableSelectorOrId, values, enableHighlighting, matchMode);
if (rowSelectors.length === 0)
return this.ErrorHandler.logException(new Error(`No items found with the provided values: ${values}.`));
if (rowSelectors.length <= index)
return this.ErrorHandler.logException(new Error(`The index ${index} is out of bounds. The number of matching items is ${rowSelectors.length}.`));
const rowSelector = rowSelectors[index];
await this._clickRowOrArrowIcon(rowSelector);
}
// =================================== HELPER ===================================
static async _resolveTableSelectorOrId(tableSelectorOrId, timeout = parseFloat(process.env.QMATE_CUSTOM_TIMEOUT) || constants_1.GLOBAL_DEFAULT_WAIT_TIMEOUT) {
if (typeof tableSelectorOrId === "string") {
const selectors = [
{
elementProperties: {
metadata: Table.SMART_TABLE_METADATA,
id: tableSelectorOrId
}
},
{
elementProperties: {
metadata: Table.TABLE_METADATA,
id: tableSelectorOrId
}
},
{
elementProperties: {
metadata: Table.UI_TABLE_METADATA,
id: tableSelectorOrId
}
},
{
elementProperties: {
metadata: Table.TREE_TABLE_METADATA,
id: tableSelectorOrId
}
}
];
try {
let index = -1;
await browser.waitUntil(async () => {
try {
index = await Promise.any(selectors.map(async (selectors, index) => {
return await ui5.element.getDisplayed(selectors, 0, 500).then(() => index);
}));
return true;
}
catch (error) {
// Ignore error and continue to next promise
return false;
}
}, {
timeout: timeout,
timeoutMsg: "Table could not be resolved",
interval: constants_1.GLOBAL_DEFAULT_WAIT_INTERVAL
});
return selectors[index];
}
catch (error) {
// Intentionally left empty, as the error is handled below
}
}
else if (typeof tableSelectorOrId === "object" && "elementProperties" in tableSelectorOrId) {
if (Table.SUPPORTED_TABLES_METADATA.includes(tableSelectorOrId.elementProperties.metadata)) {
return tableSelectorOrId;
}
}
throw new Error(`The provided table selector "${tableSelectorOrId}" is not valid. Please provide a valid selector or ID for the supported control types: ${Table.SUPPORTED_TABLES_METADATA.join(", ")}.`);
}
static async _getId(tableSelectorOrId) {
if (typeof tableSelectorOrId === "string") {
return tableSelectorOrId;
}
else {
const resolvedTableSelectorOrId = await Table._resolveTableSelectorOrId(tableSelectorOrId);
return await ui5.element.getId(resolvedTableSelectorOrId);
}
}
async _getTableMetadata(tableId) {
try {
// =========================== BROWSER COMMAND ===========================
const classCode = tableHelper_1.TableHelper.serializeClass();
const tableMetadata = await util.browser.executeScript(`
${classCode}
return TableHelper.getTableMetadata("${tableId}");
`);
return tableMetadata;
}
catch (error) {
throw new Error(`Error while executing browser command: ${error}`);
}
}
async _constructTableSelector(tableSelector) {
this.vlf.initLog(this._constructTableSelector);
const tableId = await Table._getId(tableSelector);
const selector = {
elementProperties: {
id: tableId
}
};
await ui5.element.waitForAll(selector);
const tableMetadata = await this._getTableMetadata(tableId);
return {
elementProperties: {
...selector.elementProperties,
metadata: tableMetadata
}
};
}
_constructRowSelector(filteredRowIds, tableMetadata) {
const rowsSelectors = [];
const rowMetadata = this._getRowMetadataByTableMetadata(tableMetadata);
for (const id of filteredRowIds) {
const columnListItemSelector = {
elementProperties: {
metadata: rowMetadata,
id: id
}
};
rowsSelectors.push(columnListItemSelector);
}
return rowsSelectors;
}
_getRowMetadataByTableMetadata(tableMetadata) {
if (tableMetadata === Table.TABLE_METADATA || tableMetadata === Table.SMART_TABLE_METADATA) {
return Table.COLUMN_LIST_ITEM_METADATA;
}
else {
return Table.TABLE_ROW_METADATA;
}
}
_extractRowCountFromTitle(title) {
const vl = this.vlf.initLog(this._extractRowCountFromTitle);
const match = title.match(/\((\d+)\)/);
if (match) {
return parseInt(match[1], 10);
}
else {
vl.log(`Extracting row count from title was not successful, returning 0.`);
return 0;
}
}
async _clickColumn(name, tableSelector, timeout = parseFloat(process.env.QMATE_CUSTOM_TIMEOUT) || constants_1.GLOBAL_DEFAULT_WAIT_TIMEOUT) {
const vl = this.vlf.initLog(this._clickColumn);
const tableColumnSelector = {
elementProperties: {
metadata: "sap.m.Column"
},
descendantProperties: {
text: name
}
};
const tableGridColumnSelector = {
elementProperties: {
metadata: "sap.ui.table.Column"
},
descendantProperties: {
text: name
}
};
if (!tableSelector) {
await browser.waitUntil(async () => {
try {
await Promise.any([ui5.userInteraction.click(tableColumnSelector, 0, 500), ui5.userInteraction.click(tableGridColumnSelector, 0, 500)]);
return true;
}
catch (error) {
// Ignore error and continue to next promise
return false;
}
}, {
timeout: timeout,
timeoutMsg: "Column not clickable",
interval: constants_1.GLOBAL_DEFAULT_WAIT_INTERVAL
});
}
else if (typeof tableSelector === "object") {
await browser.waitUntil(async () => {
try {
await Promise.any([ui5.userInteraction.click(this._prepareAncestorSelector(tableColumnSelector, tableSelector), 0, 500), ui5.userInteraction.click(this._prepareAncestorSelector(tableGridColumnSelector, tableSelector), 0, 500)]);
return true;
}
catch (error) {
// Ignore error and continue to next promise
return false;
}
}, {
timeout: timeout,
timeoutMsg: "Column not clickable",
interval: constants_1.GLOBAL_DEFAULT_WAIT_INTERVAL
});
}
}
async _getSortValueGridTable(selector, ancestor) {
const sortOrder = await ui5.element.getPropertyValue(selector, "sortOrder", ancestor, 500);
const sorted = await ui5.element.getPropertyValue(selector, "sorted", ancestor, 500);
return sorted ? sortOrder : "";
}
async _getSortIndicatorValue(name, tableSelector, timeout = parseFloat(process.env.QMATE_CUSTOM_TIMEOUT) || constants_1.GLOBAL_DEFAULT_WAIT_TIMEOUT) {
const vl = this.vlf.initLog(this._getSortIndicatorValue);
const tableColumnSelector = {
elementProperties: {
metadata: "sap.m.Column"
},
descendantProperties: {
text: name
}
};
const tableGridColumnSelector = {
elementProperties: {
metadata: "sap.ui.table.Column"
},
descendantProperties: {
text: name
}
};
let sortIndicator;
if (!tableSelector) {
await browser.waitUntil(async () => {
try {
sortIndicator = await Promise.any([ui5.element.getPropertyValue(tableColumnSelector, "sortIndicator", 0, 500), this._getSortValueGridTable(tableGridColumnSelector)]);
return true;
}
catch (error) {
// Ignore error and continue to next promise
return false;
}
}, {
timeout: timeout,
timeoutMsg: "Sort indicator not found",
interval: constants_1.GLOBAL_DEFAULT_WAIT_INTERVAL
});
}
else if (typeof tableSelector === "object") {
const selector = this._prepareAncestorSelector(tableColumnSelector, tableSelector);
await browser.waitUntil(async () => {
try {
sortIndicator = await Promise.any([ui5.element.getPropertyValue(this._prepareAncestorSelector(tableColumnSelector, tableSelector), "sortIndicator", 0, 500), this._getSortValueGridTable(this._prepareAncestorSelector(tableGridColumnSelector, tableSelector))]);
return true;
}
catch (error) {
// Ignore error and continue to next promise
return false;
}
}, {
timeout: timeout,
timeoutMsg: "Sort indicator not found",
interval: constants_1.GLOBAL_DEFAULT_WAIT_INTERVAL
});
}
return sortIndicator;
}
_prepareAncestorSelector(selector, ancestorSelector) {
const vl = this.vlf.initLog(this._prepareAncestorSelector);
if ("elementProperties" in ancestorSelector) {
selector.ancestorProperties = ancestorSelector.elementProperties;
}
else if (!("ancestorProperties" in selector)) {
selector.ancestorProperties = {};
}
const keys = Object.keys(ancestorSelector);
for (const key of keys) {
if (key !== "elementProperties") {
selector.ancestorProperties[key] = ancestorSelector[key];
}
}
return selector;
}
async _getSelectorTypeForRowSelection(rowSelector) {
const vl = this.vlf.initLog(this._getSelectorTypeForRowSelection);
return await util.browser.executeScript((rowSelector) => {
const id = rowSelector.elementProperties.id;
const selectorChecks = [
{
type: "ui5CheckBox",
selector: `tr[id='${id}'] [data-sap-ui*='selectMulti'][role='checkbox']`
},
{
type: "ui5RadioButton",
selector: `tr[id='${id}'] [role='radio']`
},
{
type: "cssItem",
selector: `[data-sap-ui-related='${id}'] [role='gridcell']`
}
];
for (const check of selectorChecks) {
// Note: Following command slows down the execution and might be used after refactoring service
// const isPresent = await nonUi5.element.isPresentByCss(check.selector);
// @ts-ignore
if (window.document.querySelector(check.selector)) {
return check.type;
}
}
return "none";
}, rowSelector);
}
_buildRowSelectionSelector(selectorType, rowSelector) {
const vl = this.vlf.initLog(this._buildRowSelectionSelector);
switch (selectorType) {
case "ui5CheckBox":
return {
elementProperties: {
metadata: Table.CHECKBOX_METADATA
},
ancestorProperties: rowSelector.elementProperties
};
case "ui5RadioButton":
return {
elementProperties: {
metadata: "sap.m.RadioButton"
},
ancestorProperties: rowSelector.elementProperties
};
case "cssItem":
return `[data-sap-ui-related = '${rowSelector.elementProperties.id}'] [role='gridcell']`;
case "none":
throw new Error("No selectable CheckBox, RadioButton, or Css element found for the row.");
}
}
async _selectRow(rowSelector, check = true) {
const vl = this.vlf.initLog(this._selectRow);
const selectorType = await this._getSelectorTypeForRowSelection(rowSelector);
const selectionSelector = this._buildRowSelectionSelector(selectorType, rowSelector);
switch (selectorType) {
case "ui5CheckBox":
await ui5.element.waitForAll(rowSelector);
if (check) {
await ui5.userInteraction.check(selectionSelector);
}
else {
await ui5.userInteraction.uncheck(selectionSelector);
}
break;
case "ui5RadioButton":
await ui5.element.waitForAll(rowSelector);
if (!check) {
throw new Error("Unselecting is not supported for RadioButton-based selection.");
}
await ui5.userInteraction.check(selectionSelector);
break;
case "cssItem":
await nonUi5.element.waitForAll(selectionSelector);
if (check) {
await nonUi5.userInteraction.check(selectionSelector);
}
else {
await nonUi5.userInteraction.uncheck(selectionSelector);
}
break;
default:
throw new Error("No selectable element found for the row.");
}
}
async _clickRowOrArrowIcon(rowSelector) {
const rowArrowIconSelector = {
elementProperties: {
metadata: "sap.ui.core.Icon",
src: "sap-icon://slim-arrow-right"
},
parentProperties: rowSelector.elementProperties
};
if (await ui5.element.isVisible(rowArrowIconSelector, 0, 5000)) {
await ui5.userInteraction.click(rowArrowIconSelector);
}
else {
await ui5.userInteraction.click(rowSelector);
}
}
}
exports.Table = Table;
exports.default = new Table();
//# sourceMappingURL=table.js.map