@ibm-cloud/cd-tools 1.15.2 → 1.15.4

package/cmd/utils/import-terraform.js

@@ -15,7 +15,7 @@ import { jsonToTf } from 'json-to-tf';
 import { getPipelineData, getToolchainTools } from './requests.js';
 import { runTerraformPlanGenerate, setTerraformEnv } from './terraform.js';
 import { getRandChars, isSecretReference, normalizeName } from './utils.js';
-import { logger } from './logger.js';
+import { LOG_STAGES, logger } from './logger.js';
 
 import { SECRET_KEYS_MAP, SUPPORTED_TOOLS_MAP } from '../../config.js';
 
@@ -160,9 +160,24 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
 
     // STEP 2/2: run terraform import and post-processing
     setTerraformEnv(apiKey, verbosity);
-    await runTerraformPlanGenerate(dir, 'generated/draft.tf').catch((err) => { DEBUG_MODE && logger.dump(`\n[DEBUG_MODE=true] Draft errors: ${err}`) }); // temp fix for errors before post-processing
 
-    const generatedFile = fs.readFileSync(`${dir}/generated/draft.tf`);
+    let draftErrors = '';
+    await runTerraformPlanGenerate(dir, 'generated/draft.tf').catch((err) => {
+        if (DEBUG_MODE) logger.dump(`\n[DEBUG_MODE=true] Draft errors: ${err}`);
+        draftErrors = err;
+    });
+    // above is a temp fix for errors before post-processing
+    // empty pipeline_id and trigger_id are expected and is a known provider bug
+
+    let generatedFile = '';
+    try {
+        generatedFile = fs.readFileSync(`${dir}/generated/draft.tf`);
+    } catch (err) {
+        // if draft file is missing, then something went wrong
+        // also, no need to log draft errors twice
+        throw new Error(err + (!DEBUG_MODE ? ('\nDraft errors: ' + draftErrors) : '\nDraft errors already logged'));
+    }
+
     const generatedFileJson = await tfToJson('draft.tf', generatedFile.toString());
 
     const newTfFileObj = { 'resource': {} }
@@ -236,6 +251,10 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
                 const propValue = newTfFileObj['resource'][key][k]['value'];
                 if (newTfFileObj['resource'][key][k]['type'] === 'integration' && propValue in toolIdMap) {
                     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, '\\"');
                 }
             }
 

package/cmd/utils/terraform.js

@@ -334,13 +334,15 @@ async function setupTerraformFiles(config) {
         if (isCompact || resourceName === 'ibm_cd_tekton_pipeline_property') {
             for (const [k, v] of Object.entries(newTfFileObj['resource']['ibm_cd_tekton_pipeline_property'])) {
                 try {
-                    if (v['type'] === 'integration') {
-                        const thisValue = v['value'];
-
-                        if (thisValue in toolIdToTfName) {
-                            const thisTfName = toolIdToTfName[thisValue];
-                            newTfFileObj['resource']['ibm_cd_tekton_pipeline_property'][k]['value'] = `\${ibm_cd_toolchain_tool_githubconsolidated.${thisTfName}.tool_id}`;
-                        }
+                    const thisValue = v['value'];
+
+                    if (v['type'] === 'integration' && thisValue in toolIdToTfName) {
+                        const thisTfName = toolIdToTfName[thisValue];
+                        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, '\\"');
                     }
                 }
                 catch {
@@ -354,13 +356,15 @@ async function setupTerraformFiles(config) {
         if (isCompact || resourceName === 'ibm_cd_tekton_pipeline_trigger_property') {
             for (const [k, v] of Object.entries(newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger_property'])) {
                 try {
-                    if (v['type'] === 'integration') {
-                        const thisValue = v['value'];
-
-                        if (thisValue in toolIdToTfName) {
-                            const thisTfName = toolIdToTfName[thisValue];
-                            newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger_property'][k]['value'] = `\${ibm_cd_toolchain_tool_githubconsolidated.${thisTfName}.tool_id}`;
-                        }
+                    const thisValue = v['value'];
+
+                    if (v['type'] === 'integration' && thisValue in toolIdToTfName) {
+                        const thisTfName = toolIdToTfName[thisValue];
+                        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, '\\"');
                     }
                 }
                 catch {

package/package.json

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