Releasing 6.1.0 version

Author: manoharreddydavired

README.md

@@ -1,7 +1,16 @@
-# 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
 
@@ -56,11 +65,11 @@ npm unlink .
 ### Building Docker Image
 
 ```sh
-docker build -t servicenowdocker/sndevops:6.0.0 .
+docker build -t servicenowdocker/sndevops:6.1.0 .
 ```
 
 ```sh
-docker push servicenowdocker/sndevops:6.0.0
+docker push servicenowdocker/sndevops:6.1.0
 ```
 
 ## Integrating with GitLab
@@ -106,7 +115,7 @@ stages:
 
 package:
   stage: package
-  image: servicenowdocker/sndevops:6.0.0
+  image: servicenowdocker/sndevops:6.1.0
   script: 
     - 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"}]
@@ -118,7 +127,7 @@ stages:
 
 package:
   stage: package
-  image: servicenowdocker/sndevops:6.0.0
+  image: servicenowdocker/sndevops:6.1.0
   script: 
     - 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"}]
@@ -142,7 +151,7 @@ stages:
 
 ServiceNow DevOps Change:
   stage: DevOpsChangeApproval
-  image: servicenowdocker/sndevops:6.0.0
+  image: servicenowdocker/sndevops:6.1.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"}}'
 
@@ -182,7 +191,7 @@ stages:
 
 ServiceNow DevOps Sonar Scan Results:
   stage: DevOpsSonarStage
-  image: servicenowdocker/sndevops:6.0.0
+  image: servicenowdocker/sndevops:6.1.0
   script: 
     - sndevopscli create sonar -url 'https://sonarcloud.io' -projectKey 'xxxxxxx' -branch 'master'
 
@@ -207,7 +216,7 @@ stages:
 
 ServiceNow DevOps Security Scan Results:
   stage: DevOpsSecurityScanStage
-  image: servicenowdocker/sndevops:6.0.0
+  image: servicenowdocker/sndevops:6.1.0
   script: 
     - sndevopscli create securityScan -p "{\"pipelineInfo\":{\"buildNumber\":\"buildNumber\",\"pipelineExecutionUrl\":\"pipelineExecutionUrl\" },\"securityResultAttributes\":{ \"scanner\":\"Veracode\",\"applicationName\":\"PetStoreAPI-Github\",\"buildVersion\":\"\",\"securityToolId\":\"\"}}"
 
@@ -235,7 +244,7 @@ stages:
 
 ServiceNow DevOps Get Change:
   stage: DevOpsGetChange
-  image: servicenowdocker/sndevops:6.0.0
+  image: servicenowdocker/sndevops:6.1.0
   script: 
     - sndevopscli get change -p "{\"buildNumber\":\"buildNumber\",\"stageName\":\"ServiceNow DevOps Change Step\",\"pipelineName\":\"GitlabDockerGetAndUpdateChange\"}"
 
@@ -271,7 +280,7 @@ stages:
 
 ServiceNow DevOps Update Change:
   stage: DevOpsUpdateChangeStage
-  image: servicenowdocker/sndevops:6.0.0
+  image: servicenowdocker/sndevops:6.1.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\"}"
 
@@ -298,7 +307,7 @@ stages:
 
 ServiceNow DevOps Change Step:
   stage: changeapproval
-  image: servicenowdocker/sndevops:6.0.0
+  image: servicenowdocker/sndevops:6.1.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

@@ -48,7 +48,7 @@ jobs:
        runs-on: ubuntu-latest
        needs: ServiceNowDevOpsChange
        container:
-         image: servicenowdocker/sndevops:6.0.0
+         image: servicenowdocker/sndevops:6.1.0
        env:
          CI_JOB_NAME: "ServiceNowDevOpsChange"
 
@@ -61,7 +61,7 @@ jobs:
       runs-on: ubuntu-latest
       needs: build
       container:
-        image: servicenowdocker/sndevops:6.0.0
+        image: servicenowdocker/sndevops:6.1.0
       env:
         CI_JOB_NAME: "ArtifactAndPackage"
       steps:
@@ -75,7 +75,7 @@ jobs:
       needs: ArtifactAndPackage
       runs-on: ubuntu-latest
       container:
-        image: servicenowdocker/sndevops:6.0.0
+        image: servicenowdocker/sndevops:6.1.0
       env:
         CI_JOB_NAME: "ServiceNowDevOpsSonarScanResults"
       steps:
@@ -88,7 +88,7 @@ jobs:
       runs-on: ubuntu-latest
       needs: build
       container:
-        image: servicenowdocker/sndevops:6.0.0
+        image: servicenowdocker/sndevops:6.1.0
       steps:
         - name: security scan
           run: |

gitlab-ci.yml

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

harness-ci.yml

@@ -45,7 +45,7 @@ pipeline:
                   identifier: Sonar_container
                   spec:
                     connectorRef: docker_connector # harness docker connector
-                    image: servicenowdocker/sndevops:6.0.0
+                    image: servicenowdocker/sndevops:6.1.0
                     command: |-
                       export SNOW_URL="<+variable.SNOW_URL>"
                       export SNOW_TOOLID="<+variable.SNOW_TOOLID>"
@@ -93,7 +93,7 @@ pipeline:
                   identifier: security
                   spec:
                     connectorRef: docker_connector # harness docker connector
-                    image: servicenowdocker/sndevops:6.0.0
+                    image: servicenowdocker/sndevops:6.1.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:6.0.0
+                    image: servicenowdocker/sndevops:6.1.0
                     command: |-
                       # set mandetory variables. These can be set from Environment variable section of Optional configuration as well.
                       export HARNESS_STAGE_NAME="<+stage.identifier>"

package-lock.json

@@ -13,7 +13,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "axios": "^1.6.8",
+    "axios": "^1.7.4",
     "commander": "^11.0.0",
     "dotenv": "^16.3.1"
   }

package.json

@@ -22,7 +22,6 @@ class ChangeRequestManager extends SnDevopsApi {
        }
      */
     async createChange(pipelineContext, changeAttrPayload) {
-        let status = true;
         let response;
         let changePayload; //Payload contains information necessary for change creation
         let changeDetails; //Incoming payload after JSON parsed
@@ -77,7 +76,22 @@ class ChangeRequestManager extends SnDevopsApi {
 
             let payload = this._getRequestBodyForChangeCreation(changePayload, pipelineContext);
             response = await this.createChangeNotification(payload);
-            if (status) {
+            if (response) {
+                var result = response.data.result;
+                if (result && result.pipelineTracked === 'false') {
+                    console.log("Change request cannot be created as pipeline is configured to NOT track in the servicenow instance");
+                    return;
+                }
+
+                if (result && result.status == "Success") {
+                    if (result.changeControl === false)
+                        console.log('\n     \x1b[1m\x1b[36m' + "Change control is not enabled on the pipeline stage" + '\x1b[0m\x1b[0m');
+                    else if (result.message)
+                        console.log('\n     \x1b[1m\x1b[36m' + result.message + '\x1b[0m\x1b[0m');
+                    else
+                        console.log('\n     \x1b[1m\x1b[36m' + "The job is under change control. A callback request is created and polling has been started to retrieve the change info." + '\x1b[0m\x1b[0m');
+                }
+
                 interval = interval >= 100 ? interval : 100;
                 timeout = timeout >= 100 ? timeout : 3600;
 
@@ -91,14 +105,12 @@ class ChangeRequestManager extends SnDevopsApi {
                 }
             }
         } catch (err) {
-            status = false;
             console.error('\n \x1b[1m\x1b[31m' + err.message + '\x1b[0m\x1b[0m');
             process.exit(1);
         }
     }
 
     async createChangeNotification(changePayload) {
-        let status = false;
         let response;
 
         try {
@@ -114,7 +126,6 @@ class ChangeRequestManager extends SnDevopsApi {
             let httpHeaders = { headers: defaultHeadersForToken };
             try {
                 response = await axios.post(url.toString(), JSON.stringify(changePayload), httpHeaders);
-                status = true;
             } catch (err) {
                 if (err.code === 'ECONNABORTED') {
                     throw new Error(`change creation timeout after ${err.config.timeout}s`);
@@ -163,18 +174,7 @@ class ChangeRequestManager extends SnDevopsApi {
                     throw new Error(errMsg);
                 }
             }
-
-            if (status) {
-                var result = response.data.result;
-                if (result && result.status == "Success") {
-                    if (result.changeControl === false)
-                        console.log('\n     \x1b[1m\x1b[36m' + "Change control is not enabled on the pipeline stage" + '\x1b[0m\x1b[0m');
-                    else if (result.message)
-                        console.log('\n     \x1b[1m\x1b[36m' + result.message + '\x1b[0m\x1b[0m');
-                    else
-                        console.log('\n     \x1b[1m\x1b[36m' + "The job is under change control. A callback request is created and polling has been started to retrieve the change info." + '\x1b[0m\x1b[0m');
-                }
-            }
+           return response;
         } catch (error) {
             throw new Error(error.message);
         }