@sap-ux/deploy-tooling 0.4.5 → 0.6.0

package/README.md

@@ -62,6 +62,9 @@ Options:
   --cloud                              target is an ABAP Cloud system
   --cloud-service-key <file-location>  JSON file location with the ABAP cloud service key.
   --cloud-service-env                  Load ABAP cloud service properties from either a .env file or your environment variables. Secrets in your .env should not be committed to source control.
+  --username                           ABAP Service username
+  --password                           ABAP Service password
+  --create-transport                   Create a transport request during deployment
   --transport <transport-request>      Transport number to record the change in the ABAP system
   --name <bsp-name>                    Project name of the app
   --strict-ssl                         Perform certificate validation (use --no-strict-ssl to deactivate it)
@@ -95,6 +98,8 @@ Options:
   --cloud                              target is an ABAP Cloud system
   --cloud-service-key <file-location>  JSON file location with the ABAP cloud service key.
   --cloud-service-env                  Load ABAP cloud service properties from either a .env file or your environment variables
+  --username                           ABAP Service username
+  --password                           ABAP Service password
   --transport <transport-request>      Transport number to record the change in the ABAP system
   --name <bsp-name>                    Project name of the app
   --strict-ssl                         Perform certificate validation (use --no-strict-ssl to deactivate it)

package/dist/base/deploy.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
+import type { AbapServiceProvider } from '@sap-ux/axios-extension';
 import type { Logger } from '@sap-ux/logger';
 import type { BackendSystem } from '@sap-ux/store';
 import type { AbapDeployConfig, UrlAbapTarget } from '../types';
@@ -14,6 +15,16 @@ type ServiceAuth = Required<Pick<BackendSystem, 'serviceKeys' | 'name'>> & {
  * @returns {*}  {(Promise<T | undefined>)} - Credentials
  */
 export declare function getCredentials<T extends BasicAuth | ServiceAuth | undefined>(target: UrlAbapTarget): Promise<T | undefined>;
+/**
+ * Creates a new transport request using adt service.
+ *
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ * @param provider - optional instance of the axios-extension abap service provider
+ * @throws error if transport request creation fails
+ * @returns transportRequest
+ */
+export declare function createTransportRequest(config: AbapDeployConfig, logger: Logger, provider?: AbapServiceProvider): Promise<string>;
 /**
  * Deploy the given archive to the given target using the given app description.
  *

package/dist/base/deploy.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.undeploy = exports.deploy = exports.getCredentials = void 0;
+exports.undeploy = exports.deploy = exports.createTransportRequest = 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");
@@ -109,14 +109,14 @@ function createAbapServiceProvider(options, target) {
     });
 }
 /**
- * Create an instance of a UI5AbapRepository service connected to the given target configuration.
+ * Create an instance of an AbapServiceProvider 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, _d;
+function getAbapServiceProvider(config, logger) {
+    var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
         let provider;
         const options = {};
@@ -151,7 +151,7 @@ function createDeployService(config, logger) {
         else {
             throw new Error('Unable to handle the configuration in the current environment.');
         }
-        return provider.getUi5AbapRepository((_d = config.target) === null || _d === void 0 ? void 0 : _d.service);
+        return provider;
     });
 }
 /**
@@ -159,16 +159,16 @@ function createDeployService(config, logger) {
  *
  * @param command - the request type deploy | undeploy
  * @param error - thrown error object
- * @param service - instance of the axios-extension deployment service
+ * @param provider - instance of the axios-extension abap service provider
  * @param config - configuration used for the previous request
  * @param logger - reference to the logger instance
  * @param archive - archive file that is to be deployed
  */
-function handleError(command, error, service, config, logger, archive) {
+function handleError(command, error, provider, config, logger, archive) {
     return __awaiter(this, void 0, void 0, function* () {
         const retry = config.retry === undefined ? true : config.retry;
         if (retry && (0, axios_extension_1.isAxiosError)(error)) {
-            const success = yield handleAxiosError(command, error.response, service, config, logger, archive);
+            const success = yield axiosErrorRetryHandler(command, error.response, provider, config, logger, archive);
             if (success) {
                 return;
             }
@@ -181,43 +181,74 @@ function handleError(command, error, service, config, logger, archive) {
         throw error;
     });
 }
+/**
+ * Handler for 412 error code.
+ *
+ * @param command - the request type deploy | undeploy
+ * @param provider - instance of the axios-extension abap service provider
+ * @param config - configuration used for the previous request
+ * @param logger - reference to the logger instance
+ * @param archive - archive file that is to be deployed
+ * @returns true if the error was handled otherwise false is returned
+ */
+function handle412Error(command, provider, config, logger, archive) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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 deploymentCommands[command](provider, Object.assign(Object.assign({}, config), { safe: false, retry: false }), logger, archive);
+            return true;
+        }
+        else {
+            return false;
+        }
+    });
+}
+/**
+ * Handler for 401 error code.
+ *
+ * @param command - the request type deploy | undeploy
+ * @param provider - instance of the axios-extension abap service provider
+ * @param config - configuration used for the previous request
+ * @param logger - reference to the logger instance
+ * @param archive - archive file that is to be deployed
+ * @returns true if the error was handled otherwise false is returned
+ */
+function handle401Error(command, provider, config, logger, archive) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        logger.warn(`${command === "tryDeploy" /* TryCommands.Deploy */ ? 'Deployment' : 'Undeployment'} 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.');
+        const service = getUi5AbapRepositoryService(provider, config, logger);
+        const credentials = yield (0, prompt_1.promptCredentials)((_a = service.defaults.auth) === null || _a === void 0 ? void 0 : _a.username);
+        if (Object.keys(credentials).length) {
+            service.defaults.auth = credentials;
+            yield deploymentCommands[command](provider, config, logger, archive);
+            return true;
+        }
+        else {
+            return false;
+        }
+    });
+}
 /**
  * Main function for different deploy retry handling.
  *
  * @param command - the request type deploy | undeploy
  * @param response - response of that triggered and axios error
- * @param service - instance of the axios-extension deployment service
+ * @param provider - instance of the axios-extension abap service provider
  * @param config - configuration used for the previous request
  * @param logger - reference to the logger instance
  * @param archive - archive file that is to be deployed
  * @returns true if the error was handled otherwise false is return or an error is raised
  */
-function handleAxiosError(command, response, service, config, logger, archive) {
-    var _a;
+function axiosErrorRetryHandler(command, response, provider, config, logger, archive) {
     return __awaiter(this, void 0, void 0, function* () {
         switch (response === null || response === void 0 ? void 0 : response.status) {
             case 401:
-                logger.warn(`${command === "tryDeploy" /* TryCommands.Deploy */ ? 'Deployment' : 'Undeployment'} 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.');
-                const credentials = yield (0, prompt_1.promptCredentials)((_a = service.defaults.auth) === null || _a === void 0 ? void 0 : _a.username);
-                if (Object.keys(credentials).length) {
-                    service.defaults.auth = credentials;
-                    yield deploymentCommands[command](service, config, logger, archive);
-                    return true;
-                }
-                else {
-                    return false;
-                }
+                return handle401Error(command, provider, config, logger, archive);
             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 deploymentCommands[command](service, Object.assign(Object.assign({}, config), { safe: false, retry: false }), logger, archive);
-                    return true;
-                }
-                else {
-                    return false;
-                }
+                return handle412Error(command, provider, config, logger, archive);
             default:
                 return false;
         }
@@ -226,20 +257,56 @@ function handleAxiosError(command, response, service, config, logger, archive) {
 /**
  * Generate a Ui5AbapRepositoryService instance from the supplied deployment config.
  *
+ * @param provider - instance of the axios-extension abap service provider
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
  * @returns service returns the UI5 ABAP Repository service
  */
-function getAbapService(config, logger) {
+function getUi5AbapRepositoryService(provider, config, logger) {
+    var _a;
+    const service = provider.getUi5AbapRepository((_a = config.target) === null || _a === void 0 ? void 0 : _a.service);
+    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).');
+    }
+    return service;
+}
+/**
+ * Creates a new transport request using adt service.
+ *
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ * @param provider - optional instance of the axios-extension abap service provider
+ * @throws error if transport request creation fails
+ * @returns transportRequest
+ */
+function createTransportRequest(config, logger, provider) {
+    var _a;
     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).');
+        try {
+            if (!provider) {
+                provider = yield getAbapServiceProvider(config, logger);
+            }
+            const adtService = yield provider.getAdtService(axios_extension_1.TransportRequestService);
+            logger.debug(`ADTService created for application ${config.app.name}, ${!adtService}.`);
+            const transportRequest = yield (adtService === null || adtService === void 0 ? void 0 : adtService.createTransportRequest({
+                packageName: (_a = config.app.package) !== null && _a !== void 0 ? _a : '',
+                ui5AppName: config.app.name,
+                description: 'Created by @sap-ux/deploy-tooling'
+            }));
+            if (transportRequest) {
+                logger.info(`Transport request ${transportRequest} created for application ${config.app.name}.`);
+                return transportRequest;
+            }
+            throw new Error(`Transport request could not be created for application ${config.app.name}.`);
+        }
+        catch (e) {
+            logger.error(`Transport request could not be created for application ${config.app.name}. Please create it manually and re-run deployment configuration for this project.`);
+            throw e;
         }
-        return service;
     });
 }
+exports.createTransportRequest = createTransportRequest;
 /**
  * Generic method to run the deployment request i.e. deploy | undeploy.
  *
@@ -250,22 +317,28 @@ function getAbapService(config, logger) {
  */
 function runCommand(command, config, logger, archive = Buffer.from('')) {
     return __awaiter(this, void 0, void 0, function* () {
-        const service = yield getAbapService(config, logger);
+        const provider = yield getAbapServiceProvider(config, logger);
         logger.info(`Starting to ${command === "tryDeploy" /* TryCommands.Deploy */ ? 'deploy' : 'undeploy'}${config.test === true ? ' in test mode' : ''}.`);
-        yield deploymentCommands[command](service, config, logger, archive);
+        yield deploymentCommands[command](provider, config, logger, archive);
     });
 }
 /**
  * Try executing the deployment command and handle known errors.
  *
- * @param service - instance of the axios-extension deployment service
+ * @param provider - instance of the axios-extension abap service provider
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
  * @param archive - archive file that is to be deployed
  */
-function tryDeploy(service, config, logger, archive) {
+function tryDeploy(provider, config, logger, archive) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
+            if (config.createTransport) {
+                config.app.transport = yield createTransportRequest(config, logger, provider);
+                // Reset as we dont want other flows kicking it off again!
+                config.createTransport = false;
+            }
+            const service = getUi5AbapRepositoryService(provider, config, logger);
             yield service.deploy({ archive, bsp: config.app, testMode: config.test, safeMode: config.safe });
             if (config.test === true) {
                 logger.info('Deployment in TestMode completed. A successful TestMode execution does not necessarily mean that your upload will be successful.');
@@ -275,7 +348,7 @@ function tryDeploy(service, config, logger, archive) {
             }
         }
         catch (error) {
-            yield handleError("tryDeploy" /* TryCommands.Deploy */, error, service, config, logger, archive);
+            yield handleError("tryDeploy" /* TryCommands.Deploy */, error, provider, config, logger, archive);
         }
     });
 }
@@ -298,13 +371,14 @@ exports.deploy = deploy;
 /**
  * Try executing the undeployment command and handle known errors.
  *
- * @param service - instance of the axios-extension deployment service
+ * @param provider - instance of the axios-extension abap service provider
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
  */
-function tryUndeploy(service, config, logger) {
+function tryUndeploy(provider, config, logger) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
+            const service = getUi5AbapRepositoryService(provider, config, logger);
             yield service.undeploy({ bsp: config.app, testMode: config.test });
             if (config.test === true) {
                 logger.info('Undeployment in TestMode completed. A successful TestMode execution does not necessarily mean that your undeploy will be successful.');
@@ -314,7 +388,7 @@ function tryUndeploy(service, config, logger) {
             }
         }
         catch (error) {
-            yield handleError("tryUndeploy" /* TryCommands.UnDeploy */, error, service, config, logger, Buffer.from(''));
+            yield handleError("tryUndeploy" /* TryCommands.UnDeploy */, error, provider, config, logger, Buffer.from(''));
         }
     });
 }

package/dist/base/prompt.d.ts

@@ -13,7 +13,7 @@ export declare function promptConfirmation(message: string): Promise<boolean>;
  * @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">>;
+export declare function promptCredentials(username?: string): Promise<prompts.Answers<"username" | "password">>;
 /**
  * Prompt for the location of the service keys.
  *

package/dist/cli/config.js

@@ -145,6 +145,22 @@ function mergeTarget(baseTarget, options) {
         service: (_d = options.service) !== null && _d !== void 0 ? _d : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.service
     };
 }
+/**
+ * Merge CLI and environment credentials.
+ *
+ * @param taskConfig - base configuration from the file
+ * @param options - CLI options
+ * @returns merged credentials
+ */
+function mergeCredentials(taskConfig, options) {
+    var _a, _b, _c, _d;
+    let credentials = taskConfig.credentials;
+    // Support CLI params and|or dotenv file
+    if (options.username || process.env.SERVICE_USERNAME) {
+        credentials = Object.assign(Object.assign({}, (credentials !== null && credentials !== void 0 ? credentials : {})), { username: (_b = (_a = options.username) !== null && _a !== void 0 ? _a : process.env.SERVICE_USERNAME) !== null && _b !== void 0 ? _b : '', password: (_d = (_c = options.password) !== null && _c !== void 0 ? _c : process.env.SERVICE_PASSWORD) !== null && _d !== void 0 ? _d : '' });
+    }
+    return credentials;
+}
 /**
  * Merge the configuration from the ui5*.yaml with CLI options.
  *
@@ -162,12 +178,13 @@ function mergeConfig(taskConfig, options) {
             transport: (_g = options.transport) !== null && _g !== void 0 ? _g : (_h = taskConfig.app) === null || _h === void 0 ? void 0 : _h.transport
         };
         const target = mergeTarget(taskConfig.target, options);
-        const config = { app, target, credentials: taskConfig.credentials };
+        const config = { app, target, credentials: mergeCredentials(taskConfig, options) };
         config.test = mergeFlag(options.test, taskConfig.test);
         config.safe = mergeFlag(options.safe, taskConfig.safe);
         config.keep = mergeFlag(options.keep, taskConfig.keep);
         config.strictSsl = mergeFlag(options.strictSsl, taskConfig.strictSsl);
         config.yes = mergeFlag(options.yes, taskConfig.yes);
+        config.createTransport = mergeFlag(options.createTransport, taskConfig.createTransport);
         config.retry = process.env.NO_RETRY ? !process.env.NO_RETRY : mergeFlag(options.retry, taskConfig.retry);
         if (!options.archiveUrl && !options.archivePath && !options.archiveFolder) {
             options.archiveFolder = 'dist';

package/dist/cli/index.js

@@ -39,6 +39,16 @@ function createCommand(name) {
         .addOption(new commander_1.Option('--cloud-service-key <file-location>', 'JSON file location with the ABAP cloud service key.').conflicts('destination'))
         .addOption(new commander_1.Option('--cloud-service-env', 'Read ABAP cloud service properties from environment variables or .env file').conflicts(['cloudServiceKey', 'destination']))
         .option('--transport <transport-request>', 'Transport number to record the change in the ABAP system')
+        .addOption(new commander_1.Option('--username <username>', 'ABAP System username').conflicts([
+        'cloudServiceKey',
+        'cloudServiceEnv',
+        'destination'
+    ]))
+        .addOption(new commander_1.Option('--password <password>', 'ABAP System password').conflicts([
+        'cloudServiceKey',
+        'cloudServiceEnv',
+        'destination'
+    ]))
         .option('--name <bsp-name>', 'Project name of the app')
         .option('--strict-ssl', 'Perform certificate validation (use --no-strict-ssl to deactivate it)')
         .option('--query-params <param1=value&param2=value>', 'Additional parameters that are to be added to calls to the target.')
@@ -48,6 +58,7 @@ function createCommand(name) {
         command
             .option('--package <abap-package>', 'Package name for deploy target ABAP system')
             .option('--description <description>', 'Project description of the app')
+            .addOption(new commander_1.Option('--create-transport', 'Create transport request during deployment').conflicts(['transport']))
             // SafeMode: Example: If the deployment would overwrite a repository that contains an app with a different sap.app/id and SafeMode is true, HTTP status code 412 (Precondition Failed) with further information would be returned.
             .option('--safe', 'Prevents accidentally breaking deployments.')
             .option('--keep', 'Keep a copy of the deployed archive in the project folder.');

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 import task from './ui5';
+import { createTransportRequest } from './base';
+export * from './types';
 export * from './cli';
-export { task };
+export { task, createTransportRequest };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -17,8 +17,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.task = void 0;
+exports.createTransportRequest = exports.task = void 0;
 const ui5_1 = __importDefault(require("./ui5"));
 exports.task = ui5_1.default;
+const base_1 = require("./base");
+Object.defineProperty(exports, "createTransportRequest", { enumerable: true, get: function () { return base_1.createTransportRequest; } });
+__exportStar(require("./types"), exports);
 __exportStar(require("./cli"), exports);
 //# sourceMappingURL=index.js.map

package/dist/types/index.d.ts

@@ -50,6 +50,10 @@ export interface CommonOptions {
      * '--no-retry' cli param negates the retry value which is true by default
      */
     retry?: boolean;
+    /**
+     * If set to true, a transport request will be created during deployment
+     */
+    createTransport?: boolean;
 }
 export interface AbapDeployConfig extends CommonOptions {
     target: AbapTarget;
@@ -64,5 +68,7 @@ export interface CliOptions extends Partial<BspConfig>, Partial<DestinationAbapT
     cloudServiceKey?: string;
     queryParams?: string;
     cloudServiceEnv?: boolean;
+    username?: string;
+    password?: string;
 }
 //# sourceMappingURL=index.d.ts.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.4.5",
+  "version": "0.6.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",