resolve FTP getContents bug for MVS and USS (#3200)

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com> Co-authored-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
zowe · Oct 8, 2024 · f1b2471 · f1b2471
1 parent 37a5102
commit f1b2471
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 2 deletions.
diff --git a/packages/zowe-explorer-ftp-extension/CHANGELOG.md b/packages/zowe-explorer-ftp-extension/CHANGELOG.md
@@ -6,6 +6,8 @@ All notable changes to the "zowe-explorer-ftp-extension" extension will be docum
 
 ### Bug fixes
 
+- Fixed bug where the `getContents` MVS and USS APIs failed to return whenever a local file path was provided. [#3199](https://github.com/zowe/zowe-explorer-vscode/issues/3199)
+
 ## `3.0.0`
 
 ### New features and enhancements

diff --git a/packages/zowe-explorer-ftp-extension/__mocks__/mockUtils.ts b/packages/zowe-explorer-ftp-extension/__mocks__/mockUtils.ts
@@ -0,0 +1,2 @@
+// Idea is borrowed from: https://github.com/kulshekhar/ts-jest/blob/master/src/util/testing.ts
+export const mocked = <T extends (..._args: any[]) => any>(fn: T): jest.Mock<ReturnType<T>> => fn as any;
diff --git a/...ges/zowe-explorer-ftp-extension/__tests__/__unit__/Mvs/ZoweExplorerFtpMvsApi.unit.test.ts b/...ges/zowe-explorer-ftp-extension/__tests__/__unit__/Mvs/ZoweExplorerFtpMvsApi.unit.test.ts
@@ -20,6 +20,7 @@ import * as tmp from "tmp";
 import { Gui, imperative } from "@zowe/zowe-explorer-api";
 import * as globals from "../../../src/globals";
 import { ZoweFtpExtensionError } from "../../../src/ZoweFtpExtensionError";
+import { mocked } from "../../../__mocks__/mockUtils";
 
 // two methods to mock modules: create a __mocks__ file for zowe-explorer-api.ts and direct mock for extension.ts
 jest.mock("../../../__mocks__/@zowe/zowe-explorer-api.ts");
@@ -93,6 +94,7 @@ describe("FtpMvsApi", () => {
 
         expect(result.apiResponse.etag).toHaveLength(64);
         expect(DataSetUtils.downloadDataSet).toHaveBeenCalledTimes(1);
+        expect(mocked(DataSetUtils.downloadDataSet).mock.calls[0][2].localFile).toBe(localFile);
         expect(MvsApi.releaseConnection).toHaveBeenCalled();
 
         expect((response._readableState.buffer.head?.data ?? response._readableState.buffer).toString()).toContain("Hello world");

diff --git a/...ges/zowe-explorer-ftp-extension/__tests__/__unit__/Uss/ZoweExplorerFtpUssApi.unit.test.ts b/...ges/zowe-explorer-ftp-extension/__tests__/__unit__/Uss/ZoweExplorerFtpUssApi.unit.test.ts
@@ -21,6 +21,7 @@ import * as globals from "../../../src/globals";
 import { ZoweFtpExtensionError } from "../../../src/ZoweFtpExtensionError";
 import * as tmp from "tmp";
 import { imperative } from "@zowe/zowe-explorer-api";
+import { mocked } from "../../../__mocks__/mockUtils";
 
 // two methods to mock modules: create a __mocks__ file for zowe-explorer-api.ts and direct mock for extension.ts
 jest.mock("../../../__mocks__/@zowe/zowe-explorer-api.ts");
@@ -78,6 +79,7 @@ describe("FtpUssApi", () => {
 
         expect(result.apiResponse.etag).toHaveLength(64);
         expect(UssUtils.downloadFile).toHaveBeenCalledTimes(1);
+        expect(mocked(UssUtils.downloadFile).mock.calls[0][2].localFile).toBe(localFile);
         expect(UssApi.releaseConnection).toHaveBeenCalled();
 
         expect((response._readableState.buffer.head?.data ?? response._readableState.buffer).toString()).toContain("Hello world");

diff --git a/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts b/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts
@@ -84,7 +84,7 @@ export class FtpMvsApi extends AbstractFtpApi implements MainframeInteraction.IM
         const result = this.getDefaultResponse();
         const transferOptions = {
             encoding: options.encoding,
-            localFile: undefined,
+            localFile: options.file,
             transferType: CoreUtils.getBinaryTransferModeOrDefault(options.binary),
         };
         const fileOrStreamSpecified = options.file != null || options.stream != null;

diff --git a/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpUssApi.ts b/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpUssApi.ts
@@ -64,7 +64,7 @@ export class FtpUssApi extends AbstractFtpApi implements MainframeInteraction.IU
         const result = this.getDefaultResponse();
         const transferOptions = {
             transferType: CoreUtils.getBinaryTransferModeOrDefault(options.binary),
-            localFile: undefined,
+            localFile: options.file,
             size: 1,
         };
         const fileOrStreamSpecified = options.file != null || options.stream != null;