Merge pull request #2003 from zowe/fix/better-validation-errors

Improve error message for null option definition
zowe · Jan 5, 2024 · dafbce6 · dafbce6
2 parents e13f4d5 + 7595412
commit dafbce6
Show file tree

Hide file tree

Showing 19 changed files with 71 additions and 69 deletions.
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -6,6 +6,7 @@ All notable changes to the Zowe CLI package will be documented in this file.
 
 - BugFix: Correct extra character being displayed at the end of lines when issuing `zowe files compare` on Windows. [#1992](https://github.com/zowe/zowe-cli/issues/1992)
 - BugFix: Correct the online help description for `zowe files compare uss`. [#1754](https://github.com/zowe/zowe-cli/issues/1754)
+- BugFix: Fixed typo in command help for `zowe zos-workflows create` commands.
 
 ## `7.20.1`
 

diff --git a/...n__/create/dataset/__snapshots__/cli.workflows.create.workflowDs.integration.test.ts.snap b/...n__/create/dataset/__snapshots__/cli.workflows.create.workflowDs.integration.test.ts.snap
diff --git a/...e/localfile/__snapshots__/cli.workflows.create.workflowLocalFile.integration.test.ts.snap b/...e/localfile/__snapshots__/cli.workflows.create.workflowLocalFile.integration.test.ts.snap
diff --git a/...__/create/ussfile/__snapshots__/cli.workflows.create.workflowUss.integration.test.ts.snap b/...__/create/ussfile/__snapshots__/cli.workflows.create.workflowUss.integration.test.ts.snap
diff --git a/...__/workflows/__system__/List/activeWorkflows/__scripts__/command/command_list_workflow.sh b/...__/workflows/__system__/List/activeWorkflows/__scripts__/command/command_list_workflow.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 wname=$1
-definiton=$2
+definition=$2
 sysname=$3
 owner=$4
 set -e

diff --git a/.../workflows/__system__/List/archivedWorkflows/__scripts__/command/command_list_workflow.sh b/.../workflows/__system__/List/archivedWorkflows/__scripts__/command/command_list_workflow.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 wname=$1
-definiton=$2
+definition=$2
 sysname=$3
 owner=$4
 set -e

diff --git a/...i/__tests__/workflows/__system__/create/__scripts__/command/command_create_workflow_ds.sh b/...i/__tests__/workflows/__system__/create/__scripts__/command/command_create_workflow_ds.sh
@@ -1,12 +1,12 @@
 #!/bin/bash
 wname=$1
-definiton=$2
+definition=$2
 sysname=$3
 owner=$4
 set -e
 
 echo "================Z/OS WORKFLOWS CREATE DATA-SET ==============="
-zowe zos-workflows create workflow-from-data-set $wname --data-set "$definiton" --system-name $sysname --owner $owner $5
+zowe zos-workflows create workflow-from-data-set $wname --data-set "$definition" --system-name $sysname --owner $owner $5
 if [ $? -gt 0 ]
 then
     exit $?

diff --git a/...s__/workflows/__system__/create/__scripts__/command/command_create_workflow_local_file.sh b/...s__/workflows/__system__/create/__scripts__/command/command_create_workflow_local_file.sh
@@ -1,12 +1,12 @@
 #!/bin/bash
 wname=$1
-definiton=$2
+definition=$2
 sysname=$3
 owner=$4
 set -e
 
 echo "================Z/OS WORKFLOWS CREATE LOCAL-FILE ==============="
-zowe zos-workflows create workflow-from-local-file $wname --local-file "$definiton" --system-name $sysname --owner $owner $5
+zowe zos-workflows create workflow-from-local-file $wname --local-file "$definition" --system-name $sysname --owner $owner $5
 if [ $? -gt 0 ]
 then
 	exit $?

diff --git a/.../__tests__/workflows/__system__/create/__scripts__/command/command_create_workflow_uss.sh b/.../__tests__/workflows/__system__/create/__scripts__/command/command_create_workflow_uss.sh
@@ -1,12 +1,12 @@
 #!/bin/bash
 wname=$1
-definiton=$2
+definition=$2
 sysname=$3
 owner=$4
 set -e
 
 echo "================Z/OS WORKFLOWS CREATE USS-FILE ==============="
-zowe zos-workflows create workflow-from-uss-file $wname --uss-file "$definiton" --system-name $sysname --owner $owner $5
+zowe zos-workflows create workflow-from-uss-file $wname --uss-file "$definition" --system-name $sysname --owner $owner $5
 if [ $? -gt 0 ]
 then
     exit $?

diff --git a/...ts__/workflows/__unit__/create/dataset/__snapshots__/Dataset.definition.unit.test.ts.snap b/...ts__/workflows/__unit__/create/dataset/__snapshots__/Dataset.definition.unit.test.ts.snap
@@ -8,11 +8,11 @@ Object {
   "description": "Create a z/OSMF workflow on a z/OS system using a Data set",
   "examples": Array [
     Object {
-      "description": "Create a workflow with name \\"testworkflow\\" using the data set \\"TESTID.WKFLOW\\" that contains the workflow definition xml on the system \\"TESTM1\\" with owner \\"OTHERID\\" and delete workflow with the same name if it already exist in z/OSMF",
+      "description": "Create a workflow with name \\"testworkflow\\" using the data set \\"TESTID.WKFLOW\\" that contains the workflow definition xml on the system \\"TESTM1\\" with owner \\"OTHERID\\" and delete workflow with the same name if it already exists in z/OSMF",
       "options": "\\"testworkflow\\" --data-set \\"TESTID.WKFLOW\\" --system-name \\"TESTM1\\" --owner \\"OTHERID\\" --overwrite",
     },
     Object {
-      "description": "Create a workflow with name \\"testworkflow\\" using data set \\"TESTID.WKFLOW\\" containing workflow definition xml, on system \\"TESTM1\\" with owner \\"MYSYSID\\" and delete succesfully completed jobs",
+      "description": "Create a workflow with name \\"testworkflow\\" using data set \\"TESTID.WKFLOW\\" containing workflow definition xml, on system \\"TESTM1\\" with owner \\"MYSYSID\\" and delete successfully completed jobs",
       "options": "\\"testworkflow\\" --data-set \\"TESTID.WKFLOW\\" --system-name \\"TESTM1\\" --owner \\"MYSYSID\\" --delete-completed",
     },
     Object {
@@ -30,7 +30,7 @@ Object {
       "aliases": Array [
         "ds",
       ],
-      "description": "Data set that contains a workflow definiton.",
+      "description": "Data set that contains a workflow definition.",
       "name": "data-set",
       "required": true,
       "type": "string",

diff --git a/.../workflows/__unit__/create/localfile/__snapshots__/LocalFile.definition.unit.test.ts.snap b/.../workflows/__unit__/create/localfile/__snapshots__/LocalFile.definition.unit.test.ts.snap
@@ -8,7 +8,7 @@ Object {
   "description": "Create a z/OSMF workflow on a z/OS system using a Local file",
   "examples": Array [
     Object {
-      "description": "Create a workflow with name \\"testworkflow\\" using the local file \\"TESTID_WKFLOW.xml\\" that contains the workflow definition xml on the system \\"TESTM1\\" with owner \\"OTHERID\\" and delete workflow with the same name if it already exist in z/OSMF",
+      "description": "Create a workflow with name \\"testworkflow\\" using the local file \\"TESTID_WKFLOW.xml\\" that contains the workflow definition xml on the system \\"TESTM1\\" with owner \\"OTHERID\\" and delete workflow with the same name if it already exists in z/OSMF",
       "options": "\\"testworkflow\\" --local-file \\"TESTID_WKFLOW.xml\\" --system-name \\"TESTM1\\" --owner \\"OTHERID\\" --overwrite",
     },
   ],
@@ -18,7 +18,7 @@ Object {
       "aliases": Array [
         "lf",
       ],
-      "description": "Local file that contains workflow definiton.",
+      "description": "Local file that contains workflow definition.",
       "name": "local-file",
       "required": true,
       "type": "string",

diff --git a/...ts__/workflows/__unit__/create/ussfile/__snapshots__/UssFile.definition.unit.test.ts.snap b/...ts__/workflows/__unit__/create/ussfile/__snapshots__/UssFile.definition.unit.test.ts.snap
@@ -8,7 +8,7 @@ Object {
   "description": "Create a workflow instance in z/OSMF using a USS file",
   "examples": Array [
     Object {
-      "description": "Create a workflow with name \\"testworkflow\\" using uss file \\"/path/workflow.xml\\" containing workflow definition, on system \\"TESTM1\\" with owner \\"OTHERID\\" and delete workflow with the same name if it already exist in z/OSMF",
+      "description": "Create a workflow with name \\"testworkflow\\" using uss file \\"/path/workflow.xml\\" containing workflow definition, on system \\"TESTM1\\" with owner \\"OTHERID\\" and delete workflow with the same name if it already exists in z/OSMF",
       "options": "\\"testworkflow\\" --uss-file \\"/path/workflow.xml\\" --system-name \\"TESTM1\\" --owner \\"OTHERID\\" --overwrite",
     },
     Object {
@@ -30,7 +30,7 @@ Object {
       "aliases": Array [
         "uf",
       ],
-      "description": "Uss file that contains workflow definiton.",
+      "description": "Uss file that contains workflow definition.",
       "name": "uss-file",
       "required": true,
       "type": "string",

diff --git a/packages/cli/src/workflows/create/Create.common.options.ts b/packages/cli/src/workflows/create/Create.common.options.ts
@@ -17,38 +17,38 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
 export const CreateCommonOptions: { [key: string]: ICommandOptionDefinition } = {
 
     /**
-     * Data set containing workflow definiton option.
+     * Data set containing workflow definition option.
      * @type {ICommandOptionDefinition}
      */
     dataSet: {
         name: "data-set",
         aliases: ["ds"],
         type: "string",
-        description: "Data set that contains a workflow definiton.",
+        description: "Data set that contains a workflow definition.",
         required: true
     },
 
     /**
-     * Uss file containing workflow definiton option.
+     * Uss file containing workflow definition option.
      * @type {ICommandOptionDefinition}
      */
     ussFile: {
         name: "uss-file",
         aliases: ["uf"],
         type: "string",
-        description: "Uss file that contains workflow definiton.",
+        description: "Uss file that contains workflow definition.",
         required: true
     },
 
     /**
-     * Local file containing workflow definiton option.
+     * Local file containing workflow definition option.
      * @type {ICommandOptionDefinition}
      */
     localFile: {
         name: "local-file",
         aliases: ["lf"],
         type: "string",
-        description: "Local file that contains workflow definiton.",
+        description: "Local file that contains workflow definition.",
         required: true
     },
 

diff --git a/packages/cli/src/workflows/create/dataset/Dataset.definition.ts b/packages/cli/src/workflows/create/dataset/Dataset.definition.ts
@@ -52,12 +52,12 @@ export const DataSet: ICommandDefinition = {
     examples: [
         {
             description: "Create a workflow with name \"testworkflow\" using the data set \"TESTID.WKFLOW\" that contains the workflow " +
-            "definition xml on the system \"TESTM1\" with owner \"OTHERID\" and delete workflow with the same name if it already exist in z/OSMF",
+            "definition xml on the system \"TESTM1\" with owner \"OTHERID\" and delete workflow with the same name if it already exists in z/OSMF",
             options: "\"testworkflow\" --data-set \"TESTID.WKFLOW\" --system-name \"TESTM1\" --owner \"OTHERID\" --overwrite"
         },
         {
             description: "Create a workflow with name \"testworkflow\" using data set \"TESTID.WKFLOW\" containing workflow definition xml, " +
-            "on system \"TESTM1\" with owner \"MYSYSID\" and delete succesfully completed jobs",
+            "on system \"TESTM1\" with owner \"MYSYSID\" and delete successfully completed jobs",
             options: "\"testworkflow\" --data-set \"TESTID.WKFLOW\" --system-name \"TESTM1\" --owner \"MYSYSID\" --delete-completed"
         },
         {

diff --git a/packages/cli/src/workflows/create/localfile/LocalFile.definition.ts b/packages/cli/src/workflows/create/localfile/LocalFile.definition.ts
@@ -54,7 +54,7 @@ export const LocalFile: ICommandDefinition = {
     examples: [
         {
             description: "Create a workflow with name \"testworkflow\" using the local file \"TESTID_WKFLOW.xml\" that contains the workflow " +
-            "definition xml on the system \"TESTM1\" with owner \"OTHERID\" and delete workflow with the same name if it already exist in z/OSMF",
+            "definition xml on the system \"TESTM1\" with owner \"OTHERID\" and delete workflow with the same name if it already exists in z/OSMF",
             options: "\"testworkflow\" --local-file \"TESTID_WKFLOW.xml\" --system-name \"TESTM1\" --owner \"OTHERID\" --overwrite"
         }
     ]

diff --git a/packages/cli/src/workflows/create/ussfile/UssFile.definition.ts b/packages/cli/src/workflows/create/ussfile/UssFile.definition.ts
@@ -52,7 +52,7 @@ export const UssFile: ICommandDefinition = {
     examples: [
         {
             description: "Create a workflow with name \"testworkflow\" using uss file \"/path/workflow.xml\" containing workflow definition, " +
-            "on system \"TESTM1\" with owner \"OTHERID\" and delete workflow with the same name if it already exist in z/OSMF",
+            "on system \"TESTM1\" with owner \"OTHERID\" and delete workflow with the same name if it already exists in z/OSMF",
             options: "\"testworkflow\" --uss-file \"/path/workflow.xml\" --system-name \"TESTM1\" --owner \"OTHERID\" --overwrite"
         },
         {

diff --git a/packages/imperative/CHANGELOG.md b/packages/imperative/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- BugFix: Fixed error message shown for null option definition to include details about which command caused the error. [#2002](https://github.com/zowe/zowe-cli/issues/2002)
+
 ## `5.19.0`
 
 - Enhancement: Deprecated function AbstractCommandYargs.getBrightYargsResponse in favor of AbstractCommandYargs.getZoweYargsResponse

diff --git a/packages/imperative/src/cmd/__tests__/CommandPreparer.unit.test.ts b/packages/imperative/src/cmd/__tests__/CommandPreparer.unit.test.ts
@@ -265,7 +265,7 @@ describe("Command Preparer", () => {
         expect(error.message).toMatchSnapshot();
     });
 
-    it("should be able to detect  if a chained handlers index is out of bounds", () => {
+    it("should be able to detect if a chained handlers index is out of bounds", () => {
         let error: ImperativeError;
         try {
             const newDef: ICommandDefinition = {
@@ -294,7 +294,7 @@ describe("Command Preparer", () => {
     });
 
 
-    it("should be able to detect  if a chained handler mapping has no 'to' field", () => {
+    it("should be able to detect if a chained handler mapping has no 'to' field", () => {
         let error: Error;
         try {
             const newDef: ICommandDefinition = {
@@ -326,7 +326,7 @@ describe("Command Preparer", () => {
     });
 
 
-    it("should be able to detect  if a chained handler mapping has both a 'from' field and a 'value' field", () => {
+    it("should be able to detect if a chained handler mapping has both a 'from' field and a 'value' field", () => {
         let error: Error;
         try {
             const newDef: ICommandDefinition = {