@ibm-cloud/cd-tools 1.15.8 → 1.15.10

package/cmd/copy-toolchain.js

@@ -368,7 +368,7 @@ async function main(options) {
 
 			if (verbosity >= 1) logger.print(''); // newline for spacing
 			logger.info(`Toolchain "${sourceToolchainData['name']}" from ${sourceRegion} was cloned to "${targetToolchainName ?? sourceToolchainData['name']}" in ${targetRegion} ${applyErrors ? 'with some errors' : 'successfully'}, with ${numResourcesCreated} / ${numResourcesPlanned} resources created!`, LOG_STAGES.info, true);
-			if (hasS2SFailures) logger.warn(`One or more service-to-service auth policies could not be created, see ${outputDir}/.s2s-script-failures-${TIME_SUFFIX} for more details.`, '', true);
+			if (hasS2SFailures) logger.warn(`Warning! One or more service-to-service auth policies could not be created, see ${outputDir}/.s2s-script-failures-${TIME_SUFFIX} for more details.`, LOG_STAGES.info, true);
 			if (newTcId) logger.info(`Cloned toolchain: https://${CLOUD_PLATFORM}/devops/toolchains/${newTcId}?env_id=ibm:yp:${targetRegion}`, LOG_STAGES.info, true);
 		} else {
 			logger.info(`DRY_RUN: ${dryRun}, skipping terraform apply...`, LOG_STAGES.tf);

package/cmd/utils/import-terraform.js

@@ -167,7 +167,7 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
         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
+    // "Insufficient initialization blocks" error is expected
 
     let generatedFile = '';
     try {
@@ -186,7 +186,7 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
         for (const [k, v] of Object.entries(value)) {
             newTfFileObj['resource'][key] = { ...(newTfFileObj['resource'][key] ?? []), [k]: v[0] };
 
-            // remove empty tool, which breaks jsonToTf
+            // remove empty tool (if it exists), which breaks jsonToTf
             try {
                 if (Object.keys(newTfFileObj['resource'][key][k]['source'][0]['properties'][0]['tool'][0]).length < 1) {
                     delete newTfFileObj['resource'][key][k]['source'][0]['properties'][0]['tool'];
@@ -195,7 +195,7 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
                 // do nothing
             }
 
-            // handle missing worker, which breaks terraform
+            // handle missing worker (if it exists), which breaks terraform
             try {
                 if (newTfFileObj['resource'][key][k]['worker'][0]['id'] === null) {
                     delete newTfFileObj['resource'][key][k]['worker'];
@@ -209,7 +209,7 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
                 if (v2 === null) delete newTfFileObj['resource'][key][k][k2];
             }
 
-            // ignore null values in parameters
+            // ignore null values (if it exists) in parameters
             try {
                 if (Object.keys(v[0]['parameters'][0]).length > 0) {
                     for (const [k2, v2] of Object.entries(v[0]['parameters'][0])) {
@@ -220,7 +220,7 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
                 // do nothing
             }
 
-            // ignore null values in source properties
+            // ignore null values (if it exists) in source properties
             try {
                 if (Object.keys(v[0]['source'][0]['properties'][0]).length > 0) {
                     for (const [k2, v2] of Object.entries(v[0]['source'][0]['properties'][0])) {
@@ -262,10 +262,7 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
                     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, '\\"');
+                        newValue = newValue.replace(/\\/g, '\\\\').replace(/\n/g, '\\n').replace(/\r/g, '\\r').replace(/"/g, '\\"');
                     }
                     newTfFileObj['resource'][key][k]['value'] = newValue;
                 }
@@ -314,16 +311,19 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
 
     // add repo url depends_on on second pass
     for (const [key, value] of Object.entries(generatedFileJson['resource'])) {
-        for (const [k, _] of Object.entries(value)) {
+        for (const [k, v] of Object.entries(value)) {
             if (key === 'ibm_cd_tekton_pipeline_definition' || key === 'ibm_cd_tekton_pipeline_trigger') {
+                if (key === 'ibm_cd_tekton_pipeline_trigger' && !v['source']) continue; // skip triggers without source, which aren't tied to a repo
                 try {
                     const thisUrl = newTfFileObj['resource'][key][k]['source'][0]['properties'][0]['url'];
 
                     if (thisUrl in repoUrlMap) {
                         newTfFileObj['resource'][key][k]['depends_on'] = [`\${${repoUrlMap[thisUrl].type}.${repoUrlMap[thisUrl].name}}`];
+                    } else {
+                        newTfFileObj['resource'][key][k]['depends_on'] = []; // we will look for and remove these in terraform.js
                     }
-                } catch {
-                    // do nothing
+                } catch (err) {
+                    logger.dump(`\n[Warning] Could not add repo URL depends_on for resource "${k}": ${err.message}`);
                 }
             }
         }

package/cmd/utils/logger.js

@@ -62,7 +62,12 @@ class Logger {
         const level = LEVELS[type] || LEVELS.log;
         const formatted = (prefix ? this.#getFullPrefix(prefix) + ' ' : '') + `${level.color}${msg}${COLORS.reset}`;
         console[level.method](formatted);
-        this.logStream?.write(stripAnsi((prefix ? this.#getFullPrefix(prefix) + ' ' : '') + `[${type.toUpperCase()}] ` + msg) + '\n');
+        if (type === 'info') {
+            // leave out [INFO] type prefix in log file
+            this.logStream?.write(stripAnsi((prefix ? this.#getFullPrefix(prefix) + ' ' : '') + msg) + '\n');
+        } else {
+            this.logStream?.write(stripAnsi((prefix ? this.#getFullPrefix(prefix) + ' ' : '') + `[${type.toUpperCase()}] ` + msg) + '\n');
+        }
     }
 
     info(msg, prefix = '', force = false) { if (this.verbosity >= 1 || force) this.#baseLog('info', msg, prefix); }

package/cmd/utils/terraform.js

@@ -179,8 +179,8 @@ async function setupTerraformFiles(config) {
                     try {
                         newTfFileObj['resource']['ibm_cd_toolchain_tool_hostedgit'][k]['parameters'][0]['auth_type'] = 'oauth';
                         delete newTfFileObj['resource']['ibm_cd_toolchain_tool_hostedgit'][k]['parameters'][0]['api_token'];
-                    } catch {
-                        // do nothing
+                    } catch (err) {
+                        logger.dump(`\n[Warning] Could not convert auth_type for hostedgit tool "${k}": ${err.message}`);
                     }
 
                     try {
@@ -263,20 +263,24 @@ async function setupTerraformFiles(config) {
                 }
             }
 
-            // set depends_on for references to legacy GHE integrations
-            if (hasGHE && newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger']) {
+            // set depends_on for references
+            if (newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger']) {
                 for (const [k, v] of Object.entries(newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger'])) {
+                    if (!v['source']) continue; // skip triggers without source, which aren't tied to a repo
                     try {
                         const thisUrl = v['source'][0]['properties'][0]['url'];
-                        if (!v['depends_on'] && thisUrl && repoToTfName[thisUrl]) {
-                            newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger'][k]['depends_on'] = [`ibm_cd_toolchain_tool_githubconsolidated.${repoToTfName[thisUrl]}`]
-                        } else if (!v['depends_on'] && thisUrl && !repoToTfName[thisUrl]) {
-                            // warn the user if the URL is not in the repoToTfName map
-                            logger.warn(`Warning! Could not find a matching tool integration for ${thisUrl}`, LOG_STAGES.terraform);
+                        if (v['depends_on']?.length === 0) {
+                            if (thisUrl && repoToTfName[thisUrl]) {
+                                newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger'][k]['depends_on'] = [`ibm_cd_toolchain_tool_githubconsolidated.${repoToTfName[thisUrl]}`]
+                            } else if (thisUrl && !repoToTfName[thisUrl]) {
+                                // warn the user if the URL is not in the repoToTfName map
+                                logger.warn(`Warning! Could not find a matching tool integration for ${thisUrl}`, LOG_STAGES.tf, true);
+                                logger.warn(` - for definition found in ${v['pipeline_id']?.slice(2, -9)}`, LOG_STAGES.tf, true); // slice out the terraform address
+                                delete newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger'][k]['depends_on'];
+                            }
                         }
-                    }
-                    catch {
-                        // do nothing
+                    } catch (err) {
+                        logger.dump(`\n[Warning] Could not set depends_on for tekton pipeline trigger "${k}": ${err.message}`);
                     }
                 }
             }
@@ -284,6 +288,7 @@ async function setupTerraformFiles(config) {
             // update GRIT urls
             if (newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger']) {
                 for (const [k, v] of Object.entries(newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger'])) {
+                    if (!v['source']) continue; // skip triggers without source, which aren't tied to a repo
                     try {
                         const thisUrl = v['source'][0]['properties'][0]['url'];
                         const newUrl = gritMapping[thisUrl];
@@ -291,29 +296,31 @@ async function setupTerraformFiles(config) {
                         if (newUrl) {
                             newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger'][k]['source'][0]['properties'][0]['url'] = newUrl;
                         }
-                    }
-                    catch {
-                        // do nothing
+                    } catch (err) {
+                        logger.dump(`\n[Warning] Could not update GRIT URL for tekton pipeline trigger "${k}": ${err.message}`);
                     }
                 }
             }
         }
 
         if (isCompact || resourceName === 'ibm_cd_tekton_pipeline_definition') {
-            // set depends_on for references to legacy GHE integrations
-            if (hasGHE && newTfFileObj['resource']['ibm_cd_tekton_pipeline_definition']) {
+            // set depends_on for references
+            if (newTfFileObj['resource']['ibm_cd_tekton_pipeline_definition']) {
                 for (const [k, v] of Object.entries(newTfFileObj['resource']['ibm_cd_tekton_pipeline_definition'])) {
                     try {
                         const thisUrl = v['source'][0]['properties'][0]['url'];
-                        if (!v['depends_on'] && thisUrl && repoToTfName[thisUrl]) {
-                            newTfFileObj['resource']['ibm_cd_tekton_pipeline_definition'][k]['depends_on'] = [`ibm_cd_toolchain_tool_githubconsolidated.${repoToTfName[thisUrl]}`]
-                        } else if (!v['depends_on'] && thisUrl && !repoToTfName[thisUrl]) {
-                            // warn the user if the URL is not in the repoToTfName map
-                            logger.warn(`Warning! Could not find a matching tool integration for ${thisUrl}`, LOG_STAGES.terraform);
+                        if (v['depends_on']?.length === 0) {
+                            if (thisUrl && repoToTfName[thisUrl]) {
+                                newTfFileObj['resource']['ibm_cd_tekton_pipeline_definition'][k]['depends_on'] = [`ibm_cd_toolchain_tool_githubconsolidated.${repoToTfName[thisUrl]}`]
+                            } else if (thisUrl && !repoToTfName[thisUrl]) {
+                                // warn the user if the URL is not in the repoToTfName map
+                                logger.warn(`Warning! Could not find a matching tool integration for ${thisUrl}`, LOG_STAGES.tf, true);
+                                logger.warn(` - for definition found in ${v['pipeline_id']?.slice(2, -9)}`, LOG_STAGES.tf, true); // slice out the terraform address
+                                delete newTfFileObj['resource']['ibm_cd_tekton_pipeline_definition'][k]['depends_on'];
+                            }
                         }
-                    }
-                    catch {
-                        // do nothing
+                    } catch (err) {
+                        logger.dump(`\n[Warning] Could not set depends_on for tekton pipeline definition "${k}": ${err.message}`);
                     }
                 }
             }
@@ -328,9 +335,8 @@ async function setupTerraformFiles(config) {
                         if (newUrl) {
                             newTfFileObj['resource']['ibm_cd_tekton_pipeline_definition'][k]['source'][0]['properties'][0]['url'] = newUrl;
                         }
-                    }
-                    catch {
-                        // do nothing
+                    } catch (err) {
+                        logger.dump(`\n[Warning] Could not update GRIT URL for tekton pipeline definition "${k}": ${err.message}`);
                     }
                 }
             }
@@ -354,13 +360,11 @@ async function setupTerraformFiles(config) {
                         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, '\\"');
+                            newTfFileObj['resource']['ibm_cd_tekton_pipeline_property'][k]['value'] = thisValue.replace(/\\/g, '\\\\').replace(/\n/g, '\\n').replace(/\r/g, '\\r').replace(/"/g, '\\"');
                         }
                     }
-                }
-                catch {
-                    // do nothing
+                } catch (err) {
+                    logger.dump(`\n[Warning] Could not process tekton pipeline property "${k}": ${err.message}`);
                 }
 
             }
@@ -384,13 +388,11 @@ async function setupTerraformFiles(config) {
                         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, '\\"');
+                            newTfFileObj['resource']['ibm_cd_tekton_pipeline_trigger_property'][k]['value'] = thisValue.replace(/\\/g, '\\\\').replace(/\n/g, '\\n').replace(/\r/g, '\\r').replace(/"/g, '\\"');
                         }
                     }
-                }
-                catch {
-                    // do nothing
+                } catch (err) {
+                    logger.dump(`\n[Warning] Could not process tekton pipeline trigger property "${k}": ${err.message}`);
                 }
 
             }
@@ -532,7 +534,8 @@ function replaceDependsOn(str) {
             // get rid of the quotes
             return str.replaceAll(pattern, (match, s) => `  depends_on = \[\n    ${s.slice(1, s.length - 1)}\n  ]`);
         }
-    } catch {
+    } catch (err) {
+        logger.dump(`\n[Warning] Could not replace depends_on in terraform string: ${err.message}`);
         return str;
     }
 }
@@ -555,7 +558,8 @@ function addS2sScriptToToolchainTf(str, timeSuffix) {
             // get rid of the quotes
             return str.replace(pattern, (match, s1, s2) => `resource "ibm_cd_toolchain" "${s1}" {\n${s2}${provisionerStr(s1)}\n}`);
         }
-    } catch {
+    } catch (err) {
+        logger.dump(`\n[Warning] Could not add S2S script to toolchain terraform: ${err.message}`);
         return str;
     }
 }

package/cmd/utils/utils.js

@@ -31,7 +31,7 @@ export async function promptUserYesNo(question) {
 
     const answer = await rl.question(fullPrompt);
 
-    logger.dump(fullPrompt + '\n' + answer + '\n');
+    logger.dump(fullPrompt + answer + '\n\n');
     rl.close();
 
     const normalized = answer.toLowerCase().trim();
@@ -56,7 +56,7 @@ export async function promptUserConfirmation(question, expectedAns, exitMsg) {
     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');
+    logger.dump(fullPrompt + answer + '\n\n');
 
     if (answer.toLowerCase().trim() !== expectedAns) {
         if (exitMsg) logger.print('\n' + exitMsg);
@@ -129,7 +129,7 @@ export async function promptUserSelection(question, choices) {
 
     while (true) {
         const answer = await rl.question(promptText);
-        logger.dump(promptText + '\n' + answer + '\n');
+        logger.dump(promptText + answer + '\n\n');
 
         index = parseInt(answer.trim(), 10) - 1;
 

package/cmd/utils/validate.js

@@ -104,7 +104,7 @@ 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(`\nWarning! A toolchain named "${tcName}" already exists in:\n - Region: ${targetRegion}\n - Resource Group: ${targetResourceGroupName} (${targetResourceGroupId})`, '', true);
+            logger.warn(`Warning! A toolchain named "${tcName}" already exists in:\n - Region: ${targetRegion}\n - Resource Group: ${targetResourceGroupName} (${targetResourceGroupId})`, LOG_STAGES.setup, true);
             logger.print(''); // newline for spacing
 
             if (!skipPrompt) {
@@ -113,7 +113,7 @@ async function warnDuplicateName(token, accountId, tcName, srcRegion, targetRegi
         } else {
             if (hasSameRegion) {
                 // soft warning of confusion
-                logger.warn(`\nWarning! A toolchain named "${tcName}" already exists in:\n - Region: ${targetRegion}`, '', true);
+                logger.warn(`Warning! A toolchain named "${tcName}" already exists in:\n - Region: ${targetRegion}`, LOG_STAGES.setup, true);
             }
         }
 

package/package.json

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

package/test/utils/testUtils.js

@@ -160,10 +160,10 @@ export async function deleteCreatedToolchains(toolchainsToDelete) {
 export async function assertExecError(fullCommand, expectedMessage, options, assertionFn) {
     try {
         const output = await execCommand(fullCommand, options);
-        logger.dump(output);
+        logger.dump(output + '\n');
         throw new Error('Expected command to fail but it succeeded');
     } catch (e) {
-        logger.dump(e.message);
+        logger.dump(e.message + '\n');
         if (assertionFn) {
             const res = assertionFn(e.message);
             if (res instanceof Promise) await res;
@@ -178,7 +178,7 @@ export async function assertExecError(fullCommand, expectedMessage, options, ass
 export async function assertPtyOutput(fullCommand, expectedMessage, options, assertionFn) {
     try {
         const output = await runPtyProcess(fullCommand, options);
-        logger.dump(output);
+        logger.dump(output + '\n');
         if (assertionFn) {
             const res = assertionFn(output);
             if (res instanceof Promise) await res;
@@ -189,7 +189,7 @@ export async function assertPtyOutput(fullCommand, expectedMessage, options, ass
         }
         return parseTcIdAndRegion(output);
     } catch (e) {
-        logger.dump(e.message);
+        logger.dump(e.message + '\n');
         throw (e);
     }
 }