Implemented unix command

packages/zowe-explorer-api/CHANGELOG.md

@@ -4,6 +4,8 @@ All notable changes to the "zowe-explorer-api" extension will be documented in t
 
 ## TBD Release
 
+- Added new APIs for Issue UNIX Command. [#1326](https://github.com/zowe/vscode-extension-for-zowe/issues/1326)
+
 ### New features and enhancements
 
 ### Bug fixes
@@ -199,3 +201,5 @@ All notable changes to the "zowe-explorer-api" extension will be documented in t
 ## `1.10.1`
 
 - Initial release
+
+

packages/zowe-explorer-api/__tests__/__unit__/profiles/ProfilesCache.unit.test.ts

@@ -267,7 +267,7 @@ describe("ProfilesCache", () => {
             expect(profCache.allProfiles.length).toEqual(2);
             expect(profCache.allProfiles[0]).toMatchObject(lpar1Profile);
             expect(profCache.allProfiles[1]).toMatchObject(zftpProfile);
-            expect(profCache.getAllTypes()).toEqual([...profileTypes, "base"]);
+            expect(profCache.getAllTypes()).toEqual([...profileTypes, "ssh","base"]);
             expect(mockLogError).not.toHaveBeenCalled();
         });
 
@@ -281,7 +281,7 @@ describe("ProfilesCache", () => {
             expect(profCache.allProfiles[0]).toMatchObject(lpar1ProfileWithToken);
             expect(profCache.allProfiles[1]).toMatchObject(lpar2Profile); // without token
             expect(profCache.allProfiles[2]).toMatchObject(baseProfileWithToken);
-            expect(profCache.getAllTypes()).toEqual([...profileTypes, "base"]);
+            expect(profCache.getAllTypes()).toEqual([...profileTypes, "ssh","base"]);
             expect(mockLogError).not.toHaveBeenCalled();
         });
 

packages/zowe-explorer-api/__tests__/__unit__/profiles/ZoweExplorerZosmfApi.unit.test.ts

@@ -43,6 +43,25 @@ const fakeProfile: ITestProfile = {
 };
 const fakeSession = zowe.imperative.Session.createFromUrl(new URL("https://example.com"));
 
+const mISshSession: zowe.ISshSession = {
+    hostname: "example.com",
+    port: 22,
+};
+
+async function expectUnixCommandApiWithSshSession<T>(
+    { name, spy, args }: ITestApi<T>,
+    apiInstance: ZoweExplorerApi.ICommon,
+    sshobj: zowe.SshSession
+): Promise<void> {
+    spy.mockClear().mockResolvedValue(undefined);
+    spy.mockImplementation((sshobject: zowe.SshSession, command: string, cwd: string, callback: (data: string) => void) => {
+        let r=""
+        callback("test");
+        r += "test";
+    });
+    await apiInstance[name as string](sshobj,...args,() => {});
+    expect(spy).toHaveBeenCalled();
+}
 async function expectApiWithSession<T>({ name, spy, args, transform }: ITestApi<T>, apiInstance: ZoweExplorerApi.ICommon): Promise<void> {
     spy.mockClear().mockResolvedValue(undefined);
     const getSessionSpy = jest.spyOn(apiInstance, "getSession").mockReturnValue(fakeSession);
@@ -537,6 +556,7 @@ describe("ZosmfJesApi", () => {
 });
 
 describe("ZosmfCommandApi", () => {
+    const SshSessionobj = new zowe.SshSession(mISshSession);
     const commandApis: ITestApi<ZosmfCommandApi>[] = [
         {
             name: "issueTsoCommandWithParms",
@@ -555,4 +575,20 @@ describe("ZosmfCommandApi", () => {
             await expectApiWithSession(commandApi, new ZosmfCommandApi());
         });
     });
+    const UnixcommandApiwithsshSession: ITestApi<ZosmfCommandApi>[] = [
+        {
+            name: "issueUnixCommand",
+            spy: jest.spyOn(zowe.Shell, "executeSshCwd"),
+            args: ["command", "cwd"],
+        },
+    ];
+    UnixcommandApiwithsshSession.forEach((cmdApi)=>{
+        it(`${cmdApi?.name} should inject session into Zowe API`, async () => {
+            await expectUnixCommandApiWithSshSession(cmdApi, new ZosmfCommandApi(),SshSessionobj);
+        });
+    })
+    it("check whether sshProfileNeeded", () => {
+        const obj = new ZosmfCommandApi();
+        expect(obj.sshProfileRequired?.()).toBe(true);
+    });
 });

packages/zowe-explorer-api/src/extend/interfaces.ts

@@ -478,4 +478,15 @@ export interface ICommand extends ICommon {
      * @memberof ICommand
      */
     issueMvsCommand?(command: string): Promise<zowe.IConsoleResponse>;
+
+    /**
+     * Issues a Unix Command and returns a Console Command API response.
+     *
+     * @param {string} command
+     * @param {string} cwd
+     * @returns {string>}
+     * @memberof ICommand
+     */
+    issueUnixCommand?(sshSession: zowe.SshSession, command: string, cwd: string): Promise<string>;
+    sshProfileRequired?(): boolean;
 }

packages/zowe-explorer-api/src/profiles/ProfilesCache.ts

@@ -201,7 +201,7 @@ export class ProfilesCache {
                 return;
             }
             const allTypes = this.getAllProfileTypes(apiRegister.registeredApiTypes());
-            allTypes.push("base");
+            allTypes.push("ssh","base");
             for (const type of allTypes) {
                 const tmpAllProfiles: zowe.imperative.IProfileLoaded[] = [];
                 // Step 1: Get all profiles for each registered type

packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts

@@ -355,4 +355,15 @@ export class ZosmfCommandApi extends ZosmfApiCommon implements ICommand {
     public issueMvsCommand(command: string): Promise<zowe.IConsoleResponse> {
         return zowe.IssueCommand.issueSimple(this.getSession(), command);
     }
+
+    public async issueUnixCommand(sshSession: zowe.SshSession, command: string, cwd: string): Promise<string> {
+        let stdout = "";
+        await zowe.Shell.executeSshCwd(sshSession, command, '"'+cwd+'"', (data: string) => {
+            stdout += data;
+        });
+        return stdout;
+    }
+    public sshProfileRequired?(): boolean {
+        return true;
+    }
 }

packages/zowe-explorer/CHANGELOG.md

@@ -984,3 +984,7 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen
 ## 0.5.0
 
 - Initial release
+
+## TBD Release
+
+- Added the Issue UNIX Commands feature. [#1326](https://github.com/zowe/vscode-extension-for-zowe/issues/1326)