2821/add cap mta prompting

.changeset/tasty-cats-search.md

@@ -0,0 +1,8 @@
+---
+'@sap-ux/cf-deploy-config-sub-generator': patch
+'@sap-ux/deploy-config-generator-shared': patch
+'@sap-ux/cf-deploy-config-inquirer': patch
+'@sap-ux/cf-deploy-config-writer': patch
+---
+
+Changes to support adding CAP MTA prompt to allow user generate MTA

README.md

@@ -127,7 +127,7 @@ When analyzing a problem, it is helpful to be able to debug the modules. How to
 
 Each of the packages has an extensive set of unit tests covering as many as possible different scenarios, therefore, as a starting point for debugging, it is a good idea to use the tests. The easiest (but not the only) way to debug a specific test in VSCode is to open a `JavaScript Debug Terminal` and then go to the package that needs to be debugged. Using the debug terminal, execute all tests with `pnpm test` or a specific one, e.g. execute `pnpm test -- test/basic.test.ts` in the `fiori-freestyle-writer` directory (`./packages/fiori-freestyle-writer`). When running either of the commands in the debug terminal, breakpoints set in VSCode will be active.
 
-Additionally for the `*-writer` modules it is sometimes helpful to manually inspect the generated output of the unit tests on the filesystem. This can be achieved by setting the variable `UX_DEBUG` before running the tests e.g. in `fiori-freestyle-writer` run `UX_DEBUG=true pnpm test` and after the tests finish, the generated files can be found at `./test/test-output`.
+Additionally, for the `*-writer` modules it is sometimes helpful to manually inspect the generated output of the unit tests on the filesystem. This can be achieved by setting the variable `UX_DEBUG` before running the tests e.g. in `fiori-freestyle-writer` run `UX_DEBUG=true pnpm test` and after the tests finish, the generated files can be found at `./test/test-output`.
 Additional checks can be performed on the generated projects by also setting `UX_DEBUG_FULL` e.g. `UX_DEBUG=true UX_DEBUG_FULL=true pnpm test`.
 This includes checks such as `npm install`, `npm run ts-typecheck`, `npm run lint` as appropriate to the project.
 

packages/cf-deploy-config-inquirer/src/index.ts

@@ -88,5 +88,6 @@ export {
     RouterModuleType,
     type CfDeployConfigQuestions,
     type CfDeployConfigAnswers,
-    type CfAppRouterDeployConfigAnswers
+    type CfAppRouterDeployConfigAnswers,
+    type CfAppRouterDeployConfigQuestions
 };

packages/cf-deploy-config-sub-generator/src/app/index.ts

@@ -11,7 +11,13 @@ import {
 } from '@sap-ux/fiori-generator-shared';
 import { isInternalFeaturesSettingEnabled } from '@sap-ux/feature-toggle';
 import { isFullUrlDestination } from '@sap-ux/btp-utils';
-import { generateAppConfig, ApiHubType, useAbapDirectServiceBinding } from '@sap-ux/cf-deploy-config-writer';
+import {
+    generateAppConfig,
+    generateCAPConfig,
+    ApiHubType,
+    useAbapDirectServiceBinding,
+    DefaultMTADestination
+} from '@sap-ux/cf-deploy-config-writer';
 import {
     DeploymentGenerator,
     showOverwriteQuestion,
@@ -22,18 +28,25 @@ import {
     mtaExecutable,
     cdsExecutable,
     generateDestinationName,
-    getDestination
+    getDestination,
+    getConfirmMtaContinuePrompt
 } from '@sap-ux/deploy-config-generator-shared';
 import { t, initI18n, DESTINATION_AUTHTYPE_NOTFOUND, API_BUSINESS_HUB_ENTERPRISE_PREFIX } from '../utils';
 import { loadManifest } from './utils';
 import { getMtaPath, findCapProjectRoot, FileName } from '@sap-ux/project-access';
 import { EventName } from '../telemetryEvents';
-import { getCFQuestions } from './questions';
-import type { ApiHubConfig, CFAppConfig } from '@sap-ux/cf-deploy-config-writer';
+import { getCFApprouterQuestionsForCap, getCFQuestions } from './questions';
+import type { ApiHubConfig, CFAppConfig, CAPConfig } from '@sap-ux/cf-deploy-config-writer';
 import type { Logger } from '@sap-ux/logger';
-import type { CfDeployConfigOptions } from './types';
-import type { CfDeployConfigAnswers, CfDeployConfigQuestions } from '@sap-ux/cf-deploy-config-inquirer';
+import { CfDeployConfigOptions } from './types';
+import {
+    type CfAppRouterDeployConfigAnswers,
+    type CfDeployConfigQuestions,
+    CfDeployConfigAnswers
+} from '@sap-ux/cf-deploy-config-inquirer';
 import type { YeomanEnvironment } from '@sap-ux/fiori-generator-shared';
+import { withCondition } from '@sap-ux/inquirer-common';
+import type { Answers, Question } from 'inquirer';
 
 /**
  * Cloud Foundry deployment configuration generator.
@@ -49,6 +62,7 @@ export default class extends DeploymentGenerator {
     private readonly cloudServiceName?: string;
     private readonly serviceBase?: string;
     private answers: CfDeployConfigAnswers & Partial<CFAppConfig> = {};
+    private appRouterAnswers: CfAppRouterDeployConfigAnswers;
     private projectRoot: string;
     private mtaPath?: string;
     private isCap = false;
@@ -75,7 +89,7 @@ export default class extends DeploymentGenerator {
         this.options = opts;
 
         this.destinationName = opts.destinationName ?? '';
-        this.addMtaDestination = opts.addMTADestination ?? false; // by default it's false unless passed in i.e. headless flow
+        this.addMtaDestination = opts.addMTADestination ?? false; // by default, it's false unless passed in i.e. headless flow
         this.lcapModeOnly = opts.lcapModeOnly ?? false;
         this.cloudServiceName = opts.cloudServiceName || undefined;
         this.apiHubConfig = opts.apiHubConfig;
@@ -106,6 +120,8 @@ export default class extends DeploymentGenerator {
 
         if (!this.launchDeployConfigAsSubGenerator) {
             await this._init();
+        } else {
+            await this._processProjectConfigs();
         }
     }
 
@@ -115,12 +131,10 @@ export default class extends DeploymentGenerator {
             this.abort = true;
             handleErrorMessage(this.appWizard, { errorType: ERROR_TYPE.NO_MTA_BIN });
         }
-
         await this._processProjectPaths();
         await this._processProjectConfigs();
 
         this.isAbapDirectServiceBinding = await useAbapDirectServiceBinding(this.appPath, false, this.mtaPath);
-
         // restricting local changes is only applicable for CAP flows
         if (!this.isCap) {
             this.lcapModeOnly = false;
@@ -134,7 +148,7 @@ export default class extends DeploymentGenerator {
     private async _processProjectPaths(): Promise<void> {
         const mtaPathResult = await getMtaPath(this.appPath);
         this.mtaPath = mtaPathResult?.mtaPath;
-        const capRoot = await findCapProjectRoot(this.appPath);
+        const capRoot = await findCapProjectRoot(this.appPath, true, this.fs);
         if (capRoot) {
             if (!hasbin.sync(cdsExecutable)) {
                 bail(ErrorHandler.getErrorMsgFromType(ERROR_TYPE.NO_CDS_BIN));
@@ -156,29 +170,45 @@ export default class extends DeploymentGenerator {
         if (!baseConfigExists) {
             bail(ErrorHandler.noBaseConfig(baseConfigFile));
         }
-
         this.deployConfigExists = this.fs.exists(join(this.appPath, this.options.config ?? FileName.Ui5Yaml));
     }
 
     public async prompting(): Promise<void> {
         if (this.abort) {
             return;
         }
-
-        if (this.isCap && this.projectRoot && !this.mtaPath) {
-            // if the user is adding deploy config to a CAP project and there is no mta.yaml in the root, then log error and exit
-            this.abort = true;
-            handleErrorMessage(this.appWizard, { errorType: ERROR_TYPE.CAP_DEPLOYMENT_NO_MTA });
-            return;
+        if (!this.launchDeployConfigAsSubGenerator) {
+            await this._prompting();
         }
+        await this._reconcileAnswersWithOptions();
+    }
 
-        if (!this.launchDeployConfigAsSubGenerator) {
+    private async _prompting(): Promise<void> {
+        const isCAPMissingMTA = this.isCap && this.projectRoot && !this.mtaPath;
+        if (isCAPMissingMTA) {
+            DeploymentGenerator.logger?.debug(t('cfGen.debug.capMissingMTA'));
+            // If launched as root generator, add a prompt to allow user decide if they want to add an MTA config
+            let questions = (await getCFApprouterQuestionsForCap({
+                projectRoot: this.projectRoot ?? process.cwd()
+            })) as Question[];
+            questions = withCondition(questions, (answers: Answers) => answers.addCapMtaContinue === true);
+            questions.unshift(...getConfirmMtaContinuePrompt());
+            this.appRouterAnswers = (await this.prompt(questions)) as CfAppRouterDeployConfigAnswers;
+            if ((this.appRouterAnswers as Answers).addCapMtaContinue !== true) {
+                this.abort = true;
+                return;
+            }
+            // Configure defaults
+            this.destinationName = DefaultMTADestination;
+            this.options.overwrite = true; // Don't prompt the user to overwrite files we've just written!
+            this.answers = {};
+            this.answers.destinationName = this.destinationName;
+            this.answers.addManagedAppRouter = false;
+        } else {
             await this._handleApiHubConfig();
             const questions = await this._getCFQuestions();
             this.answers = await this.prompt(questions);
         }
-
-        await this._reconcileAnswersWithOptions();
     }
 
     /**
@@ -251,8 +281,16 @@ export default class extends DeploymentGenerator {
 
     private async _writing(): Promise<void> {
         try {
-            const appConfig = this._getAppConfig();
-            await generateAppConfig(appConfig, this.fs, DeploymentGenerator.logger as unknown as Logger);
+            // Step1. (Optional) Generate CAP MTA with specific approuter type managed | standalone
+            if (this.appRouterAnswers) {
+                await generateCAPConfig(
+                    this.appRouterAnswers as CAPConfig,
+                    this.fs,
+                    DeploymentGenerator.logger as unknown as Logger
+                );
+            }
+            // Step2. Append HTML5 app to MTA
+            await generateAppConfig(this._getAppConfig(), this.fs, DeploymentGenerator.logger as unknown as Logger);
         } catch (error) {
             this.abort = true;
             handleErrorMessage(this.appWizard, { errorMsg: t('cfGen.error.writing', { error }) });

packages/cf-deploy-config-sub-generator/src/app/questions.ts

@@ -1,12 +1,20 @@
 import { isAppStudio } from '@sap-ux/btp-utils';
 import { DeploymentGenerator } from '@sap-ux/deploy-config-generator-shared';
 import { getMtaPath } from '@sap-ux/project-access';
-import { getPrompts, promptNames } from '@sap-ux/cf-deploy-config-inquirer';
+import {
+    appRouterPromptNames,
+    type CfAppRouterDeployConfigPromptOptions,
+    type CfAppRouterDeployConfigQuestions,
+    type CfDeployConfigPromptOptions,
+    type CfDeployConfigQuestions,
+    getAppRouterPrompts,
+    getPrompts,
+    promptNames
+} from '@sap-ux/cf-deploy-config-inquirer';
 import { getHostEnvironment, hostEnvironment } from '@sap-ux/fiori-generator-shared';
 import { destinationQuestionDefaultOption, getCFChoices } from './utils';
 import { t } from '../utils';
 import type { ApiHubConfig } from '@sap-ux/cf-deploy-config-writer';
-import type { CfDeployConfigPromptOptions, CfDeployConfigQuestions } from '@sap-ux/cf-deploy-config-inquirer';
 
 /**
  * Fetches the Cloud Foundry deployment configuration questions.
@@ -60,3 +68,29 @@ export async function getCFQuestions({
     DeploymentGenerator.logger?.debug(t('cfGen.debug.promptOptions', { options: JSON.stringify(options) }));
     return getPrompts(options);
 }
+
+/**
+ * Retrieve the CF Approuter questions, certain prompts are restricted to support CAP project.
+ *
+ * @param options - the options required for retrieving the prompts.
+ * @param options.projectRoot - the root path of the project.
+ * @returns the cf approuter config questions.
+ */
+export async function getCFApprouterQuestionsForCap({
+    projectRoot
+}: {
+    projectRoot: string;
+}): Promise<CfAppRouterDeployConfigQuestions[]> {
+    // Disable some prompts, not required for CAP flow
+    const appRouterPromptOptions: CfAppRouterDeployConfigPromptOptions = {
+        [appRouterPromptNames.mtaPath]: projectRoot,
+        [appRouterPromptNames.mtaId]: true,
+        [appRouterPromptNames.mtaDescription]: false,
+        [appRouterPromptNames.mtaVersion]: false,
+        [appRouterPromptNames.routerType]: true,
+        [appRouterPromptNames.addConnectivityService]: true,
+        [appRouterPromptNames.addABAPServiceBinding]: false
+    };
+
+    return getAppRouterPrompts(appRouterPromptOptions);
+}

packages/cf-deploy-config-sub-generator/src/app/types.ts

@@ -1,5 +1,5 @@
 import type { AppWizard } from '@sap-devx/yeoman-ui-types';
-import type { CfDeployConfigAnswers } from '@sap-ux/cf-deploy-config-inquirer';
+import { type CfDeployConfigAnswers } from '@sap-ux/cf-deploy-config-inquirer';
 import type { ApiHubConfig } from '@sap-ux/cf-deploy-config-writer';
 import type { TelemetryData } from '@sap-ux/fiori-generator-shared';
 
@@ -84,4 +84,8 @@ export interface CfDeployConfigOptions extends CfDeployConfigAnswers {
      * Telemetry data to be send after deployment configuration has been added
      */
     telemetryData?: TelemetryData;
+    /**
+     * Option to invoke the getConfirmMtaContinue prompt
+     */
+    addCapMtaContinue?: boolean;
 }

packages/cf-deploy-config-sub-generator/src/translations/cf-deploy-config-sub-generator.i18n.json

@@ -26,7 +26,8 @@
         },
         "debug": {
             "promptOptions": "Retrieving CF prompts using: \n {{- options}}",
-            "initTelemetry": "Initializing telemetry in CF deployment configuration generator"
+            "initTelemetry": "Initializing telemetry in CF deployment configuration generator",
+            "capMissingMTA": "CAP project detected with no MTA configuration"
         }
     },
     "appRouterGen": {