@sap-ux/ui5-test-writer 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,61 @@
+# @sap-ux/ui5-test-writer
+
+OPA files writer for use within Yeoman generator and other prompting libraries. 
+
+
+## Installation
+Npm
+`npm install --save @sap-ux/ui5-test-writer`
+
+Yarn
+`yarn add @sap-ux/ui5-test-writer`
+
+Pnpm
+`pnpm add @sap-ux/ui5-test-writer`
+
+## Usage
+
+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
+
+Calling the `generateOPAFiles` function
+```javascript
+import { generateOPAFiles } from '@sap-ux/ui5-test-writer'
+
+const exampleWriter = async () => {
+    const myProjectPath = 'path/to/my/project'; // Path to the root of the Fiori app
+    const fs = await generateOPAFiles(myProjectPath, { scriptName: 'myOpaTest' });
+    return new Promise((resolve) => {
+        fs.commit(resolve); // When using with Yeoman it handle the fs commit.
+    });
+}
+
+// Calling the function
+await exampleWriter();
+
+```
+
+### Generate an additional page object file
+
+Calling the `generatePageObjectFile` function
+```javascript
+import { generatePageObjectFile } from '@sap-ux/ui5-test-writer'
+
+const exampleWriter = async () => {
+    const myProjectPath = 'path/to/my/project'; // Path to the root of the Fiori app
+    const targetKey = 'MyNewPage';  // Key of the target in the app descriptor (in sap.ui5/routing/targets)
+    const fs = await generatePageObjectFile(myProjectPath, { targetKey });
+    return new Promise((resolve) => {
+        fs.commit(resolve); // When using with Yeoman it handle the fs commit.
+    });
+}
+
+// Calling the function
+await exampleWriter();
+
+```
+
+## Keywords
+SAP Fiori Elements

package/dist/i18n.d.ts

@@ -0,0 +1,14 @@
+import type { TOptions } from 'i18next';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18n(): Promise<void>;
+/**
+ * Helper function facading the call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+export declare function t(key: string, options?: TOptions): string;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/i18n.js

@@ -0,0 +1,50 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = exports.initI18n = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const ui5_test_writer_i18n_json_1 = __importDefault(require("./translations/ui5-test-writer.i18n.json"));
+const NS = 'ui5-test-writer';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+function initI18n() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield i18next_1.default.init({
+            resources: {
+                en: {
+                    [NS]: ui5_test_writer_i18n_json_1.default
+                }
+            },
+            lng: 'en',
+            fallbackLng: 'en',
+            defaultNS: NS,
+            ns: [NS]
+        });
+    });
+}
+exports.initI18n = initI18n;
+/**
+ * Helper function facading the call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    return i18next_1.default.t(key, options);
+}
+exports.t = t;
+initI18n();
+//# sourceMappingURL=i18n.js.map

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Generate OPA test files for a Fiori elements for OData V4 application.
+ * Note: this can potentially overwrite existing files in the webapp/test folder.
+ *
+ * @param basePath - the absolute target path where the application will be generated
+ * @param opaConfig - parameters for the generation
+ * @param opaConfig.scriptName - the name of the OPA journey file. If not specified, 'FirstJourney' 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
+ * @returns Reference to a mem-fs-editor
+ */
+export declare function generateOPAFiles(basePath: string, opaConfig: {
+    scriptName?: string;
+    appID?: string;
+}, fs?: Editor): 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.
+ *
+ * @param basePath - the absolute target path where the application will be generated
+ * @param pageObjectParameters - parameters for the page
+ * @param pageObjectParameters.targetKey - the key of the target in the manifest file corresponding to the page
+ * @param pageObjectParameters.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
+ * @returns Reference to a mem-fs-editor
+ */
+export declare function generatePageObjectFile(basePath: string, pageObjectParameters: {
+    targetKey: string;
+    appID?: string;
+}, fs?: Editor): Editor;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,266 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePageObjectFile = exports.generateOPAFiles = void 0;
+const path_1 = require("path");
+const mem_fs_1 = require("mem-fs");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const types_1 = require("./types");
+const i18n_1 = require("./i18n");
+/**
+ * Reads the manifest for an app.
+ *
+ * @param fs - a reference to a mem-fs editor
+ * @param basePath - the root folder of the app
+ * @returns the manifest object. An exception is thrown if the manifest cannot be read.
+ */
+function readManifest(fs, basePath) {
+    const manifest = fs.readJSON(path_1.join(basePath, 'webapp/manifest.json'));
+    if (!manifest) {
+        throw new types_1.ValidationError(i18n_1.t('error.cannotReadManifest', {
+            filePath: path_1.join(basePath, 'webapp/manifest.json')
+        }));
+    }
+    return manifest;
+}
+/**
+ * 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
+ */
+function getAppTypeFromManifest(manifest) {
+    var _a, _b;
+    const appTargets = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.routing) === null || _b === void 0 ? void 0 : _b.targets;
+    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 (!isFEV4) {
+        throw new types_1.ValidationError(i18n_1.t('error.badApplicationType'));
+    }
+    return 'v4'; // For the time being, only FE V4 is supported
+}
+/**
+ * Retrieves appID and appPath from the manifest.
+ *
+ * @param manifest - the app descriptor of the app
+ * @param forcedAppID - the appID in case we don't want to read it from the manifest
+ * @returns appID and appPath
+ */
+function getAppFromManifest(manifest, forcedAppID) {
+    var _a;
+    const appID = forcedAppID || ((_a = manifest['sap.app']) === null || _a === void 0 ? void 0 : _a.id);
+    const appPath = appID === null || appID === void 0 ? void 0 : appID.split('.').join('/');
+    if (!appID || !appPath) {
+        throw new types_1.ValidationError(i18n_1.t('error.cannotReadAppID'));
+    }
+    return { appID, appPath };
+}
+/**
+ * Create the page configuration object from the app descriptor and the target key.
+ *
+ * @param manifest - the app descriptor of the app
+ * @param targetKey - the key of the target in the manifest
+ * @param forcedAppID - the appID in case we don't want to read it from the manifest
+ * @returns Page configuration object, or undefined if the target type is not supported
+ */
+function createPageConfig(manifest, targetKey, forcedAppID) {
+    var _a, _b, _c, _d;
+    const appTargets = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.routing) === null || _b === void 0 ? void 0 : _b.targets;
+    const target = appTargets && appTargets[targetKey];
+    const { appID, appPath } = getAppFromManifest(manifest, forcedAppID);
+    if ((target === null || target === void 0 ? void 0 : target.type) === 'Component' && (target === null || target === void 0 ? void 0 : target.name) &&
+        target.name in types_1.SupportedPageTypes && (target === null || target === void 0 ? void 0 : target.id) && ((_d = (_c = target === null || target === void 0 ? void 0 : target.options) === null || _c === void 0 ? void 0 : _c.settings) === null || _d === void 0 ? void 0 : _d.entitySet)) {
+        return {
+            appPath,
+            appID,
+            targetKey,
+            componentID: target.id,
+            entitySet: target.options.settings.entitySet,
+            template: types_1.SupportedPageTypes[target.name],
+            isStartup: false
+        };
+    }
+    else {
+        return undefined;
+    }
+}
+/**
+ * Create the configuration object from the app descriptor.
+ *
+ * @param manifest - the app descriptor of the target app
+ * @param opaConfig - parameters for the generation
+ * @param opaConfig.scriptName - the name of the OPA journey file. If not specified, 'FirstJourney' will be used
+ * @param opaConfig.appID - the appID. If not specified, will be read from the manifest in sap.app/id
+ * @returns OPA test configuration object
+ */
+function createConfig(manifest, opaConfig) {
+    var _a, _b, _c, _d, _e, _f;
+    // General application info
+    const { appID, appPath } = getAppFromManifest(manifest, opaConfig.appID);
+    const config = {
+        appID,
+        appPath,
+        pages: [],
+        opaJourneyFileName: opaConfig.scriptName || 'FirstJourney'
+    };
+    // Identify startup targets from the routes
+    const appRoutes = ((_c = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.routing) === null || _b === void 0 ? void 0 : _b.routes) !== null && _c !== void 0 ? _c : []);
+    // Find the route with an empty pattern (except for the trailing query part)
+    const startupRoute = appRoutes.find((route) => {
+        return route.pattern.replace(':?query:', '') === '';
+    });
+    let startupTargets = (_d = startupRoute === null || startupRoute === void 0 ? void 0 : startupRoute.target) !== null && _d !== void 0 ? _d : [];
+    if (!Array.isArray(startupTargets)) {
+        startupTargets = [startupTargets];
+    }
+    // Create page configurations in supported cases
+    const appTargets = (_f = (_e = manifest['sap.ui5']) === null || _e === void 0 ? void 0 : _e.routing) === null || _f === void 0 ? void 0 : _f.targets;
+    for (const targetKey in appTargets) {
+        const pageConfig = createPageConfig(manifest, targetKey, opaConfig.appID);
+        if (pageConfig) {
+            pageConfig.isStartup = startupTargets.includes(targetKey);
+            config.pages.push(pageConfig);
+        }
+    }
+    return config;
+}
+/**
+ * Finds the initial ListReport page and the first Object page from the app.
+ *
+ * @param pages - the page configs of the app
+ * @param manifest - the app descriptor of the target app
+ * @returns the page fonfigs for the LR and the OP if they're found
+ */
+function findLROP(pages, manifest) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const pageLR = pages.find((page) => {
+        return page.isStartup && page.template === 'ListReport';
+    });
+    if (!pageLR) {
+        return {};
+    }
+    const appTargets = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.routing) === null || _b === void 0 ? void 0 : _b.targets;
+    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 : []);
+    const target = (appTargets && appTargets[pageLR.targetKey]);
+    if (!((_g = (_f = target === null || target === void 0 ? void 0 : target.options) === null || _f === void 0 ? void 0 : _f.settings) === null || _g === void 0 ? void 0 : _g.navigation)) {
+        return { pageLR }; // No navigation from LR
+    }
+    // Find all targets that can be navigated from the LR page
+    const navigatedTargetKeys = [];
+    for (const navKey in target.options.settings.navigation) {
+        const navObject = target.options.settings.navigation[navKey];
+        const navigatedRoute = ((_h = navObject.detail) === null || _h === void 0 ? void 0 : _h.route) &&
+            appRoutes.find((route) => {
+                var _a;
+                return route.name === ((_a = navObject.detail) === null || _a === void 0 ? void 0 : _a.route);
+            });
+        if (Array.isArray(navigatedRoute === null || navigatedRoute === void 0 ? void 0 : navigatedRoute.target)) {
+            navigatedTargetKeys.push(...navigatedRoute.target);
+        }
+        else if (navigatedRoute === null || navigatedRoute === void 0 ? void 0 : navigatedRoute.target) {
+            navigatedTargetKeys.push(navigatedRoute.target);
+        }
+    }
+    // Find the first navigated page that is valid and not the starting LR
+    let pageOP;
+    for (let i = 0; i < navigatedTargetKeys.length && !pageOP; i++) {
+        if (navigatedTargetKeys[i] === pageLR.targetKey) {
+            continue; // This can happen in the FCL case where the LR is also part of the route's targets to the OP
+        }
+        pageOP = pages.find((page) => {
+            return page.targetKey === navigatedTargetKeys[i];
+        });
+    }
+    return { pageLR, pageOP };
+}
+/**
+ * Writes a page object in a mem-fs-editor.
+ *
+ * @param pageConfig - the page configuration object
+ * @param rootTemplateDirPath - template root directory
+ * @param testOutDirPath - output test directory (.../webapp/test)
+ * @param fs - a reference to a mem-fs editor
+ */
+function writePageObject(pageConfig, rootTemplateDirPath, testOutDirPath, fs) {
+    fs.copyTpl(path_1.join(rootTemplateDirPath, `integration/pages/${pageConfig.template}.js`), path_1.join(testOutDirPath, `integration/pages/${pageConfig.targetKey}.js`), pageConfig, undefined, {
+        globOptions: { dot: true }
+    });
+}
+/**
+ * Generate OPA test files for a Fiori elements for OData V4 application.
+ * Note: this can potentially overwrite existing files in the webapp/test folder.
+ *
+ * @param basePath - the absolute target path where the application will be generated
+ * @param opaConfig - parameters for the generation
+ * @param opaConfig.scriptName - the name of the OPA journey file. If not specified, 'FirstJourney' 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
+ * @returns Reference to a mem-fs-editor
+ */
+function generateOPAFiles(basePath, opaConfig, fs) {
+    var _a, _b;
+    const editor = fs || mem_fs_editor_1.create(mem_fs_1.create());
+    const manifest = readManifest(editor, basePath);
+    const applicationType = getAppTypeFromManifest(manifest);
+    const config = createConfig(manifest, opaConfig);
+    const rootCommonTemplateDirPath = path_1.join(__dirname, '../templates/common');
+    const rootV4TemplateDirPath = path_1.join(__dirname, `../templates/${applicationType}`); // Only v4 is supported for the time being
+    const testOutDirPath = path_1.join(basePath, 'webapp/test');
+    // Common test files
+    editor.copy(path_1.join(rootCommonTemplateDirPath), testOutDirPath);
+    // Integration (OPA) test files - version-specific
+    editor.copyTpl(path_1.join(rootV4TemplateDirPath, 'integration', 'opaTests.*.*'), path_1.join(testOutDirPath, 'integration'), config, undefined, {
+        globOptions: { dot: true }
+    });
+    // Pages files (one for each page in the app)
+    config.pages.forEach((page) => {
+        writePageObject(page, rootV4TemplateDirPath, testOutDirPath, editor);
+    });
+    // OPA Journey file
+    const startPages = config.pages.filter((page) => page.isStartup).map((page) => page.targetKey);
+    const LROP = findLROP(config.pages, manifest);
+    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
+    };
+    editor.copyTpl(path_1.join(rootV4TemplateDirPath, 'integration/FirstJourney.js'), path_1.join(testOutDirPath, `integration/${config.opaJourneyFileName}.js`), journeyParams, undefined, {
+        globOptions: { dot: true }
+    });
+    return editor;
+}
+exports.generateOPAFiles = generateOPAFiles;
+/**
+ * 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.
+ *
+ * @param basePath - the absolute target path where the application will be generated
+ * @param pageObjectParameters - parameters for the page
+ * @param pageObjectParameters.targetKey - the key of the target in the manifest file corresponding to the page
+ * @param pageObjectParameters.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
+ * @returns Reference to a mem-fs-editor
+ */
+function generatePageObjectFile(basePath, pageObjectParameters, fs) {
+    const editor = fs || mem_fs_editor_1.create(mem_fs_1.create());
+    const manifest = readManifest(editor, basePath);
+    const applicationType = getAppTypeFromManifest(manifest);
+    const pageConfig = createPageConfig(manifest, pageObjectParameters.targetKey, pageObjectParameters.appID);
+    if (pageConfig) {
+        const rootTemplateDirPath = path_1.join(__dirname, `../templates/${applicationType}`); // Only v4 is supported for the time being
+        const testOutDirPath = path_1.join(basePath, 'webapp/test');
+        writePageObject(pageConfig, rootTemplateDirPath, testOutDirPath, editor);
+    }
+    else {
+        throw new types_1.ValidationError(i18n_1.t('error.cannotGeneratePageFile', {
+            targetKey: pageObjectParameters.targetKey
+        }));
+    }
+    return editor;
+}
+exports.generatePageObjectFile = generatePageObjectFile;
+//# sourceMappingURL=index.js.map

package/dist/translations/ui5-test-writer.i18n.json

@@ -0,0 +1,8 @@
+{
+    "error": {
+        "cannotReadManifest": "Cannot read manifest file {{ filePath }}",
+        "cannotReadAppID": "Cannot read appID in the manifest file",
+        "badApplicationType": "Cannot determine application type from the manifest, or unsupported type",
+        "cannotGeneratePageFile": "Cannot generate page file for target {{ targetKey }}"
+    }
+}

package/dist/types.d.ts

@@ -0,0 +1,47 @@
+export declare const SupportedPageTypes: {
+    [id: string]: string;
+};
+export declare type FEV4OPAPageConfig = {
+    appID: string;
+    appPath: string;
+    template: string;
+    componentID: string;
+    entitySet: string;
+    targetKey: string;
+    isStartup: boolean;
+};
+export declare type FEV4OPAConfig = {
+    appID: string;
+    appPath: string;
+    pages: FEV4OPAPageConfig[];
+    opaJourneyFileName: string;
+};
+export declare type FEV4ManifestTarget = {
+    type?: string;
+    name?: string;
+    id?: string;
+    options?: {
+        settings?: {
+            entitySet?: string;
+            navigation?: {
+                [id: string]: {
+                    detail?: {
+                        route?: string;
+                    };
+                };
+            };
+        };
+    };
+};
+/**
+ * General validation error thrown if app config options contain invalid combinations
+ */
+export declare class ValidationError extends Error {
+    /**
+     * ValidationError constructor.
+     *
+     * @param message - the error message
+     */
+    constructor(message: string);
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationError = exports.SupportedPageTypes = void 0;
+exports.SupportedPageTypes = {
+    'sap.fe.templates.ListReport': 'ListReport',
+    'sap.fe.templates.ObjectPage': 'ObjectPage',
+    'sap.fe.core.fpm': 'FPM'
+};
+/**
+ * General validation error thrown if app config options contain invalid combinations
+ */
+class ValidationError extends Error {
+    /**
+     * ValidationError constructor.
+     *
+     * @param message - the error message
+     */
+    constructor(message) {
+        super(`Validation error: ${message}`);
+        this.name = this.constructor.name;
+    }
+}
+exports.ValidationError = ValidationError;
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@sap-ux/ui5-test-writer",
+  "description": "SAP UI5 tests writer",
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/ui5-test-writer"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aui5-test-writer"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "templates",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "ejs": "3.1.7",
+    "mem-fs": "2.1.0",
+    "mem-fs-editor": "9.4.0",
+    "@sap-ux/ui5-config": "0.14.5",
+    "i18next": "20.3.2"
+  },
+  "devDependencies": {
+    "@types/ejs": "3.1.0",
+    "@types/mem-fs": "1.1.2",
+    "@types/fs-extra": "9.0.13",
+    "@types/mem-fs-editor": "7.0.1",
+    "fs-extra": "10.0.0"
+  },
+  "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"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "clean": "rimraf dist test/test-output coverage",
+    "watch": "tsc --watch",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  }
+}

package/templates/common/testsuite.qunit.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>QUnit test suite</title>
+    <script src="../resources/sap/ui/qunit/qunit-redirect.js"></script>
+    <script src="testsuite.qunit.js" data-sap-ui-testsuite></script>
+  </head>
+  <body></body>
+</html>

package/templates/common/testsuite.qunit.js

@@ -0,0 +1,11 @@
+window.suite = function() {
+    'use strict';
+
+    // eslint-disable-next-line
+    var oSuite = new parent.jsUnitTestSuite(),
+    
+    sContextPath = location.pathname.substring(0, location.pathname.lastIndexOf('/') + 1);
+    oSuite.addTestPage(sContextPath + 'integration/opaTests.qunit.html');
+
+    return oSuite;
+};

package/templates/v4/integration/FirstJourney.js

@@ -0,0 +1,36 @@
+sap.ui.define([
+    "sap/ui/test/opaQunit"
+], function (opaTest) {
+    "use strict";
+
+    var Journey = {
+        run: function() {
+            QUnit.module("First journey");
+
+            opaTest("Start application", function (Given, When, Then) {
+                Given.iStartMyApp();
+<% startPages.forEach(function(pageName) { %>
+                Then.onThe<%- pageName%>.iSeeThisPage();
+<% });%>
+            });
+
+<% if (startLR) { %>
+            opaTest("Navigate to ObjectPage", function (Given, When, Then) {
+                // Note: this test will fail if the ListReport page doesn't show any data
+                When.onThe<%- startLR%>.onFilterBar().iExecuteSearch();
+                Then.onThe<%- startLR%>.onTable().iCheckRows();
+<% if (navigatedOP) { %>
+                When.onThe<%- startLR%>.onTable().iPressRow(0);
+                Then.onThe<%- navigatedOP%>.iSeeThisPage();
+<%} %>
+            });
+<%} %>
+            opaTest("Teardown", function (Given, When, Then) { 
+                // Cleanup
+                Given.iTearDownMyApp();
+            });
+        }
+    }
+
+    return Journey;
+});

package/templates/v4/integration/opaTests.qunit.html

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Integration tests</title>
+    <meta charset="utf-8">
+
+    <script id="sap-ui-bootstrap"
+            src="/resources/sap-ui-core.js"
+            data-sap-ui-theme='sap_fiori_3'
+            data-sap-ui-resourceroots='{
+                "<%- appID %>": "../../"
+            }'
+            data-sap-ui-animation="false"
+            data-sap-ui-compatVersion="edge"
+            data-sap-ui-async="true">
+    </script>
+
+    <link rel="stylesheet" type="text/css" href="/resources/sap/ui/thirdparty/qunit-2.css">
+
+    <script src="/resources/sap/ui/thirdparty/qunit-2.js"></script>
+    <script src="/resources/sap/ui/qunit/qunit-junit.js"></script>
+
+    <script src="opaTests.qunit.js"></script>
+
+</head>
+<body>
+    <div id="qunit"></div>
+    <div id="qunit-fixture"></div>
+</body>
+</html>

package/templates/v4/integration/opaTests.qunit.js

@@ -0,0 +1,24 @@
+sap.ui.require(
+    [
+        'sap/fe/test/JourneyRunner',
+        '<%- appPath %>/test/integration/<%- opaJourneyFileName %>',
+<%- pages.map((page) => {return "\t\t'" + page.appPath + '/test/integration/pages/' + page.targetKey + "'";}).join(',\n')%>
+    ],
+    function(JourneyRunner, opaJourney, <%- pages.map(function(page) {return page.targetKey;}).join(', ')%>) {
+        'use strict';
+        var JourneyRunner = new JourneyRunner({
+            // start index.html in web folder
+            launchUrl: sap.ui.require.toUrl('<%- appPath %>') + '/index.html'
+        });
+
+       
+        JourneyRunner.run(
+            {
+                pages: { 
+<%- pages.map((page) => {return '\t\t\t\t\tonThe' + page.targetKey + ': ' + page.targetKey}).join(',\n')%>
+                }
+            },
+            opaJourney.run
+        );
+    }
+);

package/templates/v4/integration/pages/FPM.js

@@ -0,0 +1,13 @@
+sap.ui.define(['sap/fe/test/TemplatePage'], function(TemplatePage) {
+    'use strict';
+
+    var CustomPageDefinitions = {
+        actions: {},
+        assertions: {}
+    };
+
+    return new TemplatePage(
+        '<%- appID %>::<%- componentID %>',
+        CustomPageDefinitions
+    );
+});

package/templates/v4/integration/pages/ListReport.js

@@ -0,0 +1,17 @@
+sap.ui.define(['sap/fe/test/ListReport'], function(ListReport) {
+    'use strict';
+
+    var CustomPageDefinitions = {
+        actions: {},
+        assertions: {}
+    };
+
+    return new ListReport(
+        {
+            appId: '<%- appID %>',
+            componentId: '<%- componentID %>',
+            entitySet: '<%- entitySet %>'
+        },
+        CustomPageDefinitions
+    );
+});

package/templates/v4/integration/pages/ObjectPage.js

@@ -0,0 +1,17 @@
+sap.ui.define(['sap/fe/test/ObjectPage'], function(ObjectPage) {
+    'use strict';
+
+    var CustomPageDefinitions = {
+        actions: {},
+        assertions: {}
+    };
+
+    return new ObjectPage(
+        {
+            appId: '<%- appID %>',
+            componentId: '<%- componentID %>',
+            entitySet: '<%- entitySet %>'
+        },
+        CustomPageDefinitions
+    );
+});