Merge pull request #378 from contentstack/enhancement/DX-3285

update testcases and add GH pipeline for it

Author: naman-contentstack

.eslintrc

@@ -35,8 +35,8 @@
       "id-match": "error",
       "no-eval": "error",
       "no-var": "error",
-      "@typescript-eslint/no-explicit-any": "warn",
-      "@typescript-eslint/no-require-imports": "warn",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-require-imports": "off",
       "prefer-const": "error"
   }
 }

.github/workflows/unit-test.yml

@@ -1,28 +1,28 @@
-# name: Run Unit Tests
+name: Run Unit Tests
 
-# on:
-#   pull_request:
-#     types: [opened, synchronize, reopened]
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
 
-# jobs:
-#   run-tests:
-#     runs-on: ubuntu-latest
-#     steps:
-#       - name: Checkout code
-#         uses: actions/checkout@v4
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-#       - name: Set up Node.js
-#         uses: actions/setup-node@v4
-#         with:
-#           node-version: "22.x"
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22.x"
 
-#       - name: Install dependencies
-#         run: |
-#           npm install
-#           npm install -g @contentstack/cli
+      - name: Install dependencies
+        run: |
+          npm install
+          npm install -g @contentstack/cli
 
-#       - name: Configure Region
-#         run: csdx config:set:region AWS-NA
+      - name: Configure Region
+        run: csdx config:set:region AWS-NA
 
-#       - name: Run tests
-#         run: npm run test
+      - name: Run tests
+        run: npm run test

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.5.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`
 
@@ -71,7 +74,7 @@ EXAMPLES
   $ csdx app:update
 ```
 
-_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/index.ts)_
+_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/index.ts)_
 
 ## `csdx app:create`
 
@@ -111,7 +114,7 @@ EXAMPLES
   $ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplate <Ecommerce App Boilerplate>
 ```
 
-_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/create.ts)_
+_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/create.ts)_
 
 ## `csdx app:delete`
 
@@ -136,7 +139,7 @@ EXAMPLES
   $ csdx app:delete --app-uid <value> --org <value> -d ./boilerplate
 ```
 
-_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/delete.ts)_
+_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/delete.ts)_
 
 ## `csdx app:deploy`
 
@@ -174,7 +177,7 @@ EXAMPLES
   $ csdx app:deploy --org <UID> --app-uid <APP-UID-1> --hosting-type <hosting-with-launch> --launch-project <new> --config <config-path>
 ```
 
-_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/deploy.ts)_
+_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/deploy.ts)_
 
 ## `csdx app:get`
 
@@ -204,7 +207,7 @@ EXAMPLES
   $ csdx app:get --org <value> --app-uid <value> --app-type organization
 ```
 
-_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/get.ts)_
+_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/get.ts)_
 
 ## `csdx app:install`
 
@@ -230,7 +233,7 @@ EXAMPLES
   $ csdx app:install --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
 ```
 
-_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/install.ts)_
+_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/install.ts)_
 
 ## `csdx app:reinstall`
 
@@ -256,7 +259,7 @@ EXAMPLES
   $ csdx app:reinstall --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
 ```
 
-_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/reinstall.ts)_
+_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/reinstall.ts)_
 
 ## `csdx app:uninstall`
 
@@ -283,7 +286,7 @@ EXAMPLES
   $ csdx app:uninstall --org <UID> --app-uid <APP-UID-1> --installation-uid <INSTALLATION-UID-1>
 ```
 
-_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/uninstall.ts)_
+_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/uninstall.ts)_
 
 ## `csdx app:update`
 
@@ -306,5 +309,6 @@ EXAMPLES
   $ csdx app:update --app-manifest ./boilerplate/manifest.json
 ```
 
-_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/update.ts)_
+_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/update.ts)_
+
 <!-- commandsstop -->

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/apps-cli",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "App ClI",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/contentstack-apps-cli",

package.json

@@ -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,6 +37,9 @@ describe("app:create", () => {
     sandbox = sinon.createSandbox();
     axios.defaults.adapter = "http";
 
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
+
     writeStreamMock = new MockWriteStream();
     sandbox.stub(fs, "renameSync").callsFake(() => {});
     sandbox.stub(fs, "createWriteStream").callsFake(() => writeStreamMock);

test/unit/commands/app/create.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");
@@ -15,6 +16,10 @@ describe("app:delete", () => {
   let sandbox: sinon.SinonSandbox;
   beforeEach(() => {
     sandbox = sinon.createSandbox();
+
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
+
     nock(region.cma)
       .get("/v3/organizations?limit=100&asc=name&include_count=true&skip=0")
       .reply(200, { organizations: mock.organizations });

test/unit/commands/app/delete.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,18 +17,8 @@ describe("app:deploy", () => {
   beforeEach(() => {
     sandbox = sinon.createSandbox();
 
-    // Stub authentication
-    sandbox.stub(configHandler, "get").returns({
-      cma: "https://api.contentstack.io",
-      cda: "https://cdn.contentstack.io",
-      region: "us",
-    });
-    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) => {

test/unit/commands/app/deploy.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();
@@ -20,6 +21,10 @@ describe("app:get", () => {
 
   beforeEach(() => {
     sandbox = sinon.createSandbox();
+
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
+
     sandbox.stub(cliux, "loader").callsFake(() => {});
     sandbox.stub(fs, "writeFileSync").callsFake(() => {});
   });

test/unit/commands/app/get.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,6 +19,9 @@ describe("app:install", () => {
     sandbox = sinon.createSandbox();
     axios.defaults.adapter = "http";
 
+    // Stub authentication using shared helper
+    stubAuthentication(sandbox);
+
     sandbox.stub(cliux, "loader").callsFake(() => {});
 
     nock(region.cma)