Profile management

packages/zowe-explorer/CHANGELOG.md

@@ -7,6 +7,7 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen
 ### New features and enhancements
 
 - Added "Sort Jobs" feature for job nodes in Jobs tree view. [#2257](https://github.com/zowe/vscode-extension-for-zowe/issues/2251)
+- Introduce a new user interface for managing profiles via right-click action "Manage Profile".
 
 ### Bug fixes
 

packages/zowe-explorer/__tests__/__unit__/Profiles.extended.unit.test.ts

@@ -1376,7 +1376,7 @@ describe("Profiles Unit Tests - function checkCurrentProfile", () => {
     it("should throw an error if using token auth and is logged out or has expired token", async () => {
         const globalMocks = await createGlobalMocks();
         jest.spyOn(utils, "errorHandling").mockImplementation();
-        jest.spyOn(utils, "isUsingTokenAuth").mockResolvedValue(true);
+        jest.spyOn(utils.ProfilesUtils, "isUsingTokenAuth").mockResolvedValue(true);
         setupProfilesCheck(globalMocks);
         await expect(Profiles.getInstance().checkCurrentProfile(globalMocks.testProfile)).resolves.toEqual({ name: "sestest", status: "unverified" });
     });

packages/zowe-explorer/__tests__/__unit__/extension.unit.test.ts

@@ -244,6 +244,7 @@ async function createGlobalMocks() {
             "zowe.manualPoll",
             "zowe.updateSecureCredentials",
             "zowe.promptCredentials",
+            "zowe.profileManagement",
             "zowe.openRecentMember",
             "zowe.searchInAllLoadedItems",
             "zowe.ds.deleteProfile",

packages/zowe-explorer/__tests__/__unit__/utils/ProfileManagement.unit.test.ts

@@ -0,0 +1,100 @@
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+
+import { ZoweDatasetNode } from "../../../src/dataset/ZoweDatasetNode";
+import * as sharedMock from "../../../__mocks__/mockCreators/shared";
+import * as dsMock from "../../../__mocks__/mockCreators/datasets";
+import * as profUtils from "../../../src/utils/ProfilesUtils";
+import { ProfileManagement } from "../../../src/utils/ProfileManagement";
+import { Gui } from "@zowe/zowe-explorer-api";
+import { ZoweLogger } from "../../../src/utils/LoggerUtils";
+
+jest.mock("fs");
+jest.mock("vscode");
+jest.mock("@zowe/cli");
+
+describe("ProfileManagement unit tests", () => {
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+    function createGlobalMocks() {
+        const newMocks = {
+            mockSession: sharedMock.createISession(),
+            mockBasicAuthProfile: sharedMock.createValidIProfile(),
+            mockDsSessionNode: ZoweDatasetNode,
+            mockUpdateChosen: null as any,
+            mockAddBasicChosen: null as any,
+            mockLoginChosen: null as any,
+            mockLogoutChosen: null as any,
+            mockEditProfChosen: null as any,
+            mockCreateQp: jest.fn(),
+            debugLogSpy: null as any,
+        };
+        newMocks.mockDsSessionNode = dsMock.createDatasetSessionNode(newMocks.mockSession, newMocks.mockBasicAuthProfile) as any;
+        Object.defineProperty(newMocks.mockDsSessionNode, "getProfile", {
+            value: jest.fn().mockReturnValue(newMocks.mockBasicAuthProfile),
+            configurable: true,
+        });
+        newMocks.mockUpdateChosen = ProfileManagement.basicAuthQpItems[ProfileManagement.AuthQpLabels.update];
+        newMocks.mockAddBasicChosen = ProfileManagement.basicAuthQpItems[ProfileManagement.AuthQpLabels.add];
+        newMocks.mockLoginChosen = ProfileManagement.tokenAuthQpItems[ProfileManagement.AuthQpLabels.login];
+        newMocks.mockLogoutChosen = ProfileManagement.tokenAuthQpItems[ProfileManagement.AuthQpLabels.logout];
+        newMocks.mockEditProfChosen = ProfileManagement.otherProfileQpItems[ProfileManagement.AuthQpLabels.edit];
+        newMocks.mockCreateQp.mockReturnValue({
+            show: jest.fn(() => {
+                return {};
+            }),
+            hide: jest.fn(() => {
+                return {};
+            }),
+            onDidAccept: jest.fn(() => {
+                return {};
+            }),
+        });
+        Object.defineProperty(profUtils.ProfilesUtils, "promptCredentials", { value: jest.fn(), configurable: true });
+        Object.defineProperty(Gui, "createQuickPick", { value: jest.fn(), configurable: true });
+        Object.defineProperty(Gui, "createQuickPick", { value: newMocks.mockCreateQp, configurable: true });
+        Object.defineProperty(ZoweLogger, "debug", { value: jest.fn(), configurable: true });
+        newMocks.debugLogSpy = jest.spyOn(ZoweLogger, "debug");
+        // Object.defineProperty(profUtils.ProfilesUtils, "isUsingTokenAuth", { value: jest.fn().mockResolvedValueOnce(false), configurable: true });
+
+        return newMocks;
+    }
+    afterEach(() => {
+        jest.clearAllMocks();
+        jest.resetAllMocks();
+    });
+    it("profile using basic authentication should see Operation Cancelled when escaping quick pick", async () => {
+        const globalMocks = createGlobalMocks();
+        const logMsg = `Profile ${globalMocks.mockBasicAuthProfile.name} is using basic authentication.`;
+        Object.defineProperty(Gui, "resolveQuickPick", { value: jest.fn().mockResolvedValueOnce(undefined), configurable: true });
+        const updateSpy = jest.spyOn(profUtils.ProfilesUtils, "promptCredentials");
+        const opCancelledSpy = jest.spyOn(Gui, "infoMessage");
+        await ProfileManagement.manageProfile(globalMocks.mockDsSessionNode as any);
+        expect(globalMocks.debugLogSpy).toBeCalledWith(logMsg);
+        expect(updateSpy).not.toBeCalled();
+        expect(opCancelledSpy).toBeCalledWith("Operation Cancelled");
+        globalMocks.debugLogSpy.mockClear();
+        updateSpy.mockClear();
+        opCancelledSpy.mockClear();
+    });
+    it("profile using basic authentication should see promptCredentials called when Update Credentials chosen", async () => {
+        const globalMocks = createGlobalMocks();
+        const logMsg = `Profile ${globalMocks.mockBasicAuthProfile.name} is using basic authentication.`;
+        Object.defineProperty(Gui, "resolveQuickPick", { value: jest.fn().mockResolvedValueOnce(globalMocks.mockUpdateChosen), configurable: true });
+        const scenarioSpy = jest.spyOn(profUtils.ProfilesUtils, "promptCredentials");
+        await ProfileManagement.manageProfile(globalMocks.mockDsSessionNode as any);
+        expect(globalMocks.debugLogSpy).toBeCalledWith(logMsg);
+        expect(scenarioSpy).toBeCalled();
+        globalMocks.debugLogSpy.mockClear();
+        scenarioSpy.mockClear();
+    });
+});

packages/zowe-explorer/__tests__/__unit__/utils/ProfilesUtils.unit.test.ts

@@ -743,7 +743,7 @@ describe("ProfilesUtils unit tests", () => {
             jest.spyOn(Profiles.getInstance(), "getDefaultProfile").mockReturnValueOnce({} as any);
             jest.spyOn(Profiles.getInstance(), "getLoadedProfConfig").mockResolvedValue({ type: "test" } as any);
             jest.spyOn(Profiles.getInstance(), "getSecurePropsForProfile").mockResolvedValue([]);
-            await expect(profUtils.isUsingTokenAuth("test")).resolves.toEqual(false);
+            await expect(profUtils.ProfilesUtils.isUsingTokenAuth("test")).resolves.toEqual(false);
         });
     });
 });

packages/zowe-explorer/i18n/sample/package.i18n.json

@@ -3,6 +3,7 @@
   "description": "VS Code extension, powered by Zowe CLI, that streamlines interaction with mainframe data sets, USS files, and jobs",
   "viewsContainers.activitybar": "Zowe Explorer",
   "zowe.promptCredentials": "Update Credentials",
+  "zowe.profileManagement": "Manage Profile",
   "zowe.extRefresh": "Refresh Zowe Explorer",
   "zowe.ds.explorer": "Data Sets",
   "zowe.uss.explorer": "Unix System Services (USS)",
@@ -146,5 +147,8 @@
   "createZoweSchema.reload.button": "Reload Window",
   "createZoweSchema.reload.infoMessage": "Team Configuration file created. Location: {0}. \n Please reload your window.",
   "copyFile": "Copy",
-  "pasteFile": "Paste"
+  "pasteFile": "Paste",
+  "jobs.sortbyreturncode": "Sort by ReturnCode",
+  "jobs.sortbyname": "Sort by Name",
+  "jobs.sortbyid": "Sort by ID"
 }

packages/zowe-explorer/i18n/sample/src/Profiles.i18n.json

@@ -26,7 +26,8 @@
   "validateProfiles.progress": "Validating {0} Profile.",
   "validateProfiles.cancelled": "Validating {0} was cancelled.",
   "validateProfiles.error": "Profile validation failed for {0}.",
-  "ssoAuth.noBase": "This profile does not support token authentication.",
+  "ssoAuth.usingBasicAuth": "This profile is using basic authentication and does not support token authentication.",
+  "ssoLogin.tokenType.error": "Error getting supported tokenType value for profile {0}",
   "ssoLogin.successful": "Login to authentication service was successful.",
   "ssoLogin.error": "Unable to log in with {0}. {1}",
   "ssoLogout.successful": "Logout from authentication service was successful for {0}.",

packages/zowe-explorer/i18n/sample/src/utils/ProfileManagement.i18n.json

@@ -0,0 +1,16 @@
+{
+  "profiles.operation.cancelled": "Operation Cancelled",
+  "qpPlaceholders.qp.basic": "Profile {0} is using basic authentication. Choose a profile action.",
+  "qpPlaceholders.qp.token": "Profile {0} is using token authentication. Choose a profile action.",
+  "qpPlaceholders.qp.choose": "Profile {0} doesn't specify an authentication method. Choose a profile action.",
+  "addBasicAuthQpItem.addCredentials.qpLabel": "$(plus) Add Credentials",
+  "addBasicAuthQpItem.addCredentials.qpDetail": "Add username and password for basic authentication",
+  "updateBasicAuthQpItem.updateCredentials.qpLabel": "$(refresh) Update Credentials",
+  "updateBasicAuthQpItem.updateCredentials.qpDetail": "Update stored username and password",
+  "editProfileQpItem.editProfile.qpLabel": "$(pencil) Edit profile",
+  "editProfileQpItem.editProfile.qpDetail": "Update profile connection information",
+  "loginQpItem.login.qpLabel": "$(arrow-right) Log in to authentication service",
+  "loginQpItem.login.qpDetail": "Log in to obtain a new token value",
+  "logoutQpItem.logout.qpLabel": "$(arrow-left) Log out of authentication service",
+  "logoutQpItem.logout.qpDetail": "Log out to invalidate and remove stored token value"
+}

packages/zowe-explorer/package.json

@@ -141,6 +141,11 @@
         "title": "%zowe.promptCredentials%",
         "category": "Zowe Explorer"
       },
+      {
+        "command": "zowe.profileManagement",
+        "title": "%zowe.profileManagement%",
+        "category": "Zowe Explorer"
+      },
       {
         "command": "zowe.extRefresh",
         "title": "%zowe.extRefresh%",
@@ -965,23 +970,8 @@
         },
         {
           "when": "view == zowe.uss.explorer && viewItem =~ /^(?!.*_fav.*)ussSession.*/ && !listMultiSelection",
-          "command": "zowe.promptCredentials",
-          "group": "098_zowe_ussProfileAuthentication@3"
-        },
-        {
-          "when": "view == zowe.uss.explorer && viewItem =~ /^(?!.*_fav.*)ussSession.*/ && !listMultiSelection",
-          "command": "zowe.uss.ssoLogin",
-          "group": "098_zowe_ussProfileAuthentication@4"
-        },
-        {
-          "when": "view == zowe.uss.explorer && viewItem =~ /^(?!.*_fav.*)ussSession.*/ && !listMultiSelection",
-          "command": "zowe.uss.ssoLogout",
-          "group": "098_zowe_ussProfileAuthentication@5"
-        },
-        {
-          "when": "viewItem =~ /^(?!.*_fav.*)ussSession.*/ && !listMultiSelection",
-          "command": "zowe.uss.editSession",
-          "group": "099_zowe_ussProfileModification@1"
+          "command": "zowe.profileManagement",
+          "group": "099_zowe_ussProfileAuthentication@97"
         },
         {
           "when": "viewItem =~ /^(?!.*_fav.*)ussSession.*/",
@@ -1180,23 +1170,8 @@
         },
         {
           "when": "view == zowe.ds.explorer && viewItem =~ /^(?!.*_fav.*)session.*/ && !listMultiSelection",
-          "command": "zowe.promptCredentials",
-          "group": "098_zowe_dsProfileAuthentication@8"
-        },
-        {
-          "when": "view == zowe.ds.explorer && viewItem =~ /^(?!.*_fav.*)session.*/ && !listMultiSelection",
-          "command": "zowe.ds.ssoLogin",
-          "group": "098_zowe_dsProfileAuthentication@9"
-        },
-        {
-          "when": "view == zowe.ds.explorer && viewItem =~ /^(?!.*_fav.*)session.*/ && !listMultiSelection",
-          "command": "zowe.ds.ssoLogout",
-          "group": "098_zowe_dsProfileAuthentication@10"
-        },
-        {
-          "when": "view == zowe.ds.explorer && viewItem =~ /^(?!.*_fav.*)session.*/ && !listMultiSelection",
-          "command": "zowe.ds.editSession",
-          "group": "099_zowe_dsProfileModification@0"
+          "command": "zowe.profileManagement",
+          "group": "099_zowe_dsProfileAuthentication@97"
         },
         {
           "when": "view == zowe.ds.explorer && viewItem =~ /^(?!.*_fav.*)session.*/",
@@ -1345,23 +1320,8 @@
         },
         {
           "when": "view == zowe.jobs.explorer && viewItem =~ /^(?!.*_fav.*)server.*/ && !listMultiSelection",
-          "command": "zowe.promptCredentials",
-          "group": "098_zowe_jobsProfileAuthentication@5"
-        },
-        {
-          "when": "view == zowe.jobs.explorer && viewItem =~ /^(?!.*_fav.*)server.*/ && !listMultiSelection",
-          "command": "zowe.jobs.ssoLogin",
-          "group": "098_zowe_jobsProfileAuthentication@6"
-        },
-        {
-          "when": "view == zowe.jobs.explorer && viewItem =~ /^(?!.*_fav.*)server.*/ && !listMultiSelection",
-          "command": "zowe.jobs.ssoLogout",
-          "group": "098_zowe_jobsProfileAuthentication@7"
-        },
-        {
-          "when": "view == zowe.jobs.explorer && viewItem =~ /^(?!.*_fav.*)server.*/ && !listMultiSelection",
-          "command": "zowe.jobs.editSession",
-          "group": "099_zowe_jobsProfileModification@0"
+          "command": "zowe.profileManagement",
+          "group": "098_zowe_jobsProfileAuthentication@97"
         },
         {
           "when": "view == zowe.jobs.explorer && viewItem =~ /^(?!.*_fav.*)server.*/",
@@ -1729,6 +1689,10 @@
         {
           "command": "zowe.jobs.deleteJob",
           "when": "never"
+        },
+        {
+          "command": "zowe.profileManagement",
+          "when": "never"
         }
       ]
     },

packages/zowe-explorer/package.nls.json

@@ -3,6 +3,7 @@
   "description": "VS Code extension, powered by Zowe CLI, that streamlines interaction with mainframe data sets, USS files, and jobs",
   "viewsContainers.activitybar": "Zowe Explorer",
   "zowe.promptCredentials": "Update Credentials",
+  "zowe.profileManagement": "Manage Profile",
   "zowe.extRefresh": "Refresh Zowe Explorer",
   "zowe.ds.explorer": "Data Sets",
   "zowe.uss.explorer": "Unix System Services (USS)",

packages/zowe-explorer/src/Profiles.ts

@@ -30,7 +30,7 @@ import {
     getFullPath,
     getZoweDir,
 } from "@zowe/zowe-explorer-api";
-import { errorHandling, FilterDescriptor, FilterItem, ProfilesUtils, isUsingTokenAuth } from "./utils/ProfilesUtils";
+import { errorHandling, FilterDescriptor, FilterItem, ProfilesUtils } from "./utils/ProfilesUtils";
 import { ZoweExplorerApiRegister } from "./ZoweExplorerApiRegister";
 import { ZoweExplorerExtender } from "./ZoweExplorerExtender";
 import * as globals from "./globals";
@@ -88,7 +88,7 @@ export class Profiles extends ProfilesCache {
     public async checkCurrentProfile(theProfile: zowe.imperative.IProfileLoaded): Promise<IProfileValidation> {
         ZoweLogger.trace("Profiles.checkCurrentProfile called.");
         let profileStatus: IProfileValidation;
-        const usingTokenAuth = await isUsingTokenAuth(theProfile.name);
+        const usingTokenAuth = await ProfilesUtils.isUsingTokenAuth(theProfile.name);
 
         if (usingTokenAuth && !theProfile.profile.tokenType) {
             const error = new zowe.imperative.ImperativeError({
@@ -1165,16 +1165,18 @@ export class Profiles extends ProfilesCache {
             serviceProfile = this.loadNamedProfile(label.trim());
         }
         // This check will handle service profiles that have username and password
-        if (serviceProfile.profile.user && serviceProfile.profile.password) {
-            Gui.showMessage(localize("ssoAuth.noBase", "This profile does not support token authentication."));
+        if (ProfilesUtils.isProfileUsingBasicAuth(serviceProfile)) {
+            Gui.showMessage(
+                localize("ssoAuth.usingBasicAuth", "This profile is using basic authentication and does not support token authentication.")
+            );
             return;
         }
 
         try {
             loginTokenType = await ZoweExplorerApiRegister.getInstance().getCommonApi(serviceProfile).getTokenTypeName();
         } catch (error) {
             ZoweLogger.warn(error);
-            Gui.showMessage(localize("ssoAuth.noBase", "This profile does not support token authentication."));
+            Gui.showMessage(localize("ssoLogin.tokenType.error", "Error getting supported tokenType value for profile {0}", serviceProfile.name));
             return;
         }
         try {
@@ -1196,8 +1198,10 @@ export class Profiles extends ProfilesCache {
         ZoweLogger.trace("Profiles.ssoLogout called.");
         const serviceProfile = node.getProfile();
         // This check will handle service profiles that have username and password
-        if (serviceProfile.profile?.user && serviceProfile.profile?.password) {
-            Gui.showMessage(localize("ssoAuth.noBase", "This profile does not support token authentication."));
+        if (ProfilesUtils.isProfileUsingBasicAuth(serviceProfile)) {
+            Gui.showMessage(
+                localize("ssoAuth.usingBasicAuth", "This profile is using basic authentication and does not support token authentication.")
+            );
             return;
         }
         try {

packages/zowe-explorer/src/globals.ts

@@ -35,7 +35,7 @@ export let DS_DIR: string;
 export let CONFIG_PATH; // set during activate
 export let ISTHEIA = false; // set during activate
 export let LOG: imperative.Logger;
-export const COMMAND_COUNT = 113;
+export const COMMAND_COUNT = 114;
 export const MAX_SEARCH_HISTORY = 5;
 export const MAX_FILE_HISTORY = 10;
 export const MS_PER_SEC = 1000;

packages/zowe-explorer/src/shared/init.ts

@@ -27,6 +27,7 @@ import { ZoweLogger } from "../utils/LoggerUtils";
 import { ZoweSaveQueue } from "../abstract/ZoweSaveQueue";
 import { SettingsConfig } from "../utils/SettingsConfig";
 import { spoolFilePollEvent } from "../job/actions";
+import { ProfileManagement } from "../utils/ProfileManagement";
 
 // Set up localization
 nls.config({
@@ -92,6 +93,12 @@ export function registerCommonCommands(context: vscode.ExtensionContext, provide
         })
     );
 
+    context.subscriptions.push(
+        vscode.commands.registerCommand("zowe.profileManagement", async (node: IZoweTreeNode) => {
+            await ProfileManagement.manageProfile(node);
+        })
+    );
+
     // Register functions & event listeners
     context.subscriptions.push(
         vscode.workspace.onDidChangeConfiguration(async (e) => {