Add --ignore-not-found flag logic to zosfilesBase.handler and update command definitions and en.ts for delete operations

packages/cli/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to the Zowe CLI package will be documented in this file.
 
+## Recent Changes
+- Enhancement: Add --quiet flag logic to zosfilesBase.handler and update command definitions and en.ts for delete operations. [#2254](https://github.com/zowe/zowe-cli/pull/2254)
+
 ## `8.0.0-next.202408261543`
 
 - BugFix: Updated `micromatch` dependency for technical currency. [#2242](https://github.com/zowe/zowe-cli/pull/2242)

packages/cli/__tests__/zosfiles/__unit__/delete/zfs/zfs.handler.unit.test.ts

@@ -11,46 +11,73 @@
 
 import { Delete, IZosFilesResponse } from "@zowe/zos-files-for-zowe-sdk";
 import ZfsHandler from "../../../../../src/zosfiles/delete/zfs/zfs.handler";
-import { ZosFilesBaseHandler } from "../../../../../src/zosfiles/ZosFilesBase.handler";
+import { AbstractSession, ConnectionPropsForSessCfg, ImperativeError } from "@zowe/imperative";
 
 describe("ZfsHandler", () => {
     const defaultReturn: IZosFilesResponse = {
-        success        : true,
-        commandResponse: "THIS IS A TEST"
+        success: true,
+        commandResponse: "THIS IS A TEST",
     };
 
-    const deleteZfs = jest.spyOn(Delete, "zfs");
+    const fileNotFoundError = new ImperativeError({
+        msg: "IDC3012I ENTRY HLQ.MYNEW.ZFS NOT FOUND",
+        additionalDetails: "",
+        errorCode: '404'
+    });
+
+    let deleteZfsSpy: any;
+    // let processWithSessionSpy: any;
 
     beforeEach(() => {
-        deleteZfs.mockClear();
-        deleteZfs.mockImplementation(async () => defaultReturn);
+        jest.spyOn(ConnectionPropsForSessCfg, "addPropsOrPrompt").mockResolvedValue({
+            hostname: "example.com"
+        });
+        deleteZfsSpy = jest.spyOn(Delete, "zfs");
+        deleteZfsSpy.mockClear();
+        deleteZfsSpy.mockImplementation(async () => defaultReturn);
     });
 
-    it("should call Delete.zfs", async () => {
-        const handler = new ZfsHandler();
-
-        expect(handler).toBeInstanceOf(ZosFilesBaseHandler);
+    it("should return success: true when --quiet (-fq) flag is used and file is not found", async () => {
+        deleteZfsSpy.mockImplementation(() => {
+            throw fileNotFoundError;
+        });
 
+        const handler = new ZfsHandler();
         const commandParameters: any = {
             arguments: {
                 fileSystemName: "ABCD",
-                responseTimeout: 5
+                forSure: true,
+                quiet: true,
+            },
+            response: {
+                progress: { endBar: jest.fn() },
+                data: { setObj: jest.fn() }
             }
         };
 
-        const dummySession = {
-            lazyness: "(n.) An important quality for a developer to have."
-        }; // I'm lazy and we don't actually need the object
-        const rtoObject = {responseTimeout: 5};
+        // const error = new ImperativeError({msg: "IDC3012I ENTRY HLQ.MYNEW.ZFS NOT FOUND"});
+        // await expect(handler.processWithSession(commandParameters, {} as any)).rejects.toThrow(ImperativeError);
+        // await expect(handler.processWithSession(commandParameters, {} as any)).rejects.toThrow(error);
+        // await expect(handler.processWithSession(commandParameters, {} as any)).resolves.toEqual({ success: true });
+        await expect(handler.process(commandParameters)).resolves.toBe(undefined);
+        // await expect(handler.process(commandParameters)).resolves.toEqual({ success: true });
+    });
+
+    it("should throw file not found error (404) when --quiet is not used (-f)", async () => {
+        deleteZfsSpy.mockImplementation(() => {
+            throw fileNotFoundError;
+        });
 
-        const response = await handler.processWithSession(commandParameters, dummySession as any);
+        const handler = new ZfsHandler();
+        const commandParameters: any = {
+            arguments: {
+                fileSystemName: "ABCD",
+                forSure: true // --forSure flag, no --quiet flag
+            }
+        };
 
-        expect(deleteZfs).toHaveBeenCalledTimes(1);
-        expect(deleteZfs).toHaveBeenLastCalledWith(
-            dummySession,
-            commandParameters.arguments.fileSystemName,
-            rtoObject
-        );
-        expect(response).toBe(defaultReturn);
+        const error = new ImperativeError({ msg: "IDC3012I ENTRY HLQ.MYNEW.ZFS NOT FOUND" });
+        // await expect(handler.processWithSession(commandParameters, {} as any)).rejects.toThrow(ImperativeError);
+        await expect(handler.processWithSession(commandParameters, {} as any)).rejects.toThrow(error);
     });
 });

packages/cli/src/zosfiles/-strings-/en.ts

@@ -251,11 +251,13 @@ export default {
                 OPTIONS: {
                     VOLUME: "The volume serial (VOLSER) where the data set resides. The option is required only when the data set is not" +
                         " catalogued on the system.",
-                    FOR_SURE: "Specify this option to confirm that you want to delete the data set permanently."
+                    FOR_SURE: "Specify this option to confirm that you want to delete the data set permanently.",
+                    QUIET: "Suppress errors if the data set does not exist."
                 },
                 EXAMPLES: {
                     EX1: "Delete the data set named 'ibmuser.cntl'",
-                    EX2: "Delete the data set member named 'ibmuser.cntl(mem)'"
+                    EX2: "Delete the data set member named 'ibmuser.cntl(mem)'",
+                    EX3: "Quietly delete a data set, suppressing errors if it doesn't exist"
                 }
             },
             MIGRATED_DATA_SET: {
@@ -283,13 +285,15 @@ export default {
                     FOR_SURE: "Specify this option to confirm that you want to delete the VSAM cluster permanently.",
                     ERASE: "Specify this option to overwrite the data component for the cluster with binary zeros. This " +
                         "option is ignored if the NOERASE attribute was specified when the cluster was defined or altered.",
-                    PURGE: "Specify this option to delete the VSAM cluster regardless of its retention period or date."
+                    PURGE: "Specify this option to delete the VSAM cluster regardless of its retention period or date.",
+                    QUIET: "Suppress errors if the VSAM data set does not exist."
                 },
                 EXAMPLES: {
                     EX1: "Delete the VSAM data set named 'ibmuser.cntl.vsam'",
                     EX2: "Delete all expired VSAM data sets that match 'ibmuser.AAA.**.FFF'",
                     EX3: "Delete a non-expired VSAM data set named 'ibmuser.cntl.vsam'",
-                    EX4: "Delete an expired VSAM data set named 'ibmuser.cntl.vsam' by overwriting the components with zeros"
+                    EX4: "Delete an expired VSAM data set named 'ibmuser.cntl.vsam' by overwriting the components with zeros",
+                    EX5: "Quietly delete VSAM data set, suppressing errors if it doesn't exist"
                 }
             },
             USS: {
@@ -300,12 +304,14 @@ export default {
                 },
                 OPTIONS: {
                     FOR_SURE: "Specify this option to confirm that you want to delete the file or directory permanently.",
-                    RECURSIVE: "Delete directories recursively."
+                    RECURSIVE: "Delete directories recursively.",
+                    QUIET: "Suppress errors if the file does not exist."
                 },
                 EXAMPLES: {
                     EX1: "Delete the empty directory '/u/ibmuser/testcases'",
                     EX2: "Delete the file named '/a/ibmuser/my_text.txt'",
-                    EX3: "Recursively delete the directory named '/u/ibmuser/testcases'"
+                    EX3: "Recursively delete the directory named '/u/ibmuser/testcases'",
+                    EX4: "Quietly delete a file, suppressing errors if the file doesn't exist"
                 }
             },
             ZFS: {
@@ -315,10 +321,14 @@ export default {
                     FILESYSTEMNAME: "The name of the z/OS file system that you want to delete."
                 },
                 OPTIONS: {
-                    FOR_SURE: "Specify this option to confirm that you want to delete the ZFS permanently."
+                    FOR_SURE: "Specify this option to confirm that you want to delete the ZFS permanently.",
+                    QUIET: "Suppress errors if the z/OS file does not exist."
+
                 },
                 EXAMPLES: {
-                    EX1: "Delete the z/OS file system 'HLQ.MYNEW.ZFS'"
+                    EX1: "Delete the z/OS file system 'HLQ.MYNEW.ZFS'",
+                    EX2: "Quietly delete a z/OS file, suppressing errors if the file doesn't exist"
+
                 }
             }
         }

packages/cli/src/zosfiles/ZosFilesBase.handler.ts

@@ -39,33 +39,28 @@ export abstract class ZosFilesBaseHandler implements ICommandHandler {
      *
      * @returns {Promise<void>}
      */
-    public async process(commandParameters: IHandlerParameters) {
+    public async process(commandParameters: IHandlerParameters): Promise<void> {
         const sessCfg: ISession = ZosmfSession.createSessCfgFromArgs(
             commandParameters.arguments
         );
         const sessCfgWithCreds = await ConnectionPropsForSessCfg.addPropsOrPrompt<ISession>(
-            sessCfg, commandParameters.arguments, {parms: commandParameters}
+            sessCfg, commandParameters.arguments, { parms: commandParameters }
         );
-
         const session = new Session(sessCfgWithCreds);
-        const response = await this.processWithSession(commandParameters, session);
-
         commandParameters.response.progress.endBar(); // end any progress bars
-        // Print out the response
-        if (response.commandResponse) {
-            commandParameters.response.console.log(response.commandResponse);
-        }
-
-        // Return as an object when using --response-format-json
-        commandParameters.response.data.setObj(response);
-
-        // Ensure error gets thrown if request was unsuccessful.
-        // Sometimes it is useful to delay throwing an error until the end of the handler is
-        // reached, for example the upload API needs to return an API response even when it fails.
-        if (!response.success && response.commandResponse) {
-            throw new ImperativeError({
-                msg: response.errorMessage || response.commandResponse
-            });
+        try {
+            const response = await this.processWithSession(commandParameters, session);
+            if (response.commandResponse) {
+                commandParameters.response.console.log(response.commandResponse);
+            }
+        } catch (error) {
+            if (commandParameters.arguments.quiet && error.errorCode === '404') {
+                commandParameters.response.data.setObj({ success: true });
+            } else {
+                throw new ImperativeError({
+                    msg: error.mMessage
+                });
+            }
         }
     }
 

packages/cli/src/zosfiles/delete/ds/Ds.definition.ts

@@ -53,6 +53,13 @@ export const DsDefinition: ICommandDefinition = {
             aliases: ["vol"],
             description: strings.OPTIONS.VOLUME,
             type: "string"
+        },
+        {
+            name: "quiet",
+            aliases: ["q"],
+            description: strings.OPTIONS.QUIET,
+            type: "boolean",
+            required: false
         }
     ] as ICommandOptionDefinition[]).sort((a, b) => a.name.localeCompare(b.name)),
     examples: [
@@ -63,6 +70,10 @@ export const DsDefinition: ICommandDefinition = {
         {
             description: strings.EXAMPLES.EX2,
             options: `"ibmuser.cntl(mem)" -f`
+        },
+        {
+            description: strings.EXAMPLES.EX3,
+            options: `"ibmuser.cntl(mem)" -q`
         }
     ]
 };

packages/cli/src/zosfiles/delete/uss/Uss.definition.ts

@@ -54,6 +54,13 @@ export const UssDefinition: ICommandDefinition = {
             description: strings.OPTIONS.RECURSIVE,
             type: "boolean",
             required: false
+        },
+        {
+            name: "quiet",
+            aliases: ["q"],
+            description: strings.OPTIONS.QUIET,
+            type: "boolean",
+            required: false
         }
     ],
     examples: [
@@ -68,6 +75,10 @@ export const UssDefinition: ICommandDefinition = {
         {
             description: strings.EXAMPLES.EX3,
             options: `"/a/ibmuser/testcases" -rf`
+        },
+        {
+            description: strings.EXAMPLES.EX4,
+            options: `"/a/ibmuser/testcases" -q`
         }
     ]
 };

packages/cli/src/zosfiles/delete/vsam/Vsam.definition.ts

@@ -61,6 +61,13 @@ export const VsamDefinition: ICommandDefinition = {
             description: strings.OPTIONS.PURGE,
             type: "boolean",
             defaultValue: false
+        },
+        {
+            name: "quiet",
+            aliases: ["q"],
+            description: strings.OPTIONS.QUIET,
+            type: "boolean",
+            required: false
         }
     ] as ICommandOptionDefinition[]).sort((a, b) => a.name.localeCompare(b.name)),
     examples: [
@@ -79,6 +86,10 @@ export const VsamDefinition: ICommandDefinition = {
         {
             description: strings.EXAMPLES.EX4,
             options: `"ibmuser.cntl.vsam" -f --erase`
-        }
+        },
+        {
+            description: strings.EXAMPLES.EX2,
+            options: `"ibmuser.cntl.vsam" -q`
+        },
     ]
 };

packages/cli/src/zosfiles/delete/zfs/zfs.definition.ts

@@ -47,12 +47,23 @@ export const ZfsDefinition: ICommandDefinition = {
             description: strings.OPTIONS.FOR_SURE,
             type: "boolean",
             required: true
+        },
+        {
+            name: "quiet",
+            aliases: ["q"],
+            description: strings.OPTIONS.QUIET,
+            type: "boolean",
+            required: false
         }
     ] as ICommandOptionDefinition[]).sort((a, b) => a.name.localeCompare(b.name)),
     examples: [
         {
             description: strings.EXAMPLES.EX1,
             options: `"HLQ.MYNEW.ZFS" -f`
+        },
+        {
+            description: strings.EXAMPLES.EX1,
+            options: `"HLQ.MYNEW.ZFS" -q`
         }
     ]
 };