Generate different base profile names for global and project configs

__tests__/__integration__/__snapshots__/imperative.secure.integration.test.ts.snap

@@ -2,6 +2,7 @@
 
 exports[`Imperative Secure Tests imperative-test-cli config profiles should list profiles 1`] = `
 "secured
-base
+project_base
+global_base
 "
 `;

packages/cli/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the Zowe CLI package will be documented in this file.
 
+## Recent Changes
+
+- Enhancement: The 'zowe config auto-init' command now generates a base profile name of 'global_base' or 'project_base', depending on whether a global or project configuration file is being generated. Related to Zowe Explorer issue https://github.com/zowe/zowe-explorer-vscode/issues/2682.
+
 ## `8.0.0-next.202407021516`
 
 - BugFix: Updated dependencies for technical currency [#2188](https://github.com/zowe/zowe-cli/pull/2188)

packages/cli/__tests__/config/auto-init/__system__/cli.config.auto-init.system.test.ts

@@ -93,7 +93,7 @@ describe("config auto-init without profile", () => {
         let config = fs.readFileSync(path.join(TEST_ENVIRONMENT.workingDir, "zowe.config.json")).toString();
         // Typecasting because of this issue: https://github.com/kaelzhang/node-comment-json/issues/42
         const configJson = JSONC.parse(config) as any;
-        configJson.profiles.base.properties = {};
+        configJson.profiles.project_base.properties = {};
         config = JSONC.stringify(configJson, null, 4);
         fs.writeFileSync(path.join(TEST_ENVIRONMENT.workingDir, "zowe.config.json"), config);
 
@@ -239,8 +239,8 @@ describe("config auto-init without profile and with certificates", () => {
             let config = fs.readFileSync(path.join(TEST_ENVIRONMENT.workingDir, "zowe.config.json")).toString();
             // Typecasting because of this issue: https://github.com/kaelzhang/node-comment-json/issues/42
             const configJson = JSONC.parse(config) as any;
-            configJson.profiles.base.properties = {};
-            configJson.profiles.base.secure = [];
+            configJson.profiles.project_base.properties = {};
+            configJson.profiles.project_base.secure = [];
             config = JSONC.stringify(configJson, null, 4);
             fs.writeFileSync(path.join(TEST_ENVIRONMENT.workingDir, "zowe.config.json"), config);
 

packages/cli/__tests__/config/auto-init/__unit__/ApimlAutoInitHandler.unit.test.ts

@@ -86,16 +86,17 @@ describe("ApimlAutoInitHandler", () => {
             }, {
                 arguments: {
                     $0: "fake",
-                    _: ["fake"]
+                    _: ["fake"],
                 }
             });
         expect(mockGetPluginApimlConfigs).toHaveBeenCalledTimes(1);
         expect(mockGetServicesByConfig).toHaveBeenCalledTimes(1);
         expect(mockConvertApimlProfileInfoToProfileConfig).toHaveBeenCalledTimes(1);
         expect(mockLogin).toHaveBeenCalledTimes(1);
-        expect(response.profiles.base.secure).toContain("tokenValue");
-        expect(response.profiles.base.properties.tokenType).toEqual(SessConstants.TOKEN_TYPE_APIML);
-        expect(response.profiles.base.properties.tokenValue).toEqual("fakeToken");
+        const baseProfName = "project_base";
+        expect(response.profiles[baseProfName].secure).toContain("tokenValue");
+        expect(response.profiles[baseProfName].properties.tokenType).toEqual(SessConstants.TOKEN_TYPE_APIML);
+        expect(response.profiles[baseProfName].properties.tokenValue).toEqual("fakeToken");
     });
 
     it("should not have changed - tokenType and tokenValue", async () => {
@@ -141,9 +142,11 @@ describe("ApimlAutoInitHandler", () => {
         expect(mockGetServicesByConfig).toHaveBeenCalledTimes(1);
         expect(mockConvertApimlProfileInfoToProfileConfig).toHaveBeenCalledTimes(1);
         expect(mockLogin).toHaveBeenCalledTimes(0);
-        expect(response.profiles.base.secure).toContain("tokenValue");
-        expect(response.profiles.base.properties.tokenType).toEqual(SessConstants.TOKEN_TYPE_APIML);
-        expect(response.profiles.base.properties.tokenValue).toEqual("fakeToken");
+
+        const baseProfName = "project_base";
+        expect(response.profiles[baseProfName].secure).toContain("tokenValue");
+        expect(response.profiles[baseProfName].properties.tokenType).toEqual(SessConstants.TOKEN_TYPE_APIML);
+        expect(response.profiles[baseProfName].properties.tokenValue).toEqual("fakeToken");
     });
 
     it("should not have changed - PEM Certificates", async () => {
@@ -190,9 +193,11 @@ describe("ApimlAutoInitHandler", () => {
         expect(mockGetServicesByConfig).toHaveBeenCalledTimes(1);
         expect(mockConvertApimlProfileInfoToProfileConfig).toHaveBeenCalledTimes(1);
         expect(mockLogin).toHaveBeenCalledTimes(1);
-        expect(response.profiles.base.secure).toContain("tokenValue");
-        expect(response.profiles.base.properties.tokenType).toEqual(SessConstants.TOKEN_TYPE_APIML);
-        expect(response.profiles.base.properties.tokenValue).toEqual("fakeToken");
+
+        const baseProfName = "project_base";
+        expect(response.profiles[baseProfName].secure).toContain("tokenValue");
+        expect(response.profiles[baseProfName].properties.tokenType).toEqual(SessConstants.TOKEN_TYPE_APIML);
+        expect(response.profiles[baseProfName].properties.tokenValue).toEqual("fakeToken");
     });
 
     it("should not have changed - user & password with existing base profile", async () => {
@@ -301,7 +306,7 @@ describe("ApimlAutoInitHandler", () => {
         expect(mockGetServicesByConfig).toHaveBeenCalledTimes(1);
         expect(mockConvertApimlProfileInfoToProfileConfig).toHaveBeenCalledTimes(1);
         expect(mockLogin).toHaveBeenCalledTimes(1);
-        expect(response.profiles.base.properties.rejectUnauthorized).toEqual(true);
+        expect(response.profiles["project_base"].properties.rejectUnauthorized).toEqual(true);
     });
 
     it("should not have changed - rejectUnauthorized flag false", async () => {
@@ -349,7 +354,7 @@ describe("ApimlAutoInitHandler", () => {
         expect(mockGetServicesByConfig).toHaveBeenCalledTimes(1);
         expect(mockConvertApimlProfileInfoToProfileConfig).toHaveBeenCalledTimes(1);
         expect(mockLogin).toHaveBeenCalledTimes(1);
-        expect(response.profiles.base.properties.rejectUnauthorized).toEqual(false);
+        expect(response.profiles["project_base"].properties.rejectUnauthorized).toEqual(false);
     });
 
     it("should not have changed - a condition that shouldn't ever happen", async () => {
@@ -393,9 +398,11 @@ describe("ApimlAutoInitHandler", () => {
         expect(mockGetServicesByConfig).toHaveBeenCalledTimes(1);
         expect(mockConvertApimlProfileInfoToProfileConfig).toHaveBeenCalledTimes(1);
         expect(mockLogin).toHaveBeenCalledTimes(0);
-        expect(response.profiles.base.secure).not.toContain("tokenValue");
-        expect(response.profiles.base.properties.tokenType).not.toBeDefined();
-        expect(response.profiles.base.properties.tokenValue).not.toBeDefined();
+
+        const baseProfName = "project_base";
+        expect(response.profiles[baseProfName].secure).not.toContain("tokenValue");
+        expect(response.profiles[baseProfName].properties.tokenType).not.toBeDefined();
+        expect(response.profiles[baseProfName].properties.tokenValue).not.toBeDefined();
     });
 
     it("should throw an error if an error 403 is experienced", async () => {

packages/cli/src/config/auto-init/ApimlAutoInitHandler.ts

@@ -15,7 +15,7 @@ import * as lodash from "lodash";
 import { ZosmfSession } from "@zowe/zosmf-for-zowe-sdk";
 import { BaseAutoInitHandler, AbstractSession, ICommandArguments, IConfig, IConfigProfile,
     ISession, IHandlerResponseApi, IHandlerParameters, SessConstants, ImperativeConfig,
-    ImperativeError, RestClientError, TextUtils, Config
+    ImperativeError, RestClientError, TextUtils, Config, ConfigUtils
 } from "@zowe/imperative";
 import { IApimlProfileInfo, IAutoInitRpt, IProfileRpt, Login, Services } from "@zowe/core-for-zowe-sdk";
 
@@ -108,9 +108,15 @@ export default class ApimlAutoInitHandler extends BaseAutoInitHandler {
         // Check to see if there is an active base profile to avoid creating a new one named "base"
         let activeBaseProfile = params.arguments[`${this.mProfileType}-profile`] || config.properties.defaults[this.mProfileType];
         let baseProfileCreated = false;
+
         // Populate the config with base profile information
         if (activeBaseProfile == null) {
-            profileConfig.profiles[this.mProfileType] = {
+
+            // Name our base profile differently in a global config vs a project config
+            const globalConfig: boolean = params.arguments?.globalConfig ? true : false;
+            activeBaseProfile = ConfigUtils.formGlobOrProjProfileNm(this.mProfileType, globalConfig);
+
+            profileConfig.profiles[activeBaseProfile] = {
                 type: this.mProfileType,
                 properties: {
                     host: session.ISession.hostname,
@@ -119,7 +125,6 @@ export default class ApimlAutoInitHandler extends BaseAutoInitHandler {
                 },
                 secure: []
             };
-            activeBaseProfile = this.mProfileType;
             baseProfileCreated = true;
         } else {
             const oldBaseProfile = this.getOldBaseProfileProps(config, activeBaseProfile);
@@ -149,7 +154,7 @@ export default class ApimlAutoInitHandler extends BaseAutoInitHandler {
 
         // Report whether or not we created a base profile in this auto-init execution
         this.mAutoInitReport.profileRpts.push({
-            profName: this.mProfileType,
+            profName: activeBaseProfile,
             profType: this.mProfileType,
             changeForProf: baseProfileCreated ? "created" : "modified",
             basePath: null,

packages/imperative/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- Enhancement: Added the function ConfigUtils.formGlobOrProjProfileNm and modified the function ConfigBuilder.build so that the 'zowe config init' command now generates a base profile name of 'global_base' or 'project_base', depending on whether a global or project configuration file is being generated. Related to Zowe Explorer issue https://github.com/zowe/zowe-explorer-vscode/issues/2682.
+
 ## `8.0.0-next.202407181255`
 
 - BugFix: Resolved bug that resulted in each plug-in to have identical public registries regardless of actual installation location/reference. [#2189](https://github.com/zowe/zowe-cli/pull/2189)

packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/config/__resources__/expectedObjects.ts

@@ -196,7 +196,7 @@ export const expectedSchemaObject = {
     }
 };
 
-export const expectedConfigObject: IConfig = {
+export const expectedGlobalConfigObject: IConfig = {
     $schema: "./imperative-test-cli.schema.json",
     profiles: {
         secured: {
@@ -206,31 +206,72 @@ export const expectedConfigObject: IConfig = {
             },
             secure: []
         },
-        base: {
+        global_base: {
             type: "base",
             properties: {},
             secure: ["secret"]
         },
     },
     defaults: {
         secured: "secured",
-        base: "base"
+        base: "global_base"
     },
     autoStore: true
 };
 
-export const expectedUserConfigObject: IConfig = {
+export const expectedGlobalUserConfigObject: IConfig = {
     $schema: "./imperative-test-cli.schema.json",
     profiles: {
         secured: {
             type: "secured",
             properties: {},
             secure: []
         },
-        base: {
+        global_base: {
             type: "base",
             properties: {},
+            secure: ["secret"]
+        },
+    },
+    defaults: {},
+    autoStore: true
+};
+
+export const expectedProjectConfigObject: IConfig = {
+    $schema: "./imperative-test-cli.schema.json",
+    profiles: {
+        secured: {
+            type: "secured",
+            properties: {
+                info: ""
+            },
+            secure: []
+        },
+        project_base: {
+            type: "base",
+            properties: {},
+            secure: ["secret"]
+        },
+    },
+    defaults: {
+        secured: "secured",
+        base: "project_base"
+    },
+    autoStore: true
+};
+
+export const expectedProjectUserConfigObject: IConfig = {
+    $schema: "./imperative-test-cli.schema.json",
+    profiles: {
+        secured: {
+            type: "secured",
+            properties: {},
             secure: []
+        },
+        project_base: {
+            type: "base",
+            properties: {},
+            secure: ["secret"]
         }
     },
     defaults: {},