Merge branch 'master' into slacknotify

Author: matthewpwilson

Jenkinsfile

@@ -224,7 +224,7 @@ pipeline {
                     //sh("npm set @zowe:registry https://api.bintray.com/npm/ca/brightside/")
                     sh("npm set @zowe:registry https://registry.npmjs.org")
 
-                    sh("npm install -g @zowe/cli@latest")
+                    sh("npm install -g @zowe/cli@daily")
                     sh("zowe --version")
                 }
             }
@@ -542,6 +542,9 @@ pipeline {
                     expression {
                         return BRANCH_NAME == MASTER_BRANCH
                     }
+                    expression {
+                        return GIT_COMMIT =! GIT_PREVIOUS_SUCCESSFUL_COMMIT
+                    }
                 }
             }
             steps {
@@ -593,6 +596,9 @@ pipeline {
                     expression {
                        return BRANCH_NAME == MASTER_BRANCH
                     }
+                    expression {
+                        return GIT_COMMIT =! GIT_PREVIOUS_SUCCESSFUL_COMMIT
+                    }
                 }
             }
             steps {

__tests__/__src__/environment/TestEnvironment.ts

@@ -147,7 +147,7 @@ export class TestEnvironment {
     private static async installPlugin(testEnvironment: ITestEnvironment) {
         let installScript: string = TemporaryScripts.SHEBANG;
         installScript += TemporaryScripts.ZOWE_BIN + " plugins install ../../../../\n"; // install plugin from root of project
-        installScript += TemporaryScripts.ZOWE_BIN + " plugins validate @brightside/zowe-cli-cics-deploy-plugin\n";
+        installScript += TemporaryScripts.ZOWE_BIN + " plugins validate zowe-cli-cics-deploy-plugin\n";
         installScript += TemporaryScripts.ZOWE_BIN + " cdep --help\n"; // check that the plugin help is available
         const scriptPath = testEnvironment.workingDir + "/install_plugin.sh";
         IO.writeFile(scriptPath, Buffer.from(installScript));
@@ -156,7 +156,7 @@ export class TestEnvironment {
 
         if (output.status !== 0) {
             throw new ImperativeError({
-                msg: "Install of '@brightside/zowe-cli-cics-deploy-plugin' plugin failed! You should delete the script: \n'" + scriptPath + "' " +
+                msg: "Install of 'zowe-cli-cics-deploy-plugin' plugin failed! You should delete the script: \n'" + scriptPath + "' " +
                     "after reviewing it to check for possible errors.\n Output of the plugin install command:\n" + output.stderr.toString() +
                     output.stdout.toString()
             });

__tests__/api/BundlePush/BundlePusher.test.ts

@@ -24,6 +24,12 @@ const DEFAULT_PARAMTERS: IHandlerParameters = {
     },
     profiles: {
         get: (type: string) => {
+            if (type === "zosmf") {
+              return zosmfProfile;
+            }
+            if (type === "ssh") {
+              return sshProfile;
+            }
             return {};
         }
     } as any,
@@ -60,6 +66,8 @@ const IS_NOT_DIRECTORY: any = {
   isDirectory: jest.fn((directory) => (false))
 };
 let consoleText = "";
+let zosmfProfile = {};
+let sshProfile = {};
 
 // Initialise xml2json before mocking anything
 const parser = require("xml2json");
@@ -99,6 +107,8 @@ describe("BundlePusher01", () => {
         readdirSpy = jest.spyOn(fs, "readdirSync").mockImplementation(() => ([]));
         lstatSpy = jest.spyOn(fs, "lstatSync").mockImplementation(() => ( IS_NOT_DIRECTORY ));
         consoleText = "";
+        zosmfProfile = {};
+        sshProfile = {};
     });
     afterEach(() => {
         jest.restoreAllMocks();
@@ -191,6 +201,38 @@ describe("BundlePusher01", () => {
         expect(zosMFSpy).toHaveBeenCalledTimes(1);
         expect(sshSpy).toHaveBeenCalledTimes(1);
     });
+    it("should complain with mismatching zOSMF and SSH profile host names", async () => {
+        zosmfProfile = { host: "wibble" };
+        sshProfile = { host: "wobble" };
+
+        await runPushTest("__tests__/__resources__/ExampleBundle01", true,
+              "PUSH operation completed.");
+        expect(consoleText).toContain("WARNING: ssh profile --host value 'wobble' does not match zosmf value 'wibble'.");
+    });
+    it("should not complain with matching zOSMF and SSH profile host names", async () => {
+        zosmfProfile = { host: "wibble" };
+        sshProfile = { host: "wibble" };
+
+        await runPushTest("__tests__/__resources__/ExampleBundle01", true,
+              "PUSH operation completed.");
+        expect(consoleText).not.toContain("WARNING: ssh profile");
+    });
+    it("should complain with mismatching zOSMF and SSH profile user names", async () => {
+        zosmfProfile = { host: "wibble", user: "fred" };
+        sshProfile = { host: "wibble", user: "joe" };
+
+        await runPushTest("__tests__/__resources__/ExampleBundle01", true,
+              "PUSH operation completed.");
+        expect(consoleText).toContain("WARNING: ssh profile --user value 'joe' does not match zosmf value 'fred'.");
+    });
+    it("should not complain with matching zOSMF and SSH profile user names", async () => {
+        zosmfProfile = { host: "wibble", user: "fred" };
+        sshProfile = { host: "wibble", user: "fred" };
+
+        await runPushTest("__tests__/__resources__/ExampleBundle01", true,
+              "PUSH operation completed.");
+        expect(consoleText).not.toContain("WARNING: ssh profile");
+    });
     it("should complain if remote bundle dir mkdir fails", async () => {
         createSpy.mockImplementationOnce(() => { throw new Error( "Injected Create error" ); });
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01",  false,

docs/404.md

@@ -1,6 +1,7 @@
 ---
 title: "Page Not Found"
 search: exclude
+sidebar: cdp_sidebar
 ---  
 
 Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct.

docs/_data/sidebars/cdp_sidebar.yml

@@ -24,12 +24,15 @@ entries:
   - title: Tutorials
     output: web
     folderitems:
-    - title: Deploying your first app
-      url: /cdp-Deploying-your-first-app.html
+    - title: Deploying your first Node.js app
+      url: /cdp-Deploying-your-first-nodejs-app.html
       output: web
     - title: Deploying using individual actions
       url: /cdp-Deploying-using-individual-actions.html
       output: web
+    - title: Provision a CICS region with z/OS PT
+      url: /cdp-Provision-a-CICS-region-using-zospt.html
+      output: web
 
   - title: Concepts
     output: web
@@ -40,7 +43,7 @@ entries:
     - title: Zowe CLI profiles
       url: /cdp-zowe-profiles.html
       output: web
-    - title: CICS Bundles
+    - title: CICS bundles
       url: /cdp-cics-bundles.html
       output: web
 
@@ -50,6 +53,12 @@ entries:
     - title: Log and trace files
       url: /cdp-Troubleshooting-General.html
       output: web
+    - title: Precautionary checks
+      url: /cdp-Precautionary-Checks.html
+      output: web
+    - title: Potential problems
+      url: /cdp-Troubleshooting-Symptoms.html
+      output: web
 
   - title: Commands - zowe profiles
     output: web
@@ -70,7 +79,7 @@ entries:
       url: cdp-CLIReadMe#set-default--set
       output: web
 
-  - title: Commands - CICS deploy
+  - title: Commands - zowe cics-deploy
     output: web
     folderitems:
     - title: generate bundle

docs/_data/tags.yml

@@ -5,3 +5,4 @@ allowed-tags:
   - getting_started
   - concepts
   - troubleshooting
+  - tutorial

docs/js/customscripts.js

@@ -26,7 +26,7 @@ $(document).ready(function () {
      * Modified to use a fontawesome icon.
      */
     // get all <pre> elements
-    var allCodeBlocksElements = $("pre");
+    var allCodeBlocksElements = $("pre:not(.messageText)");
 
     allCodeBlocksElements.each(function (i) {
         // add different id for each code block

docs/pages/cdp/CLIReadme.md

@@ -90,7 +90,8 @@ the target group of CICS regions\.
 *   `--timeout`  | `--to` *(number)*
 
 	* An optional numerical value that specifies the maximum amount of time in seconds
-      (1 \- 1800 inclusive) for the DFHDPLOY command to complete\.
+      (1 \- 1800 inclusive) for the DFHDPLOY command to complete\. If not specified
+      DFHDPLOY will use its default of 300 seconds\.
 
 *   `--target-state`  | `--ts` | `--targetstate` *(string)*
 
@@ -287,7 +288,8 @@ Push a CICS bundle from the working directory to a target CICSplex\.
 *   `--timeout`  | `--to` *(number)*
 
 	* An optional numerical value that specifies the maximum amount of time in seconds
-      (1 \- 1800 inclusive) for the DFHDPLOY command to complete\.
+      (1 \- 1800 inclusive) for the DFHDPLOY command to complete\. If not specified
+      DFHDPLOY will use its default of 300 seconds\.
 
 *   `--target-state`  | `--ts` | `--targetstate` *(string)*
 
@@ -408,7 +410,8 @@ target group of CICS regions\.
 *   `--timeout`  | `--to` *(number)*
 
 	* An optional numerical value that specifies the maximum amount of time in seconds
-      (1 \- 1800 inclusive) for the DFHDPLOY command to complete\.
+      (1 \- 1800 inclusive) for the DFHDPLOY command to complete\. If not specified
+      DFHDPLOY will use its default of 300 seconds\.
 
 *   `--target-state`  | `--ts` | `--targetstate` *(string)*
 

docs/pages/cdp/cdp-Create-Zowe-CLI-profiles.md

@@ -87,7 +87,7 @@ This profile identifies the CICS environment for deployment. You need to know th
 For example to create a cics-deploy profile:
 
 ```console
-zowe profiles create cics-deploy-profile example --cicsplex PLEX1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --scope TESTGRP1 --csd-group BUNDGRP1 --target-directory /var/cicsts/bundles --overwrite
+zowe profiles create cics-deploy-profile cics --cicsplex PLEX1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --scope TESTGRP1 --csd-group BUNDGRP1 --target-directory /var/cicsts/bundles --overwrite
 ```
 
 For help on using the options:
@@ -96,4 +96,4 @@ For help on using the options:
 zowe profiles create cics-deploy-profile --help
 ```
 
-To test the cics-deploy profile, follow the steps in [Deploying your first app](cdp-Deploying-your-first-app).
+To test the cics-deploy profile, follow the steps in [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app).

docs/pages/cdp/cdp-Deploying-using-individual-actions.md

@@ -1,26 +1,26 @@
 ---
 title: Deploying using individual actions
-tags: [getting_started]
+tags: [tutorial]
 keywords:
 summary: "The following steps take you through the individual actions to deploy a Node.js application in CICS."
 sidebar: cdp_sidebar
 permalink: cdp-Deploying-using-individual-actions.html
 folder: cdp
-toc: false
+toc: true
 ---
 
-The `zowe cics-deploy push bundle` command performs a set of actions to deploy applications to CICS, as can be seen in [Deploying your first app](cdp-cdp-Deploying-your-first-app). The main actions include:
+The `zowe cics-deploy push bundle` command performs a set of actions to deploy applications to CICS, as can be seen in [Deploying your first Node.js app](cdp-Deploying-your-first-nodejs-app). The main actions include:
 
 * undeploy the old version of the CICS bundle in CICS
 * upload the new version of the CICS bundle to z/OS
-* run `npm install` on z/OS to resolve Node.js application dependencies
-* deploy the CICS bundle in CICS.
+* resolve Node.js application dependencies on z/OS
+* deploy the CICS bundle in CICS
 
 However, there may be situations where you need more control of these actions or perform alternate actions. The following sections describe how each of these actions can be performed independently, enabling you to form a sequence of commands to achieve your needs.
 
 ### Undeploy a CICS bundle
 
-Undeploying a CICS bundle disables the CICS bundle resource (BUNDLE) in CICS. Disabling the CICS bundle causes the resources defined in it to also be disabled. For Node.js applications, CICS sends a SIGTERM signal that can be handled in the application to stop in a controlled manner, such as stopping new requests and completing existing requests. Once the CICS bundle has been disabled it is then discarded in CICS.
+Undeploying a CICS bundle disables the CICS bundle resource (BUNDLE) in CICS. Disabling the BUNDLE causes the resources defined in it to also be disabled. For Node.js applications, CICS sends a SIGTERM signal that can be handled in the application to stop in a controlled manner, such as stopping new requests and completing existing requests. Once the CICS bundle has been disabled it is then discarded in CICS.
 
 ```console
 zowe cics-deploy undeploy bundle --name Express
@@ -38,17 +38,17 @@ zowe cics-deploy undeploy bundle --name Express --target-state disabled
 
 Before uploading the CICS bundle to z/OS, you need to ensure the target directory is empty in order to prevent merging with a previously deployed version of the CICS bundle.
 
-There are several ways to run shell commands and scripts on z/OS, such as SSH, batch jobs, and Zowe. When using Zowe, an SSH connection is established using information in the Zowe ssh profile, and then the shell .profile for the user will be run to setup the environment. The command is then run in the directory specified by the `--cwd` option. The return code from the Zowe CLI will be the same as that returned by the command run on z/OS, enabling you to take action in your script in error scenarios.
+There are several ways to run shell commands and scripts on z/OS, such as SSH, batch jobs, and Zowe. When using Zowe, an SSH connection is established using information in the Zowe ssh profile, and the shell .profile for the user is run to setup the environment. The command is then run in z/OS in the directory specified by the `--cwd` option. The return code from the command is used to set the Zowe CLI return code, enabling you to take action in your script in error scenarios.
 
 For example, to remove the target directory:
 
 ```console
-zowe zos-uss issue ssh "rm -Rv *" --cwd "/var/cicsts/bundles/myexpressapp_1.0.0" && echo RC=$?
+zowe zos-uss issue ssh "rm -Rv *" --cwd "/var/cicsts/bundles/myexpressapp_1.0.0" || echo "RC=$?"
 ```
 
 {% include tip.html content="You can run several commands in one request using the syntax described in [sh — Invoke a shell](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.bpxa500/sh.htm)." %}
 
-Typically you will need to upload some files as binary, some as text, and exclude others that are not required to run the application. In addition, it is best practice to tag files on z/OS as binary or with their text codepage to allow for correct codepage translation by editors and environments such as Node.js. You can specify these requirements in a `.zosattributes` file and use the Zowe CLI to upload and tag files in a single command.
+When uploading the CICS bundle to z/OS, you may need to upload some files as binary, some as text, and exclude others that are not required to run the application. In addition, it is best practice to tag files on z/OS as binary or with their text codepage to allow for correct codepage translation by editors and environments such as Node.js and Java. You can specify these requirements in a `.zosattributes` file and use the Zowe CLI to upload and tag files in a single command.
 
 For example, create file **~/myExpressApp/.zosattributes** in the CICS bundle:
 
@@ -76,10 +76,10 @@ node_modules -
 Then upload the CICS bundle to z/OS:
 
 ```console
-zowe zos-files upload dir-to-uss ~/myExpressApp/ /var/cicsts/bundles/myexpressapp_1.0.0 --recursive --attributes ~/myExpressApp/.zosattributes
+zowe zos-files upload dir-to-uss ~/myExpressApp/ "/var/cicsts/bundles/myexpressapp_1.0.0" --recursive --attributes ~/myExpressApp/.zosattributes
 ```
 
-### Run npm on z/OS
+### Resolve Node.js application dependencies on z/OS
 
 A Node.js application typically depends on packages that are described in `package.json`. The dependencies can be installed by running `npm install` in the z/OS directory containing `package.json`, for example:
 
@@ -92,11 +92,11 @@ zowe zos-uss issue ssh "npm install" --cwd "/var/cicsts/bundles/myexpressapp_1.0
 Deploying a CICS bundle defines a CICS bundle resource (BUNDLE), then installs it, and finally enables it. When the CICS bundle is enabled, the Node.js application is started. For example:
 
 ```console
-zowe cics-deploy deploy bundle --name Express --bundle-directory /var/cicsts/bundles/myexpressapp_1.0.0
+zowe cics-deploy deploy bundle --name Express --bundle-directory "/var/cicsts/bundles/myexpressapp_1.0.0"
 ```
 
 Alternatively, to define and install the BUNDLE but not enable it:
 
 ```console
-zowe cics-deploy deploy bundle --name Express --bundle-directory /var/cicsts/bundles/myexpressapp_1.0.0 --target-state disabled
+zowe cics-deploy deploy bundle --name Express --bundle-directory "/var/cicsts/bundles/myexpressapp_1.0.0" --target-state disabled
 ```