@ibm-cloud/cd-tools 1.1.1 → 1.1.2

package/cmd/copy-toolchain.js

@@ -16,8 +16,8 @@ import { Command, Option } from 'commander';
 import { parseEnvVar } from './utils/utils.js';
 import { logger, LOG_STAGES } from './utils/logger.js';
 import { setTerraformerEnv, setTerraformEnv, initProviderFile, runTerraformerImport, setupTerraformFiles, runTerraformInit, getNumResourcesPlanned, runTerraformApply, getNumResourcesCreated, getNewToolchainId } from './utils/terraform.js';
-import { getAccountId, getBearerToken, getResourceGroupId, getToolchain } from './utils/requests.js';
-import { validatePrereqsVersions, validateResourceGroupId, validateTag, validateToolchainId, validateToolchainName, validateTools, validateOAuth, warnDuplicateName, validateGritUrl } from './utils/validate.js';
+import { getAccountId, getBearerToken, getResourceGroupIdAndName, getToolchain } from './utils/requests.js';
+import { validatePrereqsVersions, validateTag, validateToolchainId, validateToolchainName, validateTools, validateOAuth, warnDuplicateName, validateGritUrl } from './utils/validate.js';
 
 import { COPY_TOOLCHAIN_DESC, MIGRATION_DOC_URL, TARGET_REGIONS, SOURCE_REGIONS } from '../config.js';
 
@@ -84,6 +84,7 @@ async function main(options) {
 	let targetToolchainName = options.name;
 	let targetTag = options.tag;
 	let targetRgId;
+	let targetRgName;
 	let apiKey = options.apikey;
 	let moreTfResources = {};
 	let gritMapping = {};
@@ -137,17 +138,11 @@ async function main(options) {
 			exit(1);
 		}
 
-		if (!targetRg) {
-			// reuse resource group if not provided
-			targetRgId = sourceToolchainData['resource_group_id'];
-		} else {
-			targetRgId = await getResourceGroupId(bearer, accountId, targetRg);
-			validateResourceGroupId(targetRgId);
-		}
+		({ id: targetRgId, name: targetRgName } = await getResourceGroupIdAndName(bearer, accountId, targetRg || sourceToolchainData['resource_group_id']));
 
 		// reuse name if not provided
 		if (!targetToolchainName) targetToolchainName = sourceToolchainData['name'];
-		[targetToolchainName, targetTag] = await warnDuplicateName(bearer, accountId, targetToolchainName, sourceRegion, targetRegion, targetRgId, targetTag, skipUserConfirmation);
+		[targetToolchainName, targetTag] = await warnDuplicateName(bearer, accountId, targetToolchainName, sourceRegion, targetRegion, targetRgId, targetRgName, targetTag, skipUserConfirmation);
 
 		const allTools = await logger.withSpinner(validateTools,
 			'Validating Toolchain Tool(s)...',

package/cmd/utils/requests.js

@@ -185,7 +185,7 @@ async function getPipelineData(bearer, pipelineId, region) {
 }
 
 // takes in resource group ID or name
-async function getResourceGroupId(bearer, accountId, resourceGroup) {
+async function getResourceGroupIdAndName(bearer, accountId, resourceGroup) {
     const apiBaseUrl = 'https://api.global-search-tagging.cloud.ibm.com/v3';
     const options = {
         url: apiBaseUrl + '/resources/search',
@@ -196,7 +196,7 @@ async function getResourceGroupId(bearer, accountId, resourceGroup) {
         },
         data: {
             'query': `type:resource-group AND (name:${resourceGroup} OR doc.id:${resourceGroup}) AND doc.state:ACTIVE`,
-            'fields': ['doc.id']
+            'fields': ['doc.id', 'doc.name']
         },
         params: { account_id: accountId },
         validateStatus: () => true
@@ -205,7 +205,7 @@ async function getResourceGroupId(bearer, accountId, resourceGroup) {
     switch (response.status) {
         case 200:
             if (response.data.items.length != 1) throw Error('The resource group with provided ID or name was not found or is not accessible');
-            return response.data.items[0].doc.id;
+            return { id: response.data.items[0].doc.id, name: response.data.items[0].doc.name };
         default:
             throw Error('The resource group with provided ID or name was not found or is not accessible');
     }
@@ -349,11 +349,11 @@ export {
     getToolchainsByName,
     getToolchainTools,
     getPipelineData,
-    getResourceGroupId,
+    getResourceGroupIdAndName,
     getAppConfigHealthcheck,
     getSecretsHealthcheck,
     getGitOAuth,
     getGritUserProject,
     getGritGroup,
     getGritGroupProject
-}
+}

package/cmd/utils/utils.js

@@ -25,7 +25,7 @@ export async function promptUserConfirmation(question, expectedAns, exitMsg) {
         output: process.stdout
     });
 
-    const fullPrompt = question + `\n\nOnly '${expectedAns}' will be accepted to proceed.\n\nEnter a value: `;
+    const fullPrompt = question + `\n\nOnly '${expectedAns}' will be accepted to proceed. (Ctrl-C to abort)\n\nEnter a value: `;
     const answer = await rl.question(fullPrompt);
 
     logger.dump(fullPrompt + '\n' + answer + '\n');
@@ -38,7 +38,7 @@ export async function promptUserConfirmation(question, expectedAns, exitMsg) {
     }
 
     rl.close();
-    logger.print('\n');
+    logger.print();
 }
 
 export async function promptUserInput(question, initialInput, validationFn) {
@@ -75,6 +75,7 @@ export async function promptUserInput(question, initialInput, validationFn) {
     }
 
     rl.close();
+    logger.print();
     return answer.trim();
 }
 
@@ -97,12 +98,12 @@ export function replaceUrlRegion(inputUrl, srcRegion, targetRegion) {
 *
 * @param {String} crn - The crn to decompose.
 **/
-export function decomposeCrn (crn) {
+export function decomposeCrn(crn) {
     const crnParts = crn.split(':');
 
     // Remove the 'a/' segment.
     let accountId = crnParts[6];
-    if(accountId) {
+    if (accountId) {
         accountId = accountId.split('/')[1];
     }
 
@@ -123,6 +124,6 @@ export function decomposeCrn (crn) {
 *
 * @param {String} value - The value to verify.
 **/
-export function isSecretReference (value) {
+export function isSecretReference(value) {
     return !!(VAULT_REGEX.find(r => r.test(value)));
-};
+};

package/cmd/utils/validate.js

@@ -9,29 +9,11 @@
 
 import { execSync } from 'child_process';
 import { logger, LOG_STAGES } from './logger.js'
-import { RESERVED_GRIT_PROJECT_NAMES, RESERVED_GRIT_GROUP_NAMES, RESERVED_GRIT_SUBGROUP_NAME, TERRAFORM_REQUIRED_VERSION, TERRAFORMER_REQUIRED_VERSION } from '../../config.js';
+import { RESERVED_GRIT_PROJECT_NAMES, RESERVED_GRIT_GROUP_NAMES, RESERVED_GRIT_SUBGROUP_NAME, TERRAFORM_REQUIRED_VERSION, TERRAFORMER_REQUIRED_VERSION, UPDATEABLE_SECRET_PROPERTIES_BY_TOOL_TYPE } from '../../config.js';
 import { getToolchainsByName, getToolchainTools, getPipelineData, getAppConfigHealthcheck, getSecretsHealthcheck, getGitOAuth, getGritUserProject, getGritGroup, getGritGroupProject } from './requests.js';
 import { promptUserConfirmation, promptUserInput } from './utils.js';
 
 
-const SECRETS_MAP = {
-    'artifactory': ['token'],
-    'hashicorpvault': ['token', 'role_id', 'secret_id', 'password'],
-    'jenkins': ['webhook_url', 'api_token'],
-    'jira': ['api_token'],
-    'nexus': ['token'],
-    'pagerduty': ['service_key'],
-    'privateworker': ['worker_queue_credentials'],
-    'saucelabs': ['access_key'],
-    'securitycompliance': ['scc_api_key'],
-    'slack': ['webhook'],
-    'sonarqube': ['user_password'],
-    'gitlab': ['api_token'],
-    'githubconsolidated': ['api_token'],
-    'github_integrated': ['api_token']
-};
-
-
 function validatePrereqsVersions() {
     const compareVersions = (verInstalled, verRequired) => {
         const installedSplit = verInstalled.split('.').map(Number);
@@ -95,18 +77,6 @@ function validateToolchainName(tcName) {
     throw Error('Provided toolchain name is invalid');
 }
 
-function validateResourceGroupId(rgId) {
-    if (typeof rgId != 'string') throw Error('Provided resource group ID is not a string');
-    const trimmed = rgId.trim();
-
-    // pattern from api docs
-    const pattern = /^[0-9a-f]{32}$/;
-    if (pattern.test(trimmed)) {
-        return trimmed;
-    }
-    throw Error('Provided resource group ID is invalid');
-}
-
 function validateTag(tag) {
     if (typeof tag != 'string') throw Error('Provided resource group ID is not a string');
     const trimmed = tag.trim();
@@ -120,7 +90,7 @@ function validateTag(tag) {
 }
 
 
-async function warnDuplicateName(token, accountId, tcName, srcRegion, targetRegion, targetResourceGroupId, targetTag, skipPrompt) {
+async function warnDuplicateName(token, accountId, tcName, srcRegion, targetRegion, targetResourceGroupId, targetResourceGroupName, targetTag, skipPrompt) {
     const toolchains = await getToolchainsByName(token, accountId, tcName);
 
     let hasSameRegion = false;
@@ -145,19 +115,19 @@ async function warnDuplicateName(token, accountId, tcName, srcRegion, targetRegi
 
         if (hasBoth) {
             // warning! prompt user to cancel, rename (e.g. add a suffix) or continue
-            logger.warn('Warning! You have a toolchain with the same name within the target region and resource group! \n', LOG_STAGES.setup, true);
+            logger.warn(`\nWarning! A toolchain named '${tcName}' already exists in:\n - Region: ${targetRegion}\n - Resource Group: ${targetResourceGroupName} (${targetResourceGroupId})`, '', true);
 
             if (!skipPrompt) {
-                newTcName = await promptUserInput('(Recommended) Change the cloned toolchain\'s name:\n', tcName, validateToolchainName);
+                newTcName = await promptUserInput(`\n(Recommended) Edit the cloned toolchain's name [default: ${tcName}] (Ctrl-C to abort):\n`, tcName, validateToolchainName);
             }
         } else {
             if (hasSameRegion) {
                 // soft warning of confusion
-                logger.warn('Warning! You have a toolchain with the same name within the target region!\n', LOG_STAGES.setup, true);
+                logger.warn(`\nWarning! A toolchain named '${tcName}' already exists in:\n - Region: ${targetRegion}`, '', true);
             }
             if (hasSameResourceGroup) {
                 // soft warning of confusion
-                logger.warn('Warning! You have a toolchain with the same name within the target resource group!\n', LOG_STAGES.setup, true);
+                logger.warn(`\nWarning! A toolchain named '${tcName}' already exists in:\n - Resource Group: ${targetResourceGroupName} (${targetResourceGroupId})`, '', true);
             }
         }
 
@@ -169,7 +139,7 @@ async function warnDuplicateName(token, accountId, tcName, srcRegion, targetRegi
                         if (str.trim() === '') return null;
                         return validateTag(str);
                     }
-                    newTag = await promptUserInput('(Recommended) Add a tag to the cloned toolchain:\n', `cloned-from-${srcRegion}`, validateTagOrEmpty);
+                    newTag = await promptUserInput('\n(Recommended) Add a tag to the cloned toolchain (Ctrl-C to abort):\n', `cloned-from-${srcRegion}`, validateTagOrEmpty);
                 }
             }
             return [newTcName, newTag];
@@ -264,7 +234,7 @@ async function validateTools(token, tcId, region, skipPrompt) {
                 });
             }
             else {
-                const secretsToCheck = SECRETS_MAP[tool.tool_type_id] || [];    // Check for secrets in the rest of the tools
+                const secretsToCheck = UPDATEABLE_SECRET_PROPERTIES_BY_TOOL_TYPE[tool.tool_type_id] || [];    // Check for secrets in the rest of the tools
                 Object.entries(tool.parameters).forEach(([key, value]) => {
                     if (secretPattern.test(value) && secretsToCheck.includes(key)) secrets.push(key);
                 });
@@ -279,14 +249,17 @@ async function validateTools(token, tcId, region, skipPrompt) {
             }
         }
     }
-    const invalid = nonConfiguredTools.length > 0 || patTools.length > 0 || classicPipelines.length > 0 || toolsWithHashedParams.length > 0;
+    const hasInvalidConfig = nonConfiguredTools.length > 0 || patTools.length > 0 || toolsWithHashedParams.length > 0;
 
-    // Manually fail and reset spinner to prevent duplicate spinners
-    if (invalid) {
-        logger.failSpinner('Invalid tools found!');
-        logger.resetSpinner();
+    if (classicPipelines.length > 0) {
+        logger.failSpinner('Unsupported tools found!');
+        logger.warn('Warning! Classic pipelines are currently not supported in migration:\n', LOG_STAGES.setup, true);
+        logger.table(classicPipelines);
     }
 
+    if (hasInvalidConfig) logger.failSpinner('Configuration problems found!');
+    if (classicPipelines.length > 0 || hasInvalidConfig) logger.resetSpinner();    // Manually reset spinner to prevent duplicate spinners
+
     if (nonConfiguredTools.length > 0) {
         logger.warn('Warning! The following tool(s) are not in configured state in toolchain, please reconfigure them before proceeding: \n', LOG_STAGES.setup, true);
         logger.table(nonConfiguredTools);
@@ -297,17 +270,13 @@ async function validateTools(token, tcId, region, skipPrompt) {
         logger.table(patTools);
     }
 
-    if (classicPipelines.length > 0) {
-        logger.warn('Warning! Classic pipelines are currently not supported in migration:\n', LOG_STAGES.setup, true);
-        logger.table(classicPipelines);
-    }
-
     if (toolsWithHashedParams.length > 0) {
         logger.warn('Warning! The following tools contain secrets that cannot be migrated, please use the \'check-secret\' command to export the secrets: \n', LOG_STAGES.setup, true);
         logger.table(toolsWithHashedParams);
     }
 
-    if (!skipPrompt && invalid) await promptUserConfirmation('Caution: The above tool(s) will not be properly configured post migration. Do you want to proceed?', 'yes', 'Toolchain migration cancelled.');
+    if (!skipPrompt && (classicPipelines.length > 0 || hasInvalidConfig))
+        await promptUserConfirmation('Caution: The above tool(s) will not be properly configured post migration. Do you want to proceed?', 'yes', 'Toolchain migration cancelled.');
 
     return allTools.tools;
 }
@@ -414,7 +383,7 @@ async function validateOAuth(token, tools, targetRegion, skipPrompt) {
 
         logger.print('Authorize using the following links: \n');
         oauthLinks.forEach((o) => {
-            logger.print(`${o.type}: \x1b[34m${o.link}\x1b[0m\n`);
+            logger.print(`${o.type}: \x1b[36m${o.link}\x1b[0m\n`);
         });
 
         if (!skipPrompt) await promptUserConfirmation('Caution: The above git tool integration(s) will not be properly configured post migration. Do you want to proceed?', 'yes', 'Toolchain migration cancelled.');
@@ -494,7 +463,6 @@ export {
     validatePrereqsVersions,
     validateToolchainId,
     validateToolchainName,
-    validateResourceGroupId,
     validateTag,
     validateTools,
     validateOAuth,

package/config.js

@@ -163,7 +163,8 @@ const UPDATEABLE_SECRET_PROPERTIES_BY_TOOL_TYPE = {
 		"service_key"
 	],
 	"private_worker": [
-		"workerQueueCredentials"
+		"workerQueueCredentials",
+		"worker_queue_credentials"
 	],
 	"saucelabs": [
 		"key",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibm-cloud/cd-tools",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Tools and utilities for the IBM Cloud Continuous Delivery service and resources",
   "repository": {
     "type": "git",