W-20893569 adding b2c-cli unit tests

Author: charithaT07

packages/b2c-cli/eslint.config.mjs

@@ -9,7 +9,7 @@ import headerPlugin from 'eslint-plugin-header';
 import path from 'node:path';
 import {fileURLToPath} from 'node:url';
 
-import {copyrightHeader, sharedRules, oclifRules, prettierPlugin} from '../../eslint.config.mjs';
+import {copyrightHeader, sharedRules, oclifRules, chaiTestRules, prettierPlugin} from '../../eslint.config.mjs';
 
 const gitignorePath = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '.gitignore');
 headerPlugin.rules.header.meta.schema = false;
@@ -19,7 +19,7 @@ export default [
   // node_modules must be explicitly ignored because the .gitignore pattern only covers
   // packages/b2c-cli/node_modules, not the monorepo root node_modules
   {
-    ignores: ['**/node_modules/**', 'test/functional/fixtures/**/*.js'],
+    ignores: ['**/node_modules/**', 'test/functional/fixtures/**/*.js', '**/node_modules/marked-terminal/**'],
   },
   includeIgnoreFile(gitignorePath),
   ...oclif,
@@ -39,4 +39,29 @@ export default [
       ...oclifRules,
     },
   },
+  {
+    files: ['test/**/*.ts'],
+    rules: {
+      ...chaiTestRules,
+      // Tests use stubbing patterns that intentionally return undefined
+      'unicorn/no-useless-undefined': 'off',
+      // Some tests use void 0 to satisfy TS stub typings; allow it in tests
+      'no-void': 'off',
+      // Command tests frequently use `any` to avoid over-typing oclif command internals
+      '@typescript-eslint/no-explicit-any': 'off',
+      // Helper functions in tests are commonly declared within suites for clarity
+      'unicorn/consistent-function-scoping': 'off',
+      // Sinon default import is intentional and idiomatic in tests
+      'import/no-named-as-default-member': 'off',
+      // import/namespace behaves inconsistently across environments when parsing CJS modules like marked-terminal
+      'import/namespace': 'off',
+    },
+  },
+  {
+    files: ['src/commands/docs/**/*.ts'],
+    rules: {
+      // marked-terminal is CJS and breaks import/namespace static analysis
+      'import/namespace': 'off',
+    },
+  },
 ];

packages/b2c-cli/package.json

@@ -52,6 +52,7 @@
     "oclif": "^4",
     "prettier": "^3.6.2",
     "shx": "^0.3.3",
+    "sinon": "^21.0.1",
     "tsx": "^4.20.6",
     "typescript": "^5"
   },

packages/b2c-cli/src/commands/code/delete.ts

@@ -51,6 +51,10 @@ export default class CodeDelete extends InstanceCommand<typeof CodeDelete> {
     }),
   };
 
+  protected async confirm(message: string): Promise<boolean> {
+    return confirm(message);
+  }
+
   async run(): Promise<void> {
     this.requireOAuthCredentials();
 
@@ -59,7 +63,7 @@ export default class CodeDelete extends InstanceCommand<typeof CodeDelete> {
 
     // Confirm deletion unless --force is used
     if (!this.flags.force) {
-      const confirmed = await confirm(
+      const confirmed = await this.confirm(
         t(
           'commands.code.delete.confirm',
           'Are you sure you want to delete code version "{{codeVersion}}" on {{hostname}}? (y/n)',

packages/b2c-cli/src/commands/code/deploy.ts

@@ -47,6 +47,18 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
     }),
   };
 
+  protected async deleteCartridges(cartridges: Parameters<typeof deleteCartridges>[1]) {
+    return deleteCartridges(this.instance, cartridges);
+  }
+
+  protected async getActiveCodeVersion() {
+    return getActiveCodeVersion(this.instance);
+  }
+
+  protected async reloadCodeVersion(codeVersion: string) {
+    return reloadCodeVersion(this.instance, codeVersion);
+  }
+
   async run(): Promise<DeployResult> {
     this.requireWebDavCredentials();
     this.requireOAuthCredentials();
@@ -59,7 +71,7 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
       this.warn(
         t('commands.code.deploy.noCodeVersion', 'No code version specified, discovering active code version...'),
       );
-      const activeVersion = await getActiveCodeVersion(this.instance);
+      const activeVersion = await this.getActiveCodeVersion();
       if (!activeVersion?.id) {
         this.error(
           t('commands.code.deploy.noActiveVersion', 'No active code version found. Specify one with --code-version.'),
@@ -118,17 +130,17 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
     try {
       // Optionally delete existing cartridges first
       if (this.flags.delete) {
-        await deleteCartridges(this.instance, cartridges);
+        await this.deleteCartridges(cartridges);
       }
 
       // Upload cartridges
-      await uploadCartridges(this.instance, cartridges);
+      await this.uploadCartridges(cartridges);
 
       // Optionally reload code version
       let reloaded = false;
       if (this.flags.reload) {
         try {
-          await reloadCodeVersion(this.instance, version);
+          await this.reloadCodeVersion(version);
           reloaded = true;
         } catch (error) {
           this.logger?.debug(`Could not reload code version: ${error instanceof Error ? error.message : error}`);
@@ -174,4 +186,8 @@ export default class CodeDeploy extends CartridgeCommand<typeof CodeDeploy> {
       throw error;
     }
   }
+
+  protected async uploadCartridges(cartridges: Parameters<typeof uploadCartridges>[1]) {
+    return uploadCartridges(this.instance, cartridges);
+  }
 }

packages/b2c-cli/src/commands/code/watch.ts

@@ -41,18 +41,7 @@ export default class CodeWatch extends CartridgeCommand<typeof CodeWatch> {
     }
 
     try {
-      const result = await watchCartridges(this.instance, this.cartridgePath, {
-        ...this.cartridgeOptions,
-        onUpload: (files) => {
-          this.log(t('commands.code.watch.uploaded', '[UPLOAD] {{count}} file(s)', {count: files.length}));
-        },
-        onDelete: (files) => {
-          this.log(t('commands.code.watch.deleted', '[DELETE] {{count}} file(s)', {count: files.length}));
-        },
-        onError: (error) => {
-          this.warn(t('commands.code.watch.error', 'Error: {{message}}', {message: error.message}));
-        },
-      });
+      const result = await this.watchCartridges();
 
       this.log(
         t('commands.code.watch.watching', 'Watching {{count}} cartridge(s)...', {count: result.cartridges.length}),
@@ -78,4 +67,19 @@ export default class CodeWatch extends CartridgeCommand<typeof CodeWatch> {
       throw error;
     }
   }
+
+  protected async watchCartridges() {
+    return watchCartridges(this.instance, this.cartridgePath, {
+      ...this.cartridgeOptions,
+      onUpload: (files) => {
+        this.log(t('commands.code.watch.uploaded', '[UPLOAD] {{count}} file(s)', {count: files.length}));
+      },
+      onDelete: (files) => {
+        this.log(t('commands.code.watch.deleted', '[DELETE] {{count}} file(s)', {count: files.length}));
+      },
+      onError: (error) => {
+        this.warn(t('commands.code.watch.error', 'Error: {{message}}', {message: error.message}));
+      },
+    });
+  }
 }

packages/b2c-cli/src/commands/docs/download.ts

@@ -37,6 +37,10 @@ export default class DocsDownload extends InstanceCommand<typeof DocsDownload> {
     }),
   };
 
+  protected async downloadDocs(input: Parameters<typeof downloadDocs>[1]) {
+    return downloadDocs(this.instance, input);
+  }
+
   async run(): Promise<DownloadDocsResult> {
     this.requireServer();
     this.requireWebDavCredentials();
@@ -50,7 +54,7 @@ export default class DocsDownload extends InstanceCommand<typeof DocsDownload> {
       }),
     );
 
-    const result = await downloadDocs(this.instance, {
+    const result = await this.downloadDocs({
       outputDir,
       keepArchive,
     });

packages/b2c-cli/src/commands/docs/read.ts

@@ -5,7 +5,7 @@
  */
 import {Args, Flags} from '@oclif/core';
 import {marked} from 'marked';
-// eslint-disable-next-line import/namespace
+
 import {markedTerminal} from 'marked-terminal';
 import {BaseCommand} from '@salesforce/b2c-tooling-sdk/cli';
 import {readDocByQuery, type DocEntry} from '@salesforce/b2c-tooling-sdk/operations/docs';
@@ -57,11 +57,15 @@ export default class DocsRead extends BaseCommand<typeof DocsRead> {
     }),
   };
 
+  protected readDocByQuery(query: string) {
+    return readDocByQuery(query);
+  }
+
   async run(): Promise<ReadDocsResult> {
     const {query} = this.args;
     const {raw} = this.flags;
 
-    const result = readDocByQuery(query);
+    const result = this.readDocByQuery(query);
 
     if (!result) {
       this.error(t('commands.docs.read.notFound', 'No documentation found matching: {{query}}', {query}), {

packages/b2c-cli/src/commands/docs/schema.ts

@@ -45,13 +45,21 @@ export default class DocsSchema extends BaseCommand<typeof DocsSchema> {
     }),
   };
 
+  protected listSchemas() {
+    return listSchemas();
+  }
+
+  protected readSchemaByQuery(query: string) {
+    return readSchemaByQuery(query);
+  }
+
   async run(): Promise<ListResult | SchemaResult> {
     const {query} = this.args;
     const {list} = this.flags;
 
     // List mode
     if (list) {
-      const entries = listSchemas();
+      const entries = this.listSchemas();
 
       if (this.jsonEnabled()) {
         return {entries};
@@ -72,7 +80,7 @@ export default class DocsSchema extends BaseCommand<typeof DocsSchema> {
       this.error(t('commands.docs.schema.queryRequired', 'Schema name is required. Use --list to see all schemas.'));
     }
 
-    const result = readSchemaByQuery(query);
+    const result = this.readSchemaByQuery(query);
 
     if (!result) {
       this.error(t('commands.docs.schema.notFound', 'No schema found matching: {{query}}', {query}), {

packages/b2c-cli/src/commands/docs/search.ts

@@ -70,13 +70,17 @@ export default class DocsSearch extends BaseCommand<typeof DocsSearch> {
     }),
   };
 
+  protected listDocs() {
+    return listDocs();
+  }
+
   async run(): Promise<ListDocsResponse | SearchDocsResponse> {
     const {query} = this.args;
     const {limit, list} = this.flags;
 
     // List mode
     if (list) {
-      const entries = listDocs();
+      const entries = this.listDocs();
 
       if (this.jsonEnabled()) {
         return {entries};
@@ -109,7 +113,7 @@ export default class DocsSearch extends BaseCommand<typeof DocsSearch> {
       );
     }
 
-    const results = searchDocs(query, limit);
+    const results = this.searchDocs(query, limit);
 
     const response: SearchDocsResponse = {
       query,
@@ -136,4 +140,8 @@ export default class DocsSearch extends BaseCommand<typeof DocsSearch> {
 
     return response;
   }
+
+  protected searchDocs(query: string, limit: number) {
+    return searchDocs(query, limit);
+  }
 }

packages/b2c-cli/src/commands/job/export.ts

@@ -114,7 +114,7 @@ export default class JobExport extends JobCommand<typeof JobExport> {
       'no-download': noDownload,
       'zip-only': zipOnly,
       timeout,
-      'show-log': showLog,
+      'show-log': showLog = true,
     } = this.flags;
 
     const hostname = this.resolvedConfig.hostname!;
@@ -173,7 +173,7 @@ export default class JobExport extends JobCommand<typeof JobExport> {
     this.log(t('commands.job.export.dataUnits', 'Data units: {{dataUnits}}', {dataUnits: JSON.stringify(dataUnits)}));
 
     try {
-      const result = await siteArchiveExportToPath(this.instance, dataUnits, output, {
+      const result = await this.siteArchiveExportToPath(dataUnits, output, {
         keepArchive: keepArchive || noDownload,
         extractZip: !zipOnly,
         waitOptions: {
@@ -254,6 +254,14 @@ export default class JobExport extends JobCommand<typeof JobExport> {
     }
   }
 
+  protected async siteArchiveExportToPath(
+    dataUnits: Parameters<typeof siteArchiveExportToPath>[1],
+    output: Parameters<typeof siteArchiveExportToPath>[2],
+    options: Parameters<typeof siteArchiveExportToPath>[3],
+  ) {
+    return siteArchiveExportToPath(this.instance, dataUnits, output, options);
+  }
+
   private buildDataUnits(params: {
     dataUnitsJson?: string;
     site?: string[];