move Freestyle OPA templates to ui5-test-writer

.changeset/shaggy-houses-pretend.md

@@ -0,0 +1,7 @@
+---
+'@sap-ux/fiori-freestyle-writer': minor
+'@sap-ux/fiori-generator-shared': minor
+'@sap-ux/ui5-test-writer': minor
+---
+
+Add Freestyle OPA templates to ui5-test-writer

packages/fiori-freestyle-writer/package.json

@@ -37,6 +37,8 @@
         "@sap-ux/ui5-config": "workspace:*",
         "@sap-ux/fiori-generator-shared": "workspace:*",
         "@sap-ux/cap-config-writer": "workspace:*",
+        "@sap-ux/ui5-test-writer": "workspace:*",
+        "@sap-ux/logger": "workspace:*",
         "ejs": "3.1.10",
         "i18next": "20.6.1",
         "lodash": "4.17.21",

packages/fiori-freestyle-writer/src/index.ts

@@ -13,16 +13,34 @@ import { initI18n } from './i18n';
 import { getBootstrapResourceUrls, getPackageScripts } from '@sap-ux/fiori-generator-shared';
 import { getTemplateVersionPath, processDestinationPath } from './utils';
 import { applyCAPUpdates, type CapProjectSettings } from '@sap-ux/cap-config-writer';
+import type { Logger } from '@sap-ux/logger';
+import { generateFreestyleOPAFiles } from '@sap-ux/ui5-test-writer';
 
+/**
+ * Adds test scripts to the package.json object.
+ *
+ * @param {Package} packageJson - The package.json object to update.
+ * @param {boolean} addMock - Whether to include the UI5 mock YAML configuration.
+ */
+function addTestScripts(packageJson: Package, addMock: boolean): void {
+    // Note: 'ui5MockYamlScript' is empty when no data source is selected.
+    const ui5MockYamlScript = addMock ? '--config ./ui5-mock.yaml ' : '';
+    packageJson.scripts = {
+        ...packageJson.scripts,
+        'unit-test': `fiori run ${ui5MockYamlScript}--open 'test/unit/unitTests.qunit.html'`,
+        'int-test': `fiori run ${ui5MockYamlScript}--open 'test/integration/opaTests.qunit.html'`
+    };
+}
 /**
  * Generate a UI5 application based on the specified Fiori Freestyle floorplan template.
  *
  * @param basePath - the absolute target path where the application will be generated
  * @param data - configuration to generate the freestyle application
  * @param fs - an optional reference to a mem-fs editor
+ * @param log - optional logger
  * @returns Reference to a mem-fs-editor
  */
-async function generate<T>(basePath: string, data: FreestyleApp<T>, fs?: Editor): Promise<Editor> {
+async function generate<T>(basePath: string, data: FreestyleApp<T>, fs?: Editor, log?: Logger): Promise<Editor> {
     // Load i18n translations asynchronously to ensure proper initialization.
     // This addresses occasional issues where i18n is not initialized in time, causing tests to fail.
     await initI18n();
@@ -133,21 +151,38 @@ async function generate<T>(basePath: string, data: FreestyleApp<T>, fs?: Editor)
         JSON.parse(render(fs.read(join(tmplPath, 'common', 'extend', 'package.json')), ffApp, {}))
     );
 
+    const addTests = ffApp.appOptions?.addTests;
     const packageJson: Package = JSON.parse(fs.read(packagePath));
+
     if (isEdmxProjectType) {
+        const addMock = !!ffApp.service?.metadata;
         // Add scripts for non-CAP applications
         packageJson.scripts = {
             ...packageJson.scripts,
             ...getPackageScripts({
                 localOnly: !!ffApp.service && !ffApp.service?.url,
-                addMock: !!ffApp.service?.metadata,
+                addMock,
                 sapClient: ffApp.service?.client,
                 flpAppId: ffApp.app.flpAppId,
                 startFile: data?.app?.startFile,
                 localStartFile: data?.app?.localStartFile,
-                generateIndex: ffApp.appOptions?.generateIndex
+                generateIndex: ffApp.appOptions?.generateIndex,
+                addTest: addTests
             })
         };
+        if (addTests) {
+            addTestScripts(packageJson, addMock);
+            const config = {
+                appId: ffApp.app.id,
+                applicationDescription: ffApp.app.description,
+                applicationTitle: ffApp.app.title,
+                viewName: (ffApp.template.settings as BasicAppSettings).viewName,
+                ui5Theme: ffApp.ui5?.ui5Theme,
+                ui5Version: ffApp.ui5?.version,
+                enableTypeScript: ffApp.appOptions?.typescript
+            };
+            await generateFreestyleOPAFiles(basePath, config, fs, log);
+        }
     } else {
         // Add deploy-config for CAP applications
         packageJson.scripts = {

packages/fiori-freestyle-writer/src/types.ts

@@ -1,4 +1,4 @@
-import type { Ui5App, App } from '@sap-ux/ui5-application-writer';
+import type { Ui5App, App, AppOptions } from '@sap-ux/ui5-application-writer';
 import type { OdataService } from '@sap-ux/odata-service-writer';
 import type { CapServiceCdsInfo } from '@sap-ux/cap-config-writer';
 
@@ -43,6 +43,13 @@ export interface FreestyleApp<T> extends Ui5App {
         capService?: CapServiceCdsInfo;
     };
     app: FioriApp;
+    appOptions?: Partial<AppOptions> & {
+        /**
+         * Generate OPA based tests, for Simple template.
+         * This will eventually move up to {@link Ui5App.appOptions}
+         */
+        addTests?: boolean;
+    };
 }
 
 // We need this for the service version

packages/fiori-freestyle-writer/tsconfig.json

@@ -19,6 +19,9 @@
     {
       "path": "../fiori-generator-shared"
     },
+    {
+      "path": "../logger"
+    },
     {
       "path": "../odata-service-writer"
     },
@@ -27,6 +30,9 @@
     },
     {
       "path": "../ui5-config"
+    },
+    {
+      "path": "../ui5-test-writer"
     }
   ]
 }

packages/fiori-generator-shared/src/npm-package-scripts/types.ts

@@ -10,6 +10,8 @@ export interface PackageJsonScripts {
     'start-noflp'?: string;
     /** Optional command to start the application with a mock server configuration. */
     'start-mock'?: string;
+    /** Optional command to run unit tests. */
+    'unit-test'?: string;
     /** Optional command to run tests. */
     'int-test'?: string;
     /** Optional command to add the variants management script. */

packages/ui5-test-writer/package.json

@@ -35,7 +35,9 @@
         "ejs": "3.1.10",
         "i18next": "20.6.1",
         "mem-fs": "2.1.0",
-        "mem-fs-editor": "9.4.0"
+        "mem-fs-editor": "9.4.0",
+        "@sap-ux/ui5-application-writer": "workspace:*",
+        "@sap-ux/logger": "workspace:*"
     },
     "devDependencies": {
         "@sap-ux/project-access": "workspace:*",