Merge pull request #2377 from zowe/v2/port-misc-fixes

v2: Port profiles and import fixes

.eslintrc.js

@@ -25,6 +25,7 @@ module.exports = {
             ],
             "rules": {
                 "@typescript-eslint/no-magic-numbers": "off",
+                "@typescript-eslint/no-restricted-imports": "off",
                 "jest/expect-expect": ["warn", {
                     "assertFunctionNames": ["expect*", "**.*expect*"]
                 }],
@@ -63,6 +64,11 @@ module.exports = {
             "ignoreEnums": true,
             "ignoreReadonlyClassProperties": true
         }],
+        "@typescript-eslint/no-restricted-imports": ["error", {
+            "patterns": [{
+                "group": ["**/../lib", "**/../src"]
+            }]
+        }],
         "@typescript-eslint/no-unused-vars": "off",
         "@typescript-eslint/no-var-requires": "off",
         "@typescript-eslint/semi": "warn",

packages/imperative/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- BugFix: Fixed an issue where the `ProfileInfo.profileManagerWillLoad` method failed if profiles were not yet read from disk. [#2284](https://github.com/zowe/zowe-cli/issues/2284)
+- BugFix: Fixed an issue where the `ProfileInfo.updateKnownProperty` method could rewrite team config file to disk without any changes when storing secure value. [#2324](https://github.com/zowe/zowe-cli/issues/2324)
+
 ## `5.27.4`
 
 - BugFix: Updated the `cross-spawn` dependency for technical currency. [#2374](https://github.com/zowe/zowe-cli/pull/2374)

packages/imperative/src/cmd/src/doc/ICommandDefinition.ts

@@ -14,7 +14,7 @@ import { IChainedHandlerEntry } from "./handler/IChainedHandlerEntry";
 import { ICommandOptionDefinition } from "./option/ICommandOptionDefinition";
 import { ICommandPositionalDefinition } from "./option/ICommandPositionalDefinition";
 import { ICommandDefinitionPassOn } from "./ICommandDefinitionPassOn";
-import { ICommandProfile } from "../../src/doc/profiles/definition/ICommandProfile";
+import { ICommandProfile } from "../doc/profiles/definition/ICommandProfile";
 /**
  * Command Segment type - either "group" or "command".
  *

packages/imperative/src/cmd/src/doc/handler/ICommandHandlerResponseValidator.ts

@@ -9,7 +9,7 @@
 *
 */
 
-import { ICommandResponse } from "../../../src/doc/response/response/ICommandResponse";
+import { ICommandResponse } from "../../doc/response/response/ICommandResponse";
 import { CommandResponse } from "../../response/CommandResponse";
 
 export interface ICommandHandlerResponseValidator {

packages/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts

@@ -12,7 +12,7 @@
 import { ICommandDefinition } from "../ICommandDefinition";
 import { IHelpGenerator } from "../../help/doc/IHelpGenerator";
 import { IProfileManagerFactory } from "../../../../profiles";
-import { ICommandProfileTypeConfiguration } from "../../../src/doc/profiles/definition/ICommandProfileTypeConfiguration";
+import { ICommandProfileTypeConfiguration } from "../../doc/profiles/definition/ICommandProfileTypeConfiguration";
 import { Config } from "../../../../config";
 import { IDaemonContext } from "../../../../imperative/src/doc/IDaemonContext";
 

packages/imperative/src/cmd/src/doc/response/api/handler/IHandlerFormatOutputApi.ts

@@ -9,7 +9,7 @@
 *
 */
 
-import { ICommandOutputFormat } from "../../../../../src/doc/response/response/ICommandOutputFormat";
+import { ICommandOutputFormat } from "../../../../doc/response/response/ICommandOutputFormat";
 
 export interface IHandlerFormatOutputApi {
     output: (format: ICommandOutputFormat) => void;

packages/imperative/src/cmd/src/doc/response/response/ICommandPrepared.ts

@@ -9,8 +9,8 @@
 *
 */
 
-import { CommandProfiles } from "../../../../src/profiles/CommandProfiles";
-import { ICommandArguments } from "../../../../src/doc/args/ICommandArguments";
+import { CommandProfiles } from "../../../profiles/CommandProfiles";
+import { ICommandArguments } from "../../../doc/args/ICommandArguments";
 /**
  * Command Processor prepare response.
  * @export

packages/imperative/src/cmd/src/help/DefaultHelpGenerator.ts

@@ -17,7 +17,7 @@ import { CommandUtils } from "../utils/CommandUtils";
 import { ImperativeError } from "../../../error";
 import { IHelpGeneratorParms } from "./doc/IHelpGeneratorParms";
 import { IHelpGeneratorFactoryParms } from "./doc/IHelpGeneratorFactoryParms";
-import { compareCommands, ICommandDefinition } from "../../src/doc/ICommandDefinition";
+import { compareCommands, ICommandDefinition } from "../doc/ICommandDefinition";
 import stripAnsi = require("strip-ansi");
 
 /**

packages/imperative/src/cmd/src/profiles/CliProfileManager.ts

@@ -27,7 +27,7 @@ import { ImperativeError } from "../../../error";
 import { Arguments } from "yargs";
 import { CommandResponse } from "../response/CommandResponse";
 import { ICommandHandlerRequire } from "../doc/handler/ICommandHandlerRequire";
-import { ICommandHandler } from "../../src/doc/handler/ICommandHandler";
+import { ICommandHandler } from "../doc/handler/ICommandHandler";
 import { ICommandProfileTypeConfiguration } from "../doc/profiles/definition/ICommandProfileTypeConfiguration";
 import { CommandProfiles } from "./CommandProfiles";
 import { ICommandProfileProperty } from "../doc/profiles/definition/ICommandProfileProperty";

packages/imperative/src/cmd/src/response/CommandResponse.ts

@@ -24,7 +24,7 @@ import { ImperativeExpect } from "../../../expect";
 import { IHandlerFormatOutputApi } from "../doc/response/api/handler/IHandlerFormatOutputApi";
 import { ICommandOutputFormat, OUTPUT_FORMAT } from "../doc/response/response/ICommandOutputFormat";
 import { Arguments } from "yargs";
-import { ICommandDefinition } from "../../src/doc/ICommandDefinition";
+import { ICommandDefinition } from "../doc/ICommandDefinition";
 import { OptionConstants } from "../constants/OptionConstants";
 import { inspect } from "util";
 import * as DeepMerge from "deepmerge";

packages/imperative/src/cmd/src/yargs/AbstractCommandYargs.ts

@@ -23,7 +23,7 @@ import { IProfileManagerFactory } from "../../../profiles";
 import { ICommandProfileTypeConfiguration } from "../doc/profiles/definition/ICommandProfileTypeConfiguration";
 import { IHelpGeneratorFactory } from "../help/doc/IHelpGeneratorFactory";
 import { CommandResponse } from "../response/CommandResponse";
-import { ICommandResponse } from "../../src/doc/response/response/ICommandResponse";
+import { ICommandResponse } from "../doc/response/response/ICommandResponse";
 import { ICommandExampleDefinition } from "../..";
 import { ImperativeConfig } from "../../../utilities/src/ImperativeConfig";
 

packages/imperative/src/cmd/src/yargs/CommandYargs.ts

@@ -14,11 +14,11 @@ import { inspect } from "util";
 import { Constants } from "../../../constants";
 import { IYargsResponse } from "./doc/IYargsResponse";
 import { AbstractCommandYargs, YargsCommandCompleted } from "./AbstractCommandYargs";
-import { ICommandOptionDefinition } from "../../src/doc/option/ICommandOptionDefinition";
+import { ICommandOptionDefinition } from "../doc/option/ICommandOptionDefinition";
 import { ICommandDefinition } from "../doc/ICommandDefinition";
 import { CommandProcessor } from "../CommandProcessor";
-import { ICommandResponse } from "../../src/doc/response/response/ICommandResponse";
-import { CommandResponse } from "../../src/response/CommandResponse";
+import { ICommandResponse } from "../doc/response/response/ICommandResponse";
+import { CommandResponse } from "../response/CommandResponse";
 import { ImperativeConfig } from "../../../utilities";
 
 /**

packages/imperative/src/cmd/src/yargs/doc/IYargsResponse.ts

@@ -9,7 +9,7 @@
 *
 */
 
-import { ICommandResponse } from "../../../src/doc/response/response/ICommandResponse";
+import { ICommandResponse } from "../../doc/response/response/ICommandResponse";
 /**
  * Indicates the action performed.
  */

packages/imperative/src/config/__tests__/ProfileInfo.TeamConfig.unit.test.ts

@@ -303,8 +303,8 @@ describe("TeamConfig ProfileInfo tests", () => {
     describe("profileManagerWillLoad", () => {
         it("should return false if secure credentials fail to load", async () => {
             const profInfo = createNewProfInfo(teamProjDir);
-            jest.spyOn((profInfo as any).mCredentials, "isSecured", "get").mockReturnValueOnce(true);
-            jest.spyOn((profInfo as any).mCredentials, "loadManager").mockImplementationOnce(async () => {
+            jest.spyOn((profInfo as any).mCredentials, "isCredentialManagerInAppSettings").mockReturnValueOnce(true);
+            jest.spyOn((profInfo as any).mCredentials, "activateCredMgrOverride").mockImplementationOnce(async () => {
                 throw new Error("bad credential manager");
             });
 
@@ -319,10 +319,10 @@ describe("TeamConfig ProfileInfo tests", () => {
             expect(response).toEqual(true);
         });
 
-        it("should return true if credentials are not secure", async () => {
+        it("should return true if there is no credential manager", async () => {
             // ensure that we are not in the team project directory
             const profInfo = createNewProfInfo(origDir);
-            (profInfo as any).mCredentials = {isSecured: false};
+            jest.spyOn((profInfo as any).mCredentials, "isCredentialManagerInAppSettings").mockReturnValueOnce(false);
             const response = await profInfo.profileManagerWillLoad();
             expect(response).toEqual(true);
         });
@@ -1232,7 +1232,7 @@ describe("TeamConfig ProfileInfo tests", () => {
     });
 
     describe("updateKnownProperty", () => {
-        it("should throw and error if the property location type is invalid", async () => {
+        it("should throw an error if the property location type is invalid", async () => {
             const profInfo = createNewProfInfo(teamProjDir);
             await profInfo.readProfilesFromDisk();
             let caughtError;
@@ -1271,6 +1271,7 @@ describe("TeamConfig ProfileInfo tests", () => {
             const profInfo = createNewProfInfo(teamProjDir);
             await profInfo.readProfilesFromDisk();
             const jsonPathMatchesSpy = jest.spyOn(ConfigUtils, "jsonPathMatches");
+            const configSaveSpy = jest.spyOn(profInfo.getTeamConfig(), "save");
 
             const prof = profInfo.mergeArgsForProfile(profInfo.getAllProfiles("dummy")[0]);
             const ret = await profInfo.updateKnownProperty({ mergedArgs: prof, property: "host", value: "example.com" });
@@ -1279,6 +1280,26 @@ describe("TeamConfig ProfileInfo tests", () => {
             expect(newHost).toEqual("example.com");
             expect(ret).toBe(true);
             expect(jsonPathMatchesSpy).toHaveBeenCalled(); // Verify that profile names are matched correctly
+            expect(configSaveSpy).toHaveBeenCalled();
+        });
+
+        it("should update the given property in the vault and return true", async () => {
+            const profInfo = createNewProfInfo(teamProjDir);
+            await profInfo.readProfilesFromDisk();
+            const jsonPathMatchesSpy = jest.spyOn(ConfigUtils, "jsonPathMatches");
+            jest.spyOn(profInfo.getTeamConfig().api.secure, "secureFields").mockReturnValue(["profiles.LPAR4.properties.host"]);
+            const configSaveSpy = jest.spyOn(profInfo.getTeamConfig(), "save");
+            const configSecureSaveSpy = jest.spyOn(profInfo.getTeamConfig().api.secure, "save");
+
+            const prof = profInfo.mergeArgsForProfile(profInfo.getAllProfiles("dummy")[0]);
+            const ret = await profInfo.updateKnownProperty({ mergedArgs: prof, property: "host", value: "example.com", setSecure: true });
+            const newHost = profInfo.getTeamConfig().api.layers.get().properties.profiles.LPAR4.properties.host;
+
+            expect(newHost).toEqual("example.com");
+            expect(ret).toBe(true);
+            expect(jsonPathMatchesSpy).toHaveBeenCalled(); // Verify that profile names are matched correctly
+            expect(configSaveSpy).not.toHaveBeenCalled();
+            expect(configSecureSaveSpy).toHaveBeenCalled();
         });
 
         it("should remove the given property if the value specified if undefined", async () => {

packages/imperative/src/config/src/ProfileCredentials.ts

@@ -74,6 +74,25 @@ export class ProfileCredentials {
             throw new ImperativeError({ msg: "Secure credential storage is not enabled" });
         }
 
+        await this.activateCredMgrOverride();
+
+        if (this.mProfileInfo.usingTeamConfig) {
+            await this.mProfileInfo.getTeamConfig().api.secure.load({
+                load: (key: string): Promise<string> => {
+                    return CredentialManagerFactory.manager.load(key, true);
+                },
+                save: (key: string, value: any): Promise<void> => {
+                    return CredentialManagerFactory.manager.save(key, value);
+                }
+            });
+        }
+    }
+
+    /**
+     * Attempt to initialize `CredentialManagerFactory` with the specified override.
+     * @internal
+     */
+    public async activateCredMgrOverride(): Promise<void> {
         if (!CredentialManagerFactory.initialized) {
             try {
                 // TODO? Make CredentialManagerFactory.initialize params optional
@@ -86,17 +105,6 @@ export class ProfileCredentials {
                 });
             }
         }
-
-        if (this.mProfileInfo.usingTeamConfig) {
-            await this.mProfileInfo.getTeamConfig().api.secure.load({
-                load: ((key: string): Promise<string> => {
-                    return CredentialManagerFactory.manager.load(key, true);
-                }),
-                save: ((key: string, value: any): Promise<void> => {
-                    return CredentialManagerFactory.manager.save(key, value);
-                })
-            });
-        }
     }
 
     /**
@@ -112,8 +120,9 @@ export class ProfileCredentials {
     /**
      * Check whether a custom CredentialManager is defined in the Imperative
      * settings.json file.
+     * @internal
      */
-    private isCredentialManagerInAppSettings(): boolean {
+    public isCredentialManagerInAppSettings(): boolean {
         try {
             const fileName = path.join(ImperativeConfig.instance.cliHome, "settings", "imperative.json");
             let settings: any;

packages/imperative/src/config/src/ProfileInfo.ts

@@ -316,8 +316,13 @@ export class ProfileInfo {
                     this.getTeamConfig().api.layers.activate(osLoc.user, osLoc.global);
                 }
 
+                const updateVaultOnly = options.setSecure && this.getTeamConfig().api.secure.secureFields().includes(toUpdate.argLoc.jsonLoc);
                 this.getTeamConfig().set(toUpdate.argLoc.jsonLoc, options.value, { secure: options.setSecure });
-                await this.getTeamConfig().save(false);
+                if (!updateVaultOnly) {
+                    await this.getTeamConfig().save(false);
+                } else {
+                    await this.getTeamConfig().api.secure.save(false);
+                }
 
                 if (oldLayer) {
                     this.getTeamConfig().api.layers.activate(oldLayer.user, oldLayer.global);
@@ -1005,13 +1010,15 @@ export class ProfileInfo {
 
     //_________________________________________________________________________
     /**
-     * Function to ensure the credential manager will load successfully
-     * Returns true if it will load, or the credentials are not secured. Returns false if it will not load.
+     * Checks whether the credential manager will load successfully.
+     * @returns
+     *     True if it loaded successfully, or there is no credential manager
+     *     configured in Imperative settings.json
      */
     public async profileManagerWillLoad(): Promise<boolean> {
-        if (this.mCredentials.isSecured) {
+        if (this.mCredentials.isCredentialManagerInAppSettings()) {
             try {
-                await this.mCredentials.loadManager();
+                await this.mCredentials.activateCredMgrOverride();
                 return true;
             } catch (err) {
                 this.mImpLogger.warn("Failed to initialize secure credential manager: " + err.message);

packages/imperative/src/imperative/src/config/cmd/report-env/EnvItems.ts

@@ -69,8 +69,8 @@ function formatLogLevelMsg(logTypeName: string) {
 export const probTests: IProbTest[] = [
     {
         itemId: ItemId.NODEJS_VER,
-        probExpr: "semver.satisfies('{val}', '<18.x || 19.x || >=21.x')",
-        probMsg: "Only Node.js versions 18 and 20 are supported."
+        probExpr: "semver.satisfies('{val}', '<18.x || 19.x || 21.x || >=23.x')",
+        probMsg: "Only Node.js versions 18, 20, and 22 are supported."
     },
     {
         itemId: ItemId.NPM_VER,

packages/imperative/src/imperative/src/plugins/PluginManagementFacility.ts

@@ -9,8 +9,8 @@
 *
 */
 
-import { IImperativeConfig } from "../../src/doc/IImperativeConfig";
-import { UpdateImpConfig } from "../../src/UpdateImpConfig";
+import { IImperativeConfig } from "../doc/IImperativeConfig";
+import { UpdateImpConfig } from "../UpdateImpConfig";
 import { isAbsolute, join } from "path";
 import { ImperativeConfig, JsUtils } from "../../../utilities";
 import { Logger } from "../../../logger";

packages/zostso/src/doc/IIssueResponse.ts

@@ -33,7 +33,7 @@ export interface IIssueResponse {
     startResponse: IStartStopResponses;
 
     /**
-     * Indicates if started TSO containes "READY " message
+     * Indicates if started TSO contains "READY" message
      * @type {boolean}
      * @memberof IIssueResponse
      */