cmd overrides for zosmf profile

Signed-off-by: Paul Cooper <[email protected]>

Author: pcoop

__tests__/api/BundlePush/BundlePusher.test.ts

@@ -10,7 +10,7 @@
 */
 
 import { BundlePusher } from "../../../src/api/BundlePush/BundlePusher";
-import { IHandlerParameters, ImperativeError, IImperativeError } from "@zowe/imperative";
+import { IHandlerParameters, ImperativeError, IImperativeError, IProfile } from "@zowe/imperative";
 import * as cmci from "@zowe/cics";
 import * as PushBundleDefinition from "../../../src/cli/push/bundle/PushBundle.definition";
 import * as fse from "fs-extra";
@@ -111,7 +111,7 @@ describe("BundlePusher01", () => {
         lstatSpy = jest.spyOn(fs, "lstatSync").mockImplementation(() => ( IS_NOT_DIRECTORY ));
         cmciSpy = jest.spyOn(cmci, "getResource").mockImplementation(() => ({ response: { records: {} } }));
         consoleText = "";
-        zosmfProfile = { host: "wibble", user: "user", password: "thisIsntReal" };
+        zosmfProfile = { host: "wibble", user: "user", password: "thisIsntReal", port: 443, rejectUnauthorized: true };
         sshProfile = { host: "wibble", user: "user", password: "thisIsntReal" };
         cicsProfile = undefined;
     });
@@ -199,6 +199,58 @@ describe("BundlePusher01", () => {
 
         expect(zosMFSpy).toHaveBeenCalledTimes(1);
     });
+    it("should implement --zosmf-* overrides" , async () => {
+        zosmfProfile = { host: "wibble", user: "user" };
+        sshProfile = { host: "wibble", user: "user" };
+        const parms = getCommonParmsForPushTests();
+        parms.arguments.zh = "overrideHost";
+        parms.arguments.zp = 123;
+        parms.arguments.zu = "overrideUser";
+        parms.arguments.zpw = "overridePassword";
+        parms.arguments.zru = false;
+        parms.arguments.zbp = "overrideBasePath";
+        zosMFSpy.mockImplementationOnce((profile: IProfile) => {
+          expect(profile.host).toMatch("overrideHost");
+          expect(profile.port).toEqual(123);
+          expect(profile.user).toMatch("overrideUser");
+          expect(profile.password).toMatch("overridePassword");
+          expect(profile.rejectUnauthorized).toEqual(false);
+          expect(profile.basePath).toMatch("overrideBasePath");
+        });
+
+        await runPushTest("__tests__/__resources__/ExampleBundle01", true,
+              "PUSH operation completed", parms);
+    });
+    it("should complain if zosmf-host notset" , async () => {
+        zosmfProfile = undefined;
+
+        await runPushTestWithError("__tests__/__resources__/ExampleBundle01", false,
+                                   "Required parameter --zosmf-host is not set.");
+    });
+    it("should complain if zosmf-port notset" , async () => {
+        zosmfProfile = { host: "wibble" };
+
+        await runPushTestWithError("__tests__/__resources__/ExampleBundle01", false,
+                                   "Required parameter --zosmf-port is not set.");
+    });
+    it("should complain if zosmf-user notset" , async () => {
+        zosmfProfile = { host: "wibble", port: 443 };
+
+        await runPushTestWithError("__tests__/__resources__/ExampleBundle01", false,
+                                   "Required parameter --zosmf-user is not set.");
+    });
+    it("should complain if zosmf-password notset" , async () => {
+        zosmfProfile = { host: "wibble", port: 443, user: "user" };
+
+        await runPushTestWithError("__tests__/__resources__/ExampleBundle01", false,
+                                   "Required parameter --zosmf-password is not set.");
+    });
+    it("should complain if zosmf-reject-unauthorized notset" , async () => {
+        zosmfProfile = { host: "wibble", port: 443, user: "user", password: "thisIsntReal" };
+
+        await runPushTestWithError("__tests__/__resources__/ExampleBundle01", false,
+                                   "Required parameter --zosmf-reject-unauthorized is not set.");
+    });
     it("should complain with missing SSH profile for push", async () => {
         sshSpy.mockImplementationOnce(() => { throw new Error( "Injected SSH Create error" ); });
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01",  false, "Injected SSH Create error");
@@ -207,15 +259,13 @@ describe("BundlePusher01", () => {
         expect(sshSpy).toHaveBeenCalledTimes(1);
     });
     it("should complain with mismatching zOSMF and SSH profile host names", async () => {
-        zosmfProfile = { host: "wibble", user: "user" };
         sshProfile = { host: "wobble", user: "user" };
 
         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", user: "user" };
         sshProfile = { host: "wibble", user: "user" };
 
         await runPushTest("__tests__/__resources__/ExampleBundle01", true,
@@ -237,67 +287,59 @@ describe("BundlePusher01", () => {
         expect(consoleText).not.toContain("WARNING: cics 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'.");
+        expect(consoleText).toContain("WARNING: ssh profile --user value 'joe' does not match zosmf value 'user'.");
     });
     it("should not complain with matching zOSMF and SSH profile user names", async () => {
-        zosmfProfile = { host: "wibble", user: "fred" };
-        sshProfile = { host: "wibble", user: "fred" };
+        sshProfile = { host: "wibble", user: "user" };
 
         await runPushTest("__tests__/__resources__/ExampleBundle01", true,
               "PUSH operation completed");
         expect(consoleText).not.toContain("WARNING: ssh profile");
     });
     it("should not complain with matching zOSMF and SSH profile user names - case", async () => {
-        zosmfProfile = { host: "wibble", user: "fred" };
-        sshProfile = { host: "wibble", user: "FRED" };
+        sshProfile = { host: "wibble", user: "USER" };
 
         await runPushTest("__tests__/__resources__/ExampleBundle01", true,
               "PUSH operation completed");
         expect(consoleText).not.toContain("WARNING: ssh profile");
     });
     it("should complain with mismatching zOSMF and CICS profile user names", async () => {
-        zosmfProfile = { host: "wibble", user: "fred" };
         sshProfile = { host: "wibble", user: "fred" };
         cicsProfile = { host: "wibble", user: "joe", password: "thisIsntReal", cicsPlex: "12345678" };
 
         await runPushTest("__tests__/__resources__/ExampleBundle01", true,
               "PUSH operation completed");
-        expect(consoleText).toContain("WARNING: cics profile --user value 'joe' does not match zosmf value 'fred'.");
+        expect(consoleText).toContain("WARNING: cics profile --user value 'joe' does not match zosmf value 'user'.");
     });
     it("should complain with mismatching zOSMF and SSH profile passwords", async () => {
-        zosmfProfile = { host: "wibble", user: "fred", password: "fakeZosmfPassword" };
-        sshProfile = { host: "wibble", user: "fred", password: "fakeSshPassword" };
+        sshProfile = { host: "wibble", user: "user", password: "fakeSshPassword" };
 
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01",  false,
               "Incompatible security credentials exist in the zosmf and ssh profiles.");
 
-        expect(consoleText).not.toContain("fakeZosmfPassword");
+        expect(consoleText).not.toContain("thisIsntReal");
         expect(consoleText).not.toContain("fakeSshPassword");
     });
     it("should tolerate mismatching zOSMF and SSH credentials if SSH keys are used", async () => {
-        zosmfProfile = { host: "wibble", user: "fred", password: "fakeZosmfPassword" };
         sshProfile = { host: "wibble", user: "fred", privateKey: "fakeSshKey" };
 
         await runPushTest("__tests__/__resources__/ExampleBundle01", true,
               "PUSH operation completed");
 
-        expect(consoleText).not.toContain("fakeZosmfPassword");
+        expect(consoleText).not.toContain("thisIsntReal");
         expect(consoleText).not.toContain("fakeSshKey");
     });
     it("should complain with mismatching zOSMF and cics profile passwords", async () => {
-        zosmfProfile = { host: "wibble", user: "fred", password: "fakePassword" };
-        sshProfile = { host: "wibble", user: "fred", password: "fakePassword" };
-        cicsProfile = { host: "wibble", user: "fred", password: "fakePassword2", cicsPlex: "12345678" };
+        cicsProfile = { host: "wibble", user: "user", password: "fakePassword2", cicsPlex: "12345678" };
 
         await runPushTestWithError("__tests__/__resources__/ExampleBundle01",  false,
               "Incompatible security credentials exist in the zosmf and cics profiles.");
 
-        expect(consoleText).not.toContain("fakePassword");
+        expect(consoleText).not.toContain("thisIsntReal");
         expect(consoleText).not.toContain("fakePassword2");
     });
     it("should complain with mismatching cics-deploy and CICS plex names", async () => {
@@ -1552,5 +1594,11 @@ function getCommonParmsForPushTests(): IHandlerParameters {
   parms.arguments.targetstate = "ENABLED";
   parms.arguments.targetdir = "/u/ThisDoesNotExist";
   parms.arguments.overwrite = undefined;
+  parms.arguments.zh = undefined;
+  parms.arguments.zp = undefined;
+  parms.arguments.zu = undefined;
+  parms.arguments.zpw = undefined;
+  parms.arguments.zru = undefined;
+  parms.arguments.zbp = undefined;
   return parms;
 }

docs/pages/cdp/CLIReadme.md

@@ -20,7 +20,7 @@ the target group of CICS regions\.
 
    zowe cics-deploy deploy bundle [options]
 
-#### cics-deploy
+#### cics-deploy Options
 
 *   `--name`  | `-n` *(string)*
 
@@ -142,7 +142,7 @@ required\.
 
    zowe cics-deploy generate bundle [options]
 
-#### cics-deploy
+#### cics-deploy Options
 
 *   `--bundle-id`  | `-b` | `--id` | `--bundleid` *(string)*
 
@@ -215,7 +215,7 @@ Push a CICS bundle from the working directory to a target CICSplex\.
 
    zowe cics-deploy push bundle [options]
 
-#### cics-deploy
+#### cics-deploy Options
 
 *   `--name`  | `-n` *(string)*
 
@@ -303,11 +303,35 @@ 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\.
 
-#### Profile Options
+#### Zosmf Connection Options
 
-*   `--zosmf-profile`  | `--zosmf-p` *(string)*
+*   `--zosmf-host`  | `--zh` *(string)*
 
-	* The name of a (zosmf) profile to load for this command execution\.
+	* 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\.
+
+#### Profile Options
 
 *   `--ssh-profile`  | `--ssh-p` *(string)*
 
@@ -317,6 +341,10 @@ Push a CICS bundle from the working directory to a target CICSplex\.
 
 	* 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\.
+
 *   `--cics-profile`  | `--cics-p` *(string)*
 
 	* The name of a (cics) profile to load for this command execution\.
@@ -349,7 +377,7 @@ target group of CICS regions\.
 
    zowe cics-deploy undeploy bundle [options]
 
-#### cics-deploy
+#### cics-deploy Options
 
 *   `--name`  | `-n` *(string)*
 

src/api/BundlePush/BundlePusher.ts

@@ -17,6 +17,7 @@ import { getResource, IResourceParms } from "@zowe/cics";
 import { BundleDeployer } from "../BundleDeploy/BundleDeployer";
 import { Bundle } from "../BundleContent/Bundle";
 import { SubtaskWithStatus } from "./SubtaskWithStatus";
+import { ZosmfConfig } from "./ZosmfConfig";
 
 
 /**
@@ -76,6 +77,7 @@ export class BundlePusher {
     const zosMFProfile = this.getProfile("zosmf", true);
     const sshProfile = this.getProfile("ssh", true);
     const cicsProfile = this.getProfile("cics", false);
+    ZosmfConfig.mergeProfile(zosMFProfile, this.params);
     this.validateProfiles(zosMFProfile, sshProfile, cicsProfile);
 
     // Create a zOSMF session
@@ -185,10 +187,10 @@ export class BundlePusher {
   }
 
   private getProfile(type: string, required: boolean): IProfile {
-    const profile =  this.params.profiles.get(type);
+    let profile =  this.params.profiles.get(type);
 
     if (required && profile === undefined) {
-      throw new Error("No " + type + " profile found");
+      profile = {};
     }
 
     return profile;

src/api/BundlePush/ZosmfConfig.ts

@@ -0,0 +1,83 @@
+/*
+* This program and the accompanying materials are made available under the terms of the
+* Eclipse Public License v2.0 which accompanies this distribution, and is available at
+* https://www.eclipse.org/legal/epl-v20.html
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Copyright IBM Corp, 2019
+*
+*/
+
+"use strict";
+
+import { IHandlerParameters, IProfile } from "@zowe/imperative";
+
+
+/**
+ * Class to represent a CICS Bundle Pusher.
+ *
+ * @export
+ * @class ZosmfConfig
+ */
+export class ZosmfConfig {
+
+  /**
+   * Merge command line overrides together with the optional zosmfProfile into a
+   * composite whole
+   */
+  public static mergeProfile(zosmfProfile: IProfile, params: IHandlerParameters) {
+
+    if (params.arguments.zh !== undefined) {
+      zosmfProfile.host = params.arguments.zh;
+      zosmfProfile.H = params.arguments.zh;
+    }
+
+    if (params.arguments.zp !== undefined) {
+      zosmfProfile.port = params.arguments.zp;
+      zosmfProfile.P = params.arguments.zp;
+    }
+
+    if (params.arguments.zu !== undefined) {
+      zosmfProfile.user = params.arguments.zu;
+      zosmfProfile.u = params.arguments.zu;
+    }
+
+    if (params.arguments.zpw !== undefined) {
+      zosmfProfile.password = params.arguments.zpw;
+      zosmfProfile.pass = params.arguments.zpw;
+      zosmfProfile.pw = params.arguments.zpw;
+    }
+
+    if (params.arguments.zru !== undefined) {
+      zosmfProfile.rejectUnauthorized = params.arguments.zru;
+      zosmfProfile.ru = params.arguments.zru;
+    }
+
+    if (params.arguments.zbp !== undefined) {
+      zosmfProfile.basePath = params.arguments.zbp;
+      zosmfProfile.bp = params.arguments.zbp;
+    }
+
+    ZosmfConfig.validateRequired(zosmfProfile);
+  }
+
+  private static validateRequired(zosmfProfile: IProfile) {
+    if (zosmfProfile.host === undefined) {
+      throw new Error("Required parameter --zosmf-host is not set.");
+    }
+    if (zosmfProfile.port === undefined) {
+      throw new Error("Required parameter --zosmf-port is not set.");
+    }
+    if (zosmfProfile.user === undefined) {
+      throw new Error("Required parameter --zosmf-user is not set.");
+    }
+    if (zosmfProfile.password === undefined) {
+      throw new Error("Required parameter --zosmf-password is not set.");
+    }
+    if (zosmfProfile.rejectUnauthorized === undefined) {
+      throw new Error("Required parameter --zosmf-reject-unauthorized is not set.");
+    }
+  }
+
+}

src/cli/deploy/bundle/options/Bundledir.option.ts

@@ -23,7 +23,7 @@ export const BundledirOption: ICommandOptionDefinition = {
     type: "string",
     required: true,
     stringLengthRange: [1, MAX_LENGTH],
-    group: "cics-deploy",
+    group: "cics-deploy Options",
     description: "Specifies the location of the CICS bundle (up to 255 characters) on zFS."
 };
 

src/cli/deploy/bundle/options/Description.option.ts

@@ -23,7 +23,7 @@ export const DescriptionOption: ICommandOptionDefinition = {
     type: "string",
     required: false,
     stringLengthRange: [1, MAX_LENGTH],
-    group: "cics-deploy",
+    group: "cics-deploy Options",
     description: "An optional value that specifies a description of the bundle definition (up to 58 characters)."
 };