Merge branch 'master' of github.com:IBM/zowe-cli-cics-deploy-plugin into subtask-progress

Conflicts:
	src/api/BundleDeploy/BundleDeployer.ts
	src/api/BundlePush/BundlePusher.ts

Author: matthewpwilson

CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+<!--
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Changes should be placed under the following headings:
+### Added
+- for new features
+### Changed
+- for changes in existing functionality
+### Deprecated
+- for soon-to-be removed features
+### Removed
+- for now removed features
+### Fixed
+- for any bug fixes
+### Security
+- in case of vulnerabilities
+-->
+
+## [Unreleased]
+
+### Added
+
+- Zowe CLI cics-deploy plugin including the commands:
+
+  - `zowe cics-deploy generate bundle`
+  - `zowe cics-deploy push bundle`
+  - `zowe cics-deploy deploy bundle`
+  - `zowe cics-deploy undeploy bundle`
+
+- Zowe CLI cics-deploy profile
+- Documentation in GitHub pages

Jenkinsfile

@@ -18,6 +18,12 @@
  */
 def RELEASE_BRANCHES = ["master"]
 
+/** 
+ * Branches to send notifcations for
+*/
+def NOTIFY_BRANCHES = ["master"]
+
+
 /**
  * The following flags are switches to control which stages of the pipeline to be run.  This is helpful when 
  * testing a specific stage of the pipeline.
@@ -63,11 +69,11 @@ def UNIT_RESULTS = "${TEST_RESULTS_FOLDER}/unit"
  */
 def MASTER_BRANCH = "master"
 
-
 /**
- * A command to be run that gets the current revision pulled down
+ * Variables to check any new commit since the previous successful commit
  */
-def GIT_REVISION_LOOKUP = 'git log -n 1 --pretty=format:%h'
+def GIT_COMMIT = "null"
+def GIT_PREVIOUS_SUCCESSFUL_COMMIT = "null"
 
 /**
  * This is the product name used by the build machine to store information about
@@ -105,6 +111,10 @@ pipeline {
 
     agent any
 
+    options {
+        skipDefaultCheckout true
+    }
+
     environment {
         // Environment variable for flow control. Indicates if the git source was updated by the pipeline.
         GIT_SOURCE_UPDATED = "false"
@@ -117,6 +127,20 @@ pipeline {
     }
 
     stages {
+        stage("Clean workspace and checkout source") {
+            steps {
+                timeout(time: 5, unit: 'MINUTES') {
+                    script {
+                        cleanWs()
+                        scmInfo = checkout scm
+
+                        GIT_COMMIT = scmInfo.GIT_COMMIT
+                        GIT_PREVIOUS_SUCCESSFUL_COMMIT = scmInfo.GIT_PREVIOUS_SUCCESSFUL_COMMIT
+                    }
+                }
+            }
+        } 
+
         /************************************************************************
          * STAGE
          * -----
@@ -145,12 +169,6 @@ pipeline {
             steps {
                 timeout(time: 2, unit: 'MINUTES') {
                     script {
-                        // We need to keep track of the current commit revision. This is to prevent the condition where
-                        // the build starts on master and another branch gets merged to master prior to version bump
-                        // commit taking place. If left unhandled, the version bump could be done on latest master branch
-                        // code which would already be ahead of this build.
-                        BUILD_REVISION = sh returnStdout: true, script: GIT_REVISION_LOOKUP
-
                         // This checks for the [ci skip] text. If found, the status code is 0
                         def result = sh returnStatus: true, script: 'git log -1 | grep \'.*\\[ci skip\\].*\''
                         if (result == 0) {
@@ -197,17 +215,16 @@ pipeline {
                 }
             }
             steps('Install Zowe CLI') {
-                withCredentials([usernamePassword(credentialsId: ARTIFACTORY_CREDENTIALS_ID, usernameVariable: 'USERNAME', passwordVariable: 'API_KEY')]) {
-                    timeout(time: 10, unit: 'MINUTES') {
-                        echo "Install Zowe CLI globaly"
-                        sh "rm -f ~/.npmrc"
-                        sh 'curl -u $USERNAME:$API_KEY https://eu.artifactory.swg-devops.com/artifactory/api/npm/auth/ >> ~/.npmrc'
-                        sh "echo registry=$TEST_NPM_REGISTRY >> ~/.npmrc"
-                        sh "echo @brightside:registry=$TEST_NPM_REGISTRY >> ~/.npmrc"
-                        sh "echo @zowe:registry=$TEST_NPM_REGISTRY >> ~/.npmrc"
-                        sh("npm install -g @zowe/cli@cicsdev")
-                        sh("zowe --version")
-                    }
+                timeout(time: 10, unit: 'MINUTES') {
+                    echo "Install Zowe CLI globaly"
+                    sh "rm -f .npmrc"
+                    sh("npm set registry https://registry.npmjs.org")
+                    //sh("npm set @brightside:registry https://api.bintray.com/npm/ca/brightside/")
+                    //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("zowe --version")
                 }
             }
         }
@@ -248,7 +265,7 @@ pipeline {
             steps {
                 timeout(time: 10, unit: 'MINUTES') {
                     echo 'Installing Dependencies'
-
+                    sh 'npm config ls'
                     sh 'npm install'
                 }
             }
@@ -524,6 +541,9 @@ pipeline {
                     expression {
                         return BRANCH_NAME == MASTER_BRANCH
                     }
+                    expression {
+                        return GIT_COMMIT != GIT_PREVIOUS_SUCCESSFUL_COMMIT
+                    }
                 }
             }
             steps {
@@ -573,7 +593,10 @@ pipeline {
                         return PIPELINE_CONTROL.deploy
                     }
                     expression {
-                       return BRANCH_NAME == MASTER_BRANCH
+                        return BRANCH_NAME == MASTER_BRANCH
+                    }
+                    expression {
+                        return GIT_COMMIT != GIT_PREVIOUS_SUCCESSFUL_COMMIT
                     }
                 }
             }
@@ -586,22 +609,39 @@ pipeline {
                         sh "rm -f .npmrc"
                         sh 'curl -u $USERNAME:$API_KEY https://eu.artifactory.swg-devops.com/artifactory/api/npm/auth/ >> .npmrc'
                         sh "echo registry=$TEST_NPM_REGISTRY >> .npmrc"
-                        sh "echo @brightside:registry=https://api.bintray.com/npm/ca/brightside/ >> .npmrc"
-                        sh "echo @brightside:always-auth=false >> .npmrc"
-
+                        sh "echo @zowe:registry=https://registry.npmjs.org >> .npmrc"
+                        sh "echo @zowe:always-auth=false >> .npmrc"
+                        
                         script {
                             if (BRANCH_NAME == MASTER_BRANCH) {
                                 echo "publishing next to $TEST_NPM_REGISTRY"
                                 sh "npm publish --tag next"
-                            }
-                            else {
+                            } else {
                                 echo "publishing latest to $TEST_NPM_REGISTRY"
                                 sh "npm publish --tag latest"
                             }
                         }
+
+                        sh "rm -f .npmrc"
                     }
                 }
             }
         }
     }
+    post {
+        unsuccessful {
+            script {
+                if (NOTIFY_BRANCHES.contains(BRANCH_NAME)) {
+                    slackSend (channel: '#cics-node-dev', message: "${env.JOB_NAME} #${env.BUILD_NUMBER} completed - ${currentBuild.result} (<${env.BUILD_URL}|Open>)", tokenCredentialId: 'slack-cics-node-dev')
+                }
+            }
+        }
+        fixed {
+            script {
+                if (NOTIFY_BRANCHES.contains(BRANCH_NAME)) {
+                    slackSend (channel: '#cics-node-dev', message: "${env.JOB_NAME} #${env.BUILD_NUMBER} completed - Back to normal (<${env.BUILD_URL}|Open>)", tokenCredentialId: 'slack-cics-node-dev')
+                }
+            }
+        }
+    }
 }

README.md

@@ -4,7 +4,7 @@ This project provides a plug-in for [Zowe CLI](https://github.com/zowe/zowe-cli)
 ## Status
 The project was started in February 2019 and is at an early stage of development. It will initially focus on generating and deploying CICS bundles containing Node.js applications.
 
-To try it out, build the plug-in from source as described in [setup](docs/tutorials/Setup.md).
+To try it out, build the plug-in from source as described in [setup](docs-internal/tutorials/Setup.md).
 
 ## 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__/__resources__/ExampleBundle03/META-INF/cics.xml

@@ -1,2 +1,2 @@
 <manifest xmlns="http://www.ibm.com/xmlns/prod/cics/bundle">
-</manifest>
+</manifest>

__tests__/__resources__/ExampleBundle05/.zosattributes

@@ -0,0 +1 @@
+Dummy Content

__tests__/__src__/environment/TestEnvironment.ts

@@ -51,16 +51,14 @@ export class TestEnvironment {
         // Get a unique test data area
         const testDirectory: string = TestEnvironment.createUniqueTestDataDir(params.testName);
 
-        const systemProps = TestEnvironment.loadSystemTestProperties(undefined, testDirectory);
-
         // set the env variables to be used for executing
         // scripts in the test environment
         const env: { [key: string]: string } = {};
         env[this.HOME_ENV_KEY] = testDirectory;
 
         const result: ITestEnvironment = {
             workingDir: testDirectory,
-            systemTestProperties: systemProps,
+            systemTestProperties: null,
             env
         };
 
@@ -149,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));
@@ -158,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/BundleDeploy/BundleDeployer.test.ts

@@ -127,14 +127,14 @@ describe("BundleDeployer01", () => {
         submitSpy = jest.spyOn(SubmitJobs, "submitJclString").mockImplementationOnce((session: any, jcl: string, parms: any) => {
                 parms.task.statusMessage = "Waiting for JOB12345 to enter OUTPUT";
                 parms.task.stageName = TaskStage.IN_PROGRESS;
-                const expectedMsg = "Waiting for JOB12345 to enter OUTPUT (Processing DFHDPLOY DEPLOY action)";
+                const expectedMsg = "Running DFHDPLOY (DEPLOY), job JOB12345";
                 // wait 1.5 seconds
                 return new Promise((resolve, reject) => {
                   setTimeout(() => {
                     // Now check that the status message has been updated by the progress bar processing
                     if (parms.task.statusMessage !== expectedMsg) {
-                      throw new Error("Failed to find the expected message. Got: '" + parms.task.statusMessage + "' expected " +
-                      expectedMsg);
+                      throw new Error("Failed to find the expected message. Got: '" + parms.task.statusMessage + "' expected '" +
+                      expectedMsg + "'");
                     }
                     resolve();
                   }, 1500);
@@ -403,6 +403,13 @@ describe("BundleDeployer01", () => {
         parms.arguments.verbose = false;
         await testDeployJCL(parms);
     });
+    it("should support long description", async () => {
+        let parms: IHandlerParameters;
+        parms = DEFAULT_PARAMTERS;
+        setCommonParmsForDeployTests(parms);
+        parms.arguments.description = "1234567890123456789012345678901234567890123456789012345678";
+        await testDeployJCL(parms);
+    });
 
     // ** UNDEPLOY TESTS **
     it("should generate undeploy JCL with neither csdgroup nor resgroup", async () => {
@@ -597,6 +604,7 @@ function setCommonParmsForUndeployTests(parms: IHandlerParameters) {
   parms.arguments.name = "12345678";
   parms.arguments.jobcard = "//DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT";
   parms.arguments.targetstate = "DISCARDED";
+  parms.arguments.description = undefined;
 }
 
 async function testDeployJCL(parms: IHandlerParameters) {

__tests__/api/BundleDeploy/__snapshots__/BundleDeployer.test.ts.snap

@@ -371,7 +371,7 @@ UNDEPLOY BUNDLE(12345678)
 
 exports[`BundleDeployer01 should handle failure during submitjobs processing 1`] = `"Failure occurred submitting DFHDPLOY JCL for JOBID UNKNOWN: 'Injected Submit error'. Most recent status update: 'Submitting DFHDPLOY JCL for the DEPLOY action'."`;
 
-exports[`BundleDeployer01 should include the JOBID in an error 1`] = `"Failure occurred submitting DFHDPLOY JCL for JOBID JOB12345: 'Injected submit error'. Most recent status update: 'Waiting for JOB12345 to enter OUTPUT (Processing DFHDPLOY DEPLOY action)'."`;
+exports[`BundleDeployer01 should include the JOBID in an error 1`] = `"Failure occurred submitting DFHDPLOY JCL for JOBID JOB12345: 'Injected submit error'. Most recent status update: 'Running DFHDPLOY (DEPLOY), job JOB12345'."`;
 
 exports[`BundleDeployer01 should support long bundledir 1`] = `
 "//DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT
@@ -396,6 +396,26 @@ DEPLOY BUNDLE(12345678)
 "
 `;
 
+exports[`BundleDeployer01 should support long description 1`] = `
+"//DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT
+//DFHDPLOY EXEC PGM=DFHDPLOY,REGION=100M
+//STEPLIB  DD DISP=SHR,DSN=12345678901234567890123456789012345.SDFHLOAD
+//         DD DISP=SHR,DSN=abcde12345abcde12345abcde12345abcde.SEYUAUTH
+//SYSTSPRT DD SYSOUT=*
+//SYSIN    DD *
+*
+SET CICSPLEX(12345678);
+*
+DEPLOY BUNDLE(12345678)
+       BUNDLEDIR(1234567890)
+       DESCRIPTION(1234567890123456789012345678901234567890123456789012
+        345678)
+       SCOPE(12345678)
+       STATE(ENABLED)
+/*
+"
+`;
+
 exports[`BundleDeployer01 should support long line jobcard 1`] = `
 "//DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT,
 //         NOEL=ABCDEFGHIJKMNOPQRSTUVWXYZ