Merge pull request #249 from pcoop/branch1

First chunk of code for cmd line options

Author: pcoop

__tests__/api/BundlePush/BundlePusher.test.ts

@@ -20,7 +20,7 @@ the target group of CICS regions\.
 
    zowe cics-deploy deploy bundle [options]
 
-#### Required Options
+#### cics-deploy Options
 
 *   `--name`  | `-n` *(string)*
 
@@ -31,8 +31,6 @@ the target group of CICS regions\.
 
 	* Specifies the location of the CICS bundle (up to 255 characters) on zFS\.
 
-#### Options
-
 *   `--cicsplex`  | `--cp` *(string)*
 
 	* Specifies the CICSplex (up to 8 characters) to target\. Use this parameter if
@@ -61,7 +59,7 @@ the target group of CICS regions\.
       bundle is undeployed, the definition is removed\. The \-\-csd\-group and
       \-\-res\-group options are mutually exclusive\.
 
-*   `--cics-hlq`  | `--ch` | `--cicshlq` *(string)*
+*   `--cics-hlq`  | `--cq` | `--cicshlq` *(string)*
 
 	* Specifies the high\-level qualifier (up to 35 characters) at which the CICS
       datasets can be found in the target environment\. Use this parameter if you have
@@ -144,7 +142,7 @@ required\.
 
    zowe cics-deploy generate bundle [options]
 
-#### Options
+#### cics-deploy Options
 
 *   `--bundle-id`  | `-b` | `--id` | `--bundleid` *(string)*
 
@@ -217,7 +215,7 @@ Push a CICS bundle from the working directory to a target CICSplex\.
 
    zowe cics-deploy push bundle [options]
 
-#### Required Options
+#### cics-deploy Options
 
 *   `--name`  | `-n` *(string)*
 
@@ -229,8 +227,6 @@ Push a CICS bundle from the working directory to a target CICSplex\.
 	* Specifies the target zFS location in which the CICS bundle is to be created (up
       to 255 characters)
 
-#### Options
-
 *   `--cicsplex`  | `--cp` *(string)*
 
 	* Specifies the CICSplex (up to 8 characters) to target\. Use this parameter if
@@ -259,7 +255,7 @@ Push a CICS bundle from the working directory to a target CICSplex\.
       bundle is undeployed, the definition is removed\. The \-\-csd\-group and
       \-\-res\-group options are mutually exclusive\.
 
-*   `--cics-hlq`  | `--ch` | `--cicshlq` *(string)*
+*   `--cics-hlq`  | `--cq` | `--cicshlq` *(string)*
 
 	* Specifies the high\-level qualifier (up to 35 characters) at which the CICS
       datasets can be found in the target environment\. Use this parameter if you have
@@ -307,8 +303,99 @@ Push a CICS bundle from the working directory to a target CICSplex\.
 	* Enable or disable the ability to replace an existing bundle directory or bundle
       on the remote system\.
 
+#### Zosmf Connection Options
+
+*   `--zosmf-host`  | `--zh` *(string)*
+
+	* The z/OSMF server host name\.
+
+*   `--zosmf-port`  | `--zp` *(number)*
+
+	* The z/OSMF server port\.
+
+*   `--zosmf-user`  | `--zu` *(string)*
+
+	* Mainframe (z/OSMF) user name, which can be the same as your TSO login\.
+
+*   `--zosmf-password`  | `--zpw` *(string)*
+
+	* Mainframe (z/OSMF) password, which can be the same as your TSO password\.
+
+*   `--zosmf-reject-unauthorized`  | `--zru` *(boolean)*
+
+	* Reject self\-signed certificates\.
+
+*   `--zosmf-base-path`  | `--zbp` *(string)*
+
+	* The base path for your API mediation layer instance\. Specify this option to
+      prepend the base path to all z/OSMF resources when making REST requests\. Do not
+      specify this option if you are not using an API mediation layer\.
+
+#### z/OS Ssh Connection Options
+
+*   `--ssh-host`  | `--sh` *(string)*
+
+	* The z/OS SSH server host name\.
+
+*   `--ssh-port`  | `--sp` *(number)*
+
+	* The z/OS SSH server port\.
+
+*   `--ssh-user`  | `--su` *(string)*
+
+	* Mainframe user name, which can be the same as your TSO login\.
+
+*   `--ssh-password`  | `--spw` *(string)*
+
+	* Mainframe password, which can be the same as your TSO password\.
+
+*   `--ssh-private-key`  | `--spk` *(string)*
+
+	* Path to a file containing your private key, that must match a public key stored
+      in the server for authentication
+
+*   `--ssh-key-passphrase`  | `--skp` *(string)*
+
+	* Private key passphrase, which unlocks the private key\.
+
+*   `--ssh-handshake-timeout`  | `--sht` *(number)*
+
+	* How long in milliseconds to wait for the SSH handshake to complete\.
+
+#### CICS Connection Options
+
+*   `--cics-host`  | `--ch` *(string)*
+
+	* The CMCI server host name\.
+
+*   `--cics-port`  | `--cpo` *(number)*
+
+	* The CICS server port\.
+
+*   `--cics-user`  | `--cu` *(string)*
+
+	* Mainframe (CICS) user name, which can be the same as your TSO login\.
+
+*   `--cics-password`  | `--cpw` *(string)*
+
+	* Mainframe (CICS) password, which can be the same as your TSO password\.
+
+*   `--cics-reject-unauthorized`  | `--cru` *(boolean)*
+
+	* Reject self\-signed certificates\.
+
+*   `--cics-protocol`  | `--cpr` *(string)*
+
+	* Specifies CMCI protocol (http or https)\.
+
+      Allowed values: http, https
+
 #### Profile Options
 
+*   `--cics-deploy-profile`  | `--cics-deploy-p` *(string)*
+
+	* The name of a (cics\-deploy) profile to load for this command execution\.
+
 *   `--zosmf-profile`  | `--zosmf-p` *(string)*
 
 	* The name of a (zosmf) profile to load for this command execution\.
@@ -317,18 +404,14 @@ Push a CICS bundle from the working directory to a target CICSplex\.
 
 	* The name of a (ssh) profile to load for this command execution\.
 
-*   `--cics-deploy-profile`  | `--cics-deploy-p` *(string)*
-
-	* The name of a (cics\-deploy) profile to load for this command execution\.
-
 *   `--cics-profile`  | `--cics-p` *(string)*
 
 	* The name of a (cics) profile to load for this command execution\.
 
 ### Examples
 
 *  Push a CICS bundle from the working directory by using
-default cics-deploy, ssh and zosmf profiles:
+default cics-deploy, cics, ssh and zosmf profiles:
 
       * `$  zowe cics-deploy push bundle --name EXAMPLE --target-directory /u/example/bundles`
 
@@ -353,15 +436,13 @@ target group of CICS regions\.
 
    zowe cics-deploy undeploy bundle [options]
 
-#### Required Options
+#### cics-deploy Options
 
 *   `--name`  | `-n` *(string)*
 
 	* Specifies the name of the CICS BUNDLE resource (up to 8 characters) to deploy or
       undeploy\.
 
-#### Options
-
 *   `--cicsplex`  | `--cp` *(string)*
 
 	* Specifies the CICSplex (up to 8 characters) to target\. Use this parameter if
@@ -390,7 +471,7 @@ target group of CICS regions\.
       bundle is undeployed, the definition is removed\. The \-\-csd\-group and
       \-\-res\-group options are mutually exclusive\.
 
-*   `--cics-hlq`  | `--ch` | `--cicshlq` *(string)*
+*   `--cics-hlq`  | `--cq` | `--cicshlq` *(string)*
 
 	* Specifies the high\-level qualifier (up to 35 characters) at which the CICS
       datasets can be found in the target environment\. Use this parameter if you have
@@ -486,7 +567,7 @@ actions\.
 	* Specifies the name of the CICS System, or CICS System Group (up to 8 characters)
       to target\.
 
-*   `--cics-hlq`  | `--ch` | `--cicshlq` *(string)*
+*   `--cics-hlq`  | `--cq` | `--cicshlq` *(string)*
 
 	* Specifies the High Level Qualifier (up to 35 characters) at which the CICS
       datasets can be found in the target environment\.
@@ -592,7 +673,7 @@ actions\.
       if a bundle is undeployed then the definition is removed\. The \-\-csd\-group
       and \-\-res\-group options are mutually exclusive\.
 
-*   `--cics-hlq`  | `--ch` | `--cicshlq` *(string)*
+*   `--cics-hlq`  | `--cq` | `--cicshlq` *(string)*
 
 	* Specifies the High Level Qualifier (up to 35 characters) at which the CICS
       datasets can be found in the target environment\.

docs/pages/cdp/CLIReadme.md

@@ -17,6 +17,9 @@ import { getResource, IResourceParms } from "@zowe/cics";
 import { BundleDeployer } from "../BundleDeploy/BundleDeployer";
 import { Bundle } from "../BundleContent/Bundle";
 import { SubtaskWithStatus } from "./SubtaskWithStatus";
+import { ZosmfConfig } from "./ZosmfConfig";
+import { SshConfig } from "./SshConfig";
+import { CmciConfig } from "./CmciConfig";
 
 
 /**
@@ -73,11 +76,22 @@ export class BundlePusher {
     }
 
     // Get the profiles
-    const zosMFProfile = this.getProfile("zosmf", true);
-    const sshProfile = this.getProfile("ssh", true);
-    const cicsProfile = this.getProfile("cics", false);
+    const zosMFProfile = this.getProfile("zosmf");
+    const sshProfile = this.getProfile("ssh");
+    let cicsProfile = this.getProfile("cics");
+    ZosmfConfig.mergeProfile(zosMFProfile, this.params);
+    SshConfig.mergeProfile(sshProfile, this.params);
+    CmciConfig.mergeProfile(cicsProfile, this.params);
+
+    // The cics profile is optional, detect whether it has been set (or constructed)
+    if (Object.keys(cicsProfile).length === 0) {
+       cicsProfile = undefined;
+    }
+
+    // Now detect any mismatches between the values from the profiles
     this.validateProfiles(zosMFProfile, sshProfile, cicsProfile);
 
+
     // Create a zOSMF session
     const zosMFSession = await this.createZosMFSession(zosMFProfile);
     // Create an SSH session
@@ -184,11 +198,11 @@ export class BundlePusher {
     }
   }
 
-  private getProfile(type: string, required: boolean): IProfile {
-    const profile =  this.params.profiles.get(type);
+  private getProfile(type: string): IProfile {
+    let profile =  this.params.profiles.get(type);
 
-    if (required && profile === undefined) {
-      throw new Error("No " + type + " profile found");
+    if (profile === undefined) {
+      profile = {};
     }
 
     return profile;
@@ -212,13 +226,13 @@ export class BundlePusher {
     let sameHostAndUser = true;
     if (zosmfProfile.host !== sshProfile.host) {
       sameHostAndUser = false;
-      this.issueWarning("ssh profile --host value '" + sshProfile.host + "' does not match zosmf value '" + zosmfProfile.host + "'.");
+      this.issueWarning("--ssh-host value '" + sshProfile.host + "' does not match --zosmf-host value '" + zosmfProfile.host + "'.");
     }
 
     // Do the required profiles share the same user name?
     if (zosmfProfile.user.toUpperCase() !== sshProfile.user.toUpperCase()) {
       sameHostAndUser = false;
-      this.issueWarning("ssh profile --user value '" + sshProfile.user + "' does not match zosmf value '" + zosmfProfile.user + "'.");
+      this.issueWarning("--ssh-user value '" + sshProfile.user + "' does not match --zosmf-user value '" + zosmfProfile.user + "'.");
     }
 
     // If the zoSMF user and host are the same then validate that the passwords are the same too.
@@ -227,7 +241,7 @@ export class BundlePusher {
     if (sameHostAndUser) {
       if (sshProfile.password !== undefined) {
         if (zosmfProfile.password !== sshProfile.password) {
-          throw new Error("Incompatible security credentials exist in the zosmf and ssh profiles.");
+          throw new Error("Different passwords are specified for the same user ID in the zosmf and ssh configurations.");
         }
       }
     }
@@ -237,24 +251,18 @@ export class BundlePusher {
       sameHostAndUser = true;
       if (zosmfProfile.host !== cicsProfile.host) {
         sameHostAndUser = false;
-        this.issueWarning("cics profile --host value '" + cicsProfile.host + "' does not match zosmf value '" + zosmfProfile.host + "'.");
+        this.issueWarning("--cics-host value '" + cicsProfile.host + "' does not match --zosmf-host value '" + zosmfProfile.host + "'.");
       }
       if (zosmfProfile.user.toUpperCase() !== cicsProfile.user.toUpperCase()) {
         sameHostAndUser = false;
-        this.issueWarning("cics profile --user value '" + cicsProfile.user + "' does not match zosmf value '" + zosmfProfile.user + "'.");
+        this.issueWarning("--cics-user value '" + cicsProfile.user + "' does not match --zosmf-user value '" + zosmfProfile.user + "'.");
       }
 
       if (sameHostAndUser) {
         if (zosmfProfile.password !== cicsProfile.password) {
-          throw new Error("Incompatible security credentials exist in the zosmf and cics profiles.");
+          throw new Error("Different passwords are specified for the same user ID in the zosmf and cics configurations.");
         }
       }
-
-      // Do the cics-plexes match?
-      if (cicsProfile.cicsPlex !== undefined && this.params.arguments.cicsplex !== cicsProfile.cicsPlex) {
-        this.issueWarning("cics profile --cics-plex value '" + cicsProfile.cicsPlex +
-          "' does not match --cicsplex value '" + this.params.arguments.cicsplex + "'.");
-      }
     }
   }