@ibm-cloud/cd-tools 1.5.2 → 1.6.0

package/cmd/utils/requests.js

@@ -13,6 +13,16 @@ import axiosRetry from 'axios-retry';
 import mocks from '../../test/data/mocks.js'
 import { logger, LOG_STAGES } from './logger.js';
 
+const CLOUD_PLATFORM = process.env['IBMCLOUD_PLATFORM_DOMAIN'] || 'cloud.ibm.com';
+const DEV_MODE = CLOUD_PLATFORM !== 'cloud.ibm.com';
+const IAM_BASE_URL = DEV_MODE ? process.env['IBMCLOUD_IAM_API_ENDPOINT'] : 'https://iam.cloud.ibm.com';
+const GHOST_BASE_URL = DEV_MODE ? process.env['IBMCLOUD_GS_API_ENDPOINT'] : 'https://api.global-search-tagging.cloud.ibm.com';
+const DEVOPS_BASE_URL = DEV_MODE ? process.env['IBMCLOUD_DEVOPS_URL'] : 'https://cloud.ibm.com/devops';
+const TOOLCHAIN_BASE_ENDPOINT = DEV_MODE ? process.env['IBMCLOUD_TOOLCHAIN_ENDPOINT'] : '';
+const PIPELINE_BASE_ENDPOINT = DEV_MODE ? process.env['IBMCLOUD_TEKTON_PIPELINE_ENDPOINT'] : '';
+const GIT_BASE_ENDPOINT = DEV_MODE ? process.env['IBMCLOUD_GIT_ENDPOINT'] : '';
+const OTC_BASE_ENDPOINT = DEV_MODE ? process.env['IBMCLOUD_OTC_ENDPOINT'] : '';
+
 const MOCK_ALL_REQUESTS = process.env.MOCK_ALL_REQUESTS === 'true' || 'false';
 
 axiosRetry(axios, {
@@ -23,13 +33,15 @@ axiosRetry(axios, {
     },
 });
 
+axios.defaults.timeout = 10000;     // 10 seconds
+
 axios.interceptors.request.use(request => {
-    logger.debug(`${request.method.toUpperCase()} ${request.url}`, LOG_STAGES.setup);
+    logger.debug(`${request.method.toUpperCase()} ${request.url}`, LOG_STAGES.request);
     if (request.data) {
         const body = typeof request.data === 'string'
             ? request.data
             : JSON.stringify(request.data);
-        logger.log(`Https Request body: ${body}`, LOG_STAGES.setup);
+        logger.log(`Https Request body: ${body}`, LOG_STAGES.request);
     }
     return request;
 });
@@ -41,21 +53,21 @@ axios.interceptors.response.use(response => {
             : JSON.stringify(response.data);
         if (response.data.access_token)   // Redact user access token in logs
             body = body.replaceAll(response.data.access_token, '<USER ACCESS TOKEN>');
-        logger.log(`Https Response body: ${body}`, LOG_STAGES.setup);
+        logger.log(`Https Response body: ${body}`, LOG_STAGES.request);
     }
     return response;
 }, error => {
     if (error.response) {
-        logger.log(`Error response status: ${error.response.status} ${error.response.statusText}`);
-        logger.log(`Error response body: ${JSON.stringify(error.response.data)}`);
+        logger.log(`Error response status: ${error.response.status} ${error.response.statusText}`, LOG_STAGES.request);
+        logger.log(`Error response body: ${JSON.stringify(error.response.data)}`, LOG_STAGES.request);
     } else {
-        logger.log(`Error message: ${error.message}`);
+        logger.log(`Error message: ${error.message}`, LOG_STAGES.request);
     }
     return Promise.reject(error);
 });
 
 async function getBearerToken(apiKey) {
-    const iamUrl = 'https://iam.cloud.ibm.com/identity/token';
+    const iamUrl = IAM_BASE_URL + '/identity/token';
     const params = new URLSearchParams();
     params.append('grant_type', 'urn:ibm:params:oauth:grant-type:apikey');
     params.append('apikey', apiKey);
@@ -78,7 +90,7 @@ async function getBearerToken(apiKey) {
 }
 
 async function getAccountId(bearer, apiKey) {
-    const iamUrl = 'https://iam.cloud.ibm.com/v1/apikeys/details';
+    const iamUrl = IAM_BASE_URL + '/v1/apikeys/details';
     const options = {
         method: 'GET',
         url: iamUrl,
@@ -97,7 +109,7 @@ async function getAccountId(bearer, apiKey) {
 }
 
 async function getToolchain(bearer, toolchainId, region) {
-    const apiBaseUrl = `https://api.${region}.devops.cloud.ibm.com/toolchain/v2`;
+    const apiBaseUrl = TOOLCHAIN_BASE_ENDPOINT || `https://api.${region}.devops.cloud.ibm.com/toolchain/v2`;
     const options = {
         method: 'GET',
         url: `${apiBaseUrl}/toolchains/${toolchainId}`,
@@ -120,9 +132,8 @@ async function getToolchain(bearer, toolchainId, region) {
 }
 
 async function getToolchainsByName(bearer, accountId, toolchainName) {
-    const apiBaseUrl = 'https://api.global-search-tagging.cloud.ibm.com/v3';
     const options = {
-        url: apiBaseUrl + '/resources/search',
+        url: GHOST_BASE_URL + '/v3/resources/search',
         method: 'POST',
         headers: {
             'Authorization': `Bearer ${bearer}`,
@@ -149,9 +160,8 @@ async function getCdInstanceByRegion(bearer, accountId, region) {
         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',
+        url: GHOST_BASE_URL + '/v3/resources/search',
         method: 'POST',
         headers: {
             'Authorization': `Bearer ${bearer}`,
@@ -174,7 +184,7 @@ async function getCdInstanceByRegion(bearer, accountId, region) {
 }
 
 async function getToolchainTools(bearer, toolchainId, region) {
-    const apiBaseUrl = `https://api.${region}.devops.cloud.ibm.com/toolchain/v2`;
+    const apiBaseUrl = TOOLCHAIN_BASE_ENDPOINT || `https://api.${region}.devops.cloud.ibm.com/toolchain/v2`;
     const options = {
         method: 'GET',
         url: `${apiBaseUrl}/toolchains/${toolchainId}/tools`,
@@ -196,7 +206,7 @@ async function getToolchainTools(bearer, toolchainId, region) {
 }
 
 async function getPipelineData(bearer, pipelineId, region) {
-    const apiBaseUrl = `https://api.${region}.devops.cloud.ibm.com/pipeline/v2`;
+    const apiBaseUrl = PIPELINE_BASE_ENDPOINT || `https://api.${region}.devops.cloud.ibm.com/pipeline/v2`;
     const options = {
         method: 'GET',
         url: `${apiBaseUrl}/tekton_pipelines/${pipelineId}`,
@@ -216,18 +226,17 @@ async function getPipelineData(bearer, pipelineId, region) {
     }
 }
 
-// takes in resource group ID or name
-async function getResourceGroupIdAndName(bearer, accountId, resourceGroup) {
-    const apiBaseUrl = 'https://api.global-search-tagging.cloud.ibm.com/v3';
+// takes in list of resource group IDs or names
+async function getResourceGroups(bearer, accountId, resourceGroups) {
     const options = {
-        url: apiBaseUrl + '/resources/search',
+        url: GHOST_BASE_URL + '/v3/resources/search',
         method: 'POST',
         headers: {
             'Authorization': `Bearer ${bearer}`,
             'Content-Type': 'application/json',
         },
         data: {
-            'query': `type:resource-group AND (name:${resourceGroup} OR doc.id:${resourceGroup}) AND doc.state:ACTIVE`,
+            'query': `type:resource-group AND doc.state:ACTIVE AND (${resourceGroups.map(rg => `name:${rg} OR doc.id:${rg}`).join(' OR ')})`,
             'fields': ['doc.id', 'doc.name']
         },
         params: { account_id: accountId },
@@ -236,17 +245,16 @@ async function getResourceGroupIdAndName(bearer, accountId, resourceGroup) {
     const response = await axios(options);
     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 { id: response.data.items[0].doc.id, name: response.data.items[0].doc.name };
+            if (response.data.items.length === 0) throw Error('No matching resource groups were found for the provided id(s) or name(s)');
+            return response.data.items.map(item => { return { id: item.doc.id, name: item.doc.name } });
         default:
-            throw Error('The resource group with provided ID or name was not found or is not accessible');
+            throw Error('No matching resource groups were found for the provided id(s) or name(s)');
     }
 }
 
 async function getAppConfigHealthcheck(bearer, tcId, toolId, region) {
-    const apiBaseUrl = 'https://cloud.ibm.com/devops/api/v1';
     const options = {
-        url: apiBaseUrl + '/appconfig/healthcheck',
+        url: DEVOPS_BASE_URL + '/api/v1/appconfig/healthcheck',
         method: 'GET',
         headers: {
             'Authorization': `Bearer ${bearer}`,
@@ -265,9 +273,8 @@ async function getAppConfigHealthcheck(bearer, tcId, toolId, region) {
 }
 
 async function getSecretsHealthcheck(bearer, tcId, toolName, region) {
-    const apiBaseUrl = 'https://cloud.ibm.com/devops/api/v1';
     const options = {
-        url: apiBaseUrl + '/secrets/healthcheck',
+        url: DEVOPS_BASE_URL + '/api/v1/secrets/healthcheck',
         method: 'GET',
         headers: {
             'Authorization': `Bearer ${bearer}`,
@@ -286,15 +293,14 @@ async function getSecretsHealthcheck(bearer, tcId, toolName, region) {
 }
 
 async function getGitOAuth(bearer, targetRegion, gitId) {
-    const url = 'https://cloud.ibm.com/devops/git/api/v1/tokens';
     const options = {
-        url: url,
+        url: DEVOPS_BASE_URL + '/git/api/v1/tokens',
         method: 'GET',
         headers: {
             'Authorization': `Bearer ${bearer}`,
             'Content-Type': 'application/json',
         },
-        params: { env_id: `ibm:yp:${targetRegion}`, git_id: gitId, console_url: 'https://cloud.ibm.com', return_uri: `https://cloud.ibm.com/devops/git/static/github_return.html` },
+        params: { env_id: `ibm:yp:${targetRegion}`, git_id: gitId, console_url: `https://${CLOUD_PLATFORM}`, return_uri: `https://${CLOUD_PLATFORM}/devops/git/static/github_return.html` },
         validateStatus: () => true
     };
     const response = await axios(options);
@@ -309,9 +315,9 @@ async function getGitOAuth(bearer, targetRegion, gitId) {
 }
 
 async function getGritUserProject(privToken, region, user, projectName) {
-    const url = `https://${region}.git.cloud.ibm.com/api/v4/users/${user}/projects`
+    const apiBaseUrl = GIT_BASE_ENDPOINT || `https://${region}.git.cloud.ibm.com/api/v4`;
     const options = {
-        url: url,
+        url: apiBaseUrl + `/users/${user}/projects`,
         method: 'GET',
         headers: {
             'PRIVATE-TOKEN': privToken
@@ -331,9 +337,9 @@ async function getGritUserProject(privToken, region, user, projectName) {
 }
 
 async function getGritGroup(privToken, region, groupName) {
-    const url = `https://${region}.git.cloud.ibm.com/api/v4/groups/${groupName}`
+    const apiBaseUrl = GIT_BASE_ENDPOINT || `https://${region}.git.cloud.ibm.com/api/v4`;
     const options = {
-        url: url,
+        url: apiBaseUrl + `/groups/${groupName}`,
         method: 'GET',
         headers: {
             'PRIVATE-TOKEN': privToken
@@ -352,9 +358,9 @@ async function getGritGroup(privToken, region, groupName) {
 }
 
 async function getGritGroupProject(privToken, region, groupId, projectName) {
-    const url = `https://${region}.git.cloud.ibm.com/api/v4/groups/${groupId}/projects`
+    const apiBaseUrl = GIT_BASE_ENDPOINT || `https://${region}.git.cloud.ibm.com/api/v4`;
     const options = {
-        url: url,
+        url: apiBaseUrl + `/groups/${groupId}/projects`,
         method: 'GET',
         headers: {
             'PRIVATE-TOKEN': privToken
@@ -374,7 +380,7 @@ async function getGritGroupProject(privToken, region, groupId, projectName) {
 }
 
 async function deleteToolchain(bearer, toolchainId, region) {
-    const apiBaseUrl = `https://api.${region}.devops.cloud.ibm.com/toolchain/v2`;
+    const apiBaseUrl = TOOLCHAIN_BASE_ENDPOINT || `https://api.${region}.devops.cloud.ibm.com/toolchain/v2`;
     const options = {
         method: 'DELETE',
         url: `${apiBaseUrl}/toolchains/${toolchainId}`,
@@ -394,6 +400,83 @@ async function deleteToolchain(bearer, toolchainId, region) {
     }
 }
 
+async function getSmInstances(bearer, accountId) {
+    const options = {
+        url: GHOST_BASE_URL + '/v3/resources/search',
+        method: 'POST',
+        headers: {
+            'Authorization': `Bearer ${bearer}`,
+            'Content-Type': 'application/json',
+        },
+        data: {
+            'query': `service_name:secrets-manager AND doc.state:ACTIVE`,
+            'fields': ['doc.resource_group_id', 'doc.region_id', 'doc.dashboard_url', 'doc.name', 'doc.guid']
+        },
+        params: { account_id: accountId },
+        validateStatus: () => true
+    };
+    const response = await axios(options);
+    switch (response.status) {
+        case 200:
+            return response.data.items.map(item => {
+                return {
+                    id: item.doc.guid,
+                    crn: item.crn,
+                    name: item.doc.name,
+                    resource_group_id: item.doc.resource_group_id,
+                    region_id: item.doc.region_id,
+                    dashboard_url: item.doc.dashboard_url
+                }
+            });
+        default:
+            throw Error('Get Secrets Manager instances failed');
+    }
+}
+
+async function createTool(bearer, toolchainId, region, params) {
+    const apiBaseUrl = TOOLCHAIN_BASE_ENDPOINT || `https://api.${region}.devops.cloud.ibm.com/toolchain/v2`;
+    const options = {
+        method: 'POST',
+        url: `${apiBaseUrl}/toolchains/${toolchainId}/tools`,
+        headers: {
+            'Accept': 'application/json',
+            'Authorization': `Bearer ${bearer}`,
+            'Content-Type': 'application/json',
+        },
+        data: params,
+        validateStatus: () => true
+    };
+    const response = await axios(options);
+    switch (response.status) {
+        case 201:
+            return response.data;
+        default:
+            throw Error(response.statusText);
+    }
+}
+
+async function migrateToolchainSecrets(bearer, data, region) {
+    const apiBaseUrl = DEV_MODE ? OTC_BASE_ENDPOINT : `https://otc-api.${region}.devops.cloud.ibm.com/api/v1`;
+    const options = {
+        method: 'POST',
+        url: `${apiBaseUrl}/export_secret`,
+        headers: {
+            'Accept': 'application/json',
+            'Authorization': `Bearer ${bearer}`,
+            'Content-Type': 'application/json',
+        },
+        data: data,
+        validateStatus: () => true
+    };
+    const response = await axios(options);
+    switch (response.status) {
+        case 201:
+            return response.headers.location;
+        default:
+            throw Error(response.data?.errors.length > 0 ? response.data.errors[0]?.message : response.statusText);
+    }
+}
+
 export {
     getBearerToken,
     getAccountId,
@@ -402,12 +485,15 @@ export {
     getToolchainsByName,
     getToolchainTools,
     getPipelineData,
-    getResourceGroupIdAndName,
+    getResourceGroups,
     getAppConfigHealthcheck,
     getSecretsHealthcheck,
     getGitOAuth,
     getGritUserProject,
     getGritGroup,
     getGritGroupProject,
-    deleteToolchain
+    deleteToolchain,
+    createTool,
+    getSmInstances,
+    migrateToolchainSecrets
 }

package/cmd/utils/terraform.js

@@ -18,6 +18,11 @@ import { validateToolchainId, validateGritUrl } from './validate.js';
 import { logger, LOG_STAGES } from './logger.js';
 import { getRandChars, promptUserInput, replaceUrlRegion } from './utils.js';
 
+const CLOUD_PLATFORM = process.env['IBMCLOUD_PLATFORM_DOMAIN'] || 'cloud.ibm.com';
+const DEV_MODE = CLOUD_PLATFORM !== 'cloud.ibm.com';
+const GIT_BASE_URL = DEV_MODE ? process.env['IBMCLOUD_GIT_URL'] : '';
+const IAM_BASE_URL = DEV_MODE ? process.env['IBMCLOUD_IAM_API_ENDPOINT'] : 'https://iam.cloud.ibm.com';
+
 // promisify
 const readFilePromise = promisify(fs.readFile);
 const readDirPromise = promisify(fs.readdir);
@@ -36,6 +41,19 @@ async function execPromise(command, options) {
 function setTerraformEnv(apiKey, verbosity) {
     if (verbosity >= 2) process.env['TF_LOG'] = 'DEBUG';
     process.env['TF_VAR_ibmcloud_api_key'] = apiKey;
+    // reset all Terraform environment variables if pointing to prod domain
+    if (!DEV_MODE) {
+        delete process.env['IBMCLOUD_TOOLCHAIN_ENDPOINT'];
+        delete process.env['IBMCLOUD_TEKTON_PIPELINE_ENDPOINT'];
+        delete process.env['IBMCLOUD_IAM_API_ENDPOINT'];
+        delete process.env['IBMCLOUD_USER_MANAGEMENT_ENDPOINT'];
+        delete process.env['IBMCLOUD_RESOURCE_MANAGEMENT_API_ENDPOINT'];
+        delete process.env['IBMCLOUD_RESOURCE_CONTROLLER_API_ENDPOINT'];
+        delete process.env['IBMCLOUD_IS_NG_API_ENDPOINT'];
+        delete process.env['IBMCLOUD_GT_API_ENDPOINT'];
+        delete process.env['IBMCLOUD_GS_API_ENDPOINT'];
+        delete process.env['IBMCLOUD_USER_MANAGEMENT_ENDPOINT'];
+    }
 }
 
 async function initProviderFile(targetRegion, dir) {
@@ -177,7 +195,7 @@ async function setupTerraformFiles({ token, srcRegion, targetRegion, targetTag,
                                     logger.print('Skipping... (URL will remain unchanged in the generatedTerraform configuration)');
                                     return '';
                                 }
-                                const newUrl = `https://${targetRegion}.git.cloud.ibm.com/${str}.git`;
+                                const newUrl = (GIT_BASE_URL || `https://${targetRegion}.git.cloud.ibm.com`) + `/${str}.git`;
                                 if (usedGritUrls.has(newUrl)) throw Error(`"${newUrl}" has already been used in another mapping entry`);
                                 return validateGritUrl(token, targetRegion, str, false);
                             }
@@ -187,10 +205,10 @@ async function setupTerraformFiles({ token, srcRegion, targetRegion, targetTag,
                                 logger.print('Please enter the new URLs for the following GRIT tool(s) (or submit empty input to skip):\n');
                             }
 
-                            const newRepoSlug = await promptUserInput(`Old URL: ${thisUrl.slice(0, thisUrl.length - 4)}\nNew URL: https://${targetRegion}.git.cloud.ibm.com/`, '', validateGritUrlPrompt);
+                            const newRepoSlug = await promptUserInput(`Old URL: ${thisUrl.slice(0, thisUrl.length - 4)}\nNew URL: ${GIT_BASE_URL || 'https://' + targetRegion + '.git.cloud.ibm.com'}`, '', validateGritUrlPrompt);
 
                             if (newRepoSlug) {
-                                newUrl = `https://${targetRegion}.git.cloud.ibm.com/${newRepoSlug}.git`;
+                                newUrl = (GIT_BASE_URL || `https://${targetRegion}.git.cloud.ibm.com`) + `/${newRepoSlug}.git`;
                                 newTfFileObj['resource']['ibm_cd_toolchain_tool_hostedgit'][k]['initialization'][0]['repo_url'] = newUrl;
                                 attemptAddUsedGritUrl(newUrl);
                                 gritMapping[thisUrl] = newUrl;
@@ -473,10 +491,12 @@ function replaceDependsOn(str) {
 
 function addS2sScriptToToolchainTf(str) {
     const provisionerStr = (tfName) => `\n\n  provisioner "local-exec" {
-    command = "node create-s2s-script.js"
+    command = "node create-s2s-script.cjs"
     environment = {
       IBMCLOUD_API_KEY = var.ibmcloud_api_key
       TARGET_TOOLCHAIN_ID = ibm_cd_toolchain.${tfName}.id
+      IBMCLOUD_PLATFORM = "${CLOUD_PLATFORM}"
+      IAM_BASE_URL = "${IAM_BASE_URL}"
     }\n  }`
     try {
         if (typeof str === 'string') {

package/cmd/utils/utils.js

@@ -21,6 +21,32 @@ export function parseEnvVar(name) {
     return value;
 };
 
+export async function promptUserYesNo(question) {
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout
+    });
+
+    const fullPrompt = `${question} [Ctrl-C to abort] (y)es (n)o: `;
+
+    const answer = await rl.question(fullPrompt);
+
+    logger.dump(fullPrompt + '\n' + answer + '\n');
+    rl.close();
+
+    const normalized = answer.toLowerCase().trim();
+    if (normalized === 'y' || normalized === 'yes') {
+        logger.print();
+        return true;
+    }
+    if (normalized === 'n' || normalized === 'no') {
+        logger.print();
+        return false;
+    }
+    logger.warn('\nInvalid input. Please enter \'y\' or \'n\'.');
+    return await promptUserYesNo(question);
+}
+
 export async function promptUserConfirmation(question, expectedAns, exitMsg) {
     const rl = readline.createInterface({
         input: process.stdin,
@@ -33,7 +59,7 @@ export async function promptUserConfirmation(question, expectedAns, exitMsg) {
     logger.dump(fullPrompt + '\n' + answer + '\n');
 
     if (answer.toLowerCase().trim() !== expectedAns) {
-        logger.print('\n' + exitMsg);
+        if (exitMsg) logger.print('\n' + exitMsg);
         rl.close();
         await logger.close();
         process.exit(1);
@@ -59,7 +85,7 @@ export async function promptUserInput(question, initialInput, validationFn) {
     });
 
     rl.prompt(true);
-    rl.write(initialInput);
+    if (initialInput) rl.write(initialInput);
 
     for await (const ans of rl) {
         try {
@@ -72,7 +98,7 @@ export async function promptUserInput(question, initialInput, validationFn) {
             logger.warn(`Validation failed... ${e.message}`, '', true);
 
             rl.prompt(true);
-            rl.write(initialInput);
+            if (initialInput) rl.write(initialInput);
         }
     }
 
@@ -81,6 +107,44 @@ export async function promptUserInput(question, initialInput, validationFn) {
     return answer.trim();
 }
 
+export async function promptUserSelection(question, choices) {
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout
+    });
+
+    rl.on('SIGINT', async () => {
+        logger.print('\n' + 'Received SIGINT signal');
+        await logger.close();
+        process.exit(1);
+    });
+
+    const list = choices
+        .map((choice, i) => `[${i + 1}] ${choice}`)
+        .join('\n');
+
+    const promptText = `${question}\n\n${list}\n\nEnter the number of your choice (Ctrl-C to abort): `;
+
+    let index;
+
+    while (true) {
+        const answer = await rl.question(promptText);
+        logger.dump(promptText + '\n' + answer + '\n');
+
+        index = parseInt(answer.trim(), 10) - 1;
+
+        if (!Number.isNaN(index) && index >= 0 && index < choices.length) {
+            break;
+        }
+
+        logger.warn('\nInvalid choice. Please enter a valid number.\n', '', true);
+    }
+
+    rl.close();
+    logger.print();
+    return index;
+}
+
 export function replaceUrlRegion(inputUrl, srcRegion, targetRegion) {
     if (!inputUrl) return '';
 

package/cmd/utils/validate.js

@@ -10,9 +10,12 @@
 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 { getToolchainsByName, getToolchainTools, getPipelineData, getAppConfigHealthcheck, getSecretsHealthcheck, getGitOAuth, getGritUserProject, getGritGroupProject } from './requests.js';
 import { promptUserConfirmation, promptUserInput, isSecretReference } from './utils.js';
 
+const CLOUD_PLATFORM = process.env['IBMCLOUD_PLATFORM_DOMAIN'] || 'cloud.ibm.com';
+const DEV_MODE = CLOUD_PLATFORM !== 'cloud.ibm.com';
+const GIT_BASE_URL = DEV_MODE ? process.env['IBMCLOUD_GIT_URL'] : '';
 
 function validatePrereqsVersions() {
     const compareVersions = (verInstalled, verRequired) => {
@@ -151,7 +154,7 @@ async function validateTools(token, tcId, region, skipPrompt) {
     for (const tool of allTools.tools) {
         const toolName = (tool.name || tool.parameters?.name || tool.parameters?.label || '').replace(/\s+/g, '+');
         logger.updateSpinnerMsg(`Validating tool \'${toolName}\'`);
-        const toolUrl = `https://cloud.ibm.com/devops/toolchains/${tool.toolchain_id}/configure/${tool.id}?env_id=ibm:yp:${region}`;
+        const toolUrl = `https://${CLOUD_PLATFORM}/devops/toolchains/${tool.toolchain_id}/configure/${tool.id}?env_id=ibm:yp:${region}`;
 
         if (tool.state !== 'configured') {  // Check for tools in misconfigured/unconfigured/configuring state
             nonConfiguredTools.push({
@@ -278,7 +281,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-secrets\' 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 \'export-secrets\' command to export the secrets: \n', LOG_STAGES.setup, true);
         logger.table(toolsWithHashedParams);
     }
 
@@ -394,7 +397,7 @@ async function validateOAuth(token, tools, targetRegion, skipPrompt) {
             logger.print(`${o.type}: \x1b[36m${o.link}\x1b[0m\n`);
         });
 
-        if (hasFailedLink) logger.print(`Please manually verify failed authorization(s): https://cloud.ibm.com/devops/git?env_id=ibm:yp:${targetRegion}\n`);
+        if (hasFailedLink) logger.print(`Please manually verify failed authorization(s): https://${CLOUD_PLATFORM}/devops/git?env_id=ibm:yp:${targetRegion}\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.');
     }
@@ -405,8 +408,9 @@ async function validateGritUrl(token, region, url, validateFull) {
     let trimmed;
 
     if (validateFull) {
-        if (!url.startsWith(`https://${region}.git.cloud.ibm.com/`) || !url.endsWith('.git')) throw Error('Provided full GRIT url is not valid');
-        trimmed = url.slice(`https://${region}.git.cloud.ibm.com/`.length, url.length - '.git'.length);
+        const baseUrl = (GIT_BASE_URL || `https://${region}.git.cloud.ibm.com`) + '/';
+        if (!url.startsWith(baseUrl) || !url.endsWith('.git')) throw Error('Provided full GRIT url is not valid');
+        trimmed = url.slice(baseUrl.length, url.length - '.git'.length);
     } else {
         trimmed = url.trim();
     }

package/create-s2s-script.js

@@ -16,9 +16,13 @@ if (!API_KEY) throw Error(`Missing 'IBMCLOUD_API_KEY'`);
 const TC_ID = process.env['TARGET_TOOLCHAIN_ID'];
 if (!TC_ID) throw Error(`Missing 'TARGET_TOOLCHAIN_ID'`);
 
+const CLOUD_PLATFORM = process.env['IBMCLOUD_PLATFORM'] || 'cloud.ibm.com';
+if (!CLOUD_PLATFORM) throw Error(`Missing 'IBMCLOUD_PLATFORM'`);
+
+const IAM_BASE_URL = process.env['IAM_BASE_URL'] || 'https://iam.cloud.ibm.com';
+if (!IAM_BASE_URL) throw Error(`Missing 'IAM_BASE_URL'`);
+
 const INPUT_PATH = 'create-s2s.json';
-const CLOUD_PLATFORM = 'https://cloud.ibm.com';
-const IAM_BASE_URL = 'https://iam.cloud.ibm.com';
 
 async function getBearer() {
     const url = `${IAM_BASE_URL}/identity/token`;
@@ -68,8 +72,8 @@ async function getBearer() {
 }
 */
 
-async function createS2sAuthPolicy(item) {
-    const url = `${CLOUD_PLATFORM}/devops/setup/api/v2/s2s_authorization?${new URLSearchParams({
+async function createS2sAuthPolicy(bearer, item) {
+    const url = `https://${CLOUD_PLATFORM}/devops/setup/api/v2/s2s_authorization?${new URLSearchParams({
         toolchainId: TC_ID,
         serviceId: item['serviceId'],
         env_id: item['env_id']
@@ -110,10 +114,10 @@ async function createS2sAuthPolicy(item) {
 
 // main
 
-const bearer = await getBearer();
+getBearer().then((bearer) => {
+    const inputArr = JSON.parse(fs.readFileSync(resolve(INPUT_PATH)));
 
-const inputArr = JSON.parse(fs.readFileSync(resolve(INPUT_PATH)));
-
-inputArr.forEach(async (item) => {
-    await createS2sAuthPolicy(item);
+    inputArr.forEach(async (item) => {
+        await createS2sAuthPolicy(bearer, item);
+    });
 });

package/index.js

@@ -10,13 +10,20 @@
 
 import { program } from 'commander';
 import * as commands from './cmd/index.js'
+import { DOCS_URL } from './config.js';
+import { logger } from './cmd/utils/logger.js';
+
 import packageJson from './package.json' with { type: "json" };
 
+process.on('exit', (code) => {
+    if (code !== 0) logger.print(`Need help? Visit ${DOCS_URL} for more troubleshooting information.`);
+});
+
 program
-  .name(packageJson.name)
-  .description('Tools and utilities for the IBM Cloud Continuous Delivery service and resources.')
-  .version(packageJson.version)
-  .showHelpAfterError();
+    .name(packageJson.name)
+    .description('Tools and utilities for the IBM Cloud Continuous Delivery service and resources.')
+    .version(packageJson.version)
+    .showHelpAfterError();
 
 for (let i in commands) {
     program.addCommand(commands[i]);

package/package.json

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

package/test/README.md

@@ -36,6 +36,6 @@ You can customize the behavior of the tests by defining configuration properties
 | `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                                          |
+| `LOG_DUMP`         | `boolean` | `false`           | When set to `true`, individual test case's process's log file generation is enabled, and logs are written to `TEST_TEMP_DIR` |
 | `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                                                                   |
+| `VERBOSE_MODE`     | `boolean` | `false`           | When set to `true`, each test case's log output increases                                                                    |

package/test/config/local.template.json

@@ -3,7 +3,7 @@
     "TEST_TEMP_DIR": "test/.tmp",
     "TEST_LOG_DIR": "test/.logs",
     "IBMCLOUD_API_KEY": "<YOUR IBMCLOUD API KEY>",
-    "LOG_DUMP": true,
+    "LOG_DUMP": false,
     "DISABLE_SPINNER": true,
     "VERBOSE_MODE": false
 }