@ibm-cloud/cd-tools 1.1.1 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibm-cloud/cd-tools",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Tools and utilities for the IBM Cloud Continuous Delivery service and resources",
   "repository": {
     "type": "git",
@@ -14,6 +14,9 @@
   },
   "author": "IBM Corp.",
   "license": "Apache-2.0",
+  "scripts": {
+    "test": "mocha --require \"test/setup.js\" \"test/copy-toolchain/*.test.js\""
+  },
   "dependencies": {
     "@cdktf/hcl2json": "^0.21.0",
     "axios": "^1.12.2",
@@ -27,5 +30,11 @@
   "bin": {
     "cd-tools": "index.js"
   },
-  "type": "module"
+  "type": "module",
+  "devDependencies": {
+    "chai": "^6.2.0",
+    "mocha": "^11.7.4",
+    "nconf": "^0.13.0",
+    "node-pty": "^1.0.0"
+  }
 }

package/test/README.md

@@ -0,0 +1,40 @@
+# Test
+
+All automated tests live in this directory.
+Before running tests, ensure that you have completed the setup steps in the main [README.md](../README.md), including installing all prerequisites and dependencies.
+
+## Getting Started
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/IBM/continuous-delivery-tools.git
+   cd continuous-delivery-tools
+   ```
+2. **Install dependencies**
+    ```bash
+    npm install
+    ```
+3. **Test configuration**
+
+    Before running tests, create a local configuration file:
+    ```bash
+    cp test/config/local.template.json test/config/local.json
+    ```
+    Then open `test/config/local.json` and replace all placeholder values with your local or test environment settings.
+4. **Running the tests**
+    
+    To execute the test suite:
+    ```bash
+    npm run test
+    ```
+
+### 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                                              |

package/test/config/local.template.json

@@ -0,0 +1,8 @@
+{
+    "TEST_DEBUG_MODE": false,
+    "TEST_TEMP_DIR": "test/.tmp",
+    "TEST_LOG_DIR": "test/.logs",
+    "IBMCLOUD_API_KEY": "<YOUR IBMCLOUD API KEY>",
+    "LOG_DUMP": true,
+    "DISABLE_SPINNER": true
+}

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

@@ -0,0 +1,11 @@
+/**
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ */
+
+describe('copy-toolchain: Test import-terraform output', function () {
+});

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

@@ -0,0 +1,11 @@
+/**
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ */
+
+describe('copy-toolchain: Test Terraform output', function () {
+});

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

@@ -0,0 +1,126 @@
+/**
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ */
+
+import path from 'node:path';
+import nconf from 'nconf';
+
+import * as chai from 'chai';
+chai.config.truncateThreshold = 0;
+
+import mocks from '../data/mocks.js';
+import { testSuiteCleanup, expectExecError, expectPtyOutputToMatch } from '../utils/testUtils.js';
+import { TEST_TOOLCHAINS } from '../data/test-toolchains.js';
+import { TARGET_REGIONS } from '../../config.js';
+
+nconf.env('__');
+nconf.file('local', 'test/config/local.json');
+
+const CLI_PATH = path.resolve('index.js');
+const COMMAND = 'copy-toolchain';
+
+const toolchainsToDelete = new Map();
+
+after(async () => await testSuiteCleanup(toolchainsToDelete));
+
+describe('copy-toolchain: Test user input handling', function () {
+    this.timeout('60s');
+    this.command = 'copy-toolchain';
+
+    const validCrn = TEST_TOOLCHAINS['empty'].crn;
+
+    const invalidArgsCases = [
+        {
+            name: 'Toolchain CRN not specified',
+            cmd: [CLI_PATH, COMMAND],
+            expected: /required option '-c, --toolchain-crn <crn>' not specified/,
+        },
+        {
+            name: 'Region is not specified',
+            cmd: [CLI_PATH, COMMAND, '-c', validCrn],
+            expected: /required option '-r, --region <region>' not specified/,
+        },
+        {
+            name: 'API Key is not specified',
+            cmd: [CLI_PATH, COMMAND, '-c', validCrn, '-r', TARGET_REGIONS[0]],
+            expected: /Environment variable 'IBMCLOUD_API_KEY' is required but not set/,
+            options: { env: { ...process.env, IBMCLOUD_API_KEY: '' } }
+        },
+        {
+            name: 'Invalid API Key provided',
+            cmd: [CLI_PATH, COMMAND, '-c', validCrn, '-r', TARGET_REGIONS[0]],
+            expected: /There was a problem getting a bearer token using IBMCLOUD_API_KEY/,
+            options: { env: { ...process.env, IBMCLOUD_API_KEY: 'not-a-valid-apikey' } }
+        },
+        {
+            name: 'Invalid region is provided',
+            cmd: [CLI_PATH, COMMAND, '-c', validCrn, '-r', mocks.invalidRegion],
+            expected: new RegExp(`option '-r, --region <region>' argument '${mocks.invalidRegion}' is invalid`)
+        },
+        {
+            name: 'Invalid CRN is provided',
+            cmd: [CLI_PATH, COMMAND, '-c', mocks.invalidCrn, '-r', TARGET_REGIONS[0]],
+            expected: /Provided toolchain CRN is invalid/,
+        },
+        {
+            name: 'Invalid Toolchain tag is provided',
+            cmd: [CLI_PATH, COMMAND, '-c', validCrn, '-r', TARGET_REGIONS[0], '-t', mocks.invalidTag],
+            expected: /Provided tag is invalid/,
+        },
+        {
+            name: 'Invalid Toolchain name is provided',
+            cmd: [CLI_PATH, COMMAND, '-c', validCrn, '-r', TARGET_REGIONS[0], '-n', mocks.invalidTcName],
+            expected: /Provided toolchain name is invalid/,
+        },
+        {
+            name: 'Invalid Resource Group name is provided',
+            cmd: [CLI_PATH, COMMAND, '-c', validCrn, '-r', TARGET_REGIONS[0], '-g', mocks.invalidRgName],
+            expected: /The resource group with provided ID or name was not found or is not accessible/,
+        },
+        {
+            name: 'Invalid Resource Group ID is provided',
+            cmd: [CLI_PATH, COMMAND, '-c', validCrn, '-r', TARGET_REGIONS[0], '-g', mocks.invalidRgId],
+            expected: /The resource group with provided ID or name was not found or is not accessible/,
+        },
+    ];
+
+    for (const { name, cmd, expected, options } of invalidArgsCases) {
+        it(`Invalid args: ${name}`, async () => {
+            await expectExecError(cmd, expected, options);
+        });
+    }
+
+    const invalidUserInputCases = [
+        {
+            name: 'Invalid Toolchain tag is provided',
+            cmd: [CLI_PATH, COMMAND, '-c', TEST_TOOLCHAINS['empty'].crn, '-r', TARGET_REGIONS[0]],
+            expected: /Provided tag is invalid/,
+            options: {
+                questionAnswerMap: { '(Recommended) Add a tag to the cloned toolchain (Ctrl-C to abort):' : mocks.invalidTag },
+                exitCondition: 'Validation failed',
+                timeout: 5000
+            }
+        },
+        {
+            name: 'Invalid Toolchain name is provided',
+            cmd: [CLI_PATH, COMMAND, '-c', TEST_TOOLCHAINS['empty'].crn, '-r', TEST_TOOLCHAINS['empty'].region],
+            expected: /Provided toolchain name is invalid/,
+            options: {
+                questionAnswerMap: { [`(Recommended) Edit the cloned toolchain's name [default: ${TEST_TOOLCHAINS['empty'].name}] (Ctrl-C to abort):`] : mocks.invalidTcName },
+                exitCondition: 'Validation failed',
+                timeout: 5000
+            }
+        },
+    ];
+
+    for (const { name, cmd, expected, options } of invalidUserInputCases) {
+        it(`Invalid user input in prompts: ${name}`, async () => {
+            await expectPtyOutputToMatch(cmd, expected, options);
+        });
+    }
+});

package/test/data/mocks.js

@@ -0,0 +1,29 @@
+/**
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ */
+
+const invalidCrn = 'crn:v1:bluemix:public:not-a-toolchain:ca-tor:a/955ce52f7b4f4aad8020fbee3e7a8sje:dacff581-8a40sdsdf3kfsd-12n3s::';
+
+const invalidRegion = 'not-br-sao';
+
+const invalidTcName = 'invalidToolchainName@';
+
+const invalidTag = 'invalid@Tag';
+
+const invalidRgId = 'invalid#RgId';
+
+const invalidRgName = 'invalid#Rg@Name';
+
+export default {
+    invalidCrn,
+    invalidRegion,
+    invalidTcName,
+    invalidTag,
+    invalidRgId,
+    invalidRgName
+};

package/test/data/test-toolchains.js

@@ -0,0 +1,21 @@
+/**
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ */
+
+export const TEST_TOOLCHAINS = {
+    'empty': {
+        'name': 'empty-toolchain',
+        'crn': 'crn:v1:bluemix:public:toolchain:ca-tor:a/9e8559fac61ee9fc74d3e595fa75d147:a3d4a26a-b447-490e-af84-356bbe63dd1c::',
+        'region': 'ca-tor'
+    },
+    'misconfigured': {
+        'name': 'misconfigured-toolchain',
+        'crn': 'crn:v1:bluemix:public:toolchain:eu-es:a/9e8559fac61ee9fc74d3e595fa75d147:0ccfaa70-ca90-47db-8246-f4ecfc6ad8f3::',
+        'region': 'eu-es'
+    }
+};

package/test/setup.js

@@ -0,0 +1,46 @@
+/**
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ */
+
+import fs from 'node:fs';
+import { resolve } from 'node:path'
+import nconf from 'nconf';
+
+import { logger } from '../cmd/utils/logger.js';
+
+nconf.env('__');
+nconf.file('local', 'test/config/local.json');
+process.env.IBMCLOUD_API_KEY = nconf.get('IBMCLOUD_API_KEY');
+process.env.DISABLE_SPINNER = nconf.get('DISABLE_SPINNER');
+process.env.LOG_DUMP = nconf.get('LOG_DUMP') || false;      // Disable each individual test case's process's log file generation by default
+
+const TEMP_DIR = resolve(nconf.get('TEST_TEMP_DIR'));
+const LOG_DIR = resolve(nconf.get('TEST_LOG_DIR'));
+const DEBUG_MODE = nconf.get('TEST_DEBUG_MODE');
+
+export const mochaHooks = {
+    beforeAll() {
+        if (!fs.existsSync(TEMP_DIR)) fs.mkdirSync(TEMP_DIR, { recursive: true });
+        if (fs.existsSync(LOG_DIR)) fs.rmSync(LOG_DIR, { recursive: true });
+    },
+    beforeEach() {
+        if (DEBUG_MODE === true && LOG_DIR) {
+            const testTitle = this.currentTest.title.toLowerCase().replaceAll(':', '').replaceAll(' ', '-');
+            const logFile = this.currentTest.parent.command ?
+                resolve(LOG_DIR, this.currentTest.parent.command, testTitle + '.log') :
+                resolve(LOG_DIR, testTitle + '.log');
+            logger.createLogStream(logFile);
+        }
+    },
+    afterEach() {
+        logger.close();
+    },
+    afterAll() {
+        if (fs.existsSync(TEMP_DIR) && DEBUG_MODE === false) fs.rmSync(TEMP_DIR, { recursive: true });
+    },
+};

package/test/utils/testUtils.js

@@ -0,0 +1,137 @@
+/**
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ */
+
+import { promisify } from 'util';
+import child_process from 'child_process';
+import stripAnsi from 'strip-ansi';
+import pty from 'node-pty';
+import nconf from 'nconf';
+import { expect } from 'chai';
+
+import { getBearerToken, deleteToolchain } from '../../cmd/utils/requests.js';
+import { logger } from '../../cmd/utils/logger.js';
+
+nconf.env('__');
+nconf.file('local', 'test/config/local.json');
+
+const IBMCLOUD_API_KEY = nconf.get('IBMCLOUD_API_KEY');
+
+function cleanOutput(data) {
+    if (typeof data === 'string') return stripAnsi(data).replace(/\r/g, '').trim();
+}
+
+export async function execCommand(fullCommand, options) {
+    const commandStr = `node ${fullCommand.join(' ')}`;
+    const execPromise = promisify(child_process.exec);
+    try {
+        const { stdout, stderr } = await execPromise(commandStr, options);
+        if (stderr) {
+            const err = new Error(cleanOutput(stderr));
+            err.stdout = cleanOutput(stdout);
+            err.stderr = cleanOutput(stderr);
+            throw err;
+        }
+        return cleanOutput(stdout);
+    } catch (e) {
+        const err = new Error(cleanOutput(e.message));
+        err.stdout = cleanOutput(e.stdout);
+        err.stderr = cleanOutput(e.stderr);
+        err.code = e.code;
+        err.signal = e.signal;
+        throw err;
+    }
+}
+
+export function runPtyProcess(fullCommand, options) {
+    const {
+        timeout = 0,
+        cwd = process.cwd(),
+        env = process.env,
+        questionAnswerMap = {},
+        exitCondition = '',
+    } = options;
+
+    return new Promise((resolve, reject) => {
+        try {
+            const ptyProcess = pty.spawn('node', fullCommand, {
+                name: 'xterm-color',
+                cols: 80,
+                rows: 30,
+                cwd: cwd,
+                env: env
+            });
+
+            let output = '';
+            let timedOut = false;
+
+            const timer = timeout > 0 ? setTimeout(() => {
+                timedOut = true;
+                ptyProcess.kill();
+            }, timeout) : null;
+
+            ptyProcess.onData((data) => {
+                output += data;
+                for (const [question, answer] of Object.entries(questionAnswerMap)) {
+                    if (data.includes(question)) {
+                        ptyProcess.write(answer + '\r');
+                    }
+                }
+                if (exitCondition.length > 0 && data.includes(exitCondition)) {
+                    ptyProcess.kill();
+                    resolve(cleanOutput(output));
+                }
+            });
+
+            ptyProcess.onExit(({ exitCode }) => {
+                if (timer) clearTimeout(timer);
+                if (timedOut) {
+                    reject(new Error(`ERROR: Process timed out after ${timeout}ms\n\nCommand: ${'node ' + fullCommand.join(' ')}\n\nOutput:\n${cleanOutput(output)}`));
+                }
+                if (exitCode !== 0) {
+                    reject(new Error(`ERROR: Process exited with code ${exitCode}\n\nCommand: ${'node ' + fullCommand.join(' ')}\n\nOutput:\n${cleanOutput(output)}`));
+                } else {
+                    resolve(cleanOutput(output));
+                }
+            });
+
+        } catch (err) {
+            reject(err);
+        }
+    });
+}
+
+export async function testSuiteCleanup(toolchainsToDelete) {
+    if (toolchainsToDelete && typeof toolchainsToDelete === 'object' && toolchainsToDelete.size > 0) {
+        const token = await getBearerToken(IBMCLOUD_API_KEY);
+        const deletePromises = [...toolchainsToDelete.entries()].map(([id, region]) => deleteToolchain(token, id, region));
+        await Promise.all(deletePromises);
+    }
+}
+
+export async function expectExecError(fullCommand, expectedMessage, options) {
+    try {
+        const output = await execCommand(fullCommand, options);
+        logger.dump(output);
+        throw new Error('Expected command to fail but it succeeded');
+    } catch (e) {
+        logger.dump(e.message);
+        expect(e.message).to.match(expectedMessage);
+    }
+}
+
+export async function expectPtyOutputToMatch(fullCommand, expectedMessage, options) {
+    try {
+        const output = await runPtyProcess(fullCommand, options);
+        logger.dump(output);
+        expect(output).to.match(expectedMessage);
+    } catch (e) {
+        logger.dump(e.message);
+        throw (e);
+    }
+}