Merge remote-tracking branch 'upstream/dev' into branch1

Author: pcoop

CONTRIBUTING.md

@@ -7,15 +7,15 @@ This project welcomes all contributions.
 - If you would like to contribute a bug fix or small enhancement, please fork the repo and make a pull request.
 - If you would like to contribute a new feature, please raise an issue describing your proposal so we can discuss it first.
 
-## Developing Zowe CLI plugins
+## Developing Zowe CLI plug-ins
 
 For guidelines on developing Zowe CLI plug-ins see the [Zowe CLI GitHub repository](https://github.com/zowe/zowe-cli). The following information is critical to working with the code, running/writing/maintaining automated tests, developing consistent syntax and ensuring that the plug-in integrates with Zowe CLI properly:
 
 | For more information about ... | See: |
 | ------------------------------ | ----- |
-| General guidelines that apply to contributing to Zowe CLI and Plug-ins | [Contribution Guidelines](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md) |
+| General guidelines that apply to contributing to Zowe CLI and plug-ins | [Contribution Guidelines](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md) |
 | Conventions and best practices for creating packages and plug-ins for Zowe CLI | [Package and Plug-in Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/PackagesAndPluginGuidelines.md)|
 | Guidelines for running tests on Zowe CLI | [Testing Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/TESTING.md) |
 | Guidelines for running tests on the plug-ins that you build for Zowe CLI | [Plug-in Testing Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/PluginTESTINGGuidelines.md) |
 | Documentation that describes the features of the Imperative CLI Framework | [About Imperative CLI Framework](https://github.com/zowe/imperative/wiki) |
-Versioning conventions for Zowe CLI and Plug-ins| [Versioning Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md) |
+Versioning conventions for Zowe CLI and plug-ins| [Versioning Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md) |

Jenkinsfile

@@ -236,7 +236,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@daily")
+                    sh("npm install -g @zowe/cli@latest")
                     sh("zowe --version")
                 }
             }

README.md

@@ -6,5 +6,8 @@ The project was started in February 2019 and is at an early stage of development
 
 To try it out, build the plug-in from source as described in [setup](docs-internal/tutorials/Setup.md).
 
+## Documentation
+You can find information and tutorials on using this plug-in in our [documentation](https://ibm.github.io/zowe-cli-cics-deploy-plugin/index.html).
+
 ## Contributing
 Contributions are welcome - see the [contribution guidelines](CONTRIBUTING.md). If you have a question or encounter a problem please raise an issue in this repo.

__tests__/api/BundleContent/BundleMocked.test.ts

@@ -11,18 +11,14 @@
 
 import { Bundle } from "../../../src/api/BundleContent/Bundle";
 import * as fs from "fs";
-
+import * as parser from "fast-xml-parser";
 
 // Note, the following tests mock the file-system. Snapshot based tests are unlikely to
 // work as the jest implementation will itself need to interact with the filesystem.
 describe("MockedFilesystemTests", () => {
     afterEach(() => {
       jest.restoreAllMocks();
     });
-    beforeAll(() => {
-      // Allow xml2json to initialise itself before we start messing with the filesystem below it.
-      const parser = require("xml2json");
-    });
 
     it("should tolerate META-INF directory not existing", () => {
         // Mocks for the manifest - META-INF exists
@@ -552,7 +548,7 @@ describe("MockedFilesystemTests", () => {
 
     it("should complain if exceptions are thrown during manifest parsing", () => {
 
-      jest.spyOn(JSON, "parse").mockImplementationOnce(() => { throw new Error("Wibble"); });
+      jest.spyOn(parser, "parse").mockImplementationOnce(() => { throw new Error("Wibble"); });
 
       let err: Error;
       try {

__tests__/api/BundleContent/Manifest.test.ts

@@ -169,7 +169,7 @@ describe("Manifest01", () => {
         }
 
         // Check the output as JSON
-        expect(err.message).toContain("Existing CICS Manifest file found with unparsable content.");
+        expect(err.message).toContain("Existing CICS Manifest file found with unparsable content:");
     });
     it("Parse a manifest with bad namespace", () => {
 
@@ -197,6 +197,6 @@ describe("Manifest01", () => {
         }
 
         // Check the output as JSON
-        expect(err.message).toContain("Existing CICS Manifest file found with unparsable content.");
+        expect(err.message).toContain("Existing CICS Manifest file found with unparsable content:");
     });
 });

__tests__/api/BundleContent/__snapshots__/AutoBundler.test.ts.snap

@@ -12,17 +12,17 @@ exports[`AutoBundler01 should not merge an existing bundle 1`] = `"{\\"manifest\
 
 exports[`AutoBundler01 should read an existing bundle 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"bundleVersion\\":\\"1\\",\\"bundleRelease\\":\\"2\\",\\"id\\":\\"ThisIsAnId\\",\\"bundleMajorVer\\":\\"10\\",\\"bundleMinorVer\\":\\"11\\",\\"bundleMicroVer\\":\\"12\\",\\"define\\":[{\\"name\\":\\"name1\\",\\"type\\":\\"type1\\",\\"path\\":\\"path1\\"},{\\"name\\":\\"name2\\",\\"type\\":\\"type2\\",\\"path\\":\\"path2\\"},{\\"name\\":\\"name3\\",\\"type\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\",\\"path\\":\\"nodejsapps/Test.nodejsapp\\"}]}}"`;
 
-exports[`AutoBundler01 should receive default values from package.json 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"$t\\":\\"\\",\\"id\\":\\"testBundleName\\",\\"bundleMajorVer\\":1,\\"bundleMinorVer\\":0,\\"bundleMicroVer\\":0,\\"define\\":[{\\"name\\":\\"testBundleName\\",\\"type\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\",\\"path\\":\\"nodejsapps/testBundleName.nodejsapp\\"}]}}"`;
+exports[`AutoBundler01 should receive default values from package.json 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"id\\":\\"testBundleName\\",\\"bundleMajorVer\\":1,\\"bundleMinorVer\\":0,\\"bundleMicroVer\\":0,\\"define\\":[{\\"name\\":\\"testBundleName\\",\\"type\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\",\\"path\\":\\"nodejsapps/testBundleName.nodejsapp\\"}]}}"`;
 
-exports[`AutoBundler01 should set a nodejsapp name 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"$t\\":\\"\\",\\"id\\":\\"testBundleName\\",\\"bundleMajorVer\\":1,\\"bundleMinorVer\\":0,\\"bundleMicroVer\\":0,\\"define\\":[{\\"name\\":\\"MyExampleOverride\\",\\"type\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\",\\"path\\":\\"nodejsapps/MyExampleOverride.nodejsapp\\"}]}}"`;
+exports[`AutoBundler01 should set a nodejsapp name 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"id\\":\\"testBundleName\\",\\"bundleMajorVer\\":1,\\"bundleMinorVer\\":0,\\"bundleMicroVer\\":0,\\"define\\":[{\\"name\\":\\"MyExampleOverride\\",\\"type\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\",\\"path\\":\\"nodejsapps/MyExampleOverride.nodejsapp\\"}]}}"`;
 
 exports[`AutoBundler01 should set a port number 1`] = `"Supplied Port is outside the range of 1-65535: -27"`;
 
-exports[`AutoBundler01 should set the bundle version 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"$t\\":\\"\\",\\"bundleMajorVer\\":3,\\"bundleMinorVer\\":4,\\"bundleMicroVer\\":5}}"`;
+exports[`AutoBundler01 should set the bundle version 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"bundleMajorVer\\":3,\\"bundleMinorVer\\":4,\\"bundleMicroVer\\":5}}"`;
 
-exports[`AutoBundler01 should set the bundleid 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"$t\\":\\"\\",\\"id\\":\\"test\\"}}"`;
+exports[`AutoBundler01 should set the bundleid 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"id\\":\\"test\\"}}"`;
 
-exports[`AutoBundler01 should support main script from package.json 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"$t\\":\\"\\",\\"id\\":\\"testBundleName\\",\\"bundleMajorVer\\":1,\\"bundleMinorVer\\":0,\\"bundleMicroVer\\":0,\\"define\\":[{\\"name\\":\\"testBundleName\\",\\"type\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\",\\"path\\":\\"nodejsapps/testBundleName.nodejsapp\\"}]}}"`;
+exports[`AutoBundler01 should support main script from package.json 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"id\\":\\"testBundleName\\",\\"bundleMajorVer\\":1,\\"bundleMinorVer\\":0,\\"bundleMicroVer\\":0,\\"define\\":[{\\"name\\":\\"testBundleName\\",\\"type\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\",\\"path\\":\\"nodejsapps/testBundleName.nodejsapp\\"}]}}"`;
 
 exports[`AutoBundler01 should tolerate an almost empty package.json 1`] = `"No startscript value set for NODEJSAPP \\"almostEmpty\\""`;
 

__tests__/api/BundleContent/__snapshots__/BundleSimple.test.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Bundle01 add a NODEJSAPP 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"$t\\":\\"\\",\\"define\\":[{\\"name\\":\\"NodeName\\",\\"type\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\",\\"path\\":\\"nodejsapps/NodeName.nodejsapp\\"}]}}"`;
+exports[`Bundle01 add a NODEJSAPP 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"define\\":[{\\"name\\":\\"NodeName\\",\\"type\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\",\\"path\\":\\"nodejsapps/NodeName.nodejsapp\\"}]}}"`;
 
 exports[`Bundle01 add a NODEJSAPP 2`] = `
 "<manifest xmlns=\\"http://www.ibm.com/xmlns/prod/cics/bundle\\"><define name=\\"NodeName\\" type=\\"http://www.ibm.com/xmlns/prod/cics/bundle/NODEJSAPP\\" path=\\"nodejsapps/NodeName.nodejsapp\\"></define></manifest>
@@ -25,4 +25,4 @@ exports[`Bundle01 should read an existing bundle 1`] = `"{\\"manifest\\":{\\"xml
 
 exports[`Bundle01 should warn that an existing bundle cant be overwritten 1`] = `"A bundle manifest file already exists. Specify --overwrite to replace it, or --merge to merge changes into it."`;
 
-exports[`Bundle01 tolerate an existing almost empty manifest 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"$t\\":\\"\\",\\"define\\":[{\\"name\\":\\"name1\\",\\"type\\":\\"type1\\",\\"path\\":\\"Artefact1\\"}]}}"`;
+exports[`Bundle01 tolerate an existing almost empty manifest 1`] = `"{\\"manifest\\":{\\"xmlns\\":\\"http://www.ibm.com/xmlns/prod/cics/bundle\\",\\"define\\":[{\\"name\\":\\"name1\\",\\"type\\":\\"type1\\",\\"path\\":\\"Artefact1\\"}]}}"`;

__tests__/api/BundlePush/BundlePusher.test.ts

@@ -74,9 +74,6 @@ let zosmfProfile = {};
 let sshProfile = {};
 let cicsProfile = {};
 
-// Initialise xml2json before mocking anything
-const parser = require("xml2json");
-
 let zosMFSpy = jest.spyOn(ZosmfSession, "createBasicZosmfSession").mockImplementation(() => ({}));
 let sshSpy = jest.spyOn(SshSession, "createBasicSshSession").mockImplementation(() => ({}));
 let createSpy = jest.spyOn(Create, "uss").mockImplementation(() => ({}));
@@ -185,7 +182,7 @@ describe("BundlePusher01", () => {
         existsSpy.mockReturnValue(true);
         readSpy.mockImplementation((data: string) => ("wibble"));
         await runPushTestWithError("__tests__/__resources__/BadManifestBundle01", false,
-                                   "Existing CICS Manifest file found with unparsable content.");
+                                   "Existing CICS Manifest file found with unparsable content:");
     });
     it("should complain with missing manifest file", async () => {
         readSpy.mockImplementationOnce(() => {

docs/_data/sidebars/cdp_sidebar.yml

@@ -15,11 +15,11 @@ entries:
     - title: Requirements on z/OS
       url: cdp-Requirements.html
       output: web
-    - title: Installation
-      url: cdp-Installation.html
+    - title: Installing
+      url: cdp-Installing.html
       output: web
-    - title: Create Zowe CLI profiles
-      url: cdp-Create-Zowe-CLI-profiles.html
+    - title: Creating Zowe CLI profiles
+      url: cdp-Creating-Zowe-CLI-profiles.html
       output: web
 
   - title: Tutorials
@@ -32,8 +32,8 @@ entries:
     - 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
+    - title: Provisioning a CICS region with z/OS PT
+      url: cdp-Provisioning-a-CICS-region-using-zospt.html
       output: web
 
   - title: Concepts

docs/_includes/head.html

@@ -16,6 +16,12 @@
 <!-- most color styles are extracted out to here -->
 <link rel="stylesheet" href="css/theme-blue.css">
 
+<!-- Added by C Harris on 5th June 2019 -->
+<style>
+    @import url('https://fonts.googleapis.com/css?family=IBM+Plex+Sans&display=swap');
+    @import url('https://fonts.googleapis.com/css?family=IBM+Plex+Mono&display=swap');
+</style>
+
 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
 
 <!-- Added by C Harris on 1st May 2019 - used for code copying buttons -->