Merge pull request #88 from pcoop/branch1

Assorted tweaks

Author: matthewpwilson

__tests__/api/BundlePush/BundlePusher.test.ts

@@ -335,6 +335,24 @@ describe("BundlePusher01", () => {
         expect(membersSpy).toHaveBeenCalledTimes(2);
         expect(submitSpy).toHaveBeenCalledTimes(2);
     });
+    it("should not tolerate mixture of FSUM9195 and other FSUM messages", async () => {
+        shellSpy.mockImplementation((session: any, cmd: string, dir: string, stdoutHandler: (data: string) => void) => {
+          stdoutHandler("Injected FSUM9195 and FSUM9196 error message");
+        });
+
+        await runPushTestWithError("__tests__/__resources__/ExampleBundle01", true,
+              "A problem occurred attempting to run 'rm -r *' in remote directory '/u/ThisDoesNotExist/12345678'. " +
+              "Problem is: The output from the remote command implied that an error occurred.");
+
+        expect(consoleText).toContain("Injected FSUM9195 and FSUM9196 error message");
+        expect(zosMFSpy).toHaveBeenCalledTimes(1);
+        expect(sshSpy).toHaveBeenCalledTimes(1);
+        expect(createSpy).toHaveBeenCalledTimes(1);
+        expect(listSpy).toHaveBeenCalledTimes(1);
+        expect(shellSpy).toHaveBeenCalledTimes(1);
+        expect(membersSpy).toHaveBeenCalledTimes(2);
+        expect(submitSpy).toHaveBeenCalledTimes(1);
+    });
     it("should handle error with attribs file", async () => {
         existsSpy.mockImplementation((data: string) => {
           if (data.indexOf(".zosattributes") > -1) {

docs/CLIReadme.md

@@ -280,6 +280,20 @@ if a bundle is undeployed then the definition is removed. The --csdgroup and
 
 	* Overwrite the cics-deploy profile when a profile of the same name exists.
 
+### Examples
+
+   *-  Create a cics-deploy profile called 'example1' to connect
+   to a CPSM managed group of CICS regions within the TESTGRP1 scope of a cicsplex
+   named PLEX1:
+
+* `          $  zowe profiles create cics-deploy-profile example1 --cicsplex PLEX1 --scope TESTGRP1 --cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550`
+
+   *-  Create a cics-deploy profile called 'example2' to connect
+   to the same CPSM managed group of regions, and identify a BAS resource group
+   BUNDGRP1 in which to store resource definitions:
+
+* `          $  zowe profiles create cics-deploy-profile example2 --cicsplex PLEX1 --scope TESTGRP1 --cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --resgroup BUNDGRP1`
+
 ## update | upd<a name="module-update"></a>
 Update a  profile.You can update any property present within the profile configuration. The updated profile  will be printed so that you can review the result of the updates.
 ### cics-deploy-profile<a name="command-cics-deploy-profile"></a>

src/api/BundlePush/BundlePusher.ts

@@ -70,11 +70,11 @@ export class BundlePusher {
     // Create an SSH session
     const sshSession = await this.createSshSession();
 
-    // Start a progress bar
+    // Start a progress bar (but only in non-verbose mode)
     this.progressBar = { percentComplete: 0,
                          statusMessage: "Starting Push operation",
                          stageName: TaskStage.IN_PROGRESS };
-    this.params.response.progress.startBar({task: this.progressBar});
+    this.startProgressBar();
 
     // Attempt to make the target bundledir
     await this.makeBundleDir(zosMFSession);
@@ -103,7 +103,7 @@ export class BundlePusher {
     // Run DFHDPLOY to install the bundle
     await this.deployBundle(zosMFSession, bd);
 
-    this.params.response.progress.endBar();
+    this.endProgressBar();
     return "PUSH operation completed.";
   }
 
@@ -223,37 +223,36 @@ export class BundlePusher {
   private async undeployExistingBundle(zosMFSession: AbstractSession, bd: BundleDeployer) {
     // End the current progress bar so that UNDEPLOY can create its own
     this.updateStatus("Undeploying any existing bundle from CICS");
-    this.params.response.progress.endBar();
+    this.endProgressBar();
+
 
     const targetstateLocal = this.params.arguments.targetstate;
     this.params.arguments.targetstate = "DISCARDED";
     await bd.undeployBundle(zosMFSession);
     this.params.arguments.targetstate = targetstateLocal;
 
     // Resume the current progress bar
-    this.params.response.progress.endBar();
+    this.endProgressBar();
     this.updateStatus("Undeployed existing bundle from CICS");
-    this.params.response.progress.startBar({task: this.progressBar});
+    this.startProgressBar();
   }
 
   private async deployBundle(zosMFSession: AbstractSession, bd: BundleDeployer) {
     // End the current progress bar so that DEPLOY can create its own
     this.updateStatus("Deploying the bundle to CICS");
-    this.params.response.progress.endBar();
+    this.endProgressBar();
 
     await bd.deployBundle(zosMFSession);
     // Resume the current progress bar
-    this.params.response.progress.endBar();
+    this.endProgressBar();
     this.updateStatus("Deployed existing bundle to CICS");
-    this.params.response.progress.startBar({task: this.progressBar});
+    this.startProgressBar();
   }
 
   private sshOutput(data: string) {
     // If verbose output is requested then log SSH output directly to the console
     if (this.params.arguments.verbose) {
-      this.params.response.progress.endBar();
       this.params.response.console.log(Buffer.from(data));
-      this.params.response.progress.startBar({task: this.progressBar});
     }
     this.sshOutputText += data;
   }
@@ -319,19 +318,30 @@ export class BundlePusher {
     try {
       this.sshOutputText = "";
       const shell = await Shell.executeSshCwd(sshSession, sshCommand, directory, this.sshOutput.bind(this));
+      const upperCaseOutputText = this.sshOutputText.toUpperCase();
 
       // Did the SSH command work? It's unclear how to tell, but for starters let's look for common
-      // signifiers in the output text. Note that FSUM9195 implies that we've tried to delete the
+      // signifiers in the output text. Note that FSUM9195 can imply that we've tried to delete the
       // contents of an empty directory - that's not a problem.
-      const upperCaseOutputText = this.sshOutputText.toUpperCase();
-      if (upperCaseOutputText.indexOf("ERROR ") > -1 ||
-          (upperCaseOutputText.indexOf("FSUM") > -1 &&
-           upperCaseOutputText.indexOf("FSUM9195") === -1) ||
+
+      // If there any FSUM messages other than FSUM9195 then that's a problem
+      let otherFSUMMessages = false;
+      const countFSUM = (upperCaseOutputText.match(/FSUM/g) || []).length;
+      const countFSUM9195 = (upperCaseOutputText.match(/FSUM9195/g) || []).length;
+      if (countFSUM > countFSUM9195) {
+        otherFSUMMessages = true;
+      }
+
+      // Now check for other common error signifiers
+      if (otherFSUMMessages ||
+          upperCaseOutputText.indexOf("ERROR ") > -1 ||
+          upperCaseOutputText.indexOf("EDC") > -1 ||
           upperCaseOutputText.indexOf("ERR!") > -1 ) {
+
         // if we've not already logged the output, log it now
         if (this.params.arguments.verbose !== true)
         {
-          this.params.response.console.log(this.sshOutputText);
+          this.params.response.console.log(Buffer.from(this.sshOutputText));
         }
         throw new Error("The output from the remote command implied that an error occurred.");
       }
@@ -372,13 +382,13 @@ export class BundlePusher {
 
     // A project specific .zosattributes has not been found, so use a default
     const warningMsg = "WARNING: No .zosAttributes file found in the bundle directory, default values will be applied.";
-    this.params.response.progress.endBar();
-    this.params.response.console.log(warningMsg);
+    this.endProgressBar();
+    this.params.response.console.log(Buffer.from(warningMsg));
     if (this.params.arguments.silent === undefined) {
       const logger = Logger.getAppLogger();
       logger.warn(warningMsg);
     }
-    this.params.response.progress.startBar({task: this.progressBar});
+    this.startProgressBar();
     return new ZosFilesAttributes(Bundle.getTemplateZosAttributesFile());
   }
 
@@ -388,12 +398,24 @@ export class BundlePusher {
     this.progressBar.statusMessage = status;
 
     if (this.params.arguments.verbose) {
-      this.params.response.console.log(status + "\n");
+      this.params.response.console.log(Buffer.from(status + "\n"));
     }
 
     if (this.params.arguments.silent === undefined) {
       const logger = Logger.getAppLogger();
       logger.debug(status);
     }
   }
+
+  private startProgressBar() {
+    if (this.params.arguments.verbose !== true) {
+      this.params.response.progress.startBar({task: this.progressBar});
+    }
+  }
+
+  private endProgressBar() {
+    if (this.params.arguments.verbose !== true) {
+      this.params.response.progress.endBar();
+    }
+  }
 }

src/cli/shared/BundleParent.handler.ts

@@ -55,7 +55,7 @@ export abstract class BundleParentHandler implements ICommandHandler {
           msg = await this.performAction(params);
 
           // Issue the success message
-          params.response.console.log(msg);
+          params.response.console.log(Buffer.from(msg));
           if (params.arguments.silent === undefined) {
             logger.debug(msg);
           }

src/imperative.ts

@@ -118,7 +118,19 @@ const config: IImperativeConfig = {
             }
           },
           required: ["cicsplex", "scope", "cicshlq", "cpsmhlq", "jobcard"]
-        }
+        },
+        createProfileExamples: [
+          {
+            options: "example1 --cicsplex PLEX1 --scope TESTGRP1 --cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550",
+            description: "Create a cics-deploy profile called 'example1' to connect to a CPSM managed group of CICS regions " +
+                         "within the TESTGRP1 scope of a cicsplex named PLEX1"
+          },
+          {
+            options: "example2 --cicsplex PLEX1 --scope TESTGRP1 --cicshlq CICSTS55.CICS720 --cpsmhlq CICSTS55.CPSM550 --resgroup BUNDGRP1",
+            description: "Create a cics-deploy profile called 'example2' to connect to the same CPSM managed group of regions, " +
+                         "and identify a BAS resource group BUNDGRP1 in which to store resource definitions"
+          }
+        ]
       }
     ]
 };