@sap-ux/ui5-test-writer 0.7.113 → 0.9.2

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

@@ -10,6 +10,7 @@ import type { Logger } from '@sap-ux/logger';
  * @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 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 opaConfig.useVirtualPreviewEndpoints - when true, OPA harness files are served virtually; skip writing them to disk
  * @param metadata - optional metadata for the OPA test generation
  * @param fs - an optional reference to a mem-fs editor
  * @param log - optional logger instance
@@ -20,6 +21,7 @@ export declare function generateOPAFiles(basePath: string, opaConfig: {
     scriptName?: string;
     appID?: string;
     htmlTarget?: string;
+    useVirtualPreviewEndpoints?: boolean;
 }, metadata?: string, fs?: Editor, log?: Logger, standalone?: boolean): Promise<Editor>;
 /**
  * Reads the manifest for an app.

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

@@ -23,6 +23,7 @@ const flpSandboxUtils_1 = require("./utils/flpSandboxUtils");
  * @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 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 opaConfig.useVirtualPreviewEndpoints - when true, OPA harness files are served virtually; skip writing them to disk
  * @param metadata - optional metadata for the OPA test generation
  * @param fs - an optional reference to a mem-fs editor
  * @param log - optional logger instance
@@ -64,8 +65,11 @@ async function generateOPAFiles(basePath, opaConfig, metadata, fs, log, standalo
         }
     }
     else {
-        writeCommonAndPageFiles(writeContext, rootCommonTemplateDirPath);
-        writeJourneyFiles(appFeatures, writeContext, false);
+        writeCommonAndPageFiles(writeContext, rootCommonTemplateDirPath, opaConfig.useVirtualPreviewEndpoints ?? false);
+        writeJourneyFiles(appFeatures, writeContext, false, false, opaConfig.useVirtualPreviewEndpoints ?? false);
+        if (opaConfig.useVirtualPreviewEndpoints) {
+            await (0, opaQUnitUtils_1.addVirtualTestConfig)(basePath, [{ framework: 'OPA5', path: '/test/integration/opaTests.qunit.html' }, { framework: 'Testsuite' }], editor);
+        }
     }
     return editor;
 }
@@ -307,15 +311,18 @@ function findLROP(pages, manifest) {
  *
  * @param writeContext - shared write context (config, paths, editor, journey params)
  * @param rootCommonTemplateDirPath - template root directory for common files
+ * @param useVirtualPreviewEndpoints - when true, testsuite harness files are served virtually; skip writing them to disk
  */
-function writeCommonAndPageFiles(writeContext, rootCommonTemplateDirPath) {
+function writeCommonAndPageFiles(writeContext, rootCommonTemplateDirPath, useVirtualPreviewEndpoints = false) {
     const { config, rootV4TemplateDirPath, testOutDirPath, editor, journeyParams } = writeContext;
-    // Common test files
-    editor.copyTpl((0, node_path_1.join)(rootCommonTemplateDirPath), testOutDirPath, 
-    // unit tests are not added for Fiori elements app
-    { appId: config.appID }, undefined, {
-        globOptions: { dot: true }
-    });
+    // Common test files (testsuite served virtually when useVirtualPreviewEndpoints is enabled)
+    if (!useVirtualPreviewEndpoints) {
+        editor.copyTpl((0, node_path_1.join)(rootCommonTemplateDirPath), testOutDirPath, 
+        // unit tests are not added for Fiori elements app
+        { appId: config.appID }, undefined, {
+            globOptions: { dot: true }
+        });
+    }
     config.pages.forEach((page) => {
         writePageObject(page, rootV4TemplateDirPath, testOutDirPath, editor);
     });

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

@@ -108,7 +108,7 @@ function getDestFilePath(filePath, freestyleTemplateDir, commonTemplateDir, temp
  */
 async function generateFreestyleOPAFiles(basePath, opaConfig, fs, log) {
     const fsEditor = fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
-    const { enableTypeScript, ui5Version, viewName, appId } = opaConfig;
+    const { enableTypeScript, ui5Version, viewName, appId, useVirtualPreviewEndpoints } = opaConfig;
     const freestyleTemplateDir = (0, node_path_1.join)(__dirname, '../templates/freestyle/webapp/test');
     const commonTemplateDir = (0, node_path_1.join)(__dirname, '../templates/common');
     const testOutDir = (0, node_path_1.join)(basePath, 'webapp/test');
@@ -118,11 +118,14 @@ async function generateFreestyleOPAFiles(basePath, opaConfig, fs, log) {
     const templateFiles = await (0, project_access_1.getFilePaths)(freestyleTemplateDir);
     const isTypeScript = Boolean(enableTypeScript);
     const templateFilteredFiles = filterByUi5Version(templateFiles, templateUi5Version);
-    const filteredFiles = filterByTypeScript(templateFilteredFiles, isTypeScript);
-    // copy common templates
-    const commonFiles = await (0, project_access_1.getFilePaths)(commonTemplateDir);
-    const filteredCommonFiles = commonFiles.filter((filePath) => filePath.endsWith('.html'));
-    filteredFiles.push(...filteredCommonFiles);
+    let filteredFiles = filterByTypeScript(templateFilteredFiles, isTypeScript);
+    if (useVirtualPreviewEndpoints) {
+        filteredFiles = filteredFiles.filter((filePath) => !['testsuite.qunit', 'unitTests.qunit', 'opaTests.qunit'].some((pattern) => filePath.includes(pattern)));
+    }
+    else {
+        const commonFiles = await (0, project_access_1.getFilePaths)(commonTemplateDir);
+        filteredFiles.push(...commonFiles.filter((f) => f.endsWith('.html')));
+    }
     const config = {
         ...opaConfig,
         viewNamePage: `${viewName}Page`,

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { generateOPAFiles } from './fiori-elements-opa-writer';
 export { generateFreestyleOPAFiles } from './fiori-freestyle-opa-writer';
+export { addVirtualTestConfig } from './utils/opaQUnitUtils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFreestyleOPAFiles = exports.generateOPAFiles = void 0;
+exports.addVirtualTestConfig = exports.generateFreestyleOPAFiles = exports.generateOPAFiles = void 0;
 var fiori_elements_opa_writer_1 = require("./fiori-elements-opa-writer");
 Object.defineProperty(exports, "generateOPAFiles", { enumerable: true, get: function () { return fiori_elements_opa_writer_1.generateOPAFiles; } });
 var fiori_freestyle_opa_writer_1 = require("./fiori-freestyle-opa-writer");
 Object.defineProperty(exports, "generateFreestyleOPAFiles", { enumerable: true, get: function () { return fiori_freestyle_opa_writer_1.generateFreestyleOPAFiles; } });
+var opaQUnitUtils_1 = require("./utils/opaQUnitUtils");
+Object.defineProperty(exports, "addVirtualTestConfig", { enumerable: true, get: function () { return opaQUnitUtils_1.addVirtualTestConfig; } });
 //# sourceMappingURL=index.js.map

package/dist/types.d.ts

@@ -75,6 +75,7 @@ export interface FFOPAConfig {
     viewName?: string;
     ui5Version?: string;
     ui5Theme?: string;
+    useVirtualPreviewEndpoints?: boolean;
 }
 export type ObjectPageNavigationParents = {
     parentLRName?: string;

package/dist/utils/opaQUnitUtils.d.ts

@@ -4,6 +4,7 @@
  * all other content (formatting, comments, whitespace) is preserved exactly.
  */
 import type { Editor } from 'mem-fs-editor';
+import type { TestConfig as PreviewMiddlewareTestConfig } from '@sap-ux/preview-middleware';
 /**
  * Splices new module paths into the sap.ui.require array of the content string.
  * Entries that are already present are skipped. All other content is preserved exactly.
@@ -90,4 +91,13 @@ export declare function addPagesToJourneyRunner(pages: JourneyRunnerPage[], test
  * @returns true when OPA5 is configured in a preview middleware, false otherwise
  */
 export declare function hasVirtualOPA5(basePath: string): Promise<boolean>;
+/**
+ * Updates the fiori-tools-preview middleware in ui5-mock.yaml to support virtual OPA test endpoints.
+ * Adds test framework entries to ui5-mock.yaml.
+ *
+ * @param basePath - the absolute target path of the application
+ * @param testFrameworks - the test framework entries to add to ui5-mock.yaml
+ * @param fs - the memfs editor instance
+ */
+export declare function addVirtualTestConfig(basePath: string, testFrameworks: PreviewMiddlewareTestConfig[], fs: Editor): Promise<void>;
 //# sourceMappingURL=opaQUnitUtils.d.ts.map

package/dist/utils/opaQUnitUtils.js

@@ -12,6 +12,7 @@ exports.addPathsToQUnitJs = addPathsToQUnitJs;
 exports.splicePageIntoJourneyRunner = splicePageIntoJourneyRunner;
 exports.addPagesToJourneyRunner = addPagesToJourneyRunner;
 exports.hasVirtualOPA5 = hasVirtualOPA5;
+exports.addVirtualTestConfig = addVirtualTestConfig;
 const node_path_1 = require("node:path");
 const flpSandboxUtils_1 = require("./flpSandboxUtils");
 const project_access_1 = require("@sap-ux/project-access");
@@ -300,4 +301,25 @@ async function hasVirtualOPA5(basePath) {
     }
     return false;
 }
+/**
+ * Updates the fiori-tools-preview middleware in ui5-mock.yaml to support virtual OPA test endpoints.
+ * Adds test framework entries to ui5-mock.yaml.
+ *
+ * @param basePath - the absolute target path of the application
+ * @param testFrameworks - the test framework entries to add to ui5-mock.yaml
+ * @param fs - the memfs editor instance
+ */
+async function addVirtualTestConfig(basePath, testFrameworks, fs) {
+    const yamlPath = (0, node_path_1.join)(basePath, project_access_1.FileName.Ui5MockYaml);
+    if (!fs.exists(yamlPath)) {
+        return;
+    }
+    const yamlConfig = await (0, project_access_1.readUi5Yaml)(basePath, project_access_1.FileName.Ui5MockYaml, fs);
+    const previewMiddleware = yamlConfig.findCustomMiddleware('fiori-tools-preview');
+    if (previewMiddleware?.configuration && !previewMiddleware.configuration.test?.length) {
+        previewMiddleware.configuration.test = [...testFrameworks];
+        yamlConfig.updateCustomMiddleware(previewMiddleware);
+        fs.write(yamlPath, yamlConfig.toString());
+    }
+}
 //# sourceMappingURL=opaQUnitUtils.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-test-writer",
   "description": "SAP UI5 tests writer",
-  "version": "0.7.113",
+  "version": "0.9.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -27,10 +27,11 @@
     "@sap/ux-specification": "1.144.0",
     "@sap-ux/edmx-parser": "0.10.0",
     "@sap-ux/annotation-converter": "0.10.21",
-    "@sap-ux/ui5-application-writer": "1.8.8",
-    "@sap-ux/logger": "0.8.5",
-    "@sap-ux/fiori-generator-shared": "0.14.1",
-    "@sap-ux/project-access": "1.36.4"
+    "@sap-ux/ui5-application-writer": "1.9.0",
+    "@sap-ux/logger": "0.9.0",
+    "@sap-ux/fiori-generator-shared": "0.15.1",
+    "@sap-ux/project-access": "1.37.0",
+    "@sap-ux/preview-middleware": "0.26.2"
   },
   "devDependencies": {
     "@types/ejs": "3.1.5",
@@ -40,10 +41,10 @@
     "rimraf": "6.1.3",
     "fs-extra": "11.3.4",
     "@sap-ux/vocabularies-types": "0.15.0",
-    "@sap-ux/jest-file-matchers": "0.2.11"
+    "@sap-ux/jest-file-matchers": "0.3.0"
   },
   "engines": {
-    "node": ">=20.x"
+    "node": ">=22.x"
   },
   "scripts": {
     "build": "tsc --build",