created a helper file for stubbing authentication

naman-contentstack · naman-contentstack · commit 733274895872 · 2025-07-24T12:54:25.000+05:30
diff --git a/README.md b/README.md
@@ -16,31 +16,34 @@ $ csdx plugins:install @contentstack/apps-cli
 This plugin requires you to be authenticated using [csdx auth:login](https://www.contentstack.com/docs/developers/cli/authenticate-with-the-cli/).
 
 <!-- usage -->
+
 ```sh-session
 $ npm install -g @contentstack/apps-cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/apps-cli/1.6.0 darwin-arm64 node-v22.13.1
+@contentstack/apps-cli/1.6.1 darwin-arm64 node-v22.13.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
 ...
 ```
+
 <!-- usagestop -->
 
 # Commands
 
 <!-- commands -->
-* [`csdx app`](#csdx-app)
-* [`csdx app:create`](#csdx-appcreate)
-* [`csdx app:delete`](#csdx-appdelete)
-* [`csdx app:deploy`](#csdx-appdeploy)
-* [`csdx app:get`](#csdx-appget)
-* [`csdx app:install`](#csdx-appinstall)
-* [`csdx app:reinstall`](#csdx-appreinstall)
-* [`csdx app:uninstall`](#csdx-appuninstall)
-* [`csdx app:update`](#csdx-appupdate)
+
+- [`csdx app`](#csdx-app)
+- [`csdx app:create`](#csdx-appcreate)
+- [`csdx app:delete`](#csdx-appdelete)
+- [`csdx app:deploy`](#csdx-appdeploy)
+- [`csdx app:get`](#csdx-appget)
+- [`csdx app:install`](#csdx-appinstall)
+- [`csdx app:reinstall`](#csdx-appreinstall)
+- [`csdx app:uninstall`](#csdx-appuninstall)
+- [`csdx app:update`](#csdx-appupdate)
 
 ## `csdx app`
 
@@ -307,4 +310,5 @@ EXAMPLES
 ```
 
 _See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/update.ts)_
+
 <!-- commandsstop -->
diff --git a/test/unit/commands/app/create.test.ts b/test/unit/commands/app/create.test.ts
@@ -15,6 +15,7 @@ import manifestData from "../../../../src/config/manifest.json";
 import orgManifestData from "../../../unit/config/org_manifest.json";
 import { getDeveloperHubUrl } from "../../../../src/util/inquirer";
 import axios from "axios";
+import { stubAuthentication } from "../../helpers/auth-stub-helper";
 
 const { origin, pathname } = new URL(config.appBoilerplateGithubUrl);
 const zipPath = join(process.cwd(), "test", "unit", "mock", "boilerplate.zip");
@@ -36,30 +37,8 @@ describe("app:create", () => {
     sandbox = sinon.createSandbox();
     axios.defaults.adapter = "http";
 
-    // Stub authentication
-    sandbox.stub(configHandler, "get").callsFake((key: string) => {
-      if (key === "region") {
-        return {
-          cma: "https://api.contentstack.io",
-          cda: "https://cdn.contentstack.io",
-          region: "us",
-        };
-      }
-      if (key === "authtoken") {
-        return "mock-auth-token";
-      }
-      if (key === "authorisationType") {
-        return "BASIC";
-      }
-      return undefined;
-    });
-
-    sandbox
-      .stub(
-        require("../../../../src/base-command").BaseCommand.prototype,
-        "validateRegionAndAuth"
-      )
-      .callsFake(() => {});
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
 
     writeStreamMock = new MockWriteStream();
     sandbox.stub(fs, "renameSync").callsFake(() => {});
diff --git a/test/unit/commands/app/delete.test.ts b/test/unit/commands/app/delete.test.ts
@@ -6,6 +6,7 @@ import * as mock from "../../mock/common.mock.json";
 import messages, { $t } from "../../../../src/messages";
 import { getDeveloperHubUrl } from "../../../../src/util/inquirer";
 import nock from "nock";
+import { stubAuthentication } from "../../helpers/auth-stub-helper";
 
 const region: { cma: string; name: string; cda: string } =
   configHandler.get("region");
@@ -16,30 +17,8 @@ describe("app:delete", () => {
   beforeEach(() => {
     sandbox = sinon.createSandbox();
 
-    // Stub authentication
-    sandbox.stub(configHandler, "get").callsFake((key: string) => {
-      if (key === "region") {
-        return {
-          cma: "https://api.contentstack.io",
-          cda: "https://cdn.contentstack.io",
-          region: "us",
-        };
-      }
-      if (key === "authtoken") {
-        return "mock-auth-token";
-      }
-      if (key === "authorisationType") {
-        return "BASIC";
-      }
-      return undefined;
-    });
-
-    sandbox
-      .stub(
-        require("../../../../src/base-command").BaseCommand.prototype,
-        "validateRegionAndAuth"
-      )
-      .callsFake(() => {});
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
 
     nock(region.cma)
       .get("/v3/organizations?limit=100&asc=name&include_count=true&skip=0")
diff --git a/test/unit/commands/app/deploy.test.ts b/test/unit/commands/app/deploy.test.ts
@@ -6,6 +6,7 @@ import messages, { $t } from "../../../../src/messages";
 import * as mock from "../../mock/common.mock.json";
 import { getDeveloperHubUrl } from "../../../../src/util/inquirer";
 import sinon from "sinon";
+import { stubAuthentication } from "../../helpers/auth-stub-helper";
 
 const region = configHandler.get("region");
 const developerHubBaseUrl = getDeveloperHubUrl();
@@ -16,30 +17,8 @@ describe("app:deploy", () => {
   beforeEach(() => {
     sandbox = sinon.createSandbox();
 
-    // Stub authentication
-    sandbox.stub(configHandler, "get").callsFake((key: string) => {
-      if (key === "region") {
-        return {
-          cma: "https://api.contentstack.io",
-          cda: "https://cdn.contentstack.io",
-          region: "us",
-        };
-      }
-      if (key === "authtoken") {
-        return "mock-auth-token";
-      }
-      if (key === "authorisationType") {
-        return "BASIC";
-      }
-      return undefined;
-    });
-
-    sandbox
-      .stub(
-        require("../../../../src/base-command").BaseCommand.prototype,
-        "validateRegionAndAuth"
-      )
-      .callsFake(() => {});
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
 
     sandbox.stub(cliux, "loader").callsFake(() => {});
     sandbox.stub(cliux, "inquire").callsFake((prompt: any) => {
diff --git a/test/unit/commands/app/get.test.ts b/test/unit/commands/app/get.test.ts
@@ -11,6 +11,7 @@ import * as mock from "../../mock/common.mock.json";
 import manifestData from "../../../../src/config/manifest.json";
 import { getDeveloperHubUrl } from "../../../../src/util/inquirer";
 import config from "../../../../src/config";
+import { stubAuthentication } from "../../helpers/auth-stub-helper";
 
 const region = configHandler.get("region");
 const developerHubBaseUrl = getDeveloperHubUrl();
@@ -21,30 +22,8 @@ describe("app:get", () => {
   beforeEach(() => {
     sandbox = sinon.createSandbox();
 
-    // Stub authentication
-    sandbox.stub(configHandler, "get").callsFake((key: string) => {
-      if (key === "region") {
-        return {
-          cma: "https://api.contentstack.io",
-          cda: "https://cdn.contentstack.io",
-          region: "us",
-        };
-      }
-      if (key === "authtoken") {
-        return "mock-auth-token";
-      }
-      if (key === "authorisationType") {
-        return "BASIC";
-      }
-      return undefined;
-    });
-
-    sandbox
-      .stub(
-        require("../../../../src/base-command").BaseCommand.prototype,
-        "validateRegionAndAuth"
-      )
-      .callsFake(() => {});
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
 
     sandbox.stub(cliux, "loader").callsFake(() => {});
     sandbox.stub(fs, "writeFileSync").callsFake(() => {});
diff --git a/test/unit/commands/app/install.test.ts b/test/unit/commands/app/install.test.ts
@@ -7,6 +7,7 @@ import messages from "../../../../src/messages";
 import * as mock from "../../mock/common.mock.json";
 import { getDeveloperHubUrl } from "../../../../src/util/inquirer";
 import axios from "axios";
+import { stubAuthentication } from "../../helpers/auth-stub-helper";
 
 const region = configHandler.get("region");
 const developerHubBaseUrl = getDeveloperHubUrl();
@@ -18,30 +19,8 @@ describe("app:install", () => {
     sandbox = sinon.createSandbox();
     axios.defaults.adapter = "http";
 
-    // Stub authentication
-    sandbox.stub(configHandler, "get").callsFake((key: string) => {
-      if (key === "region") {
-        return {
-          cma: "https://api.contentstack.io",
-          cda: "https://cdn.contentstack.io",
-          region: "us",
-        };
-      }
-      if (key === "authtoken") {
-        return "mock-auth-token";
-      }
-      if (key === "authorisationType") {
-        return "BASIC";
-      }
-      return undefined;
-    });
-
-    sandbox
-      .stub(
-        require("../../../../src/base-command").BaseCommand.prototype,
-        "validateRegionAndAuth"
-      )
-      .callsFake(() => {});
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
 
     sandbox.stub(cliux, "loader").callsFake(() => {});
 
diff --git a/test/unit/commands/app/reinstall.test.ts b/test/unit/commands/app/reinstall.test.ts
@@ -6,6 +6,7 @@ import { cliux, configHandler } from "@contentstack/cli-utilities";
 import messages, { $t } from "../../../../src/messages";
 import * as mock from "../../mock/common.mock.json";
 import { getDeveloperHubUrl } from "../../../../src/util/inquirer";
+import { stubAuthentication } from "../../helpers/auth-stub-helper";
 
 const region = configHandler.get("region");
 const developerHubBaseUrl = getDeveloperHubUrl();
@@ -16,30 +17,8 @@ describe("app:reinstall", () => {
   beforeEach(() => {
     sandbox = sinon.createSandbox();
 
-    // Stub authentication
-    sandbox.stub(configHandler, "get").callsFake((key: string) => {
-      if (key === "region") {
-        return {
-          cma: "https://api.contentstack.io",
-          cda: "https://cdn.contentstack.io",
-          region: "us",
-        };
-      }
-      if (key === "authtoken") {
-        return "mock-auth-token";
-      }
-      if (key === "authorisationType") {
-        return "BASIC";
-      }
-      return undefined;
-    });
-
-    sandbox
-      .stub(
-        require("../../../../src/base-command").BaseCommand.prototype,
-        "validateRegionAndAuth"
-      )
-      .callsFake(() => {});
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
 
     sandbox.stub(cliux, "loader").callsFake(() => {});
 
diff --git a/test/unit/commands/app/uninstall.test.ts b/test/unit/commands/app/uninstall.test.ts
@@ -6,6 +6,7 @@ import { cliux, configHandler } from "@contentstack/cli-utilities";
 import messages, { $t } from "../../../../src/messages";
 import { getDeveloperHubUrl } from "../../../../src/util/inquirer";
 import * as mock from "../../mock/common.mock.json";
+import { stubAuthentication } from "../../helpers/auth-stub-helper";
 
 const region = configHandler.get("region");
 const developerHubBaseUrl = getDeveloperHubUrl();
@@ -16,30 +17,8 @@ describe("app:uninstall", () => {
   beforeEach(() => {
     sandbox = sinon.createSandbox();
 
-    // Stub authentication
-    sandbox.stub(configHandler, "get").callsFake((key: string) => {
-      if (key === "region") {
-        return {
-          cma: "https://api.contentstack.io",
-          cda: "https://cdn.contentstack.io",
-          region: "us",
-        };
-      }
-      if (key === "authtoken") {
-        return "mock-auth-token";
-      }
-      if (key === "authorisationType") {
-        return "BASIC";
-      }
-      return undefined;
-    });
-
-    sandbox
-      .stub(
-        require("../../../../src/base-command").BaseCommand.prototype,
-        "validateRegionAndAuth"
-      )
-      .callsFake(() => {});
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
 
     sandbox.stub(cliux, "loader").callsFake(() => {});
 
diff --git a/test/unit/commands/app/update.test.ts b/test/unit/commands/app/update.test.ts
@@ -9,6 +9,7 @@ import { getDeveloperHubUrl } from "../../../../src/util/inquirer";
 import sinon from "sinon";
 import nock from "nock";
 import fs from "fs";
+import { stubAuthentication } from "../../helpers/auth-stub-helper";
 
 const region = configHandler.get("region");
 const developerHubBaseUrl = getDeveloperHubUrl();
@@ -19,31 +20,8 @@ describe("app:update", () => {
   beforeEach(() => {
     sandbox = sinon.createSandbox();
 
-    // Stub authentication
-    sandbox.stub(configHandler, "get").callsFake((key: string) => {
-      if (key === "region") {
-        return {
-          cma: "https://api.contentstack.io",
-          cda: "https://cdn.contentstack.io",
-          region: "us",
-        };
-      }
-      if (key === "authtoken") {
-        return "mock-auth-token";
-      }
-      if (key === "authorisationType") {
-        return "BASIC";
-      }
-      return undefined;
-    });
-
-    // Stub the validateRegionAndAuth method to skip authentication check
-    sandbox
-      .stub(
-        require("../../../../src/base-command").BaseCommand.prototype,
-        "validateRegionAndAuth"
-      )
-      .callsFake(() => {});
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
 
     nock(region.cma)
       .get("/v3/organizations?limit=100&asc=name&include_count=true&skip=0")
diff --git a/test/unit/helpers/auth-stub-helper.ts b/test/unit/helpers/auth-stub-helper.ts
