Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copying a PDS into existing PDS w/ no members #2386

Merged
merged 18 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/cli/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
All notable changes to the Zowe CLI package will be documented in this file.

## Recent Changes
-Enhancement: Updated the help text with PDS enhancement of `zowe zos-files copy data-set` command.[#2386](https://github.com/zowe/zowe-cli/pull/2386)

-Enhancement: Added new command zowe zos-files download all-members-matching, (zowe files dl amm), to download members matching specified pattern(s). The success message for the Download.allMembers API was changed from originally "Data set downloaded successfully" to "Member(s) downloaded successfully." The change also alters the commandResponse when using the --rfj flag. [#2359](https://github.com/zowe/zowe-cli/pull/2359)

Expand Down
7 changes: 4 additions & 3 deletions packages/cli/src/zosfiles/-strings-/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@ export default {
DESCRIPTION: "Copy a data set.",
ACTIONS: {
DATA_SET: {
SUMMARY: "Copy a data set to another data set",
DESCRIPTION: "Copy a data set to another data set.",
SUMMARY: "Copy a data set/partitioned data set to another data set/partitioned data set",
DESCRIPTION: "Copy a data set/partitioned data set to another data set/partitioned data set.",
POSITIONALS: {
FROMDSNAME: "The name of the data set that you want to copy from",
TODSNAME: "The name of the data set that you want to copy to (data set must be preallocated)"
Expand All @@ -202,7 +202,8 @@ export default {
EX2: "Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)'",
EX3: "Copy the data set named 'USER.FROM.SET' to the data set member named 'USER.TO.SET(MEM2)'",
EX4: "Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set named 'USER.TO.SET'",
EX5: "Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' and replace like-named members"
EX5: "Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' and replace like-named members",
EX6: "Copy the partitioned data set named 'TEST.PDS1' to the partitioned data set named 'TEST.PDS2'"
}
},
DATA_SET_CROSS_LPAR: {
Expand Down
1 change: 1 addition & 0 deletions packages/zosfiles/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
All notable changes to the Zowe z/OS files SDK package will be documented in this file.

## Recent Changes
-Enhancement: `Copy.dataset` method now recognizes Partioned data sets and can copy members of source PDS into an existing target PDS. [#2386](https://github.com/zowe/zowe-cli/pull/2386)

- Enhancement: Added a `List.membersMatchingPattern` method to download all members that match a specific pattern.[#2359](https://github.com/zowe/zowe-cli/pull/2359)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,18 @@
*/

import { Create, Upload, Delete, CreateDataSetTypeEnum, Copy, ZosFilesMessages, Get, IDataSet,
ICrossLparCopyDatasetOptions, IGetOptions, IZosFilesResponse } from "../../../../src";
import { Imperative, Session } from "@zowe/imperative";
ICrossLparCopyDatasetOptions, IGetOptions, IZosFilesResponse,
ZosFilesUtils} from "../../../../src";
import { Imperative, IO, Session } from "@zowe/imperative";
import { inspect } from "util";
import { TestEnvironment } from "../../../../../../__tests__/__src__/environment/TestEnvironment";
import { ITestPropertiesSchema } from "../../../../../../__tests__/__src__/properties/ITestPropertiesSchema";
import { join } from "path";
import { readFileSync } from "fs";
import { ITestEnvironment } from "../../../../../../__tests__/__src__/environment/ITestEnvironment";
import { tmpdir } from "os";
import path = require("path");
import * as fs from "fs";

let REAL_SESSION: Session;
let REAL_TARGET_SESSION: Session;
Expand Down Expand Up @@ -98,6 +102,60 @@ describe("Copy", () => {
expect(contents1.toString()).toEqual(contents2.toString());
});
});
describe("Partioned > Partioned", () => {
let downloadDir: string;
beforeEach(async () => {
try {
downloadDir = path.join(tmpdir(), fromDataSetName);
fs.mkdirSync(downloadDir, { recursive: true });
const mockFile = path.join(downloadDir, "mockFile.txt");
fs.writeFileSync(mockFile, "test file content");
Dismissed Show dismissed Hide dismissed

const uploadFileList: string[] = ZosFilesUtils.getFileListFromPath(downloadDir);
const stream = IO.createReadStream(uploadFileList[0]);
await Create.dataSet(REAL_SESSION, CreateDataSetTypeEnum.DATA_SET_SEQUENTIAL, fromDataSetName);
await Create.dataSet(REAL_SESSION, CreateDataSetTypeEnum.DATA_SET_SEQUENTIAL, toDataSetName);
await Upload.streamToDataSet(REAL_SESSION, stream, fromDataSetName);
} catch (err) {
Imperative.console.info(`Error: ${inspect(err)}`);
}
});
it("Should copy a partitioned data set", async () => {
let error;
let response;
let contents1;
let contents2;

try {
response = await Copy.dataSet(
REAL_SESSION,
{dsn: toDataSetName},
{"from-dataset": {
dsn:fromDataSetName
}}
);
contents1 = await Get.dataSet(REAL_SESSION, fromDataSetName);
contents2 = await Get.dataSet(REAL_SESSION, toDataSetName);
Imperative.console.info(`Response: ${inspect(response)}`);
} catch (err) {
error = err;
Imperative.console.info(`Error: ${inspect(err)}`);
}

expect(error).toBeFalsy();

expect(response).toBeTruthy();
expect(response.success).toBe(true);
expect(response.commandResponse).toContain(ZosFilesMessages.datasetCopiedSuccessfully.message);

expect(contents1).toBeTruthy();
expect(contents2).toBeTruthy();
expect(contents1.toString()).toEqual(contents2.toString());
});
afterEach(() => {
fs.rmSync(downloadDir, { recursive: true, force: true });
});
});
describe("Member > Member", () => {
beforeEach(async () => {
try {
Expand Down
147 changes: 143 additions & 4 deletions packages/zosfiles/__tests__/__unit__/methods/copy/Copy.unit.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
*
*/

import { Session, ImperativeError } from "@zowe/imperative";
import { Session, ImperativeError, IO } from "@zowe/imperative";
import { posix } from "path";

import * as fs from "fs";
Fixed Show fixed Hide fixed
import { error } from "console";

import { Copy, Create, Get, List, Upload, ZosFilesConstants, ZosFilesMessages, IZosFilesResponse } from "../../../../src";
import { Copy, Create, Get, List, Upload, ZosFilesConstants, ZosFilesMessages, IZosFilesResponse, Download, ZosFilesUtils } from "../../../../src";
Fixed Show fixed Hide fixed
import { ZosmfHeaders, ZosmfRestClient } from "@zowe/core-for-zowe-sdk";

describe("Copy", () => {
Expand All @@ -33,14 +33,18 @@ describe("Copy", () => {
const fromMemberName = "mem1";
const toDataSetName = "USER.DATA.TO";
const toMemberName = "mem2";
let isPDSSpy: jest.SpyInstance;

beforeEach(() => {
copyExpectStringSpy.mockClear();
copyExpectStringSpy.mockImplementation(async () => {
return "";
});
isPDSSpy = jest.spyOn(Copy as any, "isPDS").mockResolvedValue(false);
});
afterAll(() => {
isPDSSpy.mockRestore();
});

describe("Success Scenarios", () => {
describe("Sequential > Sequential", () => {
it("should send a request", async () => {
Expand Down Expand Up @@ -438,6 +442,40 @@ describe("Copy", () => {
expect(lastArgumentOfCall).toHaveProperty("replace", false);
});
});
describe("Partitioned > Partitioned", () => {
let copyPDSSpy = jest.spyOn(Copy, "copyPDS");
beforeEach(() => {
copyPDSSpy.mockClear();
copyPDSSpy = jest.spyOn(Copy, "copyPDS").mockResolvedValue({
success:true,
commandResponse: ZosFilesMessages.datasetCopiedSuccessfully.message,
});
isPDSSpy = jest.spyOn(Copy as any, "isPDS").mockResolvedValue(true);
});
afterAll(() => {
copyPDSSpy.mockRestore();
isPDSSpy.mockRestore();
});
it("should call copyPDS to copy members of source PDS to target PDS", async () => {
const response = await Copy.dataSet(
dummySession,
{dsn: toDataSetName},
{"from-dataset": {
dsn:fromDataSetName
}}
);
expect(isPDSSpy).toHaveBeenNthCalledWith(1, dummySession, fromDataSetName);
expect(isPDSSpy).toHaveBeenNthCalledWith(2, dummySession, toDataSetName);

expect(copyPDSSpy).toHaveBeenCalledTimes(1);
expect(copyPDSSpy).toHaveBeenCalledWith(dummySession, fromDataSetName, toDataSetName);

expect(response).toEqual({
success: true,
commandResponse: ZosFilesMessages.datasetCopiedSuccessfully.message
});
});
});
});
describe("Failure Scenarios", () => {
it("should fail if the zOSMF REST client fails", async () => {
Expand Down Expand Up @@ -515,6 +553,107 @@ describe("Copy", () => {
});
});

describe("Copy Partitioned Data Set", () => {
const listAllMembersSpy = jest.spyOn(List, "allMembers");
Fixed Show fixed Hide fixed
const downloadAllMembersSpy = jest.spyOn(Download, "allMembers");
Fixed Show fixed Hide fixed
const uploadSpy = jest.spyOn(Upload, "streamToDataSet");
Fixed Show fixed Hide fixed
const fileListPathSpy = jest.spyOn(ZosFilesUtils, "getFileListFromPath");
Fixed Show fixed Hide fixed
const generateMemName = jest.spyOn(ZosFilesUtils, "generateMemberName");
const fromDataSetName = "USER.DATA.FROM";
Fixed Show fixed Hide fixed
const toDataSetName = "USER.DATA.TO";
Fixed Show fixed Hide fixed
const readStream = jest.spyOn(IO, "createReadStream");
const rmSync = jest.spyOn(fs, "rmSync");
const listDatasetSpy = jest.spyOn(List, "dataSet");

const dsPO = {
dsname: fromDataSetName,
dsorg: "PO",
};
const dsPS = {
dsname: fromDataSetName,
dsorg: "PS",
};

it("should detect PDS datasets correctly during copy", async () => {
let caughtError;
let response;
listDatasetSpy.mockImplementation(async (): Promise<any> => {
return {
apiResponse: {
items: [dsPO]
}
};
});
try {
response = await Copy.isPDS(dummySession, dsPO.dsname);
}
catch(e) {
caughtError = e;
Dismissed Show dismissed Hide dismissed
}
expect(response).toEqual(true);
expect(listDatasetSpy).toHaveBeenCalledWith(dummySession, dsPO.dsname, { attributes: true });
});

it("should return false if the data set is not partitioned", async () => {
let response;
let caughtError;
listDatasetSpy.mockImplementation(async (): Promise<any> => {
return {
apiResponse: {
items: [dsPS]
}
};
});
try {
response = await Copy.isPDS(dummySession, dsPS.dsname);
}
catch(e) {
caughtError = e;
Dismissed Show dismissed Hide dismissed
}
expect(response).toEqual(false);
expect(listDatasetSpy).toHaveBeenCalledWith(dummySession, dsPS.dsname, { attributes: true });
});

it("should successfully copy members from source to target PDS", async () => {
let caughtError;
let response;
const sourceResponse = {
apiResponse: {
items: [
{ member: "mem1" },
{ member: "mem2" },
]
}
};
const fileList = ["mem1", "mem2"];

listAllMembersSpy.mockImplementation(async (): Promise<any> => sourceResponse);
downloadAllMembersSpy.mockImplementation(async (): Promise<any> => undefined);
fileListPathSpy.mockReturnValue(fileList);
generateMemName.mockReturnValue("mem1");
readStream.mockReturnValue("test" as any);
uploadSpy.mockResolvedValue(undefined);
rmSync.mockImplementation(jest.fn());


try{
response = await Copy.copyPDS(dummySession, fromDataSetName, toDataSetName);
}
catch(e) {
caughtError = e;
Dismissed Show dismissed Hide dismissed
}
expect(listAllMembersSpy).toHaveBeenCalledWith(dummySession, fromDataSetName);
expect(downloadAllMembersSpy).toHaveBeenCalledWith(dummySession, fromDataSetName, expect.any(Object));
expect(fileListPathSpy).toHaveBeenCalled();
expect(uploadSpy).toHaveBeenCalledTimes(fileList.length);
expect(rmSync).toHaveBeenCalled();
expect(response).toEqual({
success: true,
commandResponse: ZosFilesMessages.datasetCopiedSuccessfully.message,
});
});
});

describe("Data Set Cross LPAR", () => {
const getDatasetSpy = jest.spyOn(Get, "dataSet");
const listDatasetSpy = jest.spyOn(List, "dataSet");
Expand Down
Loading
Loading