Merge pull request zowe#8 from nurra01/directory-to-uss

add system tests for api function, fix bug which doesn't upload dir i…
nurra01 · Jan 29, 2019 · da4a451 · da4a451
2 parents e3590bc + 48e7a44
commit da4a451
Show file tree

Hide file tree

Showing 2 changed files with 316 additions and 24 deletions.
diff --git a/packages/zosfiles/__tests__/__system__/api/methods/upload/Upload.system.test.ts b/packages/zosfiles/__tests__/__system__/api/methods/upload/Upload.system.test.ts
@@ -19,6 +19,7 @@ import { ITestSystemSchema } from "../../../../../../../__tests__/__src__/proper
 import { getUniqueDatasetName, stripNewLines } from "../../../../../../../__tests__/__src__/TestUtils";
 import { Get, ZosFilesConstants } from "../../../../../index";
 import { ZosmfRestClient } from "../../../../../../rest";
+import { IUploadMap } from "../../../../../src/api/methods/upload/doc/IUploadMap";
 
 let REAL_SESSION: Session;
 let testEnvironment: ITestEnvironment;
@@ -471,7 +472,6 @@ describe("Upload USS file", () => {
 
             try {
                 uploadResponse = await Upload.bufferToUSSFile(REAL_SESSION, ussname, data);
-                getResponse = await Get.USSFile(REAL_SESSION, ussname);
             } catch (err) {
                 error = err;
                 Imperative.console.info("Error: " + inspect(error));
@@ -537,3 +537,291 @@ describe("Upload USS file", () => {
     });
 });
 
+describe("Upload a local directory to USS directory", () => {
+    describe("Success scenarios", () => {
+        const localDir = `${__dirname}/testfiles`;
+        let parameters: string = `${ZosFilesConstants.RES_USS_FILES}?path=`;
+        beforeAll(async () => {
+            testEnvironment = await TestEnvironment.setUp({
+                tempProfileTypes: ["zosmf"],
+                testName: "zos_file_upload_dir_to_uss"
+            });
+            systemProps = new TestProperties(testEnvironment.systemTestProperties);
+            defaultSystem = systemProps.getDefaultSystem();
+
+            REAL_SESSION = TestEnvironment.createZosmfSession(testEnvironment);
+
+            parameters += ussname;
+            Imperative.console.info("Using ussfile:" + ussname);
+        });
+
+        afterAll(async () => {
+            await TestEnvironment.cleanUp(testEnvironment);
+        });
+
+        afterEach(async () => {
+            let error;
+            const endpoint: string = ZosFilesConstants.RESOURCE + ZosFilesConstants.RES_USS_FILES + ussname;
+            try {
+                await ZosmfRestClient.deleteExpectString(REAL_SESSION, endpoint, [{"X-IBM-Option": "recursive"}]);
+            } catch (err) {
+                error = err;
+            }
+        });
+
+        it("should upload local directory to USS", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            let isDirectoryExist: boolean;
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, localDir, ussname);
+                Imperative.console.info(`THIS IS USS ${ussname}/testfiles`);
+                isDirectoryExist = await Upload.isDirectoryExist(REAL_SESSION, ussname);
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeFalsy();
+            expect(uploadResponse).toBeDefined();
+            expect(uploadResponse.success).toBeTruthy();
+            expect(isDirectoryExist).toBeDefined();
+            expect(isDirectoryExist).toBeTruthy();
+        });
+
+        it("should upload local directory to USS recursively", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            let isDirectoryExist: any;
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, localDir, ussname, false, true);
+                isDirectoryExist = await Upload.isDirectoryExist(REAL_SESSION, `${ussname}/longline`);
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeFalsy();
+            expect(uploadResponse).toBeDefined();
+            expect(uploadResponse.success).toBeTruthy();
+            expect(isDirectoryExist).toBeDefined();
+            expect(isDirectoryExist).toBeTruthy();
+        });
+
+        it("should upload local directory to USS in binary mode", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            let isDirectoryExist: any;
+            let getResponse;
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, localDir, ussname, true);
+                isDirectoryExist = await Upload.isDirectoryExist(REAL_SESSION, ussname);
+                getResponse = await Get.USSFile(REAL_SESSION, `${ussname}/file1.txt`, {binary: true});
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeFalsy();
+            expect(uploadResponse).toBeDefined();
+            expect(uploadResponse.success).toBeTruthy();
+            expect(isDirectoryExist).toBeDefined();
+            expect(isDirectoryExist).toBeTruthy();
+            expect(getResponse).toEqual(Buffer.from(testdata));
+        });
+
+        it("should upload local directory to USS recursively and all files in binary mode", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            const magicNum = 6;
+            let isDirectoryExist: any;
+            let getResponse;
+            let longResponse: string = "";
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, localDir, ussname, true, true);
+                isDirectoryExist = await Upload.isDirectoryExist(REAL_SESSION, ussname);
+                getResponse = await Get.USSFile(REAL_SESSION, `${ussname}/longline/longline.txt`, {binary: true});
+                for(let i = 0; i < magicNum; i++) {
+                    longResponse += testdata;
+                }
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeFalsy();
+            expect(uploadResponse).toBeDefined();
+            expect(uploadResponse.success).toBeTruthy();
+            expect(isDirectoryExist).toBeDefined();
+            expect(isDirectoryExist).toBeTruthy();
+            expect(getResponse).toEqual(Buffer.from(longResponse));
+        });
+
+        it("should upload local directory to USS some files need to be uploaded as binary", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            let isDirectoryExist: any;
+            let getResponseFile3;
+            let getResponseFile1;
+            let getResponseLongFile;
+            let longResponse: string = "";
+            const magicNum = 6;
+            const filesMap: IUploadMap = {binary:  true, fileNames: ["file3.txt", "longline.txt"]};
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, localDir, ussname, false, true, filesMap);
+                isDirectoryExist = await Upload.isDirectoryExist(REAL_SESSION, `${ussname}/longline`);
+                // file3.txt should be binary as it is mentioned in filesMap
+                getResponseFile3 = await Get.USSFile(REAL_SESSION, `${ussname}/file3.txt`, {binary: true});
+                // longline/longline.txt should be binary as it is mentioned in filesMap
+                getResponseLongFile = await Get.USSFile(REAL_SESSION, `${ussname}/longline/longline.txt`, {binary: true});
+                // file1.txt should be ASCII like other files not mentioned in filesMap
+                getResponseFile1 = await Get.USSFile(REAL_SESSION, `${ussname}/file1.txt`, {binary: false});
+                for(let i = 0; i < magicNum; i++) {
+                    longResponse += testdata;
+                }
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeFalsy();
+            expect(uploadResponse).toBeDefined();
+            expect(uploadResponse.success).toBeTruthy();
+            expect(isDirectoryExist).toBeDefined();
+            expect(isDirectoryExist).toBeTruthy();
+            expect(getResponseFile3).toEqual(Buffer.from(testdata));
+            expect(getResponseLongFile).toEqual(Buffer.from(longResponse));
+            expect(getResponseFile1.toString()).toEqual(testdata);
+        });
+
+        it("should upload local directory to USS some files need to be uploaded as ASCII", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            let isDirectoryExist: any;
+            let getResponseFile3;
+            let getResponseFile1;
+            let getResponseLongFile;
+            let longResponse: string = "";
+            const magicNum = 6;
+            const filesMap: IUploadMap = {binary:  false, fileNames: ["file3.txt", "longline.txt"]};
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, localDir, ussname, true, true, filesMap);
+                isDirectoryExist = await Upload.isDirectoryExist(REAL_SESSION, `${ussname}/longline`);
+                // file3.txt should be ASCII as it is mentioned in filesMap
+                getResponseFile3 = await Get.USSFile(REAL_SESSION, `${ussname}/file3.txt`, {binary: false});
+                // longline/longline.txt should be ASCII as it is mentioned in filesMap
+                getResponseLongFile = await Get.USSFile(REAL_SESSION, `${ussname}/longline/longline.txt`, {binary: false});
+                // file1.txt should be binary like other files not mentioned in filesMap
+                getResponseFile1 = await Get.USSFile(REAL_SESSION, `${ussname}/file1.txt`, {binary: true});
+                for(let i = 0; i < magicNum; i++) {
+                    longResponse += testdata;
+                }
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeFalsy();
+            expect(uploadResponse).toBeDefined();
+            expect(uploadResponse.success).toBeTruthy();
+            expect(isDirectoryExist).toBeDefined();
+            expect(isDirectoryExist).toBeTruthy();
+            expect(getResponseFile3).toEqual(Buffer.from(testdata));
+            expect(getResponseLongFile).toEqual(Buffer.from(longResponse));
+            expect(getResponseFile1).toEqual(Buffer.from(testdata));
+        });
+    });
+
+    describe("Fail scenarios", () => {
+        it("should throw an error if local directory is null", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, null, ussname);
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeDefined();
+            expect(stripNewLines(error.message)).toContain(ZosFilesMessages.missingInputDirectory.message);
+            expect(uploadResponse).not.toBeDefined();
+        });
+
+        it("should throw an error if local directory is empty string", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, "", ussname);
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeDefined();
+            expect(stripNewLines(error.message)).toContain(ZosFilesMessages.missingInputDirectory.message);
+            expect(uploadResponse).not.toBeDefined();
+        });
+
+        it("should throw an error if passed local directory doesn't exist", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, "some/path", ussname);
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeDefined();
+            expect(stripNewLines(error.message)).toContain("no such file or directory");
+            expect(uploadResponse).not.toBeDefined();
+        });
+
+        it("should throw an error if passed local directory is file", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, `${__dirname}/testfiles/file1.txt`, ussname);
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeDefined();
+            expect(stripNewLines(error.message)).toContain(ZosFilesMessages.missingInputDirectory.message);
+            expect(uploadResponse).not.toBeDefined();
+        });
+
+        it("should throw an error if USS directory path is null", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, "some/path", null);
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeDefined();
+            expect(stripNewLines(error.message)).toContain(ZosFilesMessages.missingUSSDirectoryName.message);
+            expect(uploadResponse).not.toBeDefined();
+        });
+
+        it("should throw an error if USS directory path is empty string", async () => {
+            let error;
+            let uploadResponse: IZosFilesResponse;
+            try {
+                uploadResponse = await Upload.dirToUSSDir(REAL_SESSION, "some/path", "");
+            } catch (err) {
+                error = err;
+                Imperative.console.info("Error: " + inspect(error));
+            }
+
+            expect(error).toBeDefined();
+            expect(stripNewLines(error.message)).toContain(ZosFilesMessages.missingUSSDirectoryName.message);
+            expect(uploadResponse).not.toBeDefined();
+        });
+    });
+});
+
diff --git a/packages/zosfiles/src/api/methods/upload/Upload.ts b/packages/zosfiles/src/api/methods/upload/Upload.ts
@@ -467,14 +467,14 @@ export class Upload {
                                     recursive: boolean = false,
                                     filesMap?: IUploadMap): Promise<IZosFilesResponse> {
         ImperativeExpect.toNotBeNullOrUndefined(inputDirectory, ZosFilesMessages.missingInputDirectory.message);
-        ImperativeExpect.toNotBeEqual("", ZosFilesMessages.missingInputDirectory.message);
+        ImperativeExpect.toNotBeEqual(inputDirectory,"", ZosFilesMessages.missingInputDirectory.message);
         ImperativeExpect.toNotBeNullOrUndefined(ussname, ZosFilesMessages.missingUSSDirectoryName.message);
         ImperativeExpect.toNotBeEqual(ussname, "", ZosFilesMessages.missingUSSDirectoryName.message);
 
         // Check if inputDirectory is directory
         if(!fs.lstatSync(inputDirectory).isDirectory()) {
             throw new ImperativeError({
-                msg: ZosFilesMessages.missingInputFile.message
+                msg: ZosFilesMessages.missingInputDirectory.message
             });
         }
 
@@ -496,6 +496,8 @@ export class Upload {
                         } else {
                             tempBinary = binary;
                         }
+                    } else {
+                        tempBinary = binary;
                     }
                     const ussFilePath = path.posix.join(ussname, fileName);
                     await this.fileToUSSFile(session, filePath, ussFilePath, tempBinary);
@@ -517,6 +519,27 @@ export class Upload {
         };
     }
 
+    /**
+     * Check if USS directory exists
+     * @param {AbstractSession} session - z/OS connection info
+     * @param {string} ussname          - the name of uss folder
+     * @return {Promise<boolean>}
+     */
+    public static async isDirectoryExist(session: AbstractSession, ussname: string): Promise<boolean> {
+        const parameters: string = `${ZosFilesConstants.RES_USS_FILES}?path=${ussname}`;
+        try {
+            const response: any = await ZosmfRestClient.getExpectJSON(session, ZosFilesConstants.RESOURCE + parameters);
+            if(response.items) {
+                return true;
+            }
+        } catch (err) {
+            if (err) {
+                return false;
+            }
+        }
+        return false;
+    }
+
     /**
      * Upload directory to USS recursively
      * @param {AbstractSession} session - z/OS connection info
@@ -541,6 +564,8 @@ export class Upload {
                     } else {
                         tempBinary = binary;
                     }
+                } else {
+                    tempBinary = binary;
                 }
                 const ussFilePath = path.posix.join(ussname, fileName);
                 await this.fileToUSSFile(session, filePath, ussFilePath, tempBinary);
@@ -557,27 +582,6 @@ export class Upload {
         return;
     }
 
-    /**
-     * Check if USS directory exists
-     * @param {AbstractSession} session - z/OS connection info
-     * @param {string} ussname          - the name of uss folder
-     * @return {Promise<boolean>}
-     */
-    private static async isDirectoryExist(session: AbstractSession, ussname: string): Promise<boolean> {
-        const parameters: string = `${ZosFilesConstants.RES_USS_FILES}?path=${ussname}`;
-        try {
-            const response: any = await ZosmfRestClient.getExpectJSON(session, ZosFilesConstants.RESOURCE + parameters);
-            if(response.items) {
-                return true;
-            }
-        } catch (err) {
-            if (err) {
-                return false;
-            }
-        }
-        return false;
-    }
-
     /**
      * Get Log
      * @returns {Logger} applicationLogger.