@sap-ux/deploy-tooling 0.9.16 → 0.9.17

package/dist/base/deploy.js

@@ -15,6 +15,7 @@ const fs_1 = require("fs");
 const config_1 = require("./config");
 const prompt_1 = require("./prompt");
 const system_access_1 = require("@sap-ux/system-access");
+const validate_1 = require("./validate");
 const deploymentCommands = { tryUndeploy, tryDeploy };
 /**
  * Handle exceptions thrown, in some cases we to retry them.
@@ -198,6 +199,7 @@ function runCommand(command, config, logger, archive = Buffer.from('')) {
  * @param archive - archive file that is to be deployed
  */
 function tryDeploy(provider, config, logger, archive) {
+    var _a, _b, _c, _d, _e;
     return __awaiter(this, void 0, void 0, function* () {
         try {
             if (config.createTransport) {
@@ -205,6 +207,17 @@ function tryDeploy(provider, config, logger, archive) {
                 // Reset as we dont want other flows kicking it off again!
                 config.createTransport = false;
             }
+            if (config.test === true) {
+                const validateOutput = yield (0, validate_1.validateBeforeDeploy)({
+                    appName: config.app.name,
+                    description: (_a = config.app.description) !== null && _a !== void 0 ? _a : '',
+                    package: (_b = config.app.package) !== null && _b !== void 0 ? _b : '',
+                    transport: (_c = config.app.transport) !== null && _c !== void 0 ? _c : '',
+                    client: (_d = config.target.client) !== null && _d !== void 0 ? _d : '',
+                    url: (_e = config.target.url) !== null && _e !== void 0 ? _e : ''
+                }, provider, logger);
+                logger.info((0, validate_1.formatSummary)(validateOutput.summary));
+            }
             const service = getUi5AbapRepositoryService(provider, config, logger);
             yield service.deploy({ archive, bsp: config.app, testMode: config.test, safeMode: config.safe });
             if (config.test === true) {

package/dist/base/validate.d.ts

@@ -0,0 +1,52 @@
+import type { AbapServiceProvider } from '@sap-ux/axios-extension';
+import type { Logger } from '@sap-ux/logger';
+export type ValidationInputs = {
+    appName: string;
+    description: string;
+    package: string;
+    transport: string;
+    client: string;
+    url: string;
+};
+export type ValidationOutput = {
+    summary: SummaryRecord[];
+    result: boolean;
+};
+export type SummaryRecord = {
+    message: string;
+    status: SummaryStatus;
+};
+export declare enum SummaryStatus {
+    Valid = 0,
+    Invalid = 1,
+    Unknown = 2
+}
+export declare const summaryMessage: {
+    allClientCheckPass: string;
+    adtServiceUndefined: string;
+    packageCheckPass: string;
+    packageNotFound: string;
+    pacakgeAdtAccessError: string;
+    transportCheckPass: string;
+    transportNotFound: string;
+    transportAdtAccessError: string;
+    transportNotRequired: string;
+    atoAdtAccessError: string;
+};
+/**
+ * Validation of deploy configuration before running deploy-test.
+ *
+ * @param input Deploy configuration that needs to be validated
+ * @param provider AbapServiceProvider
+ * @param logger Logger used by deploy tooling
+ * @returns Validation result and a summary report of identified issues.
+ */
+export declare function validateBeforeDeploy(input: ValidationInputs, provider: AbapServiceProvider, logger: Logger): Promise<ValidationOutput>;
+/**
+ * Format a list of summary records that is ready to be printed on the console.
+ *
+ * @param summary A list of summary records
+ * @returns Formatted summary string
+ */
+export declare function formatSummary(summary: SummaryRecord[]): string;
+//# sourceMappingURL=validate.d.ts.map

package/dist/base/validate.js

@@ -0,0 +1,289 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatSummary = exports.validateBeforeDeploy = exports.summaryMessage = exports.SummaryStatus = void 0;
+const axios_extension_1 = require("@sap-ux/axios-extension");
+const chalk_1 = require("chalk");
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
+const os_1 = require("os");
+var SummaryStatus;
+(function (SummaryStatus) {
+    SummaryStatus[SummaryStatus["Valid"] = 0] = "Valid";
+    SummaryStatus[SummaryStatus["Invalid"] = 1] = "Invalid";
+    SummaryStatus[SummaryStatus["Unknown"] = 2] = "Unknown";
+})(SummaryStatus = exports.SummaryStatus || (exports.SummaryStatus = {}));
+exports.summaryMessage = {
+    allClientCheckPass: 'SAPUI5 ABAP Repository follows the rules of creating BSP application',
+    adtServiceUndefined: 'AdtService cannot be instantiated',
+    packageCheckPass: 'Package is found on ABAP system',
+    packageNotFound: 'Package does not exist on ABAP system',
+    pacakgeAdtAccessError: 'Package could not be validated. Please check manually.',
+    transportCheckPass: 'Transport Request is found on ABAP system',
+    transportNotFound: 'Transport Request does not exist on ABAP system',
+    transportAdtAccessError: 'Transport Request could not be validated. Please check manually.',
+    transportNotRequired: 'Transport Request is not required for local package',
+    atoAdtAccessError: 'Development prefix could not be validated. Please check manually.'
+};
+/**
+ * Validation of deploy configuration before running deploy-test.
+ *
+ * @param input Deploy configuration that needs to be validated
+ * @param provider AbapServiceProvider
+ * @param logger Logger used by deploy tooling
+ * @returns Validation result and a summary report of identified issues.
+ */
+function validateBeforeDeploy(input, provider, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const output = {
+            summary: [],
+            result: true
+        };
+        // output is passed by reference and status updated during the internal pipeline below.
+        yield validateInputTextFormat(input, output, provider, logger);
+        yield validatePackageWithAdt(input, output, provider, logger);
+        yield validateTransportRequestWithAdt(input, output, provider, logger);
+        return output;
+    });
+}
+exports.validateBeforeDeploy = validateBeforeDeploy;
+/**
+ * Format a list of summary records that is ready to be printed on the console.
+ *
+ * @param summary A list of summary records
+ * @returns Formatted summary string
+ */
+function formatSummary(summary) {
+    const summaryStr = summary
+        .map((next) => {
+        let statusSymbol = '';
+        switch (next.status) {
+            case SummaryStatus.Valid:
+                statusSymbol = (0, chalk_1.green)('√');
+                break;
+            case SummaryStatus.Invalid:
+                statusSymbol = (0, chalk_1.red)('×');
+                break;
+            case SummaryStatus.Unknown:
+            default:
+                statusSymbol = (0, chalk_1.yellow)('?');
+                break;
+        }
+        return `${statusSymbol} ${next.message}`;
+    })
+        .reduce((aggregated, current) => {
+        return `${aggregated}${os_1.EOL}${current}`;
+    }, '');
+    return summaryStr;
+}
+exports.formatSummary = formatSummary;
+/**
+ * Client-side validation on the deploy configuration based on the
+ * known input format constraints.
+ *
+ * @param input Deploy config that needs to be validated
+ * @param output Validation output
+ * @param provider AbapServiceProvider
+ * @param logger Logger from the calling context
+ */
+function validateInputTextFormat(input, output, provider, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Prepare backend info for validation
+        const prefix = yield getSystemPrefix(output, provider, logger);
+        // A sequence of client-side validations. No early termination of detecting invalid inputs.
+        // Setting output.result to false if any of the checks is invalid.
+        // Add individual error messages into output.summary array if validation failed.
+        let result = (0, project_input_validator_1.validateAppName)(input.appName, prefix);
+        processInputValidationResult(result, output);
+        result = (0, project_input_validator_1.validateAppDescription)(input.description);
+        processInputValidationResult(result, output);
+        result = (0, project_input_validator_1.validateTransportRequestNumber)(input.transport, input.package);
+        processInputValidationResult(result, output);
+        result = (0, project_input_validator_1.validatePackage)(input.package);
+        processInputValidationResult(result, output);
+        result = (0, project_input_validator_1.validateClient)(input.client);
+        processInputValidationResult(result, output);
+        result = (0, project_input_validator_1.validateUrl)(input.url);
+        processInputValidationResult(result, output);
+        // If all the text validation passed, only show the following success message.
+        if (output.result) {
+            output.summary.push({
+                message: exports.summaryMessage.allClientCheckPass,
+                status: SummaryStatus.Valid
+            });
+        }
+    });
+}
+/**
+ * Helper function that calls ADT service to retrieve system specific prefix
+ * requirement for Fiori app name.
+ *
+ * @param output Validation output
+ * @param provider AbapServiceProvider
+ * @param logger Logger from the calling context
+ * @returns System specific development prefix constraint for Fiori app name
+ */
+function getSystemPrefix(output, provider, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const adtService = yield provider.getAdtService(axios_extension_1.AtoService);
+            if (!adtService) {
+                output.summary.push({
+                    message: `${exports.summaryMessage.adtServiceUndefined} for AtoService`,
+                    status: SummaryStatus.Unknown
+                });
+                output.result = false;
+                return undefined;
+            }
+            const atoSettings = yield adtService.getAtoInfo();
+            return atoSettings === null || atoSettings === void 0 ? void 0 : atoSettings.developmentPrefix;
+        }
+        catch (e) {
+            logger.error(e);
+            output.summary.push({
+                message: exports.summaryMessage.atoAdtAccessError,
+                status: SummaryStatus.Unknown
+            });
+            output.result = false;
+            return undefined;
+        }
+    });
+}
+/**
+ * Helper function to proces input validation result. Avoids sonarqube warning about
+ * increasing complexity.
+ *
+ * @param validationResult Validation result is either true or error message
+ * @param output validation output
+ */
+function processInputValidationResult(validationResult, output) {
+    if (typeof validationResult === 'string') {
+        output.summary.push({
+            message: validationResult,
+            status: SummaryStatus.Invalid
+        });
+        output.result = false;
+    }
+    else if (validationResult !== true) {
+        // Strict check for validator functions that return false instead of error message.
+        throw new Error('Expect error message string returned from validation function instead of false');
+    }
+}
+/**
+ * Query ADT backend service to verify input package name is valid.
+ *
+ * @param input Inputs to query ADT service
+ * @param output Output to be updated during this function call
+ * @param provider AbapServiceProvider
+ * @param logger Logger from the calling context
+ */
+function validatePackageWithAdt(input, output, provider, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (output.result === false) {
+            return;
+        }
+        try {
+            const adtService = yield provider.getAdtService(axios_extension_1.ListPackageService);
+            if (!adtService) {
+                output.summary.push({
+                    message: `${exports.summaryMessage.adtServiceUndefined} for ListPackageService`,
+                    status: SummaryStatus.Unknown
+                });
+                output.result = false;
+                return;
+            }
+            const packages = yield adtService.listPackages({ phrase: input.package });
+            const isValidPackage = packages.findIndex((packageName) => packageName === input.package) >= 0;
+            if (isValidPackage) {
+                output.summary.push({
+                    message: exports.summaryMessage.packageCheckPass,
+                    status: SummaryStatus.Valid
+                });
+            }
+            else {
+                output.summary.push({
+                    message: exports.summaryMessage.packageNotFound,
+                    status: SummaryStatus.Invalid
+                });
+                output.result = false;
+            }
+        }
+        catch (e) {
+            logger.error(e);
+            output.summary.push({
+                message: exports.summaryMessage.pacakgeAdtAccessError,
+                status: SummaryStatus.Unknown
+            });
+            output.result = false;
+        }
+    });
+}
+/**
+ * Query ADT backend service to verify input transport request.
+ *
+ * @param input Inputs to query ADT service
+ * @param output Output to be updated during this function call
+ * @param provider AbapServiceProvider
+ * @param logger Logger from the calling context
+ */
+function validateTransportRequestWithAdt(input, output, provider, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (output.result === false) {
+            return;
+        }
+        try {
+            const adtService = yield provider.getAdtService(axios_extension_1.TransportChecksService);
+            if (!adtService) {
+                output.summary.push({
+                    message: `${exports.summaryMessage.adtServiceUndefined} for TransportChecksService`,
+                    status: SummaryStatus.Unknown
+                });
+                output.result = false;
+                return;
+            }
+            const trList = yield adtService.getTransportRequests(input.package, input.appName);
+            const isValidTrList = trList.findIndex((tr) => tr.transportNumber === input.transport) >= 0;
+            if (isValidTrList) {
+                output.summary.push({
+                    message: exports.summaryMessage.transportCheckPass,
+                    status: SummaryStatus.Valid
+                });
+            }
+            else {
+                output.summary.push({
+                    message: exports.summaryMessage.transportNotFound,
+                    status: SummaryStatus.Invalid
+                });
+                output.result = false;
+            }
+        }
+        catch (e) {
+            // TransportChecksService.getTransportRequests() API is used to provide valid
+            // transport request list. If input packge is local package, no transport request
+            // is returned and LocalPackageError is thrown as exception.
+            // LocalPackageError is acceptable for validation purpose here.
+            if (e.message === axios_extension_1.TransportChecksService.LocalPackageError) {
+                output.summary.push({
+                    message: exports.summaryMessage.transportNotRequired,
+                    status: SummaryStatus.Valid
+                });
+            }
+            else {
+                logger.error(e);
+                output.summary.push({
+                    message: exports.summaryMessage.transportAdtAccessError,
+                    status: SummaryStatus.Unknown
+                });
+                output.result = false;
+            }
+        }
+    });
+}
+//# sourceMappingURL=validate.js.map

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Adeploy-tooling"
   },
-  "version": "0.9.16",
+  "version": "0.9.17",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -31,11 +31,13 @@
     "dotenv": "16.3.1",
     "prompts": "2.4.2",
     "yazl": "2.5.1",
-    "@sap-ux/axios-extension": "1.4.8",
+    "chalk": "4.1.2",
+    "@sap-ux/axios-extension": "1.5.0",
     "@sap-ux/btp-utils": "0.11.9",
     "@sap-ux/logger": "0.3.8",
-    "@sap-ux/system-access": "0.2.8",
-    "@sap-ux/ui5-config": "0.19.4"
+    "@sap-ux/system-access": "0.2.9",
+    "@sap-ux/ui5-config": "0.19.4",
+    "@sap-ux/project-input-validator": "0.1.0"
   },
   "devDependencies": {
     "@types/prompts": "2.4.4",