Merge pull request #159 from pcoop/branch1

matthewpwilson · web-flow · commit 55f6ffe61260 · 2019-05-15T17:17:58.000+01:00
Rename parms to follow the naming convention
diff --git a/__tests__/api/BundlePush/BundlePusher.test.ts b/__tests__/api/BundlePush/BundlePusher.test.ts
@@ -415,7 +415,7 @@ describe("BundlePusher01", () => {
 
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01", true,
               "A problem occurred attempting to run 'if [ \"$(ls)\" ]; then rm -r *; fi' in remote directory '/u/ThisDoesNotExist/12345678'. " +
-              "Problem is: The output from the remote command implied that an error occurred.");
+              "Problem is: The output from the remote command implied that an error occurred, return code 1.");
 
         expect(consoleText).toContain("Ssh command exit with non zero status");
         expect(zosMFSpy).toHaveBeenCalledTimes(1);
@@ -434,7 +434,7 @@ describe("BundlePusher01", () => {
 
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01", true,
               "A problem occurred attempting to run 'if [ \"$(ls)\" ]; then rm -r *; fi' in remote directory '/u/ThisDoesNotExist/12345678'. " +
-              "Problem is: The output from the remote command implied that an error occurred.");
+              "Problem is: The output from the remote command implied that an error occurred, return code 127");
 
         expect(consoleText).toContain("Injected FSUM9195 error message");
         expect(zosMFSpy).toHaveBeenCalledTimes(1);
@@ -453,7 +453,7 @@ describe("BundlePusher01", () => {
 
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01", true,
               "A problem occurred attempting to run 'if [ \"$(ls)\" ]; then rm -r *; fi' in remote directory '/u/ThisDoesNotExist/12345678'. " +
-              "Problem is: The output from the remote command implied that an error occurred.");
+              "Problem is: The output from the remote command implied that an error occurred, return code 1.");
 
         expect(consoleText).toContain("Injected FSUM9195 and FSUM9196 error message");
         expect(zosMFSpy).toHaveBeenCalledTimes(1);
@@ -647,7 +647,7 @@ describe("BundlePusher01", () => {
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01", false,
               "A problem occurred attempting to run 'export PATH=\"$PATH:/usr/lpp/IBM/cnj/IBM/node-latest-os390-s390x/bin\" " +
               "&& npm install' in remote directory '/u/ThisDoesNotExist/12345678'. " +
-              "Problem is: The output from the remote command implied that an error occurred.");
+              "Problem is: The output from the remote command implied that an error occurred, return code 1.");
 
         expect(consoleText).toContain("Injected stdout error message");
         expect(zosMFSpy).toHaveBeenCalledTimes(1);
@@ -680,7 +680,7 @@ describe("BundlePusher01", () => {
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01", false,
               "A problem occurred attempting to run 'export PATH=\"$PATH:/usr/lpp/IBM/cnj/IBM/node-latest-os390-s390x/bin\" " +
               "&& npm install' in remote directory '/u/ThisDoesNotExist/12345678'. " +
-              "Problem is: The output from the remote command implied that an error occurred.");
+              "Problem is: The output from the remote command implied that an error occurred, return code 1.");
 
         expect(consoleText).toContain("Injected FSUM7351 not found message");
         expect(zosMFSpy).toHaveBeenCalledTimes(1);
@@ -713,7 +713,7 @@ describe("BundlePusher01", () => {
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01", false,
               "A problem occurred attempting to run 'export PATH=\"$PATH:/usr/lpp/IBM/cnj/IBM/node-latest-os390-s390x/bin\" " +
               "&& npm install' in remote directory '/u/ThisDoesNotExist/12345678'. " +
-              "Problem is: The output from the remote command implied that an error occurred.");
+              "Problem is: The output from the remote command implied that an error occurred, return code 1.");
 
         expect(consoleText).toContain("Injected npm ERR! Exit status 1 message");
         expect(zosMFSpy).toHaveBeenCalledTimes(1);
diff --git a/docs-internal/CLIReadme.md b/docs-internal/CLIReadme.md
diff --git a/src/api/BundlePush/BundlePusher.ts b/src/api/BundlePush/BundlePusher.ts
@@ -372,7 +372,7 @@ export class BundlePusher {
       }
 
       this.sshOutputText = "";
-      const shell = await Shell.executeSshCwd(sshSession, sshCommand, directory, this.sshOutput.bind(this));
+      const sshReturnCode = await Shell.executeSshCwd(sshSession, sshCommand, directory, this.sshOutput.bind(this));
       const upperCaseOutputText = this.sshOutputText.toUpperCase();
 
       // Note that FSUM9195 can imply that we've tried to delete the
@@ -383,19 +383,19 @@ export class BundlePusher {
       const countFSUM9195 = (upperCaseOutputText.match(/FSUM9195/g) || []).length;
       if (countFSUM9195 !== 0 &&
           countFSUM === countFSUM9195 &&
-          shell === 1) {
+          sshReturnCode === 1) {
         isOnlyFSUM9195 = true;
       }
 
       // Now check
       // A. If exit code is non zero
       // B. FSUM9195 is not the only FSUM error
-      if (shell !== 0 && !isOnlyFSUM9195) {
+      if (sshReturnCode !== 0 && !isOnlyFSUM9195) {
         // if we've not already logged the output, log it now
         if (this.params.arguments.verbose !== true) {
           this.params.response.console.log(Buffer.from(this.sshOutputText));
         }
-        throw new Error("The output from the remote command implied that an error occurred.");
+        throw new Error("The output from the remote command implied that an error occurred, return code " + sshReturnCode + ".");
       }
     }
     catch (error) {
diff --git a/src/cli/deploy/bundle/DeployBundle.definition.ts b/src/cli/deploy/bundle/DeployBundle.definition.ts
@@ -44,16 +44,16 @@ export const DeployBundleDefinition: ICommandDefinition = {
     examples: [
         {
             description: "Deploy a CICS bundle with a specific name and location to a default set of target regions",
-            options: `--name EXAMPLE --bundledir /u/example/bundleDir`
+            options: `--name EXAMPLE --bundle-directory /u/example/bundleDir`
         },
         {
             description: "Deploy a CICS bundle, but declare a timeout if the processing takes too long",
-            options: `--name EXAMPLE --bundledir /u/example/bundleDir --timeout 60`
+            options: `--name EXAMPLE --bundle-directory /u/example/bundleDir --timeout 60`
         },
         {
             description: "Deploy a CICS bundle to a specific target environment by using specific zosmf & cics-deploy profiles",
-            options: `--name EXAMPLE --bundledir /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP ` +
-                     `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
+            options: `--name EXAMPLE --bundle-directory /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --res-group BUNDGRP ` +
+                     `--cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
         }
     ]
 };
diff --git a/src/cli/deploy/bundle/options/Bundledir.option.ts b/src/cli/deploy/bundle/options/Bundledir.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 255;
  *
  */
 export const BundledirOption: ICommandOptionDefinition = {
-    name: "bundledir",
-    aliases: ["bd"],
+    name: "bundle-directory",
+    aliases: ["bd", "bundledir", "bundle-dir"],
     type: "string",
     required: true,
     stringLengthRange: [1, MAX_LENGTH],
diff --git a/src/cli/deploy/bundle/options/TargetState.option.ts b/src/cli/deploy/bundle/options/TargetState.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const TargetStateOption: ICommandOptionDefinition = {
-    name: "targetstate",
-    aliases: ["ts"],
+    name: "target-state",
+    aliases: ["ts", "targetstate"],
     type: "string",
     required: false,
     defaultValue: "ENABLED",
diff --git a/src/cli/generate/bundle/GenerateBundle.definition.ts b/src/cli/generate/bundle/GenerateBundle.definition.ts
@@ -29,7 +29,7 @@ export const GenerateBundleDefinition: ICommandDefinition = {
     description: "Generate a CICS bundle in the working directory. " +
                  "The associated data is constructed from a combination of the " +
                  "command-line options and the contents of package.json. If package.json exists, " +
-                 "no options are required. If package.json does not exist, both --startscript and --nodejsapp are required.",
+                 "no options are required. If package.json does not exist, both --start-script and --nodejsapp are required.",
     type: "command",
     handler: __dirname + "/GenerateBundle.handler",
     options: [ BundleidOption, BundleversionOption, NodejsappOption, StartscriptOption, PortOption,
@@ -41,11 +41,11 @@ export const GenerateBundleDefinition: ICommandDefinition = {
         },
         {
             description: "Generate a CICS bundle in the working directory, based on package.json but using a bundle ID of \"mybundle\"",
-            options: `--bundleid mybundle`
+            options: `--bundle-id mybundle`
         },
         {
             description: "Generate a CICS bundle in the working directory in which a package.json does not exist",
-            options: `--bundleid mybundle --nodejsapp myapp --startscript server.js`
+            options: `--bundle-id mybundle --nodejsapp myapp --start-script server.js`
         }
     ]
 };
diff --git a/src/cli/generate/bundle/options/Bundleid.option.ts b/src/cli/generate/bundle/options/Bundleid.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const BundleidOption: ICommandOptionDefinition = {
-    name: "bundleid",
-    aliases: ["b", "id", "bid"],
+    name: "bundle-id",
+    aliases: ["b", "id", "bundleid"],
     type: "string",
     description: "The ID for the generated CICS bundle, up to 64 characters. If no value is " +
                  "specified, a default value is created from the 'name' property " +
diff --git a/src/cli/generate/bundle/options/Bundleversion.option.ts b/src/cli/generate/bundle/options/Bundleversion.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const BundleversionOption: ICommandOptionDefinition = {
-    name: "bundleversion",
-    aliases: ["bv", "bundlever"],
+    name: "bundle-version",
+    aliases: ["bv", "bundleversion"],
     type: "string",
     description: "The major.minor.micro version number for the generated CICS bundle. If no value is " +
                  "specified, a default value of 1.0.0 is used."
diff --git a/src/cli/generate/bundle/options/Startscript.option.ts b/src/cli/generate/bundle/options/Startscript.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const StartscriptOption: ICommandOptionDefinition = {
-    name: "startscript",
-    aliases: ["s", "ss"],
+    name: "start-script",
+    aliases: ["s", "ss", "startscript"],
     type: "string",
     description: "Up to 255 character path to the Node.js start script that runs when " +
                  "the associated bundle is enabled in CICS. If a value is not " +
diff --git a/src/cli/push/bundle/PushBundle.definition.ts b/src/cli/push/bundle/PushBundle.definition.ts
@@ -43,15 +43,15 @@ export const PushBundleDefinition: ICommandDefinition = {
     examples: [
         {
             description: "Push a CICS bundle from the working directory by using default cics-deploy, ssh and zosmf profiles",
-            options: `--name EXAMPLE --targetdir /u/example/bundles`
+            options: `--name EXAMPLE --target-directory /u/example/bundles`
         },
         {
             description: "Push a CICS bundle from the working directory by using specific zosmf, ssh & cics-deploy profiles",
-            options: `--name EXAMPLE --targetdir /u/example/bundles --zosmf-profile testplex --cics-deploy-profile devcics --ssh-profile ssh`
+            options: `--name EXAMPLE --target-directory /u/example/bundles --zosmf-profile testplex --cics-deploy-profile devcics --ssh-profile ssh`
         },
         {
             description: "Push a CICS bundle from the working directory replacing any bundle of the same name that is already deployed",
-            options: `--name EXAMPLE --targetdir /u/example/bundles --overwrite`
+            options: `--name EXAMPLE --target-directory /u/example/bundles --overwrite`
         }
     ]
 };
diff --git a/src/cli/push/bundle/options/Targetdir.option.ts b/src/cli/push/bundle/options/Targetdir.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 255;
  *
  */
 export const TargetdirOption: ICommandOptionDefinition = {
-    name: "targetdir",
-    aliases: ["td"],
+    name: "target-directory",
+    aliases: ["td", "targetdir", "target-dir"],
     type: "string",
     required: true,
     stringLengthRange: [1, MAX_LENGTH],
diff --git a/src/cli/shared/Cicshlq.option.ts b/src/cli/shared/Cicshlq.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 35;
  *
  */
 export const CicshlqOption: ICommandOptionDefinition = {
-    name: "cicshlq",
-    aliases: ["hlq"],
+    name: "cics-hlq",
+    aliases: ["ch", "cicshlq"],
     type: "string",
     required: false,
     stringLengthRange: [1, MAX_LENGTH],
diff --git a/src/cli/shared/Cpsmhlq.option.ts b/src/cli/shared/Cpsmhlq.option.ts
@@ -18,8 +18,8 @@ const MAX_LENGTH = 35;
  *
  */
 export const CpsmhlqOption: ICommandOptionDefinition = {
-    name: "cpsmhlq",
-    aliases: ["cphlq"],
+    name: "cpsm-hlq",
+    aliases: ["cph", "cpsmhlq"],
     type: "string",
     required: false,
     stringLengthRange: [1, MAX_LENGTH],
diff --git a/src/cli/shared/Csdgroup.option.ts b/src/cli/shared/Csdgroup.option.ts
@@ -18,14 +18,14 @@ const MAX_LENGTH = 8;
  *
  */
 export const CsdgroupOption: ICommandOptionDefinition = {
-    name: "csdgroup",
-    aliases: ["cg"],
+    name: "csd-group",
+    aliases: ["cg", "csdgroup"],
     type: "string",
     stringLengthRange: [1, MAX_LENGTH],
     description: "Specifies the CSD group (up to 8 characters) for the bundle resource. If a bundle is " +
                  "deployed, a definition is added to this group. If a bundle is undeployed, then the " +
                  "definition is removed from this group. The definition is added or removed from the CSD of each system " +
-                 "that is specified by the --scope option. The --csdgroup and --resgroup options are " +
+                 "that is specified by the --scope option. The --csd-group and --res-group options are " +
                  "mutually exclusive."
 };
 
diff --git a/src/cli/shared/Jobcard.option.ts b/src/cli/shared/Jobcard.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const JobcardOption: ICommandOptionDefinition = {
-    name: "jobcard",
-    aliases: ["jc"],
+    name: "job-card",
+    aliases: ["jc", "jobcard"],
     type: "string",
     description: "Specifies the job card to use with any generated DFHDPLOY JCL. Use this parameter " +
                  "if you need to tailor the job card and you have not set the --cics-deploy-profile " +
diff --git a/src/cli/shared/Resgroup.option.ts b/src/cli/shared/Resgroup.option.ts
@@ -18,14 +18,14 @@ const MAX_LENGTH = 8;
  *
  */
 export const ResgroupOption: ICommandOptionDefinition = {
-    name: "resgroup",
-    aliases: ["rg"],
+    name: "res-group",
+    aliases: ["rg", "resgroup"],
     type: "string",
     stringLengthRange: [1, MAX_LENGTH],
     conflictsWith: [ "csdgroup" ],
     description: "Specifies the BAS resource group (up to 8 characters) for the bundle resource. If a bundle is " +
                  "deployed, a resource is defined in the BAS data repository. If a bundle is undeployed, the " +
-                 "definition is removed. The --csdgroup and --resgroup options are " +
+                 "definition is removed. The --csd-group and --res-group options are " +
                  "mutually exclusive."
 };
 
diff --git a/src/cli/undeploy/bundle/UndeployBundle.definition.ts b/src/cli/undeploy/bundle/UndeployBundle.definition.ts
@@ -50,8 +50,8 @@ export const UndeployBundleDefinition: ICommandDefinition = {
         },
         {
             description: "Undeploy a CICS bundle from a specific target environment by using specific zosmf and cics-deploy profiles",
-            options: `--name EXAMPLE --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP ` +
-                     `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
+            options: `--name EXAMPLE --cics-plex TESTPLEX --scope SCOPE --res-group BUNDGRP ` +
+                     `--cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
         }
     ]
 };
diff --git a/src/cli/undeploy/bundle/options/TargetState.option.ts b/src/cli/undeploy/bundle/options/TargetState.option.ts
@@ -16,8 +16,8 @@ import { ICommandOptionDefinition } from "@zowe/imperative";
  *
  */
 export const TargetStateOption: ICommandOptionDefinition = {
-    name: "targetstate",
-    aliases: ["ts"],
+    name: "target-state",
+    aliases: ["ts", "targetstate"],
     type: "string",
     required: false,
     defaultValue: "DISCARDED",
diff --git a/src/imperative.ts b/src/imperative.ts

Original file line number	Diff line number	Diff line change
`@@ -372,7 +372,7 @@ export class BundlePusher {`
`372`	`372`	`}`
`373`	`373`
`374`	`374`	`this.sshOutputText = "";`
`375`		`- const shell = await Shell.executeSshCwd(sshSession, sshCommand, directory, this.sshOutput.bind(this));`
	`375`	`+ const sshReturnCode = await Shell.executeSshCwd(sshSession, sshCommand, directory, this.sshOutput.bind(this));`
`376`	`376`	`const upperCaseOutputText = this.sshOutputText.toUpperCase();`
`377`	`377`
`378`	`378`	`// Note that FSUM9195 can imply that we've tried to delete the`
`@@ -383,19 +383,19 @@ export class BundlePusher {`
`383`	`383`	`const countFSUM9195 = (upperCaseOutputText.match(/FSUM9195/g) \|\| []).length;`
`384`	`384`	`if (countFSUM9195 !== 0 &&`
`385`	`385`	`countFSUM === countFSUM9195 &&`
`386`		`- shell === 1) {`
	`386`	`+ sshReturnCode === 1) {`
`387`	`387`	`isOnlyFSUM9195 = true;`
`388`	`388`	`}`
`389`	`389`
`390`	`390`	`// Now check`
`391`	`391`	`// A. If exit code is non zero`
`392`	`392`	`// B. FSUM9195 is not the only FSUM error`
`393`		`- if (shell !== 0 && !isOnlyFSUM9195) {`
	`393`	`+ if (sshReturnCode !== 0 && !isOnlyFSUM9195) {`
`394`	`394`	`// if we've not already logged the output, log it now`
`395`	`395`	`if (this.params.arguments.verbose !== true) {`
`396`	`396`	`this.params.response.console.log(Buffer.from(this.sshOutputText));`
`397`	`397`	`}`
`398`		`- throw new Error("The output from the remote command implied that an error occurred.");`
	`398`	`+ throw new Error("The output from the remote command implied that an error occurred, return code " + sshReturnCode + ".");`
`399`	`399`	`}`
`400`	`400`	`}`
`401`	`401`	`catch (error) {`
Original file line number	Diff line number	Diff line change
`@@ -44,16 +44,16 @@ export const DeployBundleDefinition: ICommandDefinition = {`
`44`	`44`	`examples: [`
`45`	`45`	`{`
`46`	`46`	`description: "Deploy a CICS bundle with a specific name and location to a default set of target regions",`
`47`		- options: `--name EXAMPLE --bundledir /u/example/bundleDir`
	`47`	+ options: `--name EXAMPLE --bundle-directory /u/example/bundleDir`
`48`	`48`	`},`
`49`	`49`	`{`
`50`	`50`	`description: "Deploy a CICS bundle, but declare a timeout if the processing takes too long",`
`51`		- options: `--name EXAMPLE --bundledir /u/example/bundleDir --timeout 60`
	`51`	+ options: `--name EXAMPLE --bundle-directory /u/example/bundleDir --timeout 60`
`52`	`52`	`},`
`53`	`53`	`{`
`54`	`54`	`description: "Deploy a CICS bundle to a specific target environment by using specific zosmf & cics-deploy profiles",`
`55`		- options: `--name EXAMPLE --bundledir /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --resgroup BUNDGRP ` +
`56`		- `--cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
	`55`	+ options: `--name EXAMPLE --bundle-directory /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --res-group BUNDGRP ` +
	`56`	+ `--cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics`
`57`	`57`	`}`
`58`	`58`	`]`
`59`	`59`	`};`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ export const GenerateBundleDefinition: ICommandDefinition = {`
`29`	`29`	`description: "Generate a CICS bundle in the working directory. " +`
`30`	`30`	`"The associated data is constructed from a combination of the " +`
`31`	`31`	`"command-line options and the contents of package.json. If package.json exists, " +`
`32`		`- "no options are required. If package.json does not exist, both --startscript and --nodejsapp are required.",`
	`32`	`+ "no options are required. If package.json does not exist, both --start-script and --nodejsapp are required.",`
`33`	`33`	`type: "command",`
`34`	`34`	`handler: __dirname + "/GenerateBundle.handler",`
`35`	`35`	`options: [ BundleidOption, BundleversionOption, NodejsappOption, StartscriptOption, PortOption,`
`@@ -41,11 +41,11 @@ export const GenerateBundleDefinition: ICommandDefinition = {`
`41`	`41`	`},`
`42`	`42`	`{`
`43`	`43`	`description: "Generate a CICS bundle in the working directory, based on package.json but using a bundle ID of \"mybundle\"",`
`44`		- options: `--bundleid mybundle`
	`44`	+ options: `--bundle-id mybundle`
`45`	`45`	`},`
`46`	`46`	`{`
`47`	`47`	`description: "Generate a CICS bundle in the working directory in which a package.json does not exist",`
`48`		- options: `--bundleid mybundle --nodejsapp myapp --startscript server.js`
	`48`	+ options: `--bundle-id mybundle --nodejsapp myapp --start-script server.js`
`49`	`49`	`}`
`50`	`50`	`]`
`51`	`51`	`};`