@sap-ux/ui5-test-writer 0.2.1 → 0.3.1

package/dist/index.js

@@ -26,22 +26,26 @@ function readManifest(fs, basePath) {
  * Retrieves the application type of the main datasource (FreeStyle, FE V2 or FE V4).
  *
  * @param manifest - the app descriptor of the app
- * @returns the application type. An exception is thrown if it can't be found or if it's not supported
+ * @returns {{ applicationType: string, hideFilterBar: boolean }} An object containing the application type and hideFilterBar flag. An exception is thrown if it can't be found or if it's not supported
  */
-function getAppTypeFromManifest(manifest) {
-    var _a, _b;
+function getAppTypeAndHideFilterBarFromManifest(manifest) {
+    var _a, _b, _c, _d, _e;
     const appTargets = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.routing) === null || _b === void 0 ? void 0 : _b.targets;
+    let hideFilterBar = false;
     let isFEV4 = false;
     for (const targetKey in appTargets) {
         const target = appTargets[targetKey];
         if (target.type === 'Component' && target.name && target.name in types_1.SupportedPageTypes) {
             isFEV4 = true;
+            if (types_1.SupportedPageTypes[target.name] === 'ListReport') {
+                hideFilterBar = (_e = (_d = (_c = target.options) === null || _c === void 0 ? void 0 : _c.settings) === null || _d === void 0 ? void 0 : _d.hideFilterBar) !== null && _e !== void 0 ? _e : false;
+            }
         }
     }
     if (!isFEV4) {
         throw new types_1.ValidationError((0, i18n_1.t)('error.badApplicationType'));
     }
-    return 'v4'; // For the time being, only FE V4 is supported
+    return { applicationType: 'v4', hideFilterBar }; // For the time being, only FE V4 is supported
 }
 /**
  * Retrieves appID and appPath from the manifest.
@@ -105,9 +109,10 @@ function createPageConfig(manifest, targetKey, forcedAppID) {
  * @param opaConfig.scriptName - the name of the OPA journey file. If not specified, 'FirstJourney' will be used
  * @param opaConfig.htmlTarget - the name of the html file that will be used in the 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 hideFilterBar - whether the filter bar should be hidden in the generated tests
  * @returns OPA test configuration object
  */
-function createConfig(manifest, opaConfig) {
+function createConfig(manifest, opaConfig, hideFilterBar) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     // General application info
     const { appID, appPath } = getAppFromManifest(manifest, opaConfig.appID);
@@ -116,7 +121,8 @@ function createConfig(manifest, opaConfig) {
         appPath,
         pages: [],
         opaJourneyFileName: (_a = opaConfig.scriptName) !== null && _a !== void 0 ? _a : 'FirstJourney',
-        htmlTarget: (_b = opaConfig.htmlTarget) !== null && _b !== void 0 ? _b : 'index.html'
+        htmlTarget: (_b = opaConfig.htmlTarget) !== null && _b !== void 0 ? _b : 'index.html',
+        hideFilterBar
     };
     // Identify startup targets from the routes
     const appRoutes = ((_e = (_d = (_c = manifest['sap.ui5']) === null || _c === void 0 ? void 0 : _c.routing) === null || _d === void 0 ? void 0 : _d.routes) !== null && _e !== void 0 ? _e : []);
@@ -217,8 +223,8 @@ function generateOPAFiles(basePath, opaConfig, fs) {
     var _a, _b;
     const editor = fs || (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     const manifest = readManifest(editor, basePath);
-    const applicationType = getAppTypeFromManifest(manifest);
-    const config = createConfig(manifest, opaConfig);
+    const { applicationType, hideFilterBar } = getAppTypeAndHideFilterBarFromManifest(manifest);
+    const config = createConfig(manifest, opaConfig, hideFilterBar);
     const rootCommonTemplateDirPath = (0, path_1.join)(__dirname, '../templates/common');
     const rootV4TemplateDirPath = (0, path_1.join)(__dirname, `../templates/${applicationType}`); // Only v4 is supported for the time being
     const testOutDirPath = (0, path_1.join)(basePath, 'webapp/test');
@@ -238,7 +244,8 @@ function generateOPAFiles(basePath, opaConfig, fs) {
     const journeyParams = {
         startPages,
         startLR: (_a = LROP.pageLR) === null || _a === void 0 ? void 0 : _a.targetKey,
-        navigatedOP: (_b = LROP.pageOP) === null || _b === void 0 ? void 0 : _b.targetKey
+        navigatedOP: (_b = LROP.pageOP) === null || _b === void 0 ? void 0 : _b.targetKey,
+        hideFilterBar: config.hideFilterBar
     };
     editor.copyTpl((0, path_1.join)(rootV4TemplateDirPath, 'integration/FirstJourney.js'), (0, path_1.join)(testOutDirPath, `integration/${config.opaJourneyFileName}.js`), journeyParams, undefined, {
         globOptions: { dot: true }
@@ -260,7 +267,7 @@ exports.generateOPAFiles = generateOPAFiles;
 function generatePageObjectFile(basePath, pageObjectParameters, fs) {
     const editor = fs || (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     const manifest = readManifest(editor, basePath);
-    const applicationType = getAppTypeFromManifest(manifest);
+    const { applicationType } = getAppTypeAndHideFilterBarFromManifest(manifest);
     const pageConfig = createPageConfig(manifest, pageObjectParameters.targetKey, pageObjectParameters.appID);
     if (pageConfig) {
         const rootTemplateDirPath = (0, path_1.join)(__dirname, `../templates/${applicationType}`); // Only v4 is supported for the time being

package/dist/types.d.ts

@@ -17,6 +17,7 @@ export type FEV4OPAConfig = {
     pages: FEV4OPAPageConfig[];
     opaJourneyFileName: string;
     htmlTarget: string;
+    hideFilterBar: boolean;
 };
 export type FEV4ManifestTarget = {
     type?: string;
@@ -26,6 +27,7 @@ export type FEV4ManifestTarget = {
         settings?: {
             entitySet?: string;
             contextPath?: string;
+            hideFilterBar?: boolean;
             navigation?: {
                 [id: string]: {
                     detail?: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-test-writer",
   "description": "SAP UI5 tests writer",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -31,11 +31,11 @@
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "fs-extra": "10.0.0",
-    "@sap-ux/project-access": "1.13.8"
+    "@sap-ux/project-access": "1.15.1"
   },
   "engines": {
     "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",
-    "node": ">= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0 || >=18.0.0 < 19.0.0"
+    "node": ">=18.x"
   },
   "scripts": {
     "build": "tsc --build",

package/templates/v4/integration/FirstJourney.js

@@ -17,7 +17,9 @@ sap.ui.define([
 <% if (startLR) { %>
             opaTest("Navigate to ObjectPage", function (Given, When, Then) {
                 // Note: this test will fail if the ListReport page doesn't show any data
+                <% if (!hideFilterBar) { %>
                 When.onThe<%- startLR%>.onFilterBar().iExecuteSearch();
+                <%} %>
                 Then.onThe<%- startLR%>.onTable().iCheckRows();
 <% if (navigatedOP) { %>
                 When.onThe<%- startLR%>.onTable().iPressRow(0);