feat: Introduce integrated terminal

packages/zowe-explorer/CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen
 
 - Update Zowe SDKs to `8.2.0` to get the latest enhancements from Imperative.
 - Added expired JSON web token detection for profiles in each tree view (Data Sets, USS, Jobs). When a user performs a search on a profile, they are prompted to log in if their token expired. [#3175](https://github.com/zowe/zowe-explorer-vscode/issues/3175)
+- Added integrated terminals for z/OS Unix, TSO, and MVS commands which can be enabled via the `Zowe › Commands: Use Integrated Terminals` setting. [#3079](https://github.com/zowe/zowe-explorer-vscode/pull/3079)
 
 ### Bug fixes
 

packages/zowe-explorer/__tests__/__unit__/commands/MvsCommandHandler.unit.test.ts

@@ -19,6 +19,7 @@ import { ProfileManagement } from "../../../src/management/ProfileManagement";
 import { FilterDescriptor, FilterItem } from "../../../src/management/FilterManagement";
 import { ZoweLogger } from "../../../src/tools/ZoweLogger";
 import { MvsCommandHandler } from "../../../src/commands/MvsCommandHandler";
+import { SettingsConfig } from "../../../src/configuration/SettingsConfig";
 
 jest.mock("Session");
 
@@ -28,6 +29,7 @@ describe("mvsCommandActions unit testing", () => {
     const showInformationMessage = jest.fn();
     const showQuickPick = jest.fn();
     const createQuickPick = jest.fn();
+    const createTerminal = jest.fn();
     const getConfiguration = jest.fn();
     const createOutputChannel = jest.fn();
 
@@ -94,10 +96,7 @@ describe("mvsCommandActions unit testing", () => {
     });
 
     const withProgress = jest.fn().mockImplementation((progLocation, callback) => {
-        return {
-            success: true,
-            commandResponse: callback(),
-        };
+        return callback();
     });
 
     const session = new imperative.Session({
@@ -129,6 +128,7 @@ describe("mvsCommandActions unit testing", () => {
     Object.defineProperty(vscode.window, "showInformationMessage", { value: showInformationMessage });
     Object.defineProperty(vscode.window, "showQuickPick", { value: showQuickPick });
     Object.defineProperty(vscode.window, "createQuickPick", { value: createQuickPick });
+    Object.defineProperty(vscode.window, "createTerminal", { value: createTerminal });
     Object.defineProperty(vscode.window, "createOutputChannel", { value: createOutputChannel });
     Object.defineProperty(vscode, "ProgressLocation", { value: ProgressLocation });
     Object.defineProperty(vscode.window, "withProgress", { value: withProgress });
@@ -141,13 +141,20 @@ describe("mvsCommandActions unit testing", () => {
         }),
     });
 
+    beforeEach(() => {
+        jest.spyOn(SettingsConfig, "getDirectValue").mockReturnValue(false);
+    });
+
     afterEach(() => {
+        (MvsCommandHandler as any).instance = undefined;
         jest.clearAllMocks();
     });
 
     const apiRegisterInstance = ZoweExplorerApiRegister.getInstance();
-    const mvsActions = MvsCommandHandler.getInstance();
     const profilesForValidation = { status: "active", name: "fake" };
+    const getMvsActions = () => {
+        return MvsCommandHandler.getInstance();
+    };
 
     it("tests the issueMvsCommand function", async () => {
         Object.defineProperty(profileLoader.Profiles, "getInstance", {
@@ -180,16 +187,16 @@ describe("mvsCommandActions unit testing", () => {
 
         showInputBox.mockReturnValueOnce("/d iplinfo1");
         jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
-        jest.spyOn(mockCommandApi, "issueMvsCommand").mockReturnValue("iplinfo1" as any);
+        jest.spyOn(mockCommandApi, "issueMvsCommand").mockReturnValue({ commandResponse: "iplinfo1" } as any);
 
-        await mvsActions.issueMvsCommand();
+        await getMvsActions().issueMvsCommand();
 
         expect(showQuickPick.mock.calls.length).toBe(1);
         expect(showQuickPick.mock.calls[0][0]).toEqual(["firstName", "secondName"]);
         expect(showQuickPick.mock.calls[0][1]).toEqual({
             canPickMany: false,
             ignoreFocusOut: true,
-            placeHolder: "Select the Profile to use to submit the command",
+            placeHolder: "Select an MVS profile for this command",
         });
         expect(showInputBox.mock.calls.length).toBe(1);
         expect(appendLine.mock.calls.length).toBe(2);
@@ -223,16 +230,19 @@ describe("mvsCommandActions unit testing", () => {
         apiRegisterInstance.getCommandApi = getCommandApiMock.bind(apiRegisterInstance);
 
         jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem2));
-        jest.spyOn(mockCommandApi, "issueMvsCommand").mockReturnValue("iplinfo0" as any);
+        jest.spyOn(mockCommandApi, "issueMvsCommand").mockReturnValue({ commandResponse: "iplinfo0" } as any);
+
+        const actions = getMvsActions();
+        (actions.history as any).mSearchHistory = [qpItem2.label];
 
-        await mvsActions.issueMvsCommand();
+        await actions.issueMvsCommand();
 
         expect(showQuickPick.mock.calls.length).toBe(1);
         expect(showQuickPick.mock.calls[0][0]).toEqual(["firstName", "secondName"]);
         expect(showQuickPick.mock.calls[0][1]).toEqual({
             canPickMany: false,
             ignoreFocusOut: true,
-            placeHolder: "Select the Profile to use to submit the command",
+            placeHolder: "Select an MVS profile for this command",
         });
         expect(showInputBox.mock.calls.length).toBe(0);
         expect(appendLine.mock.calls.length).toBe(2);
@@ -267,16 +277,16 @@ describe("mvsCommandActions unit testing", () => {
         getCommandApiMock.mockReturnValue(mockCommandApi);
         apiRegisterInstance.getCommandApi = getCommandApiMock.bind(apiRegisterInstance);
         jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
-        jest.spyOn(mockCommandApi, "issueMvsCommand").mockReturnValue("iplinfo3" as any);
+        jest.spyOn(mockCommandApi, "issueMvsCommand").mockReturnValue({ commandResponse: "iplinfo3" } as any);
 
-        await mvsActions.issueMvsCommand();
+        await getMvsActions().issueMvsCommand();
 
         expect(showQuickPick.mock.calls.length).toBe(1);
         expect(showQuickPick.mock.calls[0][0]).toEqual(["firstName", "secondName"]);
         expect(showQuickPick.mock.calls[0][1]).toEqual({
             canPickMany: false,
             ignoreFocusOut: true,
-            placeHolder: "Select the Profile to use to submit the command",
+            placeHolder: "Select an MVS profile for this command",
         });
         expect(showInputBox.mock.calls.length).toBe(1);
         expect(showErrorMessage.mock.calls.length).toBe(1);
@@ -309,18 +319,21 @@ describe("mvsCommandActions unit testing", () => {
 
         jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(undefined));
 
-        await mvsActions.issueMvsCommand();
+        const actions = getMvsActions();
+        (actions.history as any).mSearchHistory = [qpItem2.label];
+
+        await actions.issueMvsCommand();
 
         expect(showQuickPick.mock.calls.length).toBe(1);
         expect(showInputBox.mock.calls.length).toBe(0);
         expect(showQuickPick.mock.calls[0][0]).toEqual(["firstName", "secondName"]);
         expect(showQuickPick.mock.calls[0][1]).toEqual({
             canPickMany: false,
             ignoreFocusOut: true,
-            placeHolder: "Select the Profile to use to submit the command",
+            placeHolder: "Select an MVS profile for this command",
         });
         expect(showInformationMessage.mock.calls.length).toBe(1);
-        expect(showInformationMessage.mock.calls[0][0]).toEqual("No selection made. Operation cancelled.");
+        expect(showInformationMessage.mock.calls[0][0]).toEqual("Operation cancelled");
     });
 
     it("tests the issueMvsCommand function user escapes the command box", async () => {
@@ -349,18 +362,18 @@ describe("mvsCommandActions unit testing", () => {
 
         jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
 
-        await mvsActions.issueMvsCommand();
+        await getMvsActions().issueMvsCommand();
 
         expect(showQuickPick.mock.calls.length).toBe(1);
         expect(showQuickPick.mock.calls[0][0]).toEqual(["firstName", "secondName"]);
         expect(showQuickPick.mock.calls[0][1]).toEqual({
             canPickMany: false,
             ignoreFocusOut: true,
-            placeHolder: "Select the Profile to use to submit the command",
+            placeHolder: "Select an MVS profile for this command",
         });
         expect(showInputBox.mock.calls.length).toBe(1);
         expect(showInformationMessage.mock.calls.length).toBe(1);
-        expect(showInformationMessage.mock.calls[0][0]).toEqual("No command entered.");
+        expect(showInformationMessage.mock.calls[0][0]).toEqual("Operation cancelled");
     });
 
     it("tests the issueMvsCommand function user starts typing a value in quick pick", async () => {
@@ -406,14 +419,17 @@ describe("mvsCommandActions unit testing", () => {
 
         jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
 
-        await mvsActions.issueMvsCommand();
+        const actions = getMvsActions();
+        (actions.history as any).mSearchHistory = [qpItem2.label];
+
+        await actions.issueMvsCommand();
 
         expect(showQuickPick.mock.calls.length).toBe(1);
         expect(showQuickPick.mock.calls[0][0]).toEqual(["firstName", "secondName"]);
         expect(showQuickPick.mock.calls[0][1]).toEqual({
             canPickMany: false,
             ignoreFocusOut: true,
-            placeHolder: "Select the Profile to use to submit the command",
+            placeHolder: "Select an MVS profile for this command",
         });
         expect(showInputBox.mock.calls.length).toBe(0);
     });
@@ -450,14 +466,14 @@ describe("mvsCommandActions unit testing", () => {
         jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
         jest.spyOn(mockCommandApi, "issueMvsCommand").mockReturnValueOnce({ commandResponse: "fake response" } as any);
 
-        await mvsActions.issueMvsCommand();
+        await getMvsActions().issueMvsCommand();
 
         expect(showQuickPick.mock.calls.length).toBe(1);
         expect(showQuickPick.mock.calls[0][0]).toEqual(["firstName", "secondName"]);
         expect(showQuickPick.mock.calls[0][1]).toEqual({
             canPickMany: false,
             ignoreFocusOut: true,
-            placeHolder: "Select the Profile to use to submit the command",
+            placeHolder: "Select an MVS profile for this command",
         });
         expect(showInputBox.mock.calls.length).toBe(1);
     });
@@ -492,14 +508,14 @@ describe("mvsCommandActions unit testing", () => {
         jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
         jest.spyOn(mockCommandApi, "issueMvsCommand").mockReturnValueOnce({ commandResponse: "fake response" } as any);
 
-        await mvsActions.issueMvsCommand();
+        await getMvsActions().issueMvsCommand();
 
         expect(showQuickPick.mock.calls.length).toBe(1);
         expect(showQuickPick.mock.calls[0][0]).toEqual(["firstName", "secondName"]);
         expect(showQuickPick.mock.calls[0][1]).toEqual({
             canPickMany: false,
             ignoreFocusOut: true,
-            placeHolder: "Select the Profile to use to submit the command",
+            placeHolder: "Select an MVS profile for this command",
         });
         expect(showInputBox.mock.calls.length).toBe(1);
     });
@@ -523,7 +539,7 @@ describe("mvsCommandActions unit testing", () => {
         showQuickPick.mockReturnValueOnce("firstName");
         showInputBox.mockReturnValueOnce("fake");
 
-        await mvsActions.issueMvsCommand();
+        await getMvsActions().issueMvsCommand();
 
         expect(showErrorMessage.mock.calls.length).toBe(1);
     });
@@ -544,10 +560,10 @@ describe("mvsCommandActions unit testing", () => {
 
         showQuickPick.mockReturnValueOnce(undefined);
 
-        await mvsActions.issueMvsCommand();
+        await getMvsActions().issueMvsCommand();
 
         expect(showInformationMessage.mock.calls.length).toBe(1);
-        expect(showInformationMessage.mock.calls[0][0]).toEqual("Operation Cancelled");
+        expect(showInformationMessage.mock.calls[0][0]).toEqual("Operation cancelled");
     });
 
     it("tests the issueMvsCommand function from a session", async () => {
@@ -564,7 +580,7 @@ describe("mvsCommandActions unit testing", () => {
             }),
         });
 
-        jest.spyOn(mvsActions, "checkCurrentProfile").mockReturnValue(undefined as any);
+        jest.spyOn(getMvsActions(), "checkCurrentProfile").mockReturnValue(undefined as any);
 
         const mockCommandApi = await apiRegisterInstance.getCommandApi(profileOne);
         const getCommandApiMock = jest.fn();
@@ -574,7 +590,7 @@ describe("mvsCommandActions unit testing", () => {
         showInputBox.mockReturnValueOnce("/d iplinfo1");
         jest.spyOn(mockCommandApi, "issueMvsCommand").mockReturnValueOnce({ commandResponse: "fake response" } as any);
 
-        await mvsActions.issueMvsCommand(session, null as any, testNode);
+        await getMvsActions().issueMvsCommand(session, null as any, testNode);
 
         expect(showInputBox.mock.calls.length).toBe(1);
         expect(showInformationMessage.mock.calls.length).toBe(0);
@@ -608,14 +624,14 @@ describe("mvsCommandActions unit testing", () => {
             throw testError;
         });
 
-        await mvsActions.issueMvsCommand();
+        await getMvsActions().issueMvsCommand();
 
         expect(showQuickPick.mock.calls.length).toBe(1);
         expect(showQuickPick.mock.calls[0][0]).toEqual(["firstName", "secondName"]);
         expect(showQuickPick.mock.calls[0][1]).toEqual({
             canPickMany: false,
             ignoreFocusOut: true,
-            placeHolder: "Select the Profile to use to submit the command",
+            placeHolder: "Select an MVS profile for this command",
         });
         expect(showInputBox.mock.calls.length).toBe(0);
         expect(showErrorMessage.mock.calls.length).toBe(1);
@@ -641,7 +657,7 @@ describe("mvsCommandActions unit testing", () => {
             value: jest.fn().mockReturnValue([]),
             configurable: true,
         });
-        await mvsActions.issueMvsCommand();
+        await getMvsActions().issueMvsCommand();
         expect(showInformationMessage.mock.calls[0][0]).toEqual("No profiles available");
     });
 });