Releasing 6.0.0 version

Author: manoharreddydavired

README.md

@@ -1,7 +1,17 @@
-# app-devops-gitlab-docker
+# app-devops-gitlab
 
  New repository for developing a plugin to integrate between ITSM DevOps and GitLab pipelines
 
+### Owners
+
+> ramachandrarao.p
+
+### How to build on Jenkins
+* Create a `pom.xml` file at the root level
+* Go to the [BT1 Service Catalog](https://buildtools1.service-now.com/nav_to.do?uri=%2Fcom.glideapp.servicecatalog_cat_item_view.do%3Fv%3D1%26sysparm_id%3D9dbd0c54db1acb403a3d5dd5ce961948%26sysparm_link_parent%3Dad2fecb72bfc310052f7c71317da157e%26sysparm_catalog%3De0d08b13c3330100c8b837659bba8fb4%26sysparm_catalog_view%3Dess%26sysparm_view%3Dess) to request a Jenkins job
+
+Once the request is processed, a multi-branch job is created on https://buildmaster-hotel.devsnc.com and will build any branches that match [ServiceNow branch naming convention](https://buildtools1.service-now.com/kb_view_customer.do?sysparm_article=KB0528607).
+
 # CLI example using npm modules
 
 ## Build and install
@@ -55,11 +65,11 @@ npm unlink .
 ### Building Docker Image
 
 ```sh
-docker build -t servicenowdocker/sndevops:5.1.0 .
+docker build -t servicenowdocker/sndevops:6.0.0 .
 ```
 
 ```sh
-docker push servicenowdocker/sndevops:5.1.0
+docker push servicenowdocker/sndevops:6.0.0
 ```
 
 ## Integrating with GitLab
@@ -80,19 +90,19 @@ SNOW_TOOLID = <servicenow-tool-id>
 
 ### Additonal Env variables
 ```
-CI_PIPELINE_ID: <pipeline-id>
-CI_API_V4_URL: <pipeline-url>
-CI_JOB_ID: <pipeline-execution-id>
-CI_PROJECT_PATH: <repository-path>
-CI_REPOSITORY_NAME: <repository-name>
-CI_RUN_ATTEMPT: <pipeline-attempt-number>
-CI_PROJECT_TITLE: <pipeline-name>
+PIPELINE_ID: <pipeline-id>
+API_V4_URL: <pipeline-url>
+JOB_ID: <pipeline-execution-id>
+PROJECT_PATH: <repository-path>
+REPOSITORY_NAME: <repository-name>
+RUN_ATTEMPT: <pipeline-attempt-number>
+PROJECT_TITLE: <pipeline-name>
 ```
 
 ### Optional Env variables
 ```
-CI_COMMIT_BRANCH: <commit-branch>
-CI_WORKFLOW_NAME: <workflow-name>
+COMMIT_BRANCH: <commit-branch>
+WORKFLOW_NAME: <workflow-name>
 ```
 
 **Example with passing all ServiceNow information via commandline**
@@ -105,10 +115,10 @@ stages:
 
 package:
   stage: package
-  image: servicenowdocker/sndevops:5.1.0
+  image: servicenowdocker/sndevops:6.0.0
   script: 
-    - sndevopscli create artifact -a '[{"name":"artifact-name-$CI_JOB_ID","repositoryName":"artifact-repo-name" ,"version":"1.3.0"}]'
-    - sndevopscli create package -n "package-name" -a '[{"name":"artifact-name-$CI_JOB_ID","repositoryName":"artifact-repo-name" ,"version":"1.3.0"}]
+    - sndevopscli create artifact -a '[{"name":"artifact-name","repositoryName":"artifact-repo-name" ,"version":"1.3.0"}]'
+    - sndevopscli create package -n "package-name" -a '[{"name":"artifact-name","repositoryName":"artifact-repo-name" ,"version":"1.3.0"}]
 
 OR
 
@@ -117,10 +127,10 @@ stages:
 
 package:
   stage: package
-  image: servicenowdocker/sndevops:5.1.0
+  image: servicenowdocker/sndevops:6.0.0
   script: 
-    - sndevopscli create artifact -u <serviceno-url> -t <tool-id> --token <tool-token> -a '[{"name":"artifact-name-$CI_JOB_ID","repositoryName":"artifact-repo-name" ,"version":"1.3.0"}]'
-    - sndevopscli create package -u <serviceno-url> -t <tool-id> --token <tool-token> -n "package-mame" -a '[{"name":"artifact-name-$CI_JOB_ID","repositoryName":"artifact-repo-name" ,"version":"1.3.0"}]
+    - sndevopscli create artifact -u <servicenow-url> -t <tool-id> --token <tool-token> -a '[{"name":"artifact-name","repositoryName":"artifact-repo-name" ,"version":"1.3.0"}]'
+    - sndevopscli create package -u <servicenow-url> -t <tool-id> --token <tool-token> -n "package-mame" -a '[{"name":"artifact-name","repositoryName":"artifact-repo-name" ,"version":"1.3.0"}]
 
  -a : [mandatory]
  This specifies artifact details.
@@ -141,7 +151,7 @@ stages:
 
 ServiceNow DevOps Change:
   stage: DevOpsChangeApproval
-  image: servicenowdocker/sndevops:5.1.0
+  image: servicenowdocker/sndevops:6.0.0
   script: 
     - sndevopscli create change -p '{"changeStepDetails":{"timeout":3600,"interval":100},"attributes":{"short_description":"Automated Software Deployment","description":"Automated Software Deployment.","assignment_group":"XXXXXXX","implementation_plan":"Software update is tested and results can be found in Test Summaries Tab.","backout_plan":"When software fails in production, the previous software release will be re-deployed.","test_plan":"Testing if the software was successfully deployed or not"}}'
 
@@ -181,7 +191,7 @@ stages:
 
 ServiceNow DevOps Sonar Scan Results:
   stage: DevOpsSonarStage
-  image: servicenowdocker/sndevops:5.1.0
+  image: servicenowdocker/sndevops:6.0.0
   script: 
     - sndevopscli create sonar -url 'https://sonarcloud.io' -projectKey 'xxxxxxx' -branch 'master'
 
@@ -192,7 +202,7 @@ projectKey: [mandatory]
 This specifies the sonar project key.
 
 branch: [optional]
-This specifies the branch on which the Sonar scan was executed. By default, it matches the branch for which the build was run. Note, for Harness, the branch option is required if CI_COMMIT_BRANCH is not provided.
+This specifies the branch on which the Sonar scan was executed. By default, it matches the branch for which the build was run. Note, for Harness, the branch option is required if COMMIT_BRANCH is not provided.
 
 ```
 
@@ -206,15 +216,15 @@ stages:
 
 ServiceNow DevOps Security Scan Results:
   stage: DevOpsSecurityScanStage
-  image: servicenowdocker/sndevops:5.1.0
+  image: servicenowdocker/sndevops:6.0.0
   script: 
-    - sndevopscli create securityScan -p "{\"pipelineInfo\":{\"buildNumber\":\"${CI_PIPELINE_ID}\",\"pipelineExecutionUrl\":\"${CI_PIPELINE_URL}\" },\"securityResultAttributes\":{ \"scanner\":\"Veracode\",\"applicationName\":\"PetStoreAPI-Github\",\"buildVersion\":\"\",\"securityToolId\":\"\"}}"
+    - sndevopscli create securityScan -p "{\"pipelineInfo\":{\"buildNumber\":\"buildNumber\",\"pipelineExecutionUrl\":\"pipelineExecutionUrl\" },\"securityResultAttributes\":{ \"scanner\":\"Veracode\",\"applicationName\":\"PetStoreAPI-Github\",\"buildVersion\":\"\",\"securityToolId\":\"\"}}"
 
 
 -p: [mandatory]
  It the payload of security result attributes. The payload will have attributes as follows:
-  buildNumber: CI_PIPELINE_ID (mandatory)
-  pipelineExecutionUrl: CI_PIPELINE_URL (mandatory)
+  buildNumber: This specifies ID of the Job (mandatory)
+  pipelineExecutionUrl: This specifies the pipeline execution URL (mandatory)
   scanner: Scanning tool and is required e.g. Checkmarx One.
   projectName/projectId: Name/Id of your Checkmarx One project and is required. This attribute is applicable only for Checkmarx One.
   applicationName: Name of your Veracode application and is required. This attribute is applicable only for Veracode.
@@ -234,11 +244,11 @@ stages:
 
 ServiceNow DevOps Get Change:
   stage: DevOpsGetChange
-  image: servicenowdocker/sndevops:5.1.0
+  image: servicenowdocker/sndevops:6.0.0
   script: 
-    - sndevopscli get change -p "{\"buildNumber\":${CHG_JOB_ID},\"stageName\":\"ServiceNow DevOps Change Step\",\"pipelineName\":\"GitlabDockerGetAndUpdateChange\"}"
+    - sndevopscli get change -p "{\"buildNumber\":\"buildNumber\",\"stageName\":\"ServiceNow DevOps Change Step\",\"pipelineName\":\"GitlabDockerGetAndUpdateChange\"}"
 
--p: It stands for changeDetails. The change details to be used for identifying change request in ServiceNow instance. The change details is a JSON object surrounded by curly braces {} containing key-value pair separated by a comma ,. A key-value pair consists of a key and a value separated by a colon :. The keys supported in key-value pair are buildNumber, pipelineName, stageName
+-p: It stands for changeDetails. The change details to be used for identifying change request in ServiceNow instance. The change details is a JSON object surrounded by curly braces {} containing key-value pair separated by a comma ,. A key-value pair consists of a key and a value separated by a colon :. The keys supported in key-value pair are buildNumber, pipelineName, stageName. All fields in the Change Request table are supported except risk, impact and risk_impact_analysis. For more information, [see documentation](https://docs.servicenow.com/bundle/vancouver-it-service-management/page/product/enterprise-dev-ops/concept/dev-ops-config-change-details.html).
 
 buildNumber: [mandatory]
 This specifies ID of the Job where we have created change request.
@@ -270,7 +280,7 @@ stages:
 
 ServiceNow DevOps Update Change:
   stage: DevOpsUpdateChangeStage
-  image: servicenowdocker/sndevops:5.1.0
+  image: servicenowdocker/sndevops:6.0.0
   script: 
     - sndevopscli update change -n 'CHGXXXXXX' -p "{\"short_description\":\"Automated Software Deployment\",\"description\":\"Automated Software Deployment.\",\"assignment_group\":\"XXXXX\",\"implementation_plan\":\"Software update is tested and results can be found in Test Summaries Tab.\",\"backout_plan\":\"When software fails in production, the previous software release will be re-deployed.\",\"test_plan\":\"Testing if the software was successfully deployed or not\"}"
 
@@ -297,7 +307,7 @@ stages:
 
 ServiceNow DevOps Change Step:
   stage: changeapproval
-  image: servicenowdocker/sndevops:5.1.0
+  image: servicenowdocker/sndevops:6.0.0
   script: 
      - sndevopscli create change -p "{\"changeStepDetails\":{\"timeout\":3600,\"interval\":100},\"autoCloseChange\":true,\"attributes\":{\"short_description\":\"Automated Software Deployment\",\"description\":\"Automated Software Deployment.\",\"assignment_group\":\"xxxxxxxx\",\"implementation_plan\":\"Software update is tested and results can be found in Test Summaries Tab.\",\"backout_plan\":\"When software fails in production, the previous software release will be re-deployed.\",\"test_plan\":\"Testing if the software was successfully deployed or not\"}}"
 

github-ci.yml

@@ -13,15 +13,15 @@ env:
   SNOW_TOKEN: ${{ secrets.SNOW_TOKEN }}
   SNOW_TOOLID: ${{ secrets.SNOW_TOOLID }}
   # These are the optional env variables
-  #CI_PIPELINE_ID: ${{ github.run_id }}
-  #CI_API_V4_URL: ${{ github.server_url }}
-  #CI_JOB_ID: ${{ github.run_id }}
-  #CI_PROJECT_PATH: ${{ github.job }}
-  #CI_REPOSITORY_NAME: ${{ github.repository }}
-  #CI_RUN_ATTEMPT: ${{ github.run_attempt }}
-  #CI_PROJECT_TITLE: ${{ github.repository }}/${{github.workflow}}
-  #CI_COMMIT_BRANCH: ${{ github.ref_name }}
-  #CI_WORKFLOW_NAME: ${{ github.workflow }}
+  #PIPELINE_ID: ${{ github.run_id }}
+  #API_V4_URL: ${{ github.server_url }}
+  #JOB_ID: ${{ github.run_id }}
+  #PROJECT_PATH: ${{ github.job }}
+  #REPOSITORY_NAME: ${{ github.repository }}
+  #RUN_ATTEMPT: ${{ github.run_attempt }}
+  #PROJECT_TITLE: ${{ github.repository }}/${{github.workflow}}
+  #COMMIT_BRANCH: ${{ github.ref_name }}
+  #WORKFLOW_NAME: ${{ github.workflow }}
 
 jobs:
   build:
@@ -35,7 +35,7 @@ jobs:
      runs-on: ubuntu-latest
      needs: build
      container:
-       image: servicenowdocker/sndevops:5.1.0
+       image: servicenowdocker/sndevops:6.0.0
      env:
        CI_JOB_NAME: "ServiceNowDevOpsChange"
 
@@ -48,7 +48,7 @@ jobs:
        runs-on: ubuntu-latest
        needs: ServiceNowDevOpsChange
        container:
-         image: servicenowdocker/sndevops:5.1.0
+         image: servicenowdocker/sndevops:6.0.0
        env:
          CI_JOB_NAME: "ServiceNowDevOpsChange"
 
@@ -61,7 +61,7 @@ jobs:
       runs-on: ubuntu-latest
       needs: build
       container:
-        image: servicenowdocker/sndevops:5.1.0
+        image: servicenowdocker/sndevops:6.0.0
       env:
         CI_JOB_NAME: "ArtifactAndPackage"
       steps:
@@ -75,7 +75,7 @@ jobs:
       needs: ArtifactAndPackage
       runs-on: ubuntu-latest
       container:
-        image: servicenowdocker/sndevops:5.1.0
+        image: servicenowdocker/sndevops:6.0.0
       env:
         CI_JOB_NAME: "ServiceNowDevOpsSonarScanResults"
       steps:
@@ -88,7 +88,7 @@ jobs:
       runs-on: ubuntu-latest
       needs: build
       container:
-        image: servicenowdocker/sndevops:5.1.0
+        image: servicenowdocker/sndevops:6.0.0
       steps:
         - name: security scan
           run: |

gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: servicenowdocker/sndevops:5.1.0
+image: servicenowdocker/sndevops:6.0.0
 stages:
   - pre-build
   - build

harness-ci.yml

@@ -45,14 +45,14 @@ pipeline:
                   identifier: Sonar_container
                   spec:
                     connectorRef: docker_connector # harness docker connector
-                    image: servicenowdocker/sndevops:5.1.0
+                    image: servicenowdocker/sndevops:6.0.0
                     command: |-
                       export SNOW_URL="<+variable.SNOW_URL>"
                       export SNOW_TOOLID="<+variable.SNOW_TOOLID>"
                       export SNOW_TOKEN="<+variable.SNOW_TOKEN>"
                       export HARNESS_STAGE_NAME="<+stage.identifier>"
                       export HARNESS_PIPELINE_NAME="<+org.identifier>/<+project.identifier>/<+pipeline.name>"
-                      export CI_COMMIT_BRANCH="main"
+                      export COMMIT_BRANCH="main"
                       sndevopscli create sonar -url 'https://sonarcloud.io' -projectKey 'SONAR_PROJECT_KEY' -branch "main"
                     shell: Sh
                     infrastructure:
@@ -93,7 +93,7 @@ pipeline:
                   identifier: security
                   spec:
                     connectorRef: docker_connector # harness docker connector
-                    image: servicenowdocker/sndevops:5.1.0
+                    image: servicenowdocker/sndevops:6.0.0
                     command: |-
                       export SNOW_URL="<+variable.SNOW_URL>"
                       export SNOW_TOOLID="<+variable.SNOW_TOOLID>"
@@ -156,7 +156,7 @@ pipeline:
                   identifier: ServiceNow_change
                   spec:
                     connectorRef: docker_connector # harness docker connector
-                    image: servicenowdocker/sndevops:5.1.0
+                    image: servicenowdocker/sndevops:6.0.0
                     command: |-
                       # set mandetory variables. These can be set from Environment variable section of Optional configuration as well.
                       export HARNESS_STAGE_NAME="<+stage.identifier>"

src/common/baseEnv.js

@@ -3,31 +3,31 @@ const ToolHandlerRegistry = require("../handler/registry");
 
 module.exports = class BaseEnv{
 
-        static CI_PROJECT_NAME = process.env.CI_PROJECT_NAME;
-        static CI_JOB_STAGE = process.env.CI_JOB_STAGE;
-        static CI_JOB_ID = process.env.CI_JOB_ID;
-        static CI_SERVER_URL = process.env.CI_SERVER_URL;
-        static CI_COMMIT_SHA = process.env.CI_COMMIT_SHA
-        static CI_JOB_NAME = process.env.CI_JOB_NAME
-        static CI_PIPELINE_ID = process.env.CI_PIPELINE_ID
-        static CI_PAGES_URL = process.env.CI_PAGES_URL;
-        static CI_PROJECT_TITLE = process.env.CI_PROJECT_TITLE;
-        static CI_PROJECT_PATH = process.env.CI_PROJECT_PATH;
-        static CI_PIPELINE_URL = process.env.CI_PROJECT_PATH;
-        static CI_COMMIT_BRANCH = process.env.CI_COMMIT_BRANCH;
-        static CI_API_V4_URL = process.env.CI_API_V4_URL;
-        static CI_PIPELINE_SOURCE = process.env.CI_PIPELINE_SOURCE;
-        static CI_PROJECT_ID = process.env.CI_PROJECT_ID;
+        static CI_PROJECT_NAME = process.env.CI_PROJECT_NAME || process.env.PROJECT_NAME;
+        static CI_JOB_STAGE = process.env.CI_JOB_STAGE || process.env.JOB_STAGE;
+        static CI_JOB_ID = process.env.CI_JOB_ID || process.env.JOB_ID;
+        static CI_SERVER_URL = process.env.CI_SERVER_URL || process.env.SERVER_URL;
+        static CI_COMMIT_SHA = process.env.CI_COMMIT_SHA || process.env.COMMIT_SHA;
+        static CI_JOB_NAME = process.env.CI_JOB_NAME || process.env.JOB_NAME;
+        static CI_PIPELINE_ID = process.env.CI_PIPELINE_ID || process.env.PIPELINE_ID;
+        static CI_PAGES_URL = process.env.CI_PAGES_URL || process.env.PAGES_URL;
+        static CI_PROJECT_TITLE = process.env.CI_PROJECT_TITLE || process.env.PROJECT_TITLE;
+        static CI_PROJECT_PATH = process.env.CI_PROJECT_PATH || process.env.PROJECT_PATH;
+        static CI_PIPELINE_URL = process.env.CI_PROJECT_PATH || process.env.PROJECT_PATH;
+        static CI_COMMIT_BRANCH = process.env.CI_COMMIT_BRANCH || process.env.COMMIT_BRANCH;
+        static CI_API_V4_URL = process.env.CI_API_V4_URL || process.env.API_V4_URL;
+        static CI_PIPELINE_SOURCE = process.env.CI_PIPELINE_SOURCE || process.env.PIPELINE_SOURCE;
+        static CI_PROJECT_ID = process.env.CI_PROJECT_ID || process.env.PROJECT_ID;
         static SNOW_URL = process.env.SNOW_URL;
         static SNOW_TOKEN = process.env.SNOW_TOKEN;
         static SNOW_TOOLID = process.env.SNOW_TOOLID;
-        static CI_DEFAULT_BRANCH = process.env.CI_DEFAULT_BRANCH;
-        static CI_MERGE_REQUEST_SOURCE_BRANCH_NAME = process.env.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME;
+        static CI_DEFAULT_BRANCH = process.env.CI_DEFAULT_BRANCH || process.env.DEFAULT_BRANCH;
+        static CI_MERGE_REQUEST_SOURCE_BRANCH_NAME = process.env.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME || process.env.MERGE_REQUEST_SOURCE_BRANCH_NAME;
 
-        static CI_RUN_ATTEMPT = process.env.CI_RUN_ATTEMPT;
-        static CI_REPOSITORY_NAME = process.env.CI_REPOSITORY_NAME;
-        static CI_CALLBACK_URL = process.env.CI_CALLBACK_URL;
-        static CI_WORKFLOW_NAME = process.env.CI_WORKFLOW_NAME;
+        static CI_RUN_ATTEMPT = process.env.RUN_ATTEMPT;
+        static CI_REPOSITORY_NAME = process.env.REPOSITORY_NAME;
+        static CI_CALLBACK_URL = process.env.CALLBACK_URL;
+        static CI_WORKFLOW_NAME = process.env.WORKFLOW_NAME;
 
     static getEnv(envVariableName){
         return process.env[envVariableName];

src/handler/harness.js

@@ -25,7 +25,7 @@ class HarnessIntegrationHandler extends AbstractToolIntegrationHandler {
   }
 
   getBranch () {
-    return process.env.CI_COMMIT_BRANCH
+    return process.env.COMMIT_BRANCH
   }
 
   getProjectTitle () {
@@ -47,7 +47,7 @@ class HarnessIntegrationHandler extends AbstractToolIntegrationHandler {
   getCallbackURL (){
     const HARNESS_DEFAULT_URL = 'https://app.harness.io/';
     const harnessPipelineExecutionUrl = `${HARNESS_DEFAULT_URL}/ng/#/account/${process.env.HARNESS_ACCOUNT_ID}/ci/orgs/${process.env.HARNESS_ORG_ID}/projects/${process.env.HARNESS_PROJECT_ID}/pipeline/${process.env.HARNESS_PIPELINE_ID}/executions/${process.env.HARNESS_EXECUTION_ID}`;
-    return process.env.CI_CALLBACK_URL || harnessPipelineExecutionUrl;
+    return process.env.CALLBACK_URL || harnessPipelineExecutionUrl;
   }
 
   getPipelineName (pipelineName) {