@sap-ux/deploy-tooling 0.2.12 → 0.3.0

package/README.md

@@ -53,13 +53,14 @@ Usage: deploy [options]
 Options:
   -c, --config <path-to-yaml>          Path to config yaml file
   -y, --yes                            yes to all questions (default: false)
-  -n, --no-retry                       do not retry if deploy fails for any reason
+  -n, --no-retry                       do not retry if deploy fails for any reason, for CI/CD pipeline flows this option needs to be included (default: false)
   --verbose                            verbose log output (default: false)
   --destination  <destination>         Destination in SAP BTP pointing to an ABAP system
   --url <target-url>                   URL of target ABAP system
   --client <sap-client>                Client number of target ABAP system
   --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.
   --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)
@@ -84,13 +85,14 @@ Usage: undeploy [options]
 Options:
   -c, --config <path-to-yaml>          Path to config yaml file
   -y, --yes                            yes to all questions (default: false)
-  -n, --no-retry                       do not retry if undeploy fails for any reason
+  -n, --no-retry                       do not retry if undeploy fails for any reason, for CI/CD pipeline flows this option needs to be included (default: false)
   --verbose                            verbose log output (default: false)
   --destination  <destination>         Destination in SAP BTP pointing to an ABAP system
   --url <target-url>                   URL of target ABAP system
   --client <sap-client>                Client number of target ABAP system
   --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
   --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/config.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateConfig = exports.replaceEnvVariables = exports.getConfigForLogging = exports.isUrlTarget = void 0;
-const dotenv_1 = require("dotenv");
 const btp_utils_1 = require("@sap-ux/btp-utils");
 /**
  * Check if it is a url or destination target.
@@ -35,7 +34,6 @@ exports.getConfigForLogging = getConfigForLogging;
  * @param obj - any object structure
  */
 function replaceEnvVariables(obj) {
-    (0, dotenv_1.config)();
     for (const key in obj) {
         const value = obj[key];
         if (typeof value === 'object') {

package/dist/base/deploy.js

@@ -127,7 +127,7 @@ function createDeployService(config, logger) {
         }
         else if ((0, config_1.isUrlTarget)(config.target)) {
             if (config.target.cloud) {
-                provider = yield createAbapCloudServiceProvider(options, config.target, config.noRetry, logger);
+                provider = yield createAbapCloudServiceProvider(options, config.target, config.retry, logger);
             }
             else {
                 provider = yield createAbapServiceProvider(options, config.target);
@@ -151,7 +151,8 @@ function createDeployService(config, logger) {
  */
 function handleError(command, error, service, config, logger, archive) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!config.noRetry && (0, axios_extension_1.isAxiosError)(error)) {
+        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);
             if (success) {
                 return;
@@ -196,7 +197,7 @@ function handleAxiosError(command, response, service, 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, noRetry: true }), logger, archive);
+                    yield deploymentCommands[command](service, Object.assign(Object.assign({}, config), { safe: false, retry: false }), logger, archive);
                     return true;
                 }
                 else {

package/dist/cli/config.js

@@ -62,6 +62,25 @@ function readServiceKeyFromFile(path) {
         throw new Error(`Unable to read service key from from ${path}`);
     }
 }
+/**
+ * Read the environment variables to generate a service object.
+ *
+ * @param targetUrl target endpoint where app is being deployed to
+ * @returns service key as js object
+ */
+function getServiceFromEnv(targetUrl) {
+    return {
+        uaa: {
+            clientid: process.env.SERVICE_CLIENT_ID,
+            clientsecret: process.env.SERVICE_CLIENT_SECRET,
+            url: process.env.SERVICE_UAA_URL,
+            username: process.env.SERVICE_USERNAME,
+            password: process.env.SERVICE_PASSWORD
+        },
+        url: targetUrl !== null && targetUrl !== void 0 ? targetUrl : process.env.SERVICE_URL,
+        systemid: process.env.SERVICE_SYSTEM_ID
+    };
+}
 /**
  * Boolean merger.
  *
@@ -89,6 +108,23 @@ function parseQueryParams(query) {
     });
     return params;
 }
+/**
+ * Generate the service object using either a service.json file or environment variables.
+ *
+ * @param options additional options
+ * @param targetUrl target endpoint where app is being deployed to
+ * @returns service key as js object
+ */
+function getServiceKey(options, targetUrl) {
+    let serviceKey;
+    if (options.cloudServiceKey) {
+        serviceKey = readServiceKeyFromFile(options.cloudServiceKey);
+    }
+    else if (options.cloudServiceEnv) {
+        serviceKey = getServiceFromEnv(targetUrl);
+    }
+    return serviceKey;
+}
 /**
  * Merge CLI options into a base target configuration.
  *
@@ -98,12 +134,13 @@ function parseQueryParams(query) {
  */
 function mergeTarget(baseTarget, options) {
     var _a, _b, _c;
+    const targetUrl = (_a = options.url) !== null && _a !== void 0 ? _a : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.url;
     return {
-        url: (_a = options.url) !== null && _a !== void 0 ? _a : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.url,
+        url: targetUrl,
         client: (_b = options.client) !== null && _b !== void 0 ? _b : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.client,
         cloud: options.cloud !== undefined ? options.cloud : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.cloud,
         destination: (_c = options.destination) !== null && _c !== void 0 ? _c : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.destination,
-        serviceKey: options.cloudServiceKey ? readServiceKeyFromFile(options.cloudServiceKey) : undefined,
+        serviceKey: getServiceKey(options, targetUrl),
         params: options.queryParams ? parseQueryParams(options.queryParams) : undefined
     };
 }
@@ -130,6 +167,7 @@ function mergeConfig(taskConfig, options) {
         config.keep = mergeFlag(options.keep, taskConfig.keep);
         config.strictSsl = mergeFlag(options.strictSsl, taskConfig.strictSsl);
         config.yes = mergeFlag(options.yes, taskConfig.yes);
+        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

@@ -16,6 +16,7 @@ const base_1 = require("../base");
 const types_1 = require("../types");
 const archive_1 = require("./archive");
 const config_1 = require("./config");
+const dotenv_1 = require("dotenv");
 /**
  * Create an instance of a command runner for deployment.
  *
@@ -26,7 +27,7 @@ function createCommand(name) {
     const command = new commander_1.Command(name)
         .option('-c, --config <path-to-yaml>', 'Path to config yaml file')
         .option('-y, --yes', 'yes to all questions', false)
-        .option('-n, --no-retry', `do not retry if ${name} fails for any reason`, false)
+        .option('-n, --no-retry', `do not retry if ${name} fails for any reason`, true) // retry by default when true, if passed from cli, will set to false
         .option('--verbose', 'verbose log output', false);
     // options to set (or overwrite) values that are otherwise read from the `ui5*.yaml`
     command
@@ -35,6 +36,7 @@ function createCommand(name) {
         .addOption(new commander_1.Option('--client <sap-client>', 'Client number of target ABAP system').conflicts('destination'))
         .addOption(new commander_1.Option('--cloud', 'target is an ABAP Cloud system').conflicts('destination'))
         .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')
         .option('--name <bsp-name>', 'Project name of the app')
         .option('--strict-ssl', 'Perform certificate validation (use --no-strict-ssl to deactivate it)')
@@ -74,6 +76,7 @@ function prepareRun(cmd) {
         if (process.argv.length < 3) {
             cmd.help();
         }
+        (0, dotenv_1.config)();
         const options = cmd.parse().opts();
         const logLevel = options.verbose ? logger_1.LogLevel.Silly : logger_1.LogLevel.Info;
         const logger = new logger_1.ToolsLogger({

package/dist/types/index.d.ts

@@ -46,9 +46,9 @@ export interface CommonOptions {
      */
     verbose?: boolean;
     /**
-     * If set to true then do not retry if a deployment fails.
+     * '--no-retry' cli param negates the retry value which is true by default
      */
-    noRetry?: boolean;
+    retry?: boolean;
 }
 export interface AbapDeployConfig extends CommonOptions {
     target: AbapTarget;
@@ -62,5 +62,6 @@ export interface CliOptions extends Partial<BspConfig>, Partial<DestinationAbapT
     archiveUrl?: string;
     cloudServiceKey?: string;
     queryParams?: string;
+    cloudServiceEnv?: boolean;
 }
 //# 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.2.12",
+  "version": "0.3.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -31,7 +31,7 @@
     "dotenv": "16.0.0",
     "prompts": "2.4.2",
     "yazl": "2.5.1",
-    "@sap-ux/axios-extension": "1.2.8",
+    "@sap-ux/axios-extension": "1.3.0",
     "@sap-ux/btp-utils": "0.11.6",
     "@sap-ux/logger": "0.3.6",
     "@sap-ux/store": "0.3.11",