Updated with Unit Testing

Signed-off-by: Likhitha Nimma <Likhitha.Nimma@ibm.com>

packages/zowe-explorer/__tests__/__unit__/command/unixCommandHandler.unit.test.ts

@@ -519,4 +519,19 @@ describe("UnixCommand Actions Unit Testing", () => {
 
  expect(showInputBox.mock.calls.length).toBe(1);
  });
+
+ it("ssh profile not found", async () => {
+ mockdefaultProfile.mockReset();
+ mockdefaultProfile.mockReturnValueOnce(undefined);
+ Object.defineProperty(profileLoader.Profiles, "getInstance", {
+ value: jest.fn(() => {
+ return {
+ getDefaultProfile: mockdefaultProfile,
+ };
+ }),
+ });
+ await unixActions.setsshSession();
+ expect(showErrorMessage.mock.calls.length).toBe(1);
+ expect(showErrorMessage.mock.calls[0][0]).toEqual("No SSH profile found. Please create an SSH profile before issuing Unix commands.");
+ });
 });

packages/zowe-explorer/__tests__/__unit__/command/unixCommandHandlerTheia.unit.test.ts

@@ -0,0 +1,253 @@
+/**
+ * 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 * as vscode from "vscode";
+import * as profileLoader from "../../../src/Profiles";
+import { Gui, ValidProfileEnum } from "@zowe/zowe-explorer-api";
+import { UnixCommandHandler } from "../../../src/command/UnixCommandHandler";
+import * as globals from "../../../src/globals";
+import * as utils from "../../../src/utils/ProfilesUtils";
+import { imperative } from "@zowe/cli";
+import { ZoweExplorerApiRegister } from "../../../src/ZoweExplorerApiRegister";
+import { ZoweLocalStorage } from "../../../src/utils/ZoweLocalStorage";
+import { SshSession } from "@zowe/zos-uss-for-zowe-sdk";
+
+describe("unixCommandActions unit testing", () => {
+ const showErrorMessage = jest.fn();
+ const showInputBox = jest.fn();
+ const showInformationMessage = jest.fn();
+ const showQuickPick = jest.fn();
+ const getConfiguration = jest.fn();
+ const createOutputChannel = jest.fn();
+
+ const appendLine = jest.fn();
+ const outputChannel: vscode.OutputChannel = {
+ append: jest.fn(),
+ name: "fakeChannel",
+ appendLine,
+ clear: jest.fn(),
+ show: jest.fn(),
+ hide: jest.fn(),
+ dispose: jest.fn(),
+ replace: jest.fn(),
+ };
+ createOutputChannel.mockReturnValue(outputChannel);
+ const qpItem: vscode.QuickPickItem = new utils.FilterDescriptor("\uFF0B " + "Create a new filter");
+
+ const mockLoadNamedProfile = jest.fn();
+ const mockdefaultProfile = jest.fn();
+
+ Object.defineProperty(profileLoader.Profiles, "createInstance", {
+ value: jest.fn(() => {
+ return {
+ allProfiles: [{ name: "firstName" }, { name: "secondName" }],
+ defaultProfile: { name: "firstName" },
+ };
+ }),
+ });
+ Object.defineProperty(ZoweLocalStorage, "storage", {
+ value: {
+ get: () => ({ persistence: true, favorites: [], history: [], sessions: ["zosmf"], searchHistory: [], fileHistory: [] }),
+ update: jest.fn(),
+ keys: () => [],
+ },
+ configurable: true,
+ });
+
+ const ProgressLocation = jest.fn().mockImplementation(() => {
+ return {
+ Notification: 15,
+ };
+ });
+ const submitResponse = {
+ success: true,
+ commandResponse: "d iplinfo..",
+ }; // I think this should be changed
+
+ const withProgress = jest.fn().mockImplementation(() => {
+ return submitResponse;
+ });
+
+ const session = new imperative.Session({
+ user: "fake",
+ password: "fake",
+ hostname: "fake",
+ port: 443,
+ protocol: "https",
+ type: "basic",
+ });
+
+ const profileOne: imperative.IProfileLoaded = {
+ name: "aProfile",
+ profile: {},
+ type: "zosmf",
+ message: "",
+ failNotFound: false,
+ };
+
+ Object.defineProperty(vscode.window, "showErrorMessage", { value: showErrorMessage });
+ Object.defineProperty(vscode.window, "showInputBox", { value: showInputBox });
+ Object.defineProperty(vscode.window, "showInformationMessage", { value: showInformationMessage });
+ Object.defineProperty(vscode.window, "showQuickPick", { value: showQuickPick });
+ Object.defineProperty(vscode.window, "createOutputChannel", { value: createOutputChannel });
+ Object.defineProperty(vscode, "ProgressLocation", { value: ProgressLocation });
+ Object.defineProperty(vscode.window, "withProgress", { value: withProgress });
+ Object.defineProperty(imperative.ConnectionPropsForSessCfg, "addPropsOrPrompt", {
+ value: jest.fn(() => {
+ return { privateKey: undefined, keyPassphrase: undefined, handshakeTimeout: undefined, type: "basic", port: 22 };
+ }),
+ });
+
+ getConfiguration.mockReturnValue({
+ get: (_setting: string) => undefined,
+ update: jest.fn(() => {
+ return {};
+ }),
+ });
+
+ afterEach(() => {
+ jest.clearAllMocks();
+ });
+ mockdefaultProfile.mockReturnValue({ profile: { name: "bprofile", type: "ssh" } });
+ const apiRegisterInstance = ZoweExplorerApiRegister.getInstance();
+ const unixActions = UnixCommandHandler.getInstance();
+
+ SshSession.createSshSessCfgFromArgs = jest.fn(() => {
+ return { privateKey: undefined, keyPassphrase: undefined, handshakeTimeout: undefined };
+ });
+
+ it("tests the issueUnixCommand function - theia route", async () => {
+ const originalTheia = globals.ISTHEIA;
+ const profilesForValidation = { status: "active", name: "fake" };
+ Object.defineProperty(globals, "ISTHEIA", { get: () => true });
+ // First run enters a command directly
+ Object.defineProperty(profileLoader.Profiles, "getInstance", {
+ value: jest.fn(() => {
+ return {
+ allProfiles: [{ name: "firstName", profile: { user: "firstName", password: "12345" } }, { name: "secondName" }],
+ defaultProfile: { name: "firstName" },
+ zosmfProfile: mockLoadNamedProfile,
+ checkCurrentProfile: jest.fn(() => {
+ return profilesForValidation;
+ }),
+ validateProfiles: jest.fn(),
+ getBaseProfile: jest.fn(),
+ getDefaultProfile: mockdefaultProfile,
+ validProfile: ValidProfileEnum.VALID,
+ };
+ }),
+ });
+
+ const mockUssApi = await ZoweExplorerApiRegister.getUssApi(profileOne);
+ const getUssApiMock = jest.fn();
+ getUssApiMock.mockReturnValue(mockUssApi);
+ ZoweExplorerApiRegister.getUssApi = getUssApiMock.bind(ZoweExplorerApiRegister);
+ jest.spyOn(mockUssApi, "getSession").mockReturnValue(session);
+
+ showQuickPick.mockReturnValueOnce("firstName");
+
+ const mockCommandApi = await apiRegisterInstance.getCommandApi(profileOne);
+ const getCommandApiMock = jest.fn();
+ getCommandApiMock.mockReturnValue(mockCommandApi);
+ apiRegisterInstance.getCommandApi = getCommandApiMock.bind(apiRegisterInstance);
+
+ showInputBox.mockReturnValueOnce("/u/directorypath");
+ showInputBox.mockReturnValueOnce("/d iplinfo1");
+
+ jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
+ jest.spyOn(mockCommandApi, "issueUnixCommand").mockReturnValue("iplinfo1" as any);
+
+ await unixActions.issueUnixCommand();
+
+ 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 Unix command",
+ });
+ expect(showInputBox.mock.calls.length).toBe(2);
+ expect(appendLine.mock.calls.length).toBe(2);
+ expect(appendLine.mock.calls[0][0]).toBe("> d iplinfo1");
+ expect(appendLine.mock.calls[1][0]["commandResponse"]).toBe(submitResponse.commandResponse);
+ expect(showInformationMessage.mock.calls.length).toBe(0);
+
+ showQuickPick.mockReset();
+ showInputBox.mockReset();
+ withProgress.mockReset();
+ appendLine.mockReset();
+
+ // Second run selects previously added run
+ showQuickPick.mockReturnValueOnce("firstName");
+ showInputBox.mockReturnValueOnce("/u/directorypath");
+ jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
+ showQuickPick.mockReturnValueOnce({ label: "d iplinfo2" });
+
+ await unixActions.issueUnixCommand();
+
+ expect(showQuickPick.mock.calls.length).toBe(2);
+ 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 Unix command",
+ });
+ expect(showInputBox.mock.calls.length).toBe(1);
+ expect(appendLine.mock.calls[0][0]).toBe("> d iplinfo2");
+ expect(withProgress.mock.calls.length).toBe(1);
+
+ showQuickPick.mockReset();
+ showInputBox.mockReset();
+ withProgress.mockReset();
+ appendLine.mockReset();
+
+ // Third run selects an alternative value
+ showQuickPick.mockReturnValueOnce("firstName");
+ showInputBox.mockReturnValueOnce("/u/directorypath");
+ jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
+ showQuickPick.mockReturnValueOnce(new utils.FilterItem({ text: "/d m=cpu" }));
+
+ await unixActions.issueUnixCommand();
+
+ expect(showQuickPick.mock.calls.length).toBe(2);
+ 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 Unix command",
+ });
+ expect(showInputBox.mock.calls.length).toBe(1);
+ expect(withProgress.mock.calls.length).toBe(1);
+
+ showQuickPick.mockReset();
+ showInputBox.mockReset();
+ withProgress.mockReset();
+ showInformationMessage.mockReset();
+ appendLine.mockReset();
+
+ showQuickPick.mockReturnValueOnce("firstName");
+ showInputBox.mockReturnValueOnce("/u/directorypath");
+ jest.spyOn(Gui, "resolveQuickPick").mockImplementation(() => Promise.resolve(qpItem));
+ showQuickPick.mockReturnValueOnce(undefined);
+
+ await unixActions.issueUnixCommand();
+
+ expect(showInputBox.mock.calls.length).toBe(1);
+ expect(showInformationMessage.mock.calls.length).toBe(1);
+ expect(showInformationMessage.mock.calls[0][0]).toEqual("No selection made. Operation cancelled.");
+
+ showQuickPick.mockReset();
+ showInputBox.mockReset();
+ withProgress.mockReset();
+
+ Object.defineProperty(globals, "ISTHEIA", { get: () => originalTheia });
+ });
+});

packages/zowe-explorer/src/command/UnixCommandHandler.ts

@@ -154,8 +154,10 @@ export class UnixCommandHandler extends ZoweCommandProvider {
  ZoweLogger.trace("UnixCommandHandler.setsshSession called.");
  const sshprofile: imperative.IProfileLoaded = Profiles.getInstance().getDefaultProfile("ssh");
  if (!sshprofile) {
- Gui.errorMessage(localize("setsshProfile.couldnotfindprofile", "No SSH profile found. Please create an SSH profile before issuing Unix commands."));
- return ;
+ Gui.errorMessage(
+ localize("setsshProfile.couldnotfindprofile", "No SSH profile found. Please create an SSH profile before issuing Unix commands.")
+ );
+ return;
  }
  const cmdArgs: imperative.ICommandArguments = this.getCmdArgs(sshprofile?.profile as imperative.IProfileLoaded);
  // create the ssh session
@@ -182,7 +184,7 @@ export class UnixCommandHandler extends ZoweCommandProvider {
  // get user selection
  const choice = await Gui.showQuickPick([createPick, ...items], options1);
  if (!choice) {
- Gui.showMessage(localize("issueUnixCommand.options.noselection", "No selection made."));
+ Gui.showMessage(localize("issueUnixCommand.options.noselection", "No selection made. Operation cancelled."));
  return;
  }
  response = choice === createPick ? "" : choice.label;