@ibm-cloud/cd-tools 1.15.4 → 1.15.6

package/cmd/copy-toolchain.js

@@ -109,13 +109,6 @@ async function main(options) {
 		bearer = await getBearerToken(apiKey);
 		const accountId = await getAccountId(bearer, apiKey);
 
-		// check for continuous delivery instance in target region
-		if (!await getCdInstanceByRegion(bearer, accountId, targetRegion)) {
-			// give users the option to bypass
-			logger.warn(`Warning! Could not find a Continuous Delivery instance in the target region ${targetRegion} or you do not have permission to view, please create one before proceeding if one does not exist already.`, LOG_STAGES.setup);
-			await promptUserConfirmation(`Do you want to proceed anyway?`, 'yes', 'Toolchain migration cancelled.');
-		}
-
 		// check for existing .tf files in output directory
 		if (fs.existsSync(outputDir)) {
 			let files = fs.readdirSync(outputDir, { recursive: true });
@@ -164,8 +157,20 @@ async function main(options) {
 			exit(1);
 		}
 
+		// check for continuous delivery instance in target region and resource group
+		const cdInstances = await getCdInstanceByRegion(bearer, accountId, targetRegion);
+		const cdInstanceFound = cdInstances?.some((instance) => {
+			return instance.doc?.resource_group_id === sourceToolchainData['resource_group_id'];
+		});
+
+		if (!cdInstanceFound) {
+			// give users the option to bypass
+			logger.warn(`Warning! Could not find a Continuous Delivery instance in the target region ${targetRegion} and toolchain's resource group or you do not have permission to view, please create one before proceeding if one does not exist already.`, LOG_STAGES.setup);
+			await promptUserConfirmation(`Do you want to proceed anyway?`, 'yes', 'Toolchain migration cancelled.');
+		}
+
 		const resourceGroups = await getResourceGroups(bearer, accountId, [targetRg || sourceToolchainData['resource_group_id']]);
-		({ id: targetRgId, name: targetRgName } = resourceGroups[0])
+		({ id: targetRgId, name: targetRgName } = resourceGroups[0]);
 		// reuse name if not provided
 		if (!targetToolchainName) targetToolchainName = sourceToolchainData['name'];
 		[targetToolchainName, targetTag] = await warnDuplicateName(bearer, accountId, targetToolchainName, sourceRegion, targetRegion, targetRgId, targetRgName, targetTag, skipUserConfirmation);

package/cmd/utils/import-terraform.js

@@ -253,8 +253,21 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
                     newTfFileObj['resource'][key][k]['value'] = `\${${toolIdMap[propValue].type}.${toolIdMap[propValue].name}.tool_id}`;
                 } else if (propValue) {
                     // escape newlines, double quotes and backslashes
-                    if (propValue.includes('\n')) logger.warn(`Warning! Multi-line values for pipeline and trigger properties are not yet supported in the provider, newlines will be replaced with '\\\\n': "${k}"`, LOG_STAGES.import, true);
-                    newTfFileObj['resource'][key][k]['value'] = propValue.replace(/\\/g, '\\\\').replace(/\n/g, '\\n').replace(/\r/g, '\\r').replace(/"/g, '\\"');
+
+                    let newValue = propValue;
+
+                    const START_INDICATOR = '${jsonencode(';
+                    const END_INDICATOR = ')}';
+
+                    if (propValue.startsWith(START_INDICATOR) && propValue.endsWith(END_INDICATOR)) {
+                        // skip substitution for jsonencode case, don't want to mangle it
+                    } else {
+                        if (propValue.includes('\n')) logger.warn(`Warning! Multi-line values for pipeline and trigger properties are not yet supported in the provider, newlines will be replaced with '\\\\n': "${k}"`, LOG_STAGES.import, true);
+
+                        // TODO: remove extra backslash in newline replacement once provider is updated
+                        newValue = newValue.replace(/\\/g, '\\\\').replace(/\n/g, '\\\\n').replace(/\r/g, '\\\\r').replace(/"/g, '\\"');
+                    }
+                    newTfFileObj['resource'][key][k]['value'] = newValue;
                 }
             }
 

package/cmd/utils/requests.js

@@ -180,7 +180,7 @@ async function getCdInstanceByRegion(bearer, accountId, region) {
     const response = await axios(options);
     switch (response.status) {
         case 200:
-            return response.data.items.length > 0;
+            return response.data.items.length > 0 ? response.data.items : null;
         default:
             throw Error('Get CD instance failed');
     }

package/cmd/utils/terraform.js

@@ -341,8 +341,16 @@ async function setupTerraformFiles(config) {
                         newTfFileObj['resource']['ibm_cd_tekton_pipeline_property'][k]['value'] = `\${ibm_cd_toolchain_tool_githubconsolidated.${thisTfName}.tool_id}`;
                     } else if (thisValue) {
                         // escape newlines, double quotes and backslashes
-                        // TODO: remove extra backslash in newline replacement once provider is updated
-                        newTfFileObj['resource']['ibm_cd_tekton_pipeline_property'][k]['value'] = thisValue.replace(/\\/g, '\\\\').replace(/\n/g, '\\\\n').replace(/\r/g, '\\\\r').replace(/"/g, '\\"');
+
+                        const START_INDICATOR = '${jsonencode(';
+                        const END_INDICATOR = ')}';
+
+                        if (thisValue.startsWith(START_INDICATOR) && thisValue.endsWith(END_INDICATOR)) {
+                            // skip newline substitution for jsonencode case, don't want to mangle it
+                        } else {
+                            // TODO: remove extra backslash in newline replacement once provider is updated
+                            newTfFileObj['resource']['ibm_cd_tekton_pipeline_property'][k]['value'] = thisValue.replace(/\\/g, '\\\\').replace(/\n/g, '\\\\n').replace(/\r/g, '\\\\r').replace(/"/g, '\\"');
+                        }
                     }
                 }
                 catch {
@@ -363,8 +371,16 @@ async function setupTerraformFiles(config) {
                         newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger_property'][k]['value'] = `\${ibm_cd_toolchain_tool_githubconsolidated.${thisTfName}.tool_id}`;
                     } else if (thisValue) {
                         // escape newlines, double quotes and backslashes
-                        // TODO: remove extra backslash in newline replacement once provider is updated
-                        newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger_property'][k]['value'] = thisValue.replace(/\\/g, '\\\\').replace(/\n/g, '\\\\n').replace(/\r/g, '\\\\r').replace(/"/g, '\\"');
+
+                        const START_INDICATOR = '${jsonencode(';
+                        const END_INDICATOR = ')}';
+
+                        if (thisValue.startsWith(START_INDICATOR) && thisValue.endsWith(END_INDICATOR)) {
+                            // skip newline substitution for jsonencode case, don't want to mangle it
+                        } else {
+                            // TODO: remove extra backslash in newline replacement once provider is updated
+                            newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger_property'][k]['value'] = thisValue.replace(/\\/g, '\\\\').replace(/\n/g, '\\\\n').replace(/\r/g, '\\\\r').replace(/"/g, '\\"');
+                        }
                     }
                 }
                 catch {

package/package.json

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

package/test/copy-toolchain/functionalities.test.js

@@ -168,7 +168,30 @@ describe('copy-toolchain: Test functionalities', function () {
                     'Only \'yes\' will be accepted to proceed. (Ctrl-C to abort)': 'yes'
                 },
             }
-        }
+        },
+        {
+            name: 'Handles special characters in names',
+            cmd: [CLI_PATH, COMMAND, '-c', TEST_TOOLCHAINS['special-chars'].crn, '-r', TEST_TOOLCHAINS['special-chars'].region, '-D', '-f'],
+            expected: null,
+            options: {
+                timeout: 100000,
+                cwd: TEMP_DIR + '/' + 'special-chars'
+            },
+            assertionFunc: () => {
+                assert.isTrue(
+                    areFilesInDir(TEMP_DIR + '/' + 'special-chars', [
+                        'cd_tekton_pipeline.tf',
+                        'cd_tekton_pipeline_definition.tf',
+                        'cd_tekton_pipeline_property.tf',
+                        'cd_tekton_pipeline_trigger.tf',
+                        'cd_tekton_pipeline_trigger_property.tf',
+                        'cd_toolchain.tf',
+                        'cd_toolchain_tool_hostedgit.tf',
+                        'cd_toolchain_tool_pipeline.tf',
+                    ])
+                );
+            }
+        },
     ];
 
     for (const { name, cmd, expected, options, assertionFunc } of testCases) {

package/test/data/test-toolchains.js

@@ -1,6 +1,6 @@
 /**
  * Licensed Materials - Property of IBM
- * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ * (c) Copyright IBM Corporation 2025, 2026. All Rights Reserved.
  *
  * Note to U.S. Government Users Restricted Rights:
  * Use, duplication or disclosure restricted by GSA ADP Schedule
@@ -52,6 +52,11 @@ export const TEST_TOOLCHAINS = {
         name: 'KEEP-SINGLE-PIPELINE-TOOLCHAIN',
         crn: 'crn:v1:bluemix:public:toolchain:us-east:a/9e8559fac61ee9fc74d3e595fa75d147:5ef88780-1e0f-4cda-94c7-f78909cc1140::',
         region: 'us-east'
+    },
+    'special-chars': {
+        name: 'KEEP-SPECIAL-CHARS-_ .TOOLCHAIN',
+        crn: 'crn:v1:bluemix:public:toolchain:ca-tor:a/9e8559fac61ee9fc74d3e595fa75d147:bda05ed4-7092-4c7c-970a-7be53f1c1796::',
+        region: 'ca-tor'
     }
 };