@sap-ux/app-config-writer 0.5.9 → 0.5.11

package/dist/preview-config/index.d.ts

@@ -8,9 +8,15 @@ import { type ToolsLogger } from '@sap-ux/logger';
  * Corresponding files which are used for the preview are renamed or deleted.
  *
  * @param basePath - base path to be used for the conversion
- * @param logger logger to report info to the user
- * @param fs - file system reference
+ * @param options - options for the conversion
+ * @param options.convertTests - if set to true, then test suite and test runners fill be included in the conversion
+ * @param options.logger - logger to report info to the user
+ * @param options.fs - file system reference
  * @returns file system reference
  */
-export declare function convertToVirtualPreview(basePath: string, logger?: ToolsLogger, fs?: Editor): Promise<Editor>;
+export declare function convertToVirtualPreview(basePath: string, options: {
+    convertTests?: boolean;
+    logger?: ToolsLogger;
+    fs?: Editor;
+}): Promise<Editor>;
 //# sourceMappingURL=index.d.ts.map

package/dist/preview-config/index.js

@@ -15,14 +15,16 @@ const package_json_1 = require("./package-json");
  * Corresponding files which are used for the preview are renamed or deleted.
  *
  * @param basePath - base path to be used for the conversion
- * @param logger logger to report info to the user
- * @param fs - file system reference
+ * @param options - options for the conversion
+ * @param options.convertTests - if set to true, then test suite and test runners fill be included in the conversion
+ * @param options.logger - logger to report info to the user
+ * @param options.fs - file system reference
  * @returns file system reference
  */
-async function convertToVirtualPreview(basePath, logger, fs) {
-    if (!fs) {
-        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
-    }
+async function convertToVirtualPreview(basePath, options) {
+    const fs = options.fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+    const logger = options.logger;
+    const convertTests = options.convertTests ?? false;
     if (!(await (0, prerequisites_1.checkPrerequisites)(basePath, fs, logger))) {
         throw Error('The prerequisites are not met. For more information, see the log messages above.');
     }
@@ -30,8 +32,12 @@ async function convertToVirtualPreview(basePath, logger, fs) {
         logger?.error('You have not approved the conversion. The conversion has been aborted.');
         return fs;
     }
-    await (0, ui5_yaml_1.updatePreviewMiddlewareConfigs)(fs, basePath, logger);
+    await (0, ui5_yaml_1.updatePreviewMiddlewareConfigs)(fs, basePath, convertTests, logger);
     await (0, preview_files_1.renameDefaultSandboxes)(fs, basePath, logger);
+    if (convertTests) {
+        await (0, preview_files_1.renameDefaultTestFiles)(fs, basePath, logger);
+        await (0, ui5_yaml_1.updateDefaultTestConfig)(fs, basePath, logger);
+    }
     await (0, preview_files_1.deleteNoLongerUsedFiles)(fs, basePath, logger);
     await (0, package_json_1.updateVariantsCreationScript)(fs, basePath, logger);
     return fs;

package/dist/preview-config/package-json.d.ts

@@ -38,9 +38,10 @@ export declare function extractUrlDetails(script: string): {
  *
  * @param scriptName - the name of the script from the package.json file
  * @param script - the content of the script from the package.json file
+ * @param convertTests - indicator if test suite and test runner should be included in the conversion (default: false)
  * @returns indicator if the script is valid
  */
-export declare function isValidPreviewScript(scriptName: string, script: string | undefined): boolean;
+export declare function isValidPreviewScript(scriptName: string, script: string | undefined, convertTests?: boolean): boolean;
 /**
  * Updates the variants creation script in package.json if needed.
  *

package/dist/preview-config/package-json.js

@@ -38,8 +38,9 @@ function ensurePreviewMiddlewareDependency(packageJson, fs, packageJsonPath) {
  */
 function extractUrlDetails(script) {
     //extract the URL from the 'open' command of the script
-    let url = / (?:--open|-o|--o) ([^"]?\S*)/.exec(script)?.[1] ?? undefined;
-    url = url?.startsWith('"') ? url.slice(1) : url;
+    let url = / (?:--open|-o|--o) (\S*)/.exec(script)?.[1] ?? undefined;
+    //delete double or single quotes from the URL
+    url = url?.replace(/['"]/g, '');
     //extract the path from the URL
     const path = /^[^?#]+\.html/.exec(url ?? '')?.[0] ?? undefined;
     //extract the intent from the URL
@@ -68,16 +69,18 @@ function extractUrlDetails(script) {
  *
  * @param scriptName - the name of the script from the package.json file
  * @param script - the content of the script from the package.json file
+ * @param convertTests - indicator if test suite and test runner should be included in the conversion (default: false)
  * @returns indicator if the script is valid
  */
-function isValidPreviewScript(scriptName, script) {
+function isValidPreviewScript(scriptName, script, convertTests = false) {
     const isValidScriptName = scriptName != 'start-variants-management' && scriptName != 'start-control-property-editor';
     //eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
     const startsWebServer = !!(script?.includes('ui5 serve') || script?.includes('fiori run'));
     const { path } = extractUrlDetails(script ?? '');
-    const opensTest = path?.includes('qunit.html');
+    const opensTest = (0, ui5_yaml_1.isTestPath)(path);
     const opensIndexHtml = path === 'index.html';
-    return isValidScriptName && startsWebServer && !opensTest && !opensIndexHtml;
+    //tests are only relevant if the conversion of test runners is excluded
+    return isValidScriptName && startsWebServer && !opensIndexHtml && (convertTests ? true : !opensTest);
 }
 /**
  * Updates the variants creation script in package.json if needed.

package/dist/preview-config/prerequisites.js

@@ -4,6 +4,23 @@ exports.checkPrerequisites = checkPrerequisites;
 exports.getExplicitApprovalToAdjustFiles = getExplicitApprovalToAdjustFiles;
 const path_1 = require("path");
 const prompts_1 = require("prompts");
+const semver_1 = require("semver");
+/**
+ * Check if the version of the given package is lower than the minimal version.
+ *
+ * @param packageJson - the package.json file content
+ * @param dependencyName - the name of the (dev)dependency to check
+ * @param minVersionInfo - the minimal version to check against
+ * @param mandatory - (default true) if the existence of the dependency is mandatory
+ * @returns indicator if the version is lower than the minimal version
+ */
+function isLowerThanMinimalVersion(packageJson, dependencyName, minVersionInfo, mandatory = true) {
+    const versionInfo = packageJson?.devDependencies?.[dependencyName] ?? packageJson?.dependencies?.[dependencyName];
+    if (!versionInfo) {
+        return mandatory;
+    }
+    return !(0, semver_1.satisfies)(minVersionInfo, versionInfo);
+}
 /**
  * Check if the prerequisites for the conversion are met.
  * - UI5 CLI version 3.0.0 or higher is being used.
@@ -28,11 +45,14 @@ async function checkPrerequisites(basePath, fs, logger) {
         logger?.error("Conversion from '@sap/grunt-sapui5-bestpractice-build' is not supported. You must migrate to UI5 CLI version 3.0.0 or higher. For more information, see https://sap.github.io/ui5-tooling/v3/updates/migrate-v3.");
         prerequisitesMet = false;
     }
-    const ui5CliVersion = packageJson?.devDependencies?.['@ui5/cli'] ?? packageJson?.dependencies?.['@ui5/cli'] ?? '0';
-    if (parseInt(ui5CliVersion.split('.')[0], 10) < 3) {
+    if (isLowerThanMinimalVersion(packageJson, '@ui5/cli', '3.0.0')) {
         logger?.error('UI5 CLI version 3.0.0 or higher is required to convert the preview to virtual files. For more information, see https://sap.github.io/ui5-tooling/v3/updates/migrate-v3.');
         prerequisitesMet = false;
     }
+    if (isLowerThanMinimalVersion(packageJson, '@sap/ux-ui5-tooling', '1.15.4', false)) {
+        logger?.error('UX UI5 Tooling version 1.15.4 or higher is required to convert the preview to virtual files. For more information, see https://www.npmjs.com/package/@sap/ux-ui5-tooling.');
+        prerequisitesMet = false;
+    }
     const ui5MiddlewareMockserverExists = !!packageJson?.devDependencies?.['@sap-ux/ui5-middleware-fe-mockserver'] ||
         !!packageJson?.dependencies?.['@sap-ux/ui5-middleware-fe-mockserver'];
     const cdsPluginUi5Exists = !!packageJson?.devDependencies?.['cds-plugin-ui5'] || !!packageJson?.dependencies?.['cds-plugin-ui5'];
@@ -52,7 +72,7 @@ async function getExplicitApprovalToAdjustFiles() {
         type: 'confirm',
         name: 'approval',
         initial: false,
-        message: 'The converter will rename the HTML files and delete the JS and TS files used for the existing preview functionality and configure virtual files instead. Do you want to proceed with the conversion?'
+        message: 'The converter will rename the HTML files and delete the JS and TS files used for the existing preview functionality and configure virtual endpoints instead. Do you want to proceed with the conversion?'
     };
     return Boolean((await (0, prompts_1.prompt)([question])).approval);
 }

package/dist/preview-config/preview-files.d.ts

@@ -21,6 +21,16 @@ export declare function renameSandbox(fs: Editor, path: string, logger?: ToolsLo
  * @param logger logger to report info to the user
  */
 export declare function renameDefaultSandboxes(fs: Editor, basePath: string, logger?: ToolsLogger): Promise<void>;
+/**
+ * Renames the default test suite and runner files.
+ *
+ * The default files are 'testsuite.qunit.html', 'integration/opaTests.qunit.html' and 'unit/unitTests.qunit.html' located under webapp/test.
+ *
+ * @param fs - file system reference
+ * @param basePath - base path to be used for the conversion
+ * @param logger logger to report info to the user
+ */
+export declare function renameDefaultTestFiles(fs: Editor, basePath: string, logger?: ToolsLogger): Promise<void>;
 /**
  * Deletes the *.js and *.ts files which are no longer used for the virtual preview.
  *

package/dist/preview-config/preview-files.js

@@ -2,10 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.renameSandbox = renameSandbox;
 exports.renameDefaultSandboxes = renameDefaultSandboxes;
+exports.renameDefaultTestFiles = renameDefaultTestFiles;
 exports.deleteNoLongerUsedFiles = deleteNoLongerUsedFiles;
 const path_1 = require("path");
 const project_access_1 = require("@sap-ux/project-access");
-const renameMessage = (filename) => `Renamed '${filename}' to '${filename.slice(0, -5)}_old.html'. This file is no longer needed for the preview functionality. If you have not modified this file, you can delete it. If you have modified this file, move the modified content to a custom init script for the preview middleware. For more information, see https://www.npmjs.com/package/preview-middleware#migration.`;
+const ui5_yaml_1 = require("./ui5-yaml");
+const renameMessage = (filename) => `Renamed '${filename}' to '${filename.slice(0, -5)}_old.html'. This file is no longer needed for the preview functionality. If you have not modified this file, you can delete it. If you have modified this file, move the modified content to a custom init script for the preview middleware. For more information, see https://github.com/SAP/open-ux-tools/tree/main/packages/preview-middleware#migration.`;
 /**
  * Renames the sandbox file which is used in a given script.
  *
@@ -28,7 +30,7 @@ async function renameSandbox(fs, path, logger) {
         logger?.debug(`The file '${(0, path_1.basename)(path)}', has already been renamed. Skipping renaming.`);
     }
     else {
-        logger?.warn(`The file '${(0, path_1.basename)(path)}', has not been found. Skipping renaming.`);
+        logger?.info(`The file '${(0, path_1.basename)(path)}', has not been found. Skipping renaming.`);
     }
 }
 /**
@@ -47,6 +49,20 @@ async function renameDefaultSandboxes(fs, basePath, logger) {
         await renameSandbox(fs, (0, path_1.join)(await (0, project_access_1.getWebappPath)(basePath), path), logger);
     }
 }
+/**
+ * Renames the default test suite and runner files.
+ *
+ * The default files are 'testsuite.qunit.html', 'integration/opaTests.qunit.html' and 'unit/unitTests.qunit.html' located under webapp/test.
+ *
+ * @param fs - file system reference
+ * @param basePath - base path to be used for the conversion
+ * @param logger logger to report info to the user
+ */
+async function renameDefaultTestFiles(fs, basePath, logger) {
+    for (const path of Object.values(ui5_yaml_1.TEST_CONFIG_DEFAULTS).map((config) => config.path)) {
+        await renameSandbox(fs, (0, path_1.join)(await (0, project_access_1.getWebappPath)(basePath), path), logger);
+    }
+}
 /**
  * Deletes the *.js and *.ts files which are no longer used for the virtual preview.
  *

package/dist/preview-config/ui5-yaml.d.ts

@@ -1,8 +1,21 @@
 import type { CustomMiddleware } from '@sap-ux/ui5-config';
 import type { Editor } from 'mem-fs-editor';
-import type { FlpConfig } from '@sap-ux/preview-middleware';
+import type { FlpConfig, MiddlewareConfig as PreviewConfig } from '@sap-ux/preview-middleware';
 import type { PreviewConfigOptions } from '../types';
 import type { ToolsLogger } from '@sap-ux/logger';
+type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType[number];
+type PreviewTestConfig = ArrayElement<Required<PreviewConfig>['test']>;
+export declare const TEST_CONFIG_DEFAULTS: Record<string, Readonly<Required<PreviewTestConfig>>>;
+/**
+ * Check if the path is a test path.
+ * 1) path matches pattern '**.qunit.html'
+ * 2) path is being used as test configuration path in yaml configuration.
+ *
+ * @param path - the path
+ * @param configuration - the preview configuration
+ * @returns indicator if the path is a test path
+ */
+export declare function isTestPath(path: string | undefined, configuration?: PreviewConfig): boolean;
 /**
  * Extract the UI5 yaml configuration file name from the script.
  *
@@ -34,6 +47,22 @@ export declare function processUi5YamlConfig(fs: Editor, basePath: string, ui5Ya
  * @returns the preview middleware configuration
  */
 export declare function updatePreviewMiddlewareConfig(previewMiddleware: CustomMiddleware<PreviewConfigOptions>, intent: FlpConfig['intent'] | undefined, path: string | undefined): CustomMiddleware<PreviewConfigOptions>;
+/**
+ * Update the test configuration.
+ *
+ * @param testConfiguration - the test configuration
+ * @param path - the path
+ * @returns the updated test configuration
+ */
+export declare function updateTestConfig(testConfiguration: PreviewConfig['test'], path: string | undefined): PreviewConfig['test'];
+/**
+ * Updates the default test configurations in the 'ui5.yaml' in case no test config exists in any UI5 configuration file.
+ *
+ * @param fs - file system reference
+ * @param basePath - base path to be used for the conversion
+ * @param logger logger to report info to the user
+ */
+export declare function updateDefaultTestConfig(fs: Editor, basePath: string, logger?: ToolsLogger): Promise<void>;
 /**
  * Updates the preview middleware configurations according to the scripts they are being used in package.json.
  *
@@ -43,7 +72,9 @@ export declare function updatePreviewMiddlewareConfig(previewMiddleware: CustomM
  *
  * @param fs - file system reference
  * @param basePath - base path to be used for the conversion
+ * @param convertTests - indicator if test suite and test runner should be included in the conversion
  * @param logger logger to report info to the user
  */
-export declare function updatePreviewMiddlewareConfigs(fs: Editor, basePath: string, logger?: ToolsLogger): Promise<void>;
+export declare function updatePreviewMiddlewareConfigs(fs: Editor, basePath: string, convertTests: boolean, logger?: ToolsLogger): Promise<void>;
+export {};
 //# sourceMappingURL=ui5-yaml.d.ts.map

package/dist/preview-config/ui5-yaml.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TEST_CONFIG_DEFAULTS = void 0;
+exports.isTestPath = isTestPath;
 exports.extractYamlConfigFileName = extractYamlConfigFileName;
 exports.processUi5YamlConfig = processUi5YamlConfig;
 exports.updatePreviewMiddlewareConfig = updatePreviewMiddlewareConfig;
+exports.updateTestConfig = updateTestConfig;
+exports.updateDefaultTestConfig = updateDefaultTestConfig;
 exports.updatePreviewMiddlewareConfigs = updatePreviewMiddlewareConfigs;
 const path_1 = require("path");
 const ui5_yaml_1 = require("../variants-config/ui5-yaml");
@@ -15,6 +19,20 @@ const DEFAULT_INTENT = {
     object: 'app',
     action: 'preview'
 };
+exports.TEST_CONFIG_DEFAULTS = {
+    qunit: {
+        path: '/test/unitTests.qunit.html',
+        framework: 'QUnit'
+    },
+    opa5: {
+        path: '/test/opaTests.qunit.html',
+        framework: 'OPA5'
+    },
+    testsuite: {
+        path: '/test/testsuite.qunit.html',
+        framework: 'Testsuite'
+    }
+};
 /**
  * Checks if a script can be converted based on the used UI5 yaml configuration file.
  *
@@ -43,25 +61,22 @@ function isUi5YamlToBeConverted(ui5Yaml, scriptName, ui5YamlFileNames, logger) {
  * @param ui5Yaml - the name of the UI5 yaml configuration file
  * @param scriptName - the name of the script from the package.json file
  * @param script - the content of the script from the package.json file
+ * @param convertTests - indicator if test suite and test runner should be included in the conversion
  * @param logger logger to report info to the user
  * @returns indicator if the UI5 yaml configuration file has already been converted
  */
-async function isUi5YamlAlreadyConverted(fs, basePath, ui5Yaml, scriptName, script, logger) {
-    if (Object.keys(fs.dump(basePath, (file) => {
+async function isUi5YamlFlpPathAlreadyConverted(fs, basePath, ui5Yaml, scriptName, script, convertTests, logger) {
+    const yamlConfigAlreadyAdjusted = Object.keys(fs.dump(basePath, (file) => {
         return file.basename === ui5Yaml && file.state === 'modified';
-    })).length === 0) {
-        return false;
-    }
+    })).length > 0;
     const flpPath = (await (0, utils_1.getPreviewMiddleware)(undefined, basePath, ui5Yaml, fs))
         ?.configuration?.flp?.path;
     const { path: scriptPath } = (0, package_json_1.extractUrlDetails)(script);
-    if (flpPath != scriptPath) {
-        logger?.warn(`Skipping script'${scriptName}', because another script also refers to UI5 YAML configuration file, '${ui5Yaml}'. Adjust the 'flp.path' property in the UI5 YAML configuration file to the correct endpoint or create a separate UI5 YAML configuration file for script '${scriptName}'. ${ui5Yaml} currently uses ${flpPath ?? DEFAULT_FLP_PATH} whereas script '${scriptName}' uses '${scriptPath}'.`);
+    if (yamlConfigAlreadyAdjusted && flpPath != scriptPath && (convertTests ? !isTestPath(scriptPath) : true)) {
+        logger?.warn(`Skipping script '${scriptName}', because another script also refers to UI5 YAML configuration file, '${ui5Yaml}'. Adjust the 'flp.path' property in the UI5 YAML configuration file to the correct endpoint or create a separate UI5 YAML configuration file for script '${scriptName}'. ${ui5Yaml} currently uses ${flpPath ?? DEFAULT_FLP_PATH} whereas script '${scriptName}' uses '${scriptPath}'.`);
+        return true;
     }
-    else {
-        logger?.info(`Skipping script '${scriptName}', because the UI5 YAML configuration file '${ui5Yaml}' has already been adjusted based on another script.`);
-    }
-    return true;
+    return false;
 }
 /**
  * Checks if the passed path is a FLP path.
@@ -70,13 +85,30 @@ async function isUi5YamlAlreadyConverted(fs, basePath, ui5Yaml, scriptName, scri
  * @param configuration - the preview configuration
  * @returns indicator if the path is an FLP path
  */
-function pathIsFlpPath(path, configuration) {
+function isFlpPath(path, configuration) {
     if (!path) {
         return false;
     }
-    const isNotRtaEditorPath = configuration.rta?.editors?.every((editor) => editor.path !== path) ?? true;
-    const isNotTestPath = configuration.test?.every((test) => test.path !== path) ?? true;
-    return isNotRtaEditorPath && isNotTestPath;
+    const isRtaEditorPath = configuration.rta?.editors?.some((editor) => editor.path === path) ?? false;
+    return !isRtaEditorPath && !isTestPath(path, configuration);
+}
+/**
+ * Check if the path is a test path.
+ * 1) path matches pattern '**.qunit.html'
+ * 2) path is being used as test configuration path in yaml configuration.
+ *
+ * @param path - the path
+ * @param configuration - the preview configuration
+ * @returns indicator if the path is a test path
+ */
+function isTestPath(path, configuration) {
+    if (!path) {
+        return false;
+    }
+    if (path.includes('.qunit.html')) {
+        return true;
+    }
+    return configuration?.test?.some((testConfig) => testConfig.path === path) ?? false;
 }
 /**
  * Sanitizes the preview middleware configuration.
@@ -160,19 +192,26 @@ function updatePreviewMiddlewareConfig(previewMiddleware, intent, path) {
     const newMiddlewareConfig = sanitizePreviewMiddleware(previewMiddleware);
     //copy of configuration to avoid ending up with an empty configuration object in some cases
     const configuration = { ...newMiddlewareConfig.configuration };
-    configuration.flp = configuration.flp ?? {};
     let writeConfig = false;
-    //check path and respect defaults
-    if (pathIsFlpPath(path, configuration) && !path?.includes(DEFAULT_FLP_PATH)) {
-        configuration.flp.path = path;
-        writeConfig = true;
+    if (isFlpPath(path, configuration)) {
+        //adjust path but respect defaults
+        if (!path?.includes(DEFAULT_FLP_PATH)) {
+            configuration.flp = configuration.flp ?? {};
+            configuration.flp.path = path;
+            writeConfig = true;
+        }
+        //adjust intent but respect defaults
+        if (intent && `${intent?.object}-${intent?.action}` !== defaultIntent) {
+            configuration.flp = configuration.flp ?? {};
+            configuration.flp.intent = {
+                object: intent.object,
+                action: intent.action
+            };
+            writeConfig = true;
+        }
     }
-    //check intent and respect defaults
-    if (intent && `${intent?.object}-${intent?.action}` !== defaultIntent) {
-        configuration.flp.intent = {
-            object: intent.object,
-            action: intent.action
-        };
+    else if (isTestPath(path, configuration)) {
+        configuration.test = updateTestConfig(configuration.test, path);
         writeConfig = true;
     }
     if (writeConfig) {
@@ -180,6 +219,82 @@ function updatePreviewMiddlewareConfig(previewMiddleware, intent, path) {
     }
     return newMiddlewareConfig;
 }
+/**
+ * Update the test configuration.
+ *
+ * @param testConfiguration - the test configuration
+ * @param path - the path
+ * @returns the updated test configuration
+ */
+function updateTestConfig(testConfiguration, path) {
+    testConfiguration = testConfiguration ?? [];
+    let framework;
+    if (path?.includes('testsuite.qunit.html')) {
+        framework = 'Testsuite';
+    }
+    else if (path?.includes('opaTests.qunit.html')) {
+        framework = 'OPA5';
+    }
+    else if (path?.includes('unitTests.qunit.html')) {
+        framework = 'QUnit';
+    }
+    if (!framework) {
+        return testConfiguration;
+    }
+    const defaultPath = exports.TEST_CONFIG_DEFAULTS[framework.toLowerCase()].path;
+    const testConfig = testConfiguration.find((test) => test.framework === framework);
+    if (testConfig) {
+        testConfig.path = path;
+        if (testConfig.path === defaultPath) {
+            //sanitize default path
+            delete testConfig.path;
+        }
+    }
+    else if (path?.includes(defaultPath)) {
+        testConfiguration.push({ framework });
+    }
+    else {
+        testConfiguration.push({ framework, path });
+    }
+    return testConfiguration;
+}
+/**
+ * Updates the default test configurations in the 'ui5.yaml' in case no test config exists in any UI5 configuration file.
+ *
+ * @param fs - file system reference
+ * @param basePath - base path to be used for the conversion
+ * @param logger logger to report info to the user
+ */
+async function updateDefaultTestConfig(fs, basePath, logger) {
+    const ui5YamlFileNames = await (0, project_access_1.getAllUi5YamlFileNames)(basePath, fs);
+    for (const ui5Yaml of ui5YamlFileNames.filter((ui5Yaml) => ui5Yaml !== project_access_1.FileName.Ui5Yaml)) {
+        const ui5YamlConfig = await (0, project_access_1.readUi5Yaml)(basePath, ui5Yaml, fs);
+        const previewMiddleware = (await (0, utils_1.getPreviewMiddleware)(ui5YamlConfig));
+        if (previewMiddleware.configuration.test) {
+            return;
+        }
+    }
+    let ui5YamlConfig;
+    try {
+        ui5YamlConfig = await (0, project_access_1.readUi5Yaml)(basePath, project_access_1.FileName.Ui5Yaml, fs);
+    }
+    catch (error) {
+        logger?.warn(`The UI5 YAML configuration file 'ui5.yaml', can't be updated to support test frameworks: '${error}'. Please manually add the test configuration to the UI5 YAML configuration file used for testing according to https://github.com/SAP/open-ux-tools/tree/main/packages/preview-middleware#configuration-option-test.`);
+        return;
+    }
+    const previewMiddleware = (await (0, utils_1.getPreviewMiddleware)(ui5YamlConfig));
+    for (const defaultConfig of Object.values(exports.TEST_CONFIG_DEFAULTS)) {
+        if (previewMiddleware.configuration?.test?.some((testConfig) => testConfig.framework.toLowerCase() === defaultConfig.framework.toLowerCase())) {
+            //do not touch existing test config
+            break;
+        }
+        previewMiddleware.configuration.test = updateTestConfig(previewMiddleware.configuration.test, defaultConfig.path);
+        logger?.info(`The UI5 YAML configuration file 'ui5.yaml', has been updated to support the test framework '${defaultConfig.framework}'. Please consider transferring the test configuration to the UI5 YAML configuration file used for testing.`);
+    }
+    ui5YamlConfig.updateCustomMiddleware(previewMiddleware);
+    const yamlPath = (0, path_1.join)(basePath, project_access_1.FileName.Ui5Yaml);
+    fs.write(yamlPath, ui5YamlConfig.toString());
+}
 /**
  * Updates the preview middleware configurations according to the scripts they are being used in package.json.
  *
@@ -189,21 +304,22 @@ function updatePreviewMiddlewareConfig(previewMiddleware, intent, path) {
  *
  * @param fs - file system reference
  * @param basePath - base path to be used for the conversion
+ * @param convertTests - indicator if test suite and test runner should be included in the conversion
  * @param logger logger to report info to the user
  */
-async function updatePreviewMiddlewareConfigs(fs, basePath, logger) {
+async function updatePreviewMiddlewareConfigs(fs, basePath, convertTests, logger) {
     const ui5YamlFileNames = await (0, project_access_1.getAllUi5YamlFileNames)(basePath, fs);
     const unprocessedUi5YamlFileNames = [...ui5YamlFileNames];
     const packageJsonPath = (0, path_1.join)(basePath, 'package.json');
     const packageJson = fs.readJSON(packageJsonPath);
     for (const [scriptName, script] of Object.entries(packageJson?.scripts ?? {})) {
-        if (!script || !(0, package_json_1.isValidPreviewScript)(scriptName, script)) {
+        if (!script || !(0, package_json_1.isValidPreviewScript)(scriptName, script, convertTests)) {
             continue;
         }
         const ui5Yaml = (0, path_1.basename)(extractYamlConfigFileName(script));
         unprocessedUi5YamlFileNames.splice(unprocessedUi5YamlFileNames.indexOf(ui5Yaml), 1);
         if (!isUi5YamlToBeConverted(ui5Yaml, scriptName, ui5YamlFileNames, logger) ||
-            (await isUi5YamlAlreadyConverted(fs, basePath, ui5Yaml, scriptName, script, logger))) {
+            (await isUi5YamlFlpPathAlreadyConverted(fs, basePath, ui5Yaml, scriptName, script, convertTests, logger))) {
             continue;
         }
         try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/app-config-writer",
   "description": "Add or update configuration for SAP Fiori tools application",
-  "version": "0.5.9",
+  "version": "0.5.11",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -26,7 +26,8 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
-    "@sap-ux/axios-extension": "1.17.8",
+    "semver": "7.6.3",
+    "@sap-ux/axios-extension": "1.18.0",
     "@sap-ux/btp-utils": "0.17.2",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.28.10",
@@ -38,9 +39,10 @@
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/prompts": "2.4.4",
+    "@types/semver": "7.5.8",
     "axios": "1.7.4",
     "nock": "13.4.0",
-    "@sap-ux/preview-middleware": "0.16.152"
+    "@sap-ux/preview-middleware": "0.16.159"
   },
   "engines": {
     "node": ">=18.x"