STRY56337017: Code changes for custom task for GitLab Docker

smruti-mishra-sn · smruti-mishra-sn · commit 86f807ce1a74 · 2023-12-11T19:50:02.000+05:30
diff --git a/README.md b/README.md
@@ -1,3 +1,17 @@
+# 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
@@ -75,7 +89,7 @@ package:
   image: servicenowdocker/sndevops-cli:0.35
   script: 
     - sndevopscli create artifact -a '[{"name":"artifact-name-$CI_JOB_ID","repositoryName":"artifact-repo-name" ,"version":"1.3.0"}]'
-    - sndevopscli create package -n "package-mame" -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"}]
 
 ```
 
@@ -116,3 +130,17 @@ ServiceNow DevOps Change:
 
 ```
 
+**Example of sonar summary for ServiceNow via commandline**
+```yaml
+
+stages:
+  - DevOpsSonarStage
+
+ServiceNow DevOps Sonar Scan Results:
+  stage: DevOpsSonarStage
+  image: servicenowdocker/sndevops-cli:0.35
+  script: 
+    - sndevopscli create sonar -sonarUrl 'https://sonarcloud.io' -sonarProjectKey 'xxxxxxx'
+
+```
+
diff --git a/src/api/base/sndevopsApi.js b/src/api/base/sndevopsApi.js
@@ -70,7 +70,14 @@ class SndevopsApi {
             });;
     }
 
+    fetchBranchName() {
+        let branchName = BaseEnv.CI_COMMIT_BRANCH || BaseEnv.CI_DEFAULT_BRANCH;
+        if(BaseEnv.CI_PIPELINE_SOURCE == 'merge_request_event')
+           branchName = BaseEnv.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME;
 
+        return branchName;
+    }
+    
 }
 
 module.exports = SndevopsApi
diff --git a/src/api/change/changeRequest.js b/src/api/change/changeRequest.js
@@ -38,8 +38,7 @@ class ChangeRequestManager extends SnDevopsApi {
                 "projectId": BaseEnv.CI_PROJECT_ID,
                 "jobId": BaseEnv.CI_JOB_ID,
                 "pipelineName": BaseEnv.CI_PROJECT_TITLE,
-                "jobName": BaseEnv.CI_JOB_NAME,
-                "branchName": BaseEnv.CI_COMMIT_BRANCH
+                "jobName": BaseEnv.CI_JOB_NAME
             };
 
             //ChangeAttributes are optional
@@ -147,12 +146,15 @@ class ChangeRequestManager extends SnDevopsApi {
                     }
                     throw new Error(errMsg);
                 }
-                
-                if(status) {
-                    var result = response.data.result;
-                    if (result && result.status ==="Success" && result.changeControl) {
-                        console.log('\n     \x1b[1m\x1b[36m' + 'Change created successfully.' + '\x1b[0m\x1b[0m');
-                    }
+            }
+
+            if(status) {
+                var result = response.data.result;
+                if (result && result.status == "Success") {
+                    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');
                 }
             }
         } catch(error) {
@@ -348,13 +350,14 @@ class ChangeRequestManager extends SnDevopsApi {
     
     _getRequestBodyForChangeCreation(changePayload) {
         this.validateChangePayload(changePayload);
+        let branchName = this.fetchBranchName();
         return {
             "toolId": this.toolId,
             "stageName": changePayload.jobName,
             "buildNumber": changePayload.buildNumber,
             "callbackURL": changePayload.apiPath + "/projects/" + changePayload.projectId +"/jobs/" + changePayload.jobId,
-            "isMultiBranch": "false",
-            "branchName": changePayload.branchName,
+            "isMultiBranch": "true",
+            "branchName": branchName,
             "changeRequestDetails": changePayload.changeRequestDetails,
             "action": "customChange",
             "pipelineName": changePayload.pipelineName,
diff --git a/src/api/package/packageManager.js b/src/api/package/packageManager.js
@@ -0,0 +1,53 @@
+const SnDevopsApi = require('../base/sndevopsApi.js')
+
+const API_PACKAGE_PATH = 'api/sn_devops/devops/package/registration';
+const BaseEnv = require('../../common/baseEnv.js')
+
+
+class PackageManager extends SnDevopsApi {
+
+    createPackage(packageName, artifacts) {
+
+        let url = new URL(API_PACKAGE_PATH, this.url);
+        url.searchParams.append("orchestrationToolId", this.toolId)
+
+        console.log("Computed  ServiceNow url " + url.toString())
+
+        let artifactJson = JSON.parse(artifacts);
+        let payload = this._getRequestBodyForPackageRegistration(packageName, artifactJson)
+
+        this.post(url.toString(), payload, this._getAuthHeaderWithToken());
+        
+    }
+
+    _getRequestBodyForPackageRegistration(packageName, artifacts) {
+        let requestPayload = {
+            "name": packageName,
+            "pipelineName": BaseEnv.CI_PROJECT_PATH,
+            "stageName": BaseEnv.CI_JOB_NAME,
+            "taskExecutionNumber": BaseEnv.CI_JOB_ID,
+            "orchestrationTask": {
+                "orchestrationTaskURL": BaseEnv.CI_PIPELINE_URL,
+                "orchestrationTaskName": BaseEnv.CI_JOB_NAME,
+                "branchName": BaseEnv.CI_COMMIT_BRANCH,
+                "toolId": this.toolId,
+            },
+            "artifacts": [
+                {
+                    "name": artifacts[0].name,
+                    "pipelineName": BaseEnv.CI_PROJECT_PATH,
+                    "repositoryName": artifacts[0].repositoryName,
+                    "stageName": BaseEnv.CI_JOB_NAME,
+                    "taskExecutionNumber": BaseEnv.CI_JOB_ID,
+                    "semanticVersion": artifacts[0].semanticVersion,
+                    "version": artifacts[0].version
+                }
+            ]
+        }
+        return requestPayload;
+
+    }
+
+}
+
+module.exports = PackageManager;
diff --git a/src/api/sonar/sonarRegistration.js b/src/api/sonar/sonarRegistration.js
@@ -0,0 +1,100 @@
+const SnDevopsApi = require('../base/sndevopsApi.js')
+const axios = require('axios');
+const API_SONAR_PATH = 'api/sn_devops/devops/tool/softwarequality';
+const BaseEnv = require('../../common/baseEnv.js')
+
+
+class SonarRegistrationManager extends SnDevopsApi {
+
+    async createSonarSummary(sonarProjectKey, sonarUrl) {
+        let sonarPayload; //Payload contains information necessary for fetching sonar summary
+        let endpoint;
+        let httpHeaders;
+        let response;
+
+        //Mandatory field validation check
+        if(!sonarUrl) {
+            console.error("sonarUrl is a required field. Enter the correct sonarUrl and try again.");
+            process.exit(1);
+        }
+        if(!sonarProjectKey) {
+            console.error("sonarProjectKey is a required field. Enter the correct sonarProjectKey and try again.");
+            process.exit(1);
+        }
+
+        sonarPayload = {
+            "sonarProjectKey": sonarProjectKey,
+            "sonarUrl": sonarUrl,
+        };
+        
+        endpoint = new URL(API_SONAR_PATH, this.url);
+        endpoint.searchParams.append("toolId", this.toolId)
+        console.log("Computed  ServiceNow url " + endpoint.toString());
+        
+        let payload = this._getRequestBodyForSonarSummary(sonarPayload);
+        console.log("Payload to fetch sonar summary = " + JSON.stringify(payload));
+        
+        const defaultHeadersForToken = {
+            'Content-Type': 'application/json',
+            'Accept': 'application/json',
+            'Authorization': 'sn_devops.DevOpsToken ' + this.toolId + ":" + this.token
+        };
+        httpHeaders = { headers: defaultHeadersForToken };
+
+        try {
+            response = await axios.post(endpoint.toString(), JSON.stringify(payload), httpHeaders);
+        } catch (e) {
+            if (e.message.includes('ECONNREFUSED') || e.message.includes('ENOTFOUND') || e.message.includes('405')) {
+                console.error('ServiceNow Instance URL is NOT valid. Enter the correct the URL and try again.');
+                process.exit(1);
+
+            } else if (e.message.includes('401')) {
+                console.error('The SNOW_TOKEN and SNOW_TOOLID are incorrect. Verify that the GitLab project level variables are configured.');
+                process.exit(1);
+
+            } else if(e.message.includes('400') || e.message.includes('404')){
+                let errMsg = '[ServiceNow DevOps] Register Sonar Scan Summaries are not Successful. ';
+                let errMsgSuffix = ' Provide valid inputs and verify that the GitLab project level variables are configured.';
+                let responseData = e.response.data;
+                
+                if (responseData && responseData.result && responseData.result.errorMessage) {
+                    errMsg = errMsg + responseData.result.errorMessage + errMsgSuffix;
+                    console.error(errMsg);
+                    process.exit(1);
+                }
+                else if (responseData && responseData.result && responseData.result.details && responseData.result.details.errors) {
+                    let errors = responseData.result.details.errors;
+                    for (var index in errors) {
+                        errMsg = errMsg + errors[index].message + errMsgSuffix;
+                    }
+                    console.error(errMsg);
+                    process.exit(1);
+                }
+
+            } else {
+                console.error('ServiceNow DevOps Event to register Sonar Scan Summaries is not created. Please check ServiceNow logs for more details.');
+                process.exit(1);
+
+            }
+        }
+    }
+
+    _getRequestBodyForSonarSummary(sonarPayload) {
+        let branchName = this.fetchBranchName();
+        return {
+            "sonarProjectKey": sonarPayload.sonarProjectKey,
+            "sonarUrl": sonarPayload.sonarUrl,
+            "repositoryName": BaseEnv.CI_PROJECT_TITLE,
+            "pipelineName": BaseEnv.CI_PROJECT_TITLE,
+            "buildNumber": BaseEnv.CI_JOB_ID,
+            "stageName": BaseEnv.CI_JOB_NAME,
+            "branchName": branchName,
+            "gitLabProjectId": BaseEnv.CI_PROJECT_ID,
+            "toolId": this.toolId
+        };
+
+    }
+
+}
+
+module.exports = SonarRegistrationManager;
diff --git a/src/commands/base.js b/src/commands/base.js
@@ -5,7 +5,7 @@ module.exports = class Base{
 
     addDefaultOptions(command){
 
-        command.option("-t, --toolId <toolId>", "Tool ID, if not passed via environmentaal variable")
+        command.option("-t, --toolId <toolId>", "Tool ID, if not passed via environmental variable")
         .option("--token <token>", "Token ID, if not passed via environmental variable")
         .option("-u --url <nowUrl>", "Service Now Url, if not passed via environmental variable")  
 
diff --git a/src/commands/create.js b/src/commands/create.js
@@ -5,6 +5,7 @@ const Base = require('./base');
 const ChangeRequest  = require('./entity/changeRequest')
 const Package = require('./entity/package')
 const Artifact = require('./entity/artifact');
+const SonarRegistration = require('./entity/sonarRegistration');
 
 module.exports = class Create extends Base{
   
@@ -17,9 +18,7 @@ module.exports = class Create extends Base{
     new ChangeRequest().create(createCommand);
     new Package().create(createCommand);
     new Artifact().create(createCommand);
-
+    new SonarRegistration().create(createCommand);
   }
-
-
   
 }
diff --git a/src/commands/entity/changeRequest.js b/src/commands/entity/changeRequest.js
@@ -1,5 +1,5 @@
 const Base = require("../base");
-const changeRequest  = require('../../api/artifact/changeRequest.js');
+const ChangeRequestManager  = require('../../api/change/changeRequest.js');
 
 const COMMAND_NAME = 'change'
 
@@ -11,10 +11,10 @@ module.exports = class ChangeRequest extends Base {
         const command = createCommand.command(COMMAND_NAME);
         this.addDefaultOptions(command);
 
-        command.option('-p , --payload <changePayload>', "Change payload in JSON format");
+        command.option('-p , --payload <changeAttributesPayload>', "Change Attributes payload in JSON format");
         command.action((options) => {
             console.log('Calling Change Control API to create change....');
-            new changeRequest(options.url,options.token,options.toolId).createChange(options.payload);
+            new ChangeRequestManager(options.url,options.token,options.toolId).createChange(options.payload);
         })
     }
 
diff --git a/src/commands/entity/package.js b/src/commands/entity/package.js
@@ -1,5 +1,5 @@
 const Base = require("../base");
-const ArtifactManager = require("../../api/artifact/artifactManager")
+const PackageManager = require("../../api/package/packageManager")
 const COMMAND_NAME = 'package'
 
 module.exports = class Package extends Base {
@@ -14,7 +14,7 @@ module.exports = class Package extends Base {
 
         command.action((options) => {
             console.log("Create Artifacts action called " )
-            new ArtifactManager(options.url,options.token,options.toolId).createPackage(options.name, options.artifacts)
+            new PackageManager(options.url,options.token,options.toolId).createPackage(options.name, options.artifacts)
             
         })
     }
diff --git a/src/commands/entity/sonarRegistration.js b/src/commands/entity/sonarRegistration.js
@@ -0,0 +1,25 @@
+const Base = require("../base");
+const SonarRegistrationManager  = require('../../api/sonar/sonarRegistration.js');
+
+const COMMAND_NAME = 'sonar'
+
+module.exports = class SonarRegistration extends Base {
+    constructor(){
+        super()
+    }
+    
+    create(createCommand) {
+
+        const command = createCommand.command(COMMAND_NAME);
+        this.addDefaultOptions(command);
+
+        command.requiredOption('-sonarProjectKey, --sonarProjectKey <sonarProjectKey>', 'Sonar Project Key')
+        .requiredOption('-sonarUrl, --sonarUrl <sonarUrl>', 'Sonar URL');
+
+        command.action((options) => {
+            console.log("Sonar registartion action called " )
+            new SonarRegistrationManager(options.url,options.token,options.toolId).createSonarSummary(options.sonarProjectKey, options.sonarUrl)
+        })
+    }
+
+}
diff --git a/src/common/baseEnv.js b/src/common/baseEnv.js
@@ -20,6 +20,8 @@ module.exports = class BaseEnv{
         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 getEnv(envVariableName){
         return process.env[envVariableName];

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,14 @@ class SndevopsApi {`
`70`	`70`	`});;`
`71`	`71`	`}`
`72`	`72`
	`73`	`+ fetchBranchName() {`
	`74`	`+ let branchName = BaseEnv.CI_COMMIT_BRANCH \|\| BaseEnv.CI_DEFAULT_BRANCH;`
	`75`	`+ if(BaseEnv.CI_PIPELINE_SOURCE == 'merge_request_event')`
	`76`	`+ branchName = BaseEnv.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME;`
`73`	`77`
	`78`	`+ return branchName;`
	`79`	`+ }`
	`80`	`+`
`74`	`81`	`}`
`75`	`82`
`76`	`83`	`module.exports = SndevopsApi`