@sap-ux/ui5-test-writer 0.7.52 → 0.7.54

package/README.md

@@ -19,9 +19,26 @@ Pnpm
 
 2 public methods are available: one to generate all OPA test files for a Fiori elements for OData V4 application, another one to generate an additional page object file for a Fiori elements for OData V4 application.
 
-
 ### Generate all OPA test files for a Fiori elements for OData V4 application
 
+The `generateOPAFiles` function creates OPA5 tests suite for Fiori elements applications by analyzing the project structure and generating dynamic test cases based on actual application configuration.
+
+#### How it works:
+
+1. **Analyzes the project** using `@sap/ux-specification` to create an application model that represents the UI structure
+2. **Extracts UI controls** from the applications page models, for example:
+   - Filter bar fields from the FilterBar control
+   - Table columns from the Table control aggregations
+3. **Generates test files** based on the extracted information:
+   - Common test infrastructure files (e.g. testsuite)
+   - Page object files for each page defined in the routing targets
+   - Journey files with dynamic test assertions for application configuration
+   - Journey runner configuration
+
+This approach ensures that OPA tests are tailored to the specific features and controls present in your application, rather than generating generic tests that might not match your actual UI.
+
+#### Usage Example
+
 Calling the `generateOPAFiles` function
 ```javascript
 import { generateOPAFiles } from '@sap-ux/ui5-test-writer'

package/dist/fiori-elements-opa-writer.d.ts

@@ -1,5 +1,6 @@
 import type { Editor } from 'mem-fs-editor';
 import type { Manifest } from '@sap-ux/project-access';
+import type { Logger } from '@sap-ux/logger';
 /**
  * Reads the manifest for an app.
  *
@@ -18,13 +19,14 @@ export declare function readManifest(fs: Editor, basePath: string): Manifest;
  * @param opaConfig.htmlTarget - the name of the html that will be used in OPA journey file. If not specified, 'index.html' will be used
  * @param opaConfig.appID - the appID. If not specified, will be read from the manifest in sap.app/id
  * @param fs - an optional reference to a mem-fs editor
+ * @param log - optional logger instance
  * @returns Reference to a mem-fs-editor
  */
 export declare function generateOPAFiles(basePath: string, opaConfig: {
     scriptName?: string;
     appID?: string;
     htmlTarget?: string;
-}, fs?: Editor): Editor;
+}, fs?: Editor, log?: Logger): Promise<Editor>;
 /**
  * Generate a page object file for a Fiori elements for OData V4 application.
  * Note: this doesn't modify other existing files in the webapp/test folder.

package/dist/fiori-elements-opa-writer.js

@@ -9,6 +9,7 @@ const mem_fs_editor_1 = require("mem-fs-editor");
 const types_1 = require("./types");
 const i18n_1 = require("./i18n");
 const project_access_1 = require("@sap-ux/project-access");
+const modelUtils_1 = require("./utils/modelUtils");
 /**
  * Reads the manifest for an app.
  *
@@ -214,9 +215,10 @@ function writePageObject(pageConfig, rootTemplateDirPath, testOutDirPath, fs) {
  * @param opaConfig.htmlTarget - the name of the html that will be used in OPA journey file. If not specified, 'index.html' will be used
  * @param opaConfig.appID - the appID. If not specified, will be read from the manifest in sap.app/id
  * @param fs - an optional reference to a mem-fs editor
+ * @param log - optional logger instance
  * @returns Reference to a mem-fs-editor
  */
-function generateOPAFiles(basePath, opaConfig, fs) {
+async function generateOPAFiles(basePath, opaConfig, fs, log) {
     const editor = fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     const manifest = readManifest(editor, basePath);
     const { applicationType, hideFilterBar } = getAppTypeAndHideFilterBarFromManifest(manifest);
@@ -241,11 +243,15 @@ function generateOPAFiles(basePath, opaConfig, fs) {
     // OPA Journey file
     const startPages = config.pages.filter((page) => page.isStartup).map((page) => page.targetKey);
     const LROP = findLROP(config.pages, manifest);
+    // Access ux-specification to get feature data for OPA test generation
+    const { filterBarItems, tableColumns } = await (0, modelUtils_1.getFeatureData)(basePath, editor, log);
     const journeyParams = {
         startPages,
         startLR: LROP.pageLR?.targetKey,
         navigatedOP: LROP.pageOP?.targetKey,
-        hideFilterBar: config.hideFilterBar
+        hideFilterBar: config.hideFilterBar,
+        filterBarItems: filterBarItems,
+        tableColumns: tableColumns
     };
     editor.copyTpl((0, node_path_1.join)(rootV4TemplateDirPath, 'integration/FirstJourney.js'), (0, node_path_1.join)(testOutDirPath, `integration/${config.opaJourneyFileName}.js`), journeyParams, undefined, {
         globOptions: { dot: true }

package/dist/types.d.ts

@@ -18,6 +18,7 @@ export type FEV4OPAConfig = {
     opaJourneyFileName: string;
     htmlTarget: string;
     hideFilterBar: boolean;
+    filterBarItems?: string[];
 };
 export type FEV4ManifestTarget = {
     type?: string;
@@ -61,4 +62,8 @@ export interface FFOPAConfig {
     ui5Version?: string;
     ui5Theme?: string;
 }
+export type FeatureData = {
+    filterBarItems?: string[];
+    tableColumns?: Record<string, Record<string, string | number | boolean>>;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/utils/modelUtils.d.ts

@@ -0,0 +1,59 @@
+import type { Editor } from 'mem-fs-editor';
+import type { Logger } from '@sap-ux/logger';
+import type { TreeAggregation, TreeAggregations, TreeModel, ApplicationModel } from '@sap/ux-specification/dist/types/src/parser';
+import type { FeatureData } from '../types';
+export interface AggregationItem extends TreeAggregation {
+    description: string;
+}
+/**
+ * Gets feature data from the application model using ux-specification.
+ *
+ * @param basePath - the absolute target path where the application will be generated
+ * @param fs - optional mem-fs editor instance
+ * @param log - optional logger instance
+ * @returns feature data extracted from the application model
+ */
+export declare function getFeatureData(basePath: string, fs?: Editor, log?: Logger): Promise<FeatureData>;
+/**
+ * Retrieves all List Report definitions from the given application model.
+ *
+ * @param applicationModel - The application model containing page definitions.
+ * @returns An array of List Report definitions.
+ */
+export declare function getListReportPage<T = ApplicationModel['pages'][string]>(applicationModel: ApplicationModel): T | null;
+/**
+ * Retrieves all Object Page definitions from the given application model.
+ *
+ * @param applicationModel - The application model containing page definitions.
+ * @returns An array of Object Page definitions.
+ */
+export declare function getObjectPages<T = ApplicationModel['pages'][string]>(applicationModel: ApplicationModel): T[];
+/**
+ * Retrieves the aggregations from the given tree aggregations node.
+ *
+ * @param node - The tree aggregations node.
+ * @returns The aggregations object.
+ */
+export declare function getAggregations(node: TreeAggregation): TreeAggregations;
+/**
+ * Retrieves selection field items from the given selection fields aggregation.
+ *
+ * @param selectionFieldsAgg - The selection fields aggregation containing field definitions.
+ * @returns An array of selection field descriptions.
+ */
+export declare function getSelectionFieldItems(selectionFieldsAgg: TreeAggregations): string[];
+/**
+ * Retrieves filter field descriptions from the given tree model.
+ *
+ * @param pageModel - The tree model containing filter bar definitions.
+ * @returns An array of filter field descriptions.
+ */
+export declare function getFilterFields(pageModel: TreeModel): TreeAggregations;
+/**
+ * Retrieves the table columns aggregation from the given tree model.
+ *
+ * @param pageModel - The tree model containing table column definitions.
+ * @returns The table columns aggregation object.
+ */
+export declare function getTableColumns(pageModel: TreeModel): TreeAggregations;
+//# sourceMappingURL=modelUtils.d.ts.map

package/dist/utils/modelUtils.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFeatureData = getFeatureData;
+exports.getListReportPage = getListReportPage;
+exports.getObjectPages = getObjectPages;
+exports.getAggregations = getAggregations;
+exports.getSelectionFieldItems = getSelectionFieldItems;
+exports.getFilterFields = getFilterFields;
+exports.getTableColumns = getTableColumns;
+const project_access_1 = require("@sap-ux/project-access");
+/**
+ * Gets feature data from the application model using ux-specification.
+ *
+ * @param basePath - the absolute target path where the application will be generated
+ * @param fs - optional mem-fs editor instance
+ * @param log - optional logger instance
+ * @returns feature data extracted from the application model
+ */
+async function getFeatureData(basePath, fs, log) {
+    const featureData = {};
+    let listReportPage = null;
+    // Read application model to extract control information needed for test generation
+    // specification and readApp might not be available due to specification version, fail gracefully
+    try {
+        // readApp calls createApplicationAccess internally if given a path, but it uses the "live" version of project-access without fs enhancement
+        const appAccess = await (0, project_access_1.createApplicationAccess)(basePath, { fs: fs });
+        const specification = await appAccess.getSpecification();
+        const appResult = await specification.readApp({ app: appAccess, fs: fs });
+        listReportPage = appResult.applicationModel ? getListReportPage(appResult.applicationModel) : listReportPage;
+    }
+    catch (error) {
+        log?.warn('Error analyzing project model using specification. No dynamic tests will be generated. Error: ' +
+            error.message);
+        return featureData;
+    }
+    if (!listReportPage) {
+        log?.warn('List Report page not found in application model. Dynamic tests will not be generated.');
+        return featureData;
+    }
+    // attempt to get individual feature data
+    featureData.filterBarItems = getFilterFieldNames(listReportPage.model, log);
+    featureData.tableColumns = getTableColumnData(listReportPage.model, log);
+    return featureData;
+}
+/**
+ * Gets identifier of a column for OPA5 tests.
+ * If the column is custom, the identifier is taken from the 'Key' entry in the schema keys.
+ * If the column is not custom, the identifier is taken from the 'Value' entry in the schema keys.
+ * If no such entry is found, undefined is returned.
+ *
+ * @param column - column module from ux specification
+ * @param column.custom boolean indicating whether the column is custom
+ * @param column.schema schema of the column
+ * @param column.schema.keys keys of the column; expected to have an entry with the name 'Key' or 'Value'
+ * @returns identifier of the column for OPA5 tests; can be the name or index
+ */
+function getColumnIdentifier(column) {
+    const key = column.custom ? 'Key' : 'Value';
+    const keyEntry = column.schema.keys.find((entry) => entry.name === key);
+    return keyEntry?.value;
+}
+/**
+ * Transforms column aggregations from the ux specification model into a map of columns for OPA5 tests.
+ *
+ * @param columnAggregations column aggregations from the ux specification model
+ * @returns a map of columns for OPA5 tests
+ */
+function transformTableColumns(columnAggregations) {
+    const columns = {};
+    Object.values(columnAggregations).forEach((columnAggregation, index) => {
+        columns[getColumnIdentifier(columnAggregation) ?? index] = {
+            header: columnAggregation.description
+            // TODO possibly more reliable properties could be used?
+        };
+    });
+    return columns;
+}
+/**
+ * Retrieves filter field names from the page model using ux-specification.
+ *
+ * @param pageModel - the tree model containing filter bar definitions
+ * @param log - optional logger instance
+ * @returns - an array of filter field names
+ */
+function getFilterFieldNames(pageModel, log) {
+    let filterBarItems = [];
+    try {
+        const filterBarAggregations = getFilterFields(pageModel);
+        filterBarItems = getSelectionFieldItems(filterBarAggregations);
+    }
+    catch (error) {
+        log?.debug(error);
+    }
+    if (!filterBarItems?.length) {
+        log?.warn('Unable to extract filter fields from project model using specification. No filter field tests will be generated.');
+    }
+    return filterBarItems;
+}
+/**
+ * Retrieves table column data from the page model using ux-specification.
+ *
+ * @param pageModel - the tree model containing table column definitions
+ * @param log - optional logger instance
+ * @returns - a map of table columns
+ */
+function getTableColumnData(pageModel, log) {
+    let tableColumns = {};
+    try {
+        const columnAggregations = getTableColumns(pageModel);
+        tableColumns = transformTableColumns(columnAggregations);
+    }
+    catch (error) {
+        log?.debug(error);
+    }
+    if (!tableColumns || !Object.keys(tableColumns).length) {
+        log?.warn('Unable to extract table columns from project model using specification. No table column tests will be generated.');
+    }
+    return tableColumns;
+}
+/**
+ * Retrieves all List Report definitions from the given application model.
+ *
+ * @param applicationModel - The application model containing page definitions.
+ * @returns An array of List Report definitions.
+ */
+function getListReportPage(applicationModel) {
+    for (const pageKey in applicationModel.pages) {
+        const page = applicationModel.pages[pageKey];
+        if (page.pageType === 'ListReport') {
+            return page;
+        }
+    }
+    return null;
+}
+/**
+ * Retrieves all Object Page definitions from the given application model.
+ *
+ * @param applicationModel - The application model containing page definitions.
+ * @returns An array of Object Page definitions.
+ */
+function getObjectPages(applicationModel) {
+    const objectPages = [];
+    for (const pageKey in applicationModel.pages) {
+        const page = applicationModel.pages[pageKey];
+        if (page.pageType === 'ObjectPage') {
+            objectPages.push(page);
+        }
+    }
+    return objectPages;
+}
+/**
+ * Retrieves the aggregations from the given tree aggregations node.
+ *
+ * @param node - The tree aggregations node.
+ * @returns The aggregations object.
+ */
+function getAggregations(node) {
+    if (node && typeof node === 'object' && 'aggregations' in node) {
+        return node.aggregations;
+    }
+    return {};
+}
+/**
+ * Retrieves selection field items from the given selection fields aggregation.
+ *
+ * @param selectionFieldsAgg - The selection fields aggregation containing field definitions.
+ * @returns An array of selection field descriptions.
+ */
+function getSelectionFieldItems(selectionFieldsAgg) {
+    if (selectionFieldsAgg && typeof selectionFieldsAgg === 'object') {
+        const items = [];
+        for (const itemKey in selectionFieldsAgg) {
+            items.push(selectionFieldsAgg[itemKey].description);
+        }
+        return items;
+    }
+    return [];
+}
+/**
+ * Retrieves filter field descriptions from the given tree model.
+ *
+ * @param pageModel - The tree model containing filter bar definitions.
+ * @returns An array of filter field descriptions.
+ */
+function getFilterFields(pageModel) {
+    const filterBar = getAggregations(pageModel.root)['filterBar'];
+    const filterBarAggregations = getAggregations(filterBar);
+    const selectionFields = filterBarAggregations['selectionFields'];
+    const selectionFieldsAggregations = getAggregations(selectionFields);
+    return selectionFieldsAggregations;
+}
+/**
+ * Retrieves the table columns aggregation from the given tree model.
+ *
+ * @param pageModel - The tree model containing table column definitions.
+ * @returns The table columns aggregation object.
+ */
+function getTableColumns(pageModel) {
+    const table = getAggregations(pageModel.root)['table'];
+    const tableAggregations = getAggregations(table);
+    const columns = tableAggregations['columns'];
+    const columnAggregations = getAggregations(columns);
+    return columnAggregations;
+}
+//# sourceMappingURL=modelUtils.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-test-writer",
   "description": "SAP UI5 tests writer",
-  "version": "0.7.52",
+  "version": "0.7.54",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -24,9 +24,10 @@
     "i18next": "25.3.0",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/ui5-application-writer": "1.7.1",
+    "@sap/ux-specification": "1.139.2",
+    "@sap-ux/ui5-application-writer": "1.7.2",
     "@sap-ux/logger": "0.8.0",
-    "@sap-ux/project-access": "1.34.0"
+    "@sap-ux/project-access": "1.34.2"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",

package/templates/v4/integration/FirstJourney.js

@@ -9,9 +9,17 @@ sap.ui.define([
 
         opaTest("Start application", function (Given, When, Then) {
             Given.iStartMyApp();
-<% startPages.forEach(function(pageName) { %>
-            Then.onThe<%- pageName%>.iSeeThisPage();
-<% });%>
+            <%_ startPages.forEach(function(pageName) { %>
+            Then.onThe<%- pageName %>.iSeeThisPage();
+            <%_ if (filterBarItems && filterBarItems.length > 0) { -%>
+                <%_ filterBarItems.forEach(function(item) { _%>
+            Then.onThe<%- pageName%>.onFilterBar().iCheckFilterField("<%- item %>");
+                <%_ }); -%>
+            <%_ } -%>
+            <%_ if (tableColumns && Object.keys(tableColumns).length > 0) { _%>
+            Then.onThe<%- pageName %>.onTable().iCheckColumns(<%- Object.keys(tableColumns).length %>, <%- JSON.stringify(tableColumns) %>);
+            <%_ } %>
+            <%_ }); -%>
         });
 
 <% if (startLR) { %>