@ibm-cloud/cd-tools 1.2.2 → 1.2.4

package/README.md

@@ -48,7 +48,7 @@ The tools are provided as an [npx](https://docs.npmjs.com/cli/commands/npx) comm
 
 ```shell-session
 $ npx @ibm-cloud/cd-tools
-Usage: npx @ibm-cloud/cd-tools [options] [command]
+Usage: @ibm-cloud/cd-tools [options] [command]
 
 Tools for migrating Toolchains, Delivery Pipelines, and Git Repos and Issue Tracking projects.
 

package/cmd/check-secrets.js

@@ -49,11 +49,15 @@ async function main(options) {
         for (let i = 0; i < getToolsRes.tools.length; i++) {
             const tool = getToolsRes.tools[i];
 
+            // Skip iff it's GitHub/GitLab/GRIT integration with OAuth
+            if (['githubconsolidated', 'github_integrated', 'gitlab', 'hostedgit'].includes(tool.tool_type_id) && (tool.parameters?.auth_type === '' || tool.parameters?.auth_type === 'oauth'))
+                continue;
+
             // Check tool integrations for any plain text secret values
             if (SECRET_KEYS_MAP[tool.tool_type_id]) {
                 SECRET_KEYS_MAP[tool.tool_type_id].forEach((entry) => {
                     const updateableSecretParam = entry.key;
-                    if (tool.parameters[updateableSecretParam] && !isSecretReference(tool.parameters[updateableSecretParam])) {
+                    if (tool.parameters[updateableSecretParam] && !isSecretReference(tool.parameters[updateableSecretParam]) && tool.parameters[updateableSecretParam].length > 0) {
                         toolResults.push({
                             'Tool ID': tool.id,
                             'Tool Type': tool.tool_type_id,
@@ -68,7 +72,7 @@ async function main(options) {
                 const pipelineData = await getPipelineData(token, tool.id, region);
 
                 pipelineData?.properties.forEach((prop) => {
-                    if (prop.type === 'secure' && !isSecretReference(prop.value)) {
+                    if (prop.type === 'secure' && !isSecretReference(prop.value) && prop.value.length > 0) {
                         pipelineResults.push({
                             'Pipeline ID': pipelineData.id,
                             'Trigger Name': '-',
@@ -79,7 +83,7 @@ async function main(options) {
 
                 pipelineData?.triggers.forEach((trigger) => {
                     trigger.properties?.forEach((prop) => {
-                        if (prop.type === 'secure' && !isSecretReference(prop.value)) {
+                        if (prop.type === 'secure' && !isSecretReference(prop.value) && prop.value.length > 0) {
                             pipelineResults.push({
                                 'Pipeline ID': pipelineData.id,
                                 'Trigger Name': trigger.name,

package/cmd/copy-toolchain.js

@@ -106,7 +106,7 @@ async function main(options) {
 
 		// check for existing .tf files in output directory
 		if (fs.existsSync(outputDir)) {
-			let files = readdirSync(outputDir, { recursive: true });
+			let files = fs.readdirSync(outputDir, { recursive: true });
 			files = files.filter((f) => f.endsWith('.tf'));
 			if (files.length > 0) throw Error(`Output directory already has ${files.length} '.tf' files, please specify a different output directory`);
 		}
@@ -237,7 +237,7 @@ async function main(options) {
 			}, 5000);
 
 			await initProviderFile(sourceRegion, TEMP_DIR);
-			await runTerraformInit(TEMP_DIR);
+			await runTerraformInit(TEMP_DIR, verbosity);
 
 			nonSecretRefs = await importTerraform(bearer, apiKey, sourceRegion, sourceToolchainId, targetToolchainName, policyIds, TEMP_DIR, isCompact, verbosity);
 		};
@@ -249,7 +249,8 @@ async function main(options) {
 			LOG_STAGES.import
 		);
 
-		if (nonSecretRefs.length > 0) logger.warn(`\nWarning! The following generated terraform resource contains a hashed secret, applying without changes may result in error(s):\n${nonSecretRefs.map((entry) => `- ${entry}\n`).join('')}`, '', true);
+		if (nonSecretRefs.length > 0) logger.warn(`\nWarning! The following generated terraform resource contains hashed secret(s) that cannot be migrated, applying without changes may result in error(s):`);
+		logger.table(nonSecretRefs);
 
 	} catch (err) {
 		if (err.message && err.stack) {
@@ -302,7 +303,8 @@ async function main(options) {
 				'Running terraform init...',
 				'Terraform successfully initialized',
 				LOG_STAGES.tf,
-				outputDir
+				outputDir,
+				verbosity
 			);
 
 			logger.info(`DRY_RUN: ${dryRun}, running terraform apply...`, LOG_STAGES.tf);

package/cmd/utils/import-terraform.js

@@ -70,8 +70,15 @@ export async function importTerraform(token, apiKey, region, toolchainId, toolch
                     if (isSecretReference(tool.parameters[key])) {
                         additionalProps[block.name].push({ param: tfKey, value: tool.parameters[key] });
                     } else {
-                        nonSecretRefs.push(block.name);
-                        if (required) additionalProps[block.name].push({ param: tfKey, value: `<${tfKey}>` });
+                        const newFileName = SUPPORTED_TOOLS_MAP[tool.tool_type_id].split('ibm_')[1];
+                        if (required) {
+                            nonSecretRefs.push({
+                            resource_name: block.name, 
+                            property_name: tfKey,
+                            file_name: isCompact ? 'resources.tf' : `${newFileName}.tf`
+                            });
+                            additionalProps[block.name].push({ param: tfKey, value: `<${tfKey}>` });
+                        }
                     }
                 });
             }

package/cmd/utils/requests.js

@@ -10,8 +10,11 @@
 import axios from 'axios';
 import axiosRetry from 'axios-retry';
 
+import mocks from '../../test/data/mocks.js'
 import { logger, LOG_STAGES } from './logger.js';
 
+const MOCK_ALL_REQUESTS = process.env.MOCK_ALL_REQUESTS === 'true' || 'false';
+
 axiosRetry(axios, {
     retries: 3,
     retryDelay: axiosRetry.exponentialDelay,
@@ -142,6 +145,10 @@ async function getToolchainsByName(bearer, accountId, toolchainName) {
 }
 
 async function getCdInstanceByRegion(bearer, accountId, region) {
+    if (MOCK_ALL_REQUESTS && process.env.MOCK_GET_CD_INSTANCE_BY_REGION_SCENARIO) {
+        return mocks.getCdInstanceByRegionResponses[process.env.MOCK_GET_CD_INSTANCE_BY_REGION_SCENARIO].data.items.length > 0;
+    }
+
     const apiBaseUrl = 'https://api.global-search-tagging.cloud.ibm.com/v3';
     const options = {
         url: apiBaseUrl + '/resources/search',
@@ -403,7 +410,7 @@ async function deleteToolchain(bearer, toolchainId, region) {
     };
     const response = await axios(options);
     switch (response.status) {
-        case 200:
+        case 204:
             return toolchainId;
         default:
             throw Error(response.statusText);

package/cmd/utils/terraform.js

@@ -15,7 +15,7 @@ import { parse as tfToJson } from '@cdktf/hcl2json'
 import { jsonToTf } from 'json-to-tf';
 
 import { validateToolchainId, validateGritUrl } from './validate.js';
-import { logger } from './logger.js';
+import { logger, LOG_STAGES } from './logger.js';
 import { getRandChars, promptUserInput, replaceUrlRegion } from './utils.js';
 
 // promisify
@@ -300,12 +300,16 @@ async function setupTerraformFiles({ token, srcRegion, targetRegion, targetTag,
     return Promise.all(promises);
 }
 
-async function runTerraformPlanGenerate(dir, fileName) {
-    return await execPromise(`terraform plan -generate-config-out="${fileName}"`, { cwd: dir });
+async function runTerraformInit(dir, verbosity) {
+    logger.log('Running command \'terraform init\'', LOG_STAGES.tf);
+    const out = await execPromise('terraform init', { cwd: dir });
+    if (verbosity >= 2) logger.print(out, '\n');
+    logger.log('Command \'terraform init\' completed', LOG_STAGES.tf);
+    return out;
 }
 
-async function runTerraformInit(dir) {
-    return await execPromise('terraform init', { cwd: dir });
+async function runTerraformPlanGenerate(dir, fileName) {
+    return await execPromise(`terraform plan -generate-config-out="${fileName}"`, { cwd: dir });
 }
 
 // primarily used to get number of resources to be used

package/cmd/utils/validate.js

@@ -11,7 +11,7 @@ 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, SECRET_KEYS_MAP } from '../../config.js';
 import { getToolchainsByName, getToolchainTools, getPipelineData, getAppConfigHealthcheck, getSecretsHealthcheck, getGitOAuth, getGritUserProject, getGritGroup, getGritGroupProject } from './requests.js';
-import { promptUserConfirmation, promptUserInput } from './utils.js';
+import { promptUserConfirmation, promptUserInput, isSecretReference } from './utils.js';
 
 
 function validatePrereqsVersions() {
@@ -146,7 +146,6 @@ async function validateTools(token, tcId, region, skipPrompt) {
     const toolsWithHashedParams = [];
     const patTools = [];
     const classicPipelines = [];
-    const secretPattern = /^hash:SHA3-512:[a-zA-Z0-9]{128}$/;
 
     for (const tool of allTools.tools) {
         const toolName = (tool.name || tool.parameters?.name || tool.parameters?.label || '').replace(/\s+/g, '+');
@@ -203,7 +202,7 @@ async function validateTools(token, tcId, region, skipPrompt) {
                 url: toolUrl
             });
         }
-        else if (['githubconsolidated', 'github_integrated', 'gitlab'].includes(tool.tool_type_id) && (tool.parameters?.auth_type === '' || tool.parameters?.auth_type === 'oauth')) {   // Skip secret check iff it's GitHub/GitLab integration with OAuth
+        else if (['githubconsolidated', 'github_integrated', 'gitlab', 'hostedgit'].includes(tool.tool_type_id) && (tool.parameters?.auth_type === '' || tool.parameters?.auth_type === 'oauth')) { // Skip secret check iff it's GitHub/GitLab/GRIT integration with OAuth
             continue;
         }
         else {
@@ -212,20 +211,23 @@ async function validateTools(token, tcId, region, skipPrompt) {
                 const pipelineData = await getPipelineData(token, tool.id, region);
 
                 pipelineData.properties.forEach((prop) => {
-                    if (prop.type === 'secure' && secretPattern.test(prop.value)) secrets.push(['properties', prop.name].join('.').replace(/\s+/g, '+'));
+                    if (prop.type === 'secure' && !isSecretReference(prop.value) && prop.value.length > 0)
+                        secrets.push(['properties', prop.name].join('.').replace(/\s+/g, '+'));
                 });
 
                 pipelineData.triggers.forEach((trigger) => {
-                    if ((trigger?.secret?.type === 'token_matches' || trigger?.secret?.type === 'digest_matches') && secretPattern.test(trigger.secret.value)) secrets.push([trigger.name, trigger.secret.key_name].join('.').replace(/\s+/g, '+'));
+                    if ((trigger?.secret?.type === 'token_matches' || trigger?.secret?.type === 'digest_matches') && !isSecretReference(trigger.secret.value) && trigger.secret.value.length > 0)
+                        secrets.push([trigger.name, trigger.secret.key_name].join('.').replace(/\s+/g, '+'));
                     trigger.properties.forEach((prop) => {
-                        if (prop.type === 'secure' && secretPattern.test(prop.value)) secrets.push([trigger.name, 'properties', prop.name].join('.').replace(/\s+/g, '+'));
+                        if (prop.type === 'secure' && !isSecretReference(prop.value) && prop.value.length > 0)
+                            secrets.push([trigger.name, 'properties', prop.name].join('.').replace(/\s+/g, '+'));
                     });
                 });
             }
             else {
                 const secretsToCheck = (SECRET_KEYS_MAP[tool.tool_type_id] || []).map((entry) => entry.key);    // 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);
+                    if (!isSecretReference(value) && value.length > 0 && secretsToCheck.includes(key)) secrets.push(key);
                 });
             }
             if (secrets.length > 0) {
@@ -260,7 +262,7 @@ async function validateTools(token, tcId, region, skipPrompt) {
     }
 
     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.warn('Warning! The following tools contain secrets that cannot be migrated, please use the \'check-secrets\' command to export the secrets: \n', LOG_STAGES.setup, true);
         logger.table(toolsWithHashedParams);
     }
 

package/config.js

@@ -126,90 +126,90 @@ Format:
 	{ 
 		key: str, // tool parameter key
 		tfKey?: str, // terraform-equivalent key
-		prereq?: { key: string, values: [string] }, // proceed only if tool parameter "prereq.key" is one of "values"
+		prereq?: { key: string, values: [string] }, // proceed only if tool parameter 'prereq.key' is one of 'values'
 		required?: bool // is this key required for terraform?
 	}
 	... which represents a secret/sensitive value
 */
 const SECRET_KEYS_MAP = {
-	"artifactory": [
-		{ key: "token", tfKey: "token" }
+	'artifactory': [
+		{ key: 'token', tfKey: 'token' }
 	],
-	"cloudobjectstorage": [
-		{ key: "cos_api_key", tfKey: "cos_api_key", prereq: { key: "auth_type", values: ["apikey"] } },
-		{ key: "hmac_access_key_id", tfKey: "hmac_access_key_id", prereq: { key: "auth_type", values: ["hmac"] } },
-		{ key: "hmac_secret_access_key", tfKey: "hmac_secret_access_key", prereq: { key: "auth_type", values: ["hmac"] } },
+	'cloudobjectstorage': [
+		{ key: 'cos_api_key', tfKey: 'cos_api_key', prereq: { key: 'auth_type', values: ['apikey'] } },
+		{ key: 'hmac_access_key_id', tfKey: 'hmac_access_key_id', prereq: { key: 'auth_type', values: ['hmac'] } },
+		{ key: 'hmac_secret_access_key', tfKey: 'hmac_secret_access_key', prereq: { key: 'auth_type', values: ['hmac'] } },
 	],
-	"github_integrated": [
-		{ key: "api_token" } // no terraform equivalent
+	'github_integrated': [
+		{ key: 'api_token' } // no terraform equivalent
 	],
-	"githubconsolidated": [
-		{ key: "api_token", tfKey: "api_token", prereq: { key: "auth_type", values: ["pat"] } },
+	'githubconsolidated': [
+		{ key: 'api_token', tfKey: 'api_token', prereq: { key: 'auth_type', values: ['pat'] } },
 	],
-	"gitlab": [
-		{ key: "api_token", tfKey: "api_token", prereq: { key: "auth_type", values: ["pat"] } },
+	'gitlab': [
+		{ key: 'api_token', tfKey: 'api_token', prereq: { key: 'auth_type', values: ['pat'] } },
 	],
-	"hashicorpvault": [
-		{ key: "token", tfKey: "token", prereq: { key: "authentication_method", values: ["github", "token"] } },
-		{ key: "role_id", tfKey: "role_id", prereq: { key: "authentication_method", values: ["approle"] } },
-		{ key: "secret_id", tfKey: "secret_id", prereq: { key: "authentication_method", values: ["approle"] } },
-		{ key: "password", tfKey: "password", prereq: { key: "authentication_method", values: ["userpass"] } },
+	'hashicorpvault': [
+		{ key: 'token', tfKey: 'token', prereq: { key: 'authentication_method', values: ['github', 'token'] } },
+		{ key: 'role_id', tfKey: 'role_id', prereq: { key: 'authentication_method', values: ['approle'] } },
+		{ key: 'secret_id', tfKey: 'secret_id', prereq: { key: 'authentication_method', values: ['approle'] } },
+		{ key: 'password', tfKey: 'password', prereq: { key: 'authentication_method', values: ['userpass'] } },
 	],
-	"hostedgit": [
-		{ key: "api_token", tfKey: "api_token", prereq: { key: "auth_type", values: ["pat"] } },
+	'hostedgit': [
+		{ key: 'api_token', tfKey: 'api_token', prereq: { key: 'auth_type', values: ['pat'] } },
 	],
-	"jenkins": [
-		{ key: "api_token", tfKey: "api_token" },
+	'jenkins': [
+		{ key: 'api_token', tfKey: 'api_token' },
 	],
-	"jira": [
-		{ key: "password", tfKey: "api_token" },
+	'jira': [
+		{ key: 'password', tfKey: 'api_token' },
 	],
-	"nexus": [
-		{ key: "token", tfKey: "token" },
+	'nexus': [
+		{ key: 'token', tfKey: 'token' },
 	],
-	"pagerduty": [
-		{ key: "service_key", tfKey: "service_key", required: true },
+	'pagerduty': [
+		{ key: 'service_key', tfKey: 'service_key', required: true },
 	],
-	"private_worker": [
-		{ key: "workerQueueCredentials", tfKey: "worker_queue_credentials", required: true },
+	'private_worker': [
+		{ key: 'workerQueueCredentials', tfKey: 'worker_queue_credentials', required: true },
 	],
-	"saucelabs": [
-		{ key: "key", tfKey: "access_key", required: true },
+	'saucelabs': [
+		{ key: 'key', tfKey: 'access_key', required: true },
 	],
-	"security_compliance": [
-		{ key: "scc_api_key", tfKey: "scc_api_key", prereq: { key: "use_profile_attachment", values: ["enabled"] } },
+	'security_compliance': [
+		{ key: 'scc_api_key', tfKey: 'scc_api_key', prereq: { key: 'use_profile_attachment', values: ['enabled'] } },
 	],
-	"slack": [
-		{ key: "api_token", tfKey: "webhook", required: true },
+	'slack': [
+		{ key: 'api_token', tfKey: 'webhook', required: true },
 	],
-	"sonarqube": [
-		{ key: "user_password", tfKey: "user_password" },
+	'sonarqube': [
+		{ key: 'user_password', tfKey: 'user_password' },
 	]
 };
 
 // maps tool parameter tool_type_id to terraform resource type
 const SUPPORTED_TOOLS_MAP = {
-	"appconfig": "ibm_cd_toolchain_tool_appconfig",
-	"artifactory": "ibm_cd_toolchain_tool_artifactory",
-	"bitbucketgit": "ibm_cd_toolchain_tool_bitbucketgit",
-	"private_worker": "ibm_cd_toolchain_tool_privateworker",
-	"draservicebroker": "ibm_cd_toolchain_tool_devopsinsights",
-	"eventnotifications": "ibm_cd_toolchain_tool_eventnotifications",
-	"hostedgit": "ibm_cd_toolchain_tool_hostedgit",
-	"githubconsolidated": "ibm_cd_toolchain_tool_githubconsolidated",
-	"gitlab": "ibm_cd_toolchain_tool_gitlab",
-	"hashicorpvault": "ibm_cd_toolchain_tool_hashicorpvault",
-	"jenkins": "ibm_cd_toolchain_tool_jenkins",
-	"jira": "ibm_cd_toolchain_tool_jira",
-	"keyprotect": "ibm_cd_toolchain_tool_keyprotect",
-	"nexus": "ibm_cd_toolchain_tool_nexus",
-	"customtool": "ibm_cd_toolchain_tool_custom",
-	"saucelabs": "ibm_cd_toolchain_tool_saucelabs",
-	"secretsmanager": "ibm_cd_toolchain_tool_secretsmanager",
-	"security_compliance": "ibm_cd_toolchain_tool_securitycompliance",
-	"slack": "ibm_cd_toolchain_tool_slack",
-	"sonarqube": "ibm_cd_toolchain_tool_sonarqube",
-	"pipeline": "ibm_cd_toolchain_tool_pipeline"
+	'appconfig': 'ibm_cd_toolchain_tool_appconfig',
+	'artifactory': 'ibm_cd_toolchain_tool_artifactory',
+	'bitbucketgit': 'ibm_cd_toolchain_tool_bitbucketgit',
+	'private_worker': 'ibm_cd_toolchain_tool_privateworker',
+	'draservicebroker': 'ibm_cd_toolchain_tool_devopsinsights',
+	'eventnotifications': 'ibm_cd_toolchain_tool_eventnotifications',
+	'hostedgit': 'ibm_cd_toolchain_tool_hostedgit',
+	'githubconsolidated': 'ibm_cd_toolchain_tool_githubconsolidated',
+	'gitlab': 'ibm_cd_toolchain_tool_gitlab',
+	'hashicorpvault': 'ibm_cd_toolchain_tool_hashicorpvault',
+	'jenkins': 'ibm_cd_toolchain_tool_jenkins',
+	'jira': 'ibm_cd_toolchain_tool_jira',
+	'keyprotect': 'ibm_cd_toolchain_tool_keyprotect',
+	'nexus': 'ibm_cd_toolchain_tool_nexus',
+	'customtool': 'ibm_cd_toolchain_tool_custom',
+	'saucelabs': 'ibm_cd_toolchain_tool_saucelabs',
+	'secretsmanager': 'ibm_cd_toolchain_tool_secretsmanager',
+	'security_compliance': 'ibm_cd_toolchain_tool_securitycompliance',
+	'slack': 'ibm_cd_toolchain_tool_slack',
+	'sonarqube': 'ibm_cd_toolchain_tool_sonarqube',
+	'pipeline': 'ibm_cd_toolchain_tool_pipeline'
 };
 
 const VAULT_REGEX = [

package/index.js

@@ -10,11 +10,12 @@
 
 import { program } from 'commander';
 import * as commands from './cmd/index.js'
+import packageJson from './package.json' with { type: "json" };
 
 program
-  .name('index.js')
+  .name(process.env.npm_package_name ?? 'index.js')
   .description('Tools and utilities for the IBM Cloud Continuous Delivery service and resources.')
-  .version('0.0.1')
+  .version(packageJson.version)
   .showHelpAfterError();
 
 for (let i in commands) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibm-cloud/cd-tools",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Tools and utilities for the IBM Cloud Continuous Delivery service and resources",
   "repository": {
     "type": "git",
@@ -15,7 +15,7 @@
   "author": "IBM Corp.",
   "license": "Apache-2.0",
   "scripts": {
-    "test": "mocha --require \"test/setup.js\" \"test/copy-toolchain/*.test.js\""
+    "test": "mocha --require \"test/setup.js\" --retries 3 --parallel \"test/copy-toolchain/*.test.js\""
   },
   "dependencies": {
     "@cdktf/hcl2json": "^0.21.0",

package/test/README.md

@@ -30,11 +30,12 @@ Before running tests, ensure that you have completed the setup steps in the main
 ### Test Configuration
 You can customize the behavior of the tests by defining configuration properties in the `test/config/local.json` file.
 
-| Property           | Type      | Default      | Description                                                                                                                  |
-| ------------------ | --------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------- |
-| `TEST_DEBUG_MODE`  | `boolean` | `false`      | When set to `true`, files generated by test cases in `TEST_TEMP_DIR` and log files generated in `TEST_LOG_DIR` are preserved |
-| `TEST_TEMP_DIR`    | `string`  | `test/.tmp`  | The directory to store temporary files generated by test cases                                                               |
-| `TEST_LOG_DIR`     | `string`  | `test/.logs` | The directory to store test run log files                                                                                    |
-| `IBMCLOUD_API_KEY` | `string`  | `null`       | The IBM Cloud API Key used to run the tests                                                                                  |
-| `LOG_DUMP`         | `boolean` | `false`      | When set to `true`, individual test case's process's log file generation is enabled                                          |
-| `DISABLE_SPINNER`  | `boolean` | `true`       | When set to `true`, visual spinner is disabled across all test cases' processes                                              |
+| Property           | Type      | Default           | Description                                                                                                                  |
+| ------------------ | --------- | ------------------| ---------------------------------------------------------------------------------------------------------------------------- |
+| `TEST_DEBUG_MODE`  | `boolean` | `false`           | When set to `true`, files generated by test cases in `TEST_TEMP_DIR` and log files generated in `TEST_LOG_DIR` are preserved |
+| `TEST_TEMP_DIR`    | `string`  | `test/.tmp`       | The directory to store temporary files generated by test cases                                                               |
+| `TEST_LOG_DIR`     | `string`  | `test/.test-logs` | The directory to store test run log files                                                                                    |
+| `IBMCLOUD_API_KEY` | `string`  | `null`            | The IBM Cloud API Key used to run the tests                                                                                  |
+| `LOG_DUMP`         | `boolean` | `false`           | When set to `true`, individual test case's process's log file generation is enabled                                          |
+| `DISABLE_SPINNER`  | `boolean` | `true`            | When set to `true`, visual spinner is disabled across all test cases' processes                                              |
+| `VERBOSE_MODE`     | `boolean` | `false`           |  When set to `true`, each test case's log output increases                                                                   |

package/test/config/local.template.json

@@ -4,5 +4,6 @@
     "TEST_LOG_DIR": "test/.logs",
     "IBMCLOUD_API_KEY": "<YOUR IBMCLOUD API KEY>",
     "LOG_DUMP": true,
-    "DISABLE_SPINNER": true
+    "DISABLE_SPINNER": true,
+    "VERBOSE_MODE": false
 }