@sap-ux/deploy-tooling 0.1.0

package/dist/base/deploy.js

@@ -0,0 +1,256 @@
+"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.undeploy = exports.deploy = exports.getCredentials = void 0;
+const axios_extension_1 = require("@sap-ux/axios-extension");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const store_1 = require("@sap-ux/store");
+const fs_1 = require("fs");
+const config_1 = require("./config");
+const prompt_1 = require("./prompt");
+/**
+ * Check the secure storage if it has credentials for the given target.
+ *
+ * @param target - ABAP target
+ */
+function getCredentials(target) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!(0, btp_utils_1.isAppStudio)()) {
+            const systemService = yield (0, store_1.getService)({ entityName: 'system' });
+            let system = yield systemService.read(new store_1.BackendSystemKey({ url: target.url, client: target.client }));
+            if (!system && target.client) {
+                // check if there are credentials for the default client
+                system = yield systemService.read(new store_1.BackendSystemKey({ url: target.url }));
+            }
+            return system;
+        }
+        else {
+            return undefined;
+        }
+    });
+}
+exports.getCredentials = getCredentials;
+/**
+ * Enhance axios options and create a service provider instance for an ABAP Cloud system.
+ *
+ * @param options - predefined axios options
+ * @param target - url target configuration
+ * @param noPrompt - only if not truthy prompt for anything
+ * @param logger - reference to the logger instance
+ */
+function createAbapCloudServiceProvider(options, target, noPrompt, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const providerConfig = Object.assign(Object.assign({}, options), { environment: axios_extension_1.AbapCloudEnvironment.Standalone, service: target.serviceKey });
+        if (!target.serviceKey) {
+            const storedOpts = yield getCredentials(target);
+            if (logger && storedOpts) {
+                providerConfig.service = storedOpts.serviceKeys;
+                providerConfig.refreshToken = storedOpts.refreshToken;
+                logger.info(`Using system [${storedOpts.name}] from System store`);
+            }
+            if (!storedOpts && !noPrompt) {
+                providerConfig.service = yield (0, prompt_1.promptServiceKeys)();
+            }
+        }
+        if (providerConfig.service) {
+            return (0, axios_extension_1.createForAbapOnCloud)(providerConfig);
+        }
+        else {
+            throw new Error('Service keys required for deployment to an ABAP Cloud environment.');
+        }
+    });
+}
+/**
+ * Enhance axios options and create a service provider instance for an on-premise ABAP system.
+ *
+ * @param options - predefined axios options
+ * @param target - url target configuration
+ */
+function createAbapServiceProvider(options, target) {
+    return __awaiter(this, void 0, void 0, function* () {
+        options.baseURL = target.url;
+        if (target.client) {
+            options.params['sap-client'] = target.client;
+        }
+        if (!options.auth) {
+            const storedOpts = yield getCredentials(target);
+            if (storedOpts === null || storedOpts === void 0 ? void 0 : storedOpts.password) {
+                options.auth = {
+                    username: storedOpts.username,
+                    password: storedOpts.password
+                };
+            }
+        }
+        return (0, axios_extension_1.createForAbap)(options);
+    });
+}
+/**
+ * Create an instance of a UI5AbapRepository service connected to the given target configuration.
+ *
+ * @param config - deployment configuration
+ * @param logger - optional reference to the logger instance
+ * @returns service instance
+ */
+function createDeployService(config, logger) {
+    var _a, _b, _c;
+    return __awaiter(this, void 0, void 0, function* () {
+        let provider;
+        const options = {};
+        if (config.strictSsl === false) {
+            options.ignoreCertErrors = true;
+        }
+        if ((_a = config.credentials) === null || _a === void 0 ? void 0 : _a.password) {
+            options.auth = {
+                username: (_b = config.credentials) === null || _b === void 0 ? void 0 : _b.username,
+                password: (_c = config.credentials) === null || _c === void 0 ? void 0 : _c.password
+            };
+        }
+        options.params = config.target.params || {};
+        // Destination only supported on Business Application studio
+        if ((0, btp_utils_1.isAppStudio)() && config.target.destination) {
+            // Need additional properties to determine the type of destination we are dealing with
+            const destinations = yield (0, btp_utils_1.listDestinations)();
+            const destination = destinations === null || destinations === void 0 ? void 0 : destinations[config.target.destination];
+            if (!destination) {
+                throw new Error(`Destination ${config.target.destination} not found on subaccount`);
+            }
+            provider = (0, axios_extension_1.createForDestination)(options, destination);
+        }
+        else if ((0, config_1.isUrlTarget)(config.target)) {
+            if (config.target.cloud) {
+                provider = yield createAbapCloudServiceProvider(options, config.target, config.noRetry, logger);
+            }
+            else {
+                provider = yield createAbapServiceProvider(options, config.target);
+            }
+        }
+        else {
+            throw new Error('Unable to handle the configuration in the current environment.');
+        }
+        return provider.getUi5AbapRepository();
+    });
+}
+/**
+ * Try executing the deployment command and handle known errors.
+ *
+ * @param archive - archive file that is to be deployed
+ * @param service - instance of the axios-extension deployment service
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ */
+function tryDeploy(archive, service, config, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield service.deploy({ archive, bsp: config.app, testMode: config.test, safeMode: config.safe });
+        }
+        catch (e) {
+            if (!config.noRetry && (0, axios_extension_1.isAxiosError)(e)) {
+                const success = yield handleAxiosError(e.response, archive, service, config, logger);
+                if (success) {
+                    return;
+                }
+            }
+            logger.error('Deployment has failed.');
+            logger.debug((0, config_1.getConfigForLogging)(config));
+            throw e;
+        }
+    });
+}
+/**
+ * Main function for different deploy retry handling.
+ *
+ * @param response - response of that trigged and axios error
+ * @param archive - archive file that is to be deployed
+ * @param service - instance of the axios-extension deployment service
+ * @param config - configuration used for the previous request
+ * @param logger - reference to the logger instance
+ * @returns true if the error was handled otherwise false is return or an error is raised
+ */
+function handleAxiosError(response, archive, service, config, logger) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        switch (response === null || response === void 0 ? void 0 : response.status) {
+            case 401:
+                logger.warn('Deployment failed with authentication error.');
+                logger.info('Please maintain correct credentials to avoid seeing this error\n\t(see help: https://www.npmjs.com/package/@sap/ux-ui5-tooling#setting-environment-variables-in-a-env-file)');
+                logger.info('Please enter your credentials for this deployment.');
+                const credentials = yield (0, prompt_1.promptCredentials)((_a = service.defaults.auth) === null || _a === void 0 ? void 0 : _a.username);
+                if (credentials) {
+                    service.defaults.auth = credentials;
+                    yield tryDeploy(archive, service, config, logger);
+                    return true;
+                }
+                else {
+                    return false;
+                }
+            case 412:
+                logger.warn('An app in the same repository with different sap app id found.');
+                if (config.yes || (yield (0, prompt_1.promptConfirmation)('Do you want to overwrite (Y/n)?'))) {
+                    yield tryDeploy(archive, service, Object.assign(Object.assign({}, config), { safe: false, noRetry: true }), logger);
+                    return true;
+                }
+                else {
+                    return false;
+                }
+            default:
+                return false;
+        }
+    });
+}
+/**
+ * Deploy the given archive to the given target using the given app description.
+ *
+ * @param archive - archive file that is to be deployed
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ */
+function deploy(archive, config, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (config.keep) {
+            (0, fs_1.writeFileSync)(`archive-${Date.now()}.zip`, archive);
+        }
+        const service = yield createDeployService(config, logger);
+        service.log = logger;
+        if (!config.strictSsl) {
+            logger.warn('You chose not to validate SSL certificate. Please verify the server certificate is trustful before proceeding. See documentation for recommended configuration (https://help.sap.com/viewer/17d50220bcd848aa854c9c182d65b699/Latest/en-US/4b318bede7eb4021a8be385c46c74045.html).');
+        }
+        logger.info(`Starting to deploy${config.test === true ? ' in test mode' : ''}.`);
+        yield tryDeploy(archive, service, config, logger);
+        if (config.test === true) {
+            logger.info('Deployment in TestMode completed. A successful TestMode execution does not necessarily mean that your upload will be successful.');
+        }
+        else {
+            logger.info('Successfully deployed.');
+        }
+    });
+}
+exports.deploy = deploy;
+/**
+ * Deploy the given archive to the given target using the given app description.
+ *
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ */
+function undeploy(config, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const service = yield createDeployService(config, logger);
+        service.log = logger;
+        if (!config.strictSsl) {
+            logger.warn('You chose not to validate SSL certificate. Please verify the server certificate is trustful before proceeding. See documentation for recommended configuration (https://help.sap.com/viewer/17d50220bcd848aa854c9c182d65b699/Latest/en-US/4b318bede7eb4021a8be385c46c74045.html).');
+        }
+        logger.info(`Starting to undeploy${config.test === true ? ' in test mode' : ''}.`);
+        if (yield service.undeploy({ bsp: config.app, testMode: config.test })) {
+            logger.info('Successfully undeployed.');
+        }
+    });
+}
+exports.undeploy = undeploy;
+//# sourceMappingURL=deploy.js.map

package/dist/base/index.d.ts

@@ -0,0 +1,5 @@
+export * from './archive';
+export * from './config';
+export * from './deploy';
+export * from './prompt';
+//# sourceMappingURL=index.d.ts.map

package/dist/base/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./archive"), exports);
+__exportStar(require("./config"), exports);
+__exportStar(require("./deploy"), exports);
+__exportStar(require("./prompt"), exports);
+//# sourceMappingURL=index.js.map

package/dist/base/prompt.d.ts

@@ -0,0 +1,23 @@
+import type { ServiceInfo } from '@sap-ux/btp-utils';
+import prompts from 'prompts';
+/**
+ * Prompt for confirmation.
+ *
+ * @param message - the message to be shown for confirmation.
+ * @returns true if confirmed, otherwise false
+ */
+export declare function promptConfirmation(message: string): Promise<boolean>;
+/**
+ * Prompt for username and password.
+ *
+ * @param username - optional username that is to be offered as default
+ * @returns credentials object with username/password
+ */
+export declare function promptCredentials(username?: string): Promise<prompts.Answers<"password" | "username">>;
+/**
+ * Prompt for the location of the service keys.
+ *
+ * @returns credentials object with service keys
+ */
+export declare function promptServiceKeys(): Promise<ServiceInfo>;
+//# sourceMappingURL=prompt.d.ts.map

package/dist/base/prompt.js

@@ -0,0 +1,86 @@
+"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.promptServiceKeys = exports.promptCredentials = exports.promptConfirmation = void 0;
+const fs_1 = require("fs");
+const prompts_1 = __importDefault(require("prompts"));
+/**
+ * Prompt for confirmation.
+ *
+ * @param message - the message to be shown for confirmation.
+ * @returns true if confirmed, otherwise false
+ */
+function promptConfirmation(message) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let abort = false;
+        const { confirm } = yield (0, prompts_1.default)({
+            type: 'confirm',
+            name: 'confirm',
+            initial: true,
+            message
+        }, {
+            onCancel() {
+                abort = true;
+                return false;
+            }
+        });
+        return confirm && !abort;
+    });
+}
+exports.promptConfirmation = promptConfirmation;
+/**
+ * Prompt for username and password.
+ *
+ * @param username - optional username that is to be offered as default
+ * @returns credentials object with username/password
+ */
+function promptCredentials(username) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const credentials = yield (0, prompts_1.default)([
+            {
+                type: 'text',
+                name: 'username',
+                initial: username,
+                message: 'Username:'
+            },
+            {
+                type: 'password',
+                name: 'password',
+                message: 'Password:'
+            }
+        ]);
+        return credentials;
+    });
+}
+exports.promptCredentials = promptCredentials;
+/**
+ * Prompt for the location of the service keys.
+ *
+ * @returns credentials object with service keys
+ */
+function promptServiceKeys() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { path } = yield (0, prompts_1.default)([
+            {
+                type: 'text',
+                name: 'path',
+                message: 'Please provide the service keys as file:',
+                validate: (input) => (0, fs_1.existsSync)(input)
+            }
+        ]);
+        return JSON.parse((0, fs_1.readFileSync)(path, 'utf-8'));
+    });
+}
+exports.promptServiceKeys = promptServiceKeys;
+//# sourceMappingURL=prompt.js.map

package/dist/cli/archive.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { CliOptions } from '../types';
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Get a zipped archived based on the given options.
+ *
+ * @param logger - reference to the logger instance
+ * @param options - options provided via CLI
+ * @returns Buffer containing the zip file
+ */
+export declare function getArchive(logger: Logger, options: CliOptions): Promise<Buffer>;
+//# sourceMappingURL=archive.d.ts.map

package/dist/cli/archive.js

@@ -0,0 +1,110 @@
+"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.getArchive = void 0;
+const axios_1 = __importDefault(require("axios"));
+const fs_1 = require("fs");
+const yazl_1 = require("yazl");
+const path_1 = require("path");
+const archive_1 = require("../base/archive");
+const https_1 = require("https");
+/**
+ * Get/read zip file from the given path.
+ *
+ * @param logger - reference to the logger instance
+ * @param path - path to the zip file
+ * @returns Buffer containing the zip file
+ */
+function getArchiveFromPath(logger, path) {
+    return new Promise((resolve, reject) => {
+        logger.info(`Loading archive from ${path}`);
+        (0, fs_1.readFile)(path, (err, data) => {
+            if (err) {
+                reject(`Archive loading has failed. Please ensure ${path} is valid and accessible.`);
+            }
+            else {
+                logger.info('Archive loaded.');
+                resolve(data);
+            }
+        });
+    });
+}
+/**
+ * Fetch/get zip file from the given url.
+ *
+ * @param url - url to the zip file
+ * @param rejectUnauthorized - strict SSL handling or not
+ * @returns Buffer containing the zip file
+ */
+function fetchArchiveFromUrl(url, rejectUnauthorized) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const response = yield axios_1.default.get(url, {
+                httpsAgent: new https_1.Agent({ rejectUnauthorized }),
+                responseType: 'arraybuffer'
+            });
+            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.
+ *
+ * @param logger - reference to the logger instance
+ * @param path - path to the folder that is to be zipped
+ * @returns Buffer containing the zip file
+ */
+function createArchiveFromFolder(logger, path) {
+    try {
+        logger.info(`Creating archive from ${path}.`);
+        const files = (0, archive_1.getFileNames)(path);
+        const zip = new yazl_1.ZipFile();
+        for (const filePath of files) {
+            const relPath = (0, path_1.relative)(path, filePath);
+            logger.debug(`Adding ${relPath}`);
+            zip.addFile(filePath, relPath);
+        }
+        logger.info(`Archive created from ${path}.`);
+        return (0, archive_1.createBuffer)(zip);
+    }
+    catch (error) {
+        throw new Error(`Archive creation has failed. Please ensure ${path} is valid and accessible.`);
+    }
+}
+/**
+ * Get a zipped archived based on the given options.
+ *
+ * @param logger - reference to the logger instance
+ * @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(options.archiveUrl, options.strictSsl);
+        }
+        else {
+            return createArchiveFromFolder(logger, (_a = options.archiveFolder) !== null && _a !== void 0 ? _a : process.cwd());
+        }
+    });
+}
+exports.getArchive = getArchive;
+//# sourceMappingURL=archive.js.map

package/dist/cli/config.d.ts

@@ -0,0 +1,23 @@
+import type { AbapDeployConfig, CliOptions } from '../types';
+/**
+ * Tries to read the version of the modules package.json but in case of an error, it returns the manually maintained version matching major.minor of the module.
+ *
+ * @returns the version of the deploy tooling.
+ */
+export declare function getVersion(): any;
+/**
+ * Read the deployment configuration from a ui5*.yaml file.
+ *
+ * @param path - path to the ui5*.yaml file
+ * @returns the configuration object or throws an error if it cannot be read.
+ */
+export declare function getDeploymentConfig(path: string): Promise<AbapDeployConfig>;
+/**
+ * Merge the configuration from the ui5*.yaml with CLI options.
+ *
+ * @param taskConfig - base configuration from the file
+ * @param options - CLI options
+ * @returns the merged config
+ */
+export declare function mergeConfig(taskConfig: AbapDeployConfig, options: CliOptions): Promise<AbapDeployConfig>;
+//# sourceMappingURL=config.d.ts.map