@sap-ux/deploy-tooling 0.14.47 → 0.15.2

package/dist/base/validate.js

@@ -1,13 +1,4 @@
 "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.checkForCredentials = exports.showAdditionalInfoForOnPrem = exports.formatSummary = exports.validateBeforeDeploy = exports.summaryMessage = exports.SummaryStatus = void 0;
 const axios_extension_1 = require("@sap-ux/axios-extension");
@@ -42,29 +33,26 @@ let cachedDestinationsList = {};
  * @param logger Logger used by deploy tooling
  * @returns Validation result and a summary report of identified issues.
  */
-function validateBeforeDeploy(config, provider, logger) {
-    var _a, _b, _c, _d, _e, _f, _g;
-    return __awaiter(this, void 0, void 0, function* () {
-        const output = {
-            summary: [],
-            result: true
-        };
-        const input = {
-            appName: (_a = config.app.name) !== null && _a !== void 0 ? _a : '',
-            description: (_b = config.app.description) !== null && _b !== void 0 ? _b : '',
-            package: (_c = config.app.package) !== null && _c !== void 0 ? _c : '',
-            transport: (_d = config.app.transport) !== null && _d !== void 0 ? _d : '',
-            client: (_e = config.target.client) !== null && _e !== void 0 ? _e : '',
-            url: (_f = config.target.url) !== null && _f !== void 0 ? _f : '',
-            destination: (_g = config.target.destination) !== null && _g !== void 0 ? _g : ''
-        };
-        // output is passed by reference and status updated during the internal pipeline below.
-        yield validateInputTextFormat(input, output, provider, logger);
-        convertInputsForAdtValidations(input, output);
-        yield validatePackageWithAdt(input, output, provider, logger);
-        yield validateTransportRequestWithAdt(input, output, provider, logger);
-        return output;
-    });
+async function validateBeforeDeploy(config, provider, logger) {
+    const output = {
+        summary: [],
+        result: true
+    };
+    const input = {
+        appName: config.app.name ?? '',
+        description: config.app.description ?? '',
+        package: config.app.package ?? '',
+        transport: config.app.transport ?? '',
+        client: config.target.client ?? '',
+        url: config.target.url ?? '',
+        destination: config.target.destination ?? ''
+    };
+    // output is passed by reference and status updated during the internal pipeline below.
+    await validateInputTextFormat(input, output, provider, logger);
+    convertInputsForAdtValidations(input, output);
+    await validatePackageWithAdt(input, output, provider, logger);
+    await validateTransportRequestWithAdt(input, output, provider, logger);
+    return output;
 }
 exports.validateBeforeDeploy = validateBeforeDeploy;
 /**
@@ -130,33 +118,31 @@ function convertInputsForAdtValidations(input, 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 = validateUrlForOnPremTargetOnly(input.destination, 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
-            });
-        }
-    });
+async function validateInputTextFormat(input, output, provider, logger) {
+    // Prepare backend info for validation
+    const prefix = await 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 = validateUrlForOnPremTargetOnly(input.destination, 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
+        });
+    }
 }
 /**
  * A wrapper of validateUrl(). It uses same logic in system-access module's createAbapServiceProvider()
@@ -187,32 +173,30 @@ function validateUrlForOnPremTargetOnly(destination, url) {
  * @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.message);
-            logger.debug(e);
+async function getSystemPrefix(output, provider, logger) {
+    try {
+        const adtService = await provider.getAdtService(axios_extension_1.AtoService);
+        if (!adtService) {
             output.summary.push({
-                message: exports.summaryMessage.atoAdtAccessError,
+                message: `${exports.summaryMessage.adtServiceUndefined} for AtoService`,
                 status: SummaryStatus.Unknown
             });
             output.result = false;
             return undefined;
         }
-    });
+        const atoSettings = await adtService.getAtoInfo();
+        return atoSettings?.developmentPrefix;
+    }
+    catch (e) {
+        logger.error(e.message);
+        logger.debug(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
@@ -242,49 +226,47 @@ function processInputValidationResult(validationResult, output) {
  * @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) {
+async function validatePackageWithAdt(input, output, provider, logger) {
+    if (output.result === false) {
+        return;
+    }
+    // ADT expects input package
+    const inputPackage = input.package;
+    try {
+        const adtService = await provider.getAdtService(axios_extension_1.ListPackageService);
+        if (!adtService) {
+            output.summary.push({
+                message: `${exports.summaryMessage.adtServiceUndefined} for ListPackageService`,
+                status: SummaryStatus.Unknown
+            });
+            output.result = false;
             return;
         }
-        // ADT expects input package
-        const inputPackage = input.package;
-        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: inputPackage });
-            const isValidPackage = packages.findIndex((packageName) => packageName === inputPackage) >= 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;
-            }
+        const packages = await adtService.listPackages({ phrase: inputPackage });
+        const isValidPackage = packages.findIndex((packageName) => packageName === inputPackage) >= 0;
+        if (isValidPackage) {
+            output.summary.push({
+                message: exports.summaryMessage.packageCheckPass,
+                status: SummaryStatus.Valid
+            });
         }
-        catch (e) {
-            logger.error(e.message);
-            logger.debug(e);
+        else {
             output.summary.push({
-                message: exports.summaryMessage.pacakgeAdtAccessError,
-                status: SummaryStatus.Unknown
+                message: exports.summaryMessage.packageNotFound,
+                status: SummaryStatus.Invalid
             });
             output.result = false;
         }
-    });
+    }
+    catch (e) {
+        logger.error(e.message);
+        logger.debug(e);
+        output.summary.push({
+            message: exports.summaryMessage.pacakgeAdtAccessError,
+            status: SummaryStatus.Unknown
+        });
+        output.result = false;
+    }
 }
 /**
  * Query ADT backend service to verify input transport request.
@@ -294,59 +276,57 @@ function validatePackageWithAdt(input, output, provider, logger) {
  * @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) {
+async function validateTransportRequestWithAdt(input, output, provider, logger) {
+    if (output.result === false) {
+        return;
+    }
+    try {
+        const adtService = await provider.getAdtService(axios_extension_1.TransportChecksService);
+        if (!adtService) {
+            output.summary.push({
+                message: `${exports.summaryMessage.adtServiceUndefined} for TransportChecksService`,
+                status: SummaryStatus.Unknown
+            });
+            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;
-            }
+        const trList = await 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
+            });
         }
-        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.message);
-                logger.debug(e);
-                output.summary.push({
-                    message: exports.summaryMessage.transportAdtAccessError,
-                    status: SummaryStatus.Unknown
-                });
-                output.result = false;
-            }
+        else {
+            logger.error(e.message);
+            logger.debug(e);
+            output.summary.push({
+                message: exports.summaryMessage.transportAdtAccessError,
+                status: SummaryStatus.Unknown
+            });
+            output.result = false;
         }
-    });
+    }
 }
 /**
  * Returns true if specified destination is on-premise and if environment is App Studio
@@ -355,15 +335,13 @@ function validateTransportRequestWithAdt(input, output, provider, logger) {
  * @param destination Identifier for destination to be checked.
  * @returns Promise boolean.
  */
-function showAdditionalInfoForOnPrem(destination) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let showInfo = false;
-        if ((0, btp_utils_1.isAppStudio)() && destination) {
-            const destinations = yield (0, btp_utils_1.listDestinations)();
-            showInfo = (0, btp_utils_1.isOnPremiseDestination)(destinations[destination]);
-        }
-        return showInfo;
-    });
+async function showAdditionalInfoForOnPrem(destination) {
+    let showInfo = false;
+    if ((0, btp_utils_1.isAppStudio)() && destination) {
+        const destinations = await (0, btp_utils_1.listDestinations)();
+        showInfo = (0, btp_utils_1.isOnPremiseDestination)(destinations[destination]);
+    }
+    return showInfo;
 }
 exports.showAdditionalInfoForOnPrem = showAdditionalInfoForOnPrem;
 /**
@@ -373,18 +351,16 @@ exports.showAdditionalInfoForOnPrem = showAdditionalInfoForOnPrem;
  * @param logger Logger from the calling context.
  * @returns Promise boolean.
  */
-function checkForCredentials(destination, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let check = true;
-        if (destination && (0, btp_utils_1.isAppStudio)()) {
-            const destinations = yield getDestinations();
-            if (destinations[destination].Authentication === btp_utils_1.Authentication.SAML_ASSERTION) {
-                logger.warn(`The SAP BTP destination is misconfigured, please check you have the appropriate trusts and permissions enabled.`);
-                check = false;
-            }
+async function checkForCredentials(destination, logger) {
+    let check = true;
+    if (destination && (0, btp_utils_1.isAppStudio)()) {
+        const destinations = await getDestinations();
+        if (destinations[destination].Authentication === btp_utils_1.Authentication.SAML_ASSERTION) {
+            logger.warn(`The SAP BTP destination is misconfigured, please check you have the appropriate trusts and permissions enabled.`);
+            check = false;
         }
-        return check;
-    });
+    }
+    return check;
 }
 exports.checkForCredentials = checkForCredentials;
 /**
@@ -392,12 +368,10 @@ exports.checkForCredentials = checkForCredentials;
  *
  * @returns Array of Destination objects
  */
-function getDestinations() {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (Object.keys(cachedDestinationsList).length === 0) {
-            cachedDestinationsList = yield (0, btp_utils_1.listDestinations)();
-        }
-        return cachedDestinationsList;
-    });
+async function getDestinations() {
+    if (Object.keys(cachedDestinationsList).length === 0) {
+        cachedDestinationsList = await (0, btp_utils_1.listDestinations)();
+    }
+    return cachedDestinationsList;
 }
 //# sourceMappingURL=validate.js.map

package/dist/cli/archive.js

@@ -1,13 +1,4 @@
 "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 };
 };
@@ -46,21 +37,19 @@ function getArchiveFromPath(logger, path) {
  * @param rejectUnauthorized - strict SSL handling or not
  * @returns Buffer containing the zip file
  */
-function fetchArchiveFromUrl(logger, url, rejectUnauthorized) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            logger.info(`Fetching archive from ${url}.`);
-            const response = yield axios_1.default.get(url, {
-                httpsAgent: new https_1.Agent({ rejectUnauthorized }),
-                responseType: 'arraybuffer'
-            });
-            logger.info(`Archive fetched from ${url}.`);
-            return response.data;
-        }
-        catch (error) {
-            throw new Error(`The archive url you provided could not be reached. Please ensure the URL is accessible and does not require authentication. ${error}`);
-        }
-    });
+async function fetchArchiveFromUrl(logger, url, rejectUnauthorized) {
+    try {
+        logger.info(`Fetching archive from ${url}.`);
+        const response = await axios_1.default.get(url, {
+            httpsAgent: new https_1.Agent({ rejectUnauthorized }),
+            responseType: 'arraybuffer'
+        });
+        logger.info(`Archive fetched from ${url}.`);
+        return response.data;
+    }
+    catch (error) {
+        throw new Error(`The archive url you provided could not be reached. Please ensure the URL is accessible and does not require authentication. ${error}`);
+    }
 }
 /**
  * Create a zipped file containing all files in the given folder.
@@ -91,19 +80,16 @@ function createArchiveFromFolder(logger, path) {
  * @param options - options provided via CLI
  * @returns Buffer containing the zip file
  */
-function getArchive(logger, options) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        if (options.archivePath) {
-            return getArchiveFromPath(logger, options.archivePath);
-        }
-        else if (options.archiveUrl) {
-            return fetchArchiveFromUrl(logger, options.archiveUrl, options.strictSsl);
-        }
-        else {
-            return createArchiveFromFolder(logger, (_a = options.archiveFolder) !== null && _a !== void 0 ? _a : process.cwd());
-        }
-    });
+async function getArchive(logger, options) {
+    if (options.archivePath) {
+        return getArchiveFromPath(logger, options.archivePath);
+    }
+    else if (options.archiveUrl) {
+        return fetchArchiveFromUrl(logger, options.archiveUrl, options.strictSsl);
+    }
+    else {
+        return createArchiveFromFolder(logger, options.archiveFolder ?? process.cwd());
+    }
 }
 exports.getArchive = getArchive;
 //# sourceMappingURL=archive.js.map