STRY56337138: Addressed error message changes

Author: smruti-mishra-sn

README.md

@@ -38,7 +38,7 @@ This will create a executable sndevopscli in bin folder ( /usr/loca/bin/)
 **Running CLI**
 
 ```sh
-sndevopscli create pakcage --help
+sndevopscli create package --help
 ```
 ### Removing symlink
 
@@ -48,22 +48,22 @@ npm unlink .
 
 ## Creating Docker image
 
-### Buildng docker image
+### Building docker image
 
 ```sh
-docker build -t dockerusername/sndevops-cli:0.35 .
+docker build -t servicenowdocker/sndevops-cli:0.01 .
 ```
 
 ```sh
-docker push dockerusername/sndevops-cli:0.35
+docker push servicenowdocker/sndevops-cli:0.01
 ```
 
 ## Integrating with gitlab
 
-[Example gitlab project](https://gitlab.k8s.sndevops.xyz/devops-admin/helloworld/-/blob/main/.gitlab-ci.yml?ref_type=heads)
+[Example gitlab project](https://gitlab.xxxx.xxxxx.xyz/devops-admin/helloworld/-/blob/main/.gitlab-ci.yml?ref_type=heads)
 
 
-**Example with passing all ServiceNow info via commandlie**
+**Example with passing all ServiceNow info via commandline**
 
 ```yaml
 
@@ -72,7 +72,7 @@ stages:
 
 package:
   stage: package
-  image: sannrao/sndevops-cli:0.35
+  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"}]
@@ -87,15 +87,15 @@ SNOW_TOKEN = <servicenow-tool-token>
 SNOW_TOOLID = <servicenow-tool-id>
 ```
 
-**Example with passing all ServiceNow info via commandlie**
+**Example with passing all ServiceNow info via commandline**
 ```yaml
 
 stages:
   - package
 
 package:
   stage: package
-  image: sannrao/sndevops-cli:0.35
+  image: servicenowdocker/sndevops-cli:0.35
   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"}]
@@ -108,9 +108,9 @@ package:
 stages:
   - DevOpsChangeApproval
 
-package:
+ServiceNow DevOps Change:
   stage: DevOpsChangeApproval
-  image: smrutisnow/sndevops-cli:0.35
+  image: servicenowdocker/sndevops-cli:0.35
   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"}}'
 

package.json

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

src/api/artifact/changeRequest.js

@@ -56,7 +56,7 @@ class ChangeRequestManager extends SnDevopsApi {
                         interval = changeStepDetails.interval;
                     } 
                 } catch (e) {
-                    throw new Error("Change cannot be created because error occured during parsing of changeRequestDetails.");
+                    throw new Error("Change request cannot be created because changeRequestDetails were not parsed.");
                 }
             }
 
@@ -106,23 +106,23 @@ class ChangeRequestManager extends SnDevopsApi {
                 }
 
                 if (err.message.includes('ECONNREFUSED') || err.message.includes('ENOTFOUND')) {
-                    throw new Error('Invalid ServiceNow Instance URL. Please correct the URL and try again.');
+                    throw new Error('Change request cannot be created because the ServiceNow Instance URL is invalid. Enter the correct URL and try again.');
                 }
 
                 if (err.message.includes('401')) {
-                    throw new Error('Invalid Credentials. Please correct the credentials and try again.');
+                    throw new Error('The SNOW_TOKEN and SNOW_TOOLID are incorrect. Verify that the GitLab project level variables are configured.');
                 }
 
                 if (err.message.includes('405')) {
-                    throw new Error('Response Code from ServiceNow is 405. Please correct ServiceNow logs for more details.');
+                    throw new Error('Change request cannot be created because response Code from ServiceNow is 405. Please check ServiceNow logs for more details.');
                 }
 
                 if (!err.response) {
-                    throw new Error('No response from ServiceNow. Please check ServiceNow logs for more details.');
+                    throw new Error('Change request cannot be created because no response from ServiceNow. Please check ServiceNow logs for more details.');
                 }
 
                 if (err.response.status == 500) {
-                    throw new Error('Response Code from ServiceNow is 500. Please check ServiceNow logs for more details.')
+                    throw new Error('Change request cannot be created because response Code from ServiceNow is 500. Please check ServiceNow logs for more details.')
                 }
 
                 if (err.response.status == 400) {
@@ -173,7 +173,7 @@ class ChangeRequestManager extends SnDevopsApi {
               }
 
               if (error.message == "401") {
-                throw new Error(`The user credentials are incorrect.`);
+                throw new Error(`The SNOW_TOKEN and SNOW_TOOLID are incorrect. Verify that the GitLab project level variables are configured.`);
               }
 
               if (error.message == "403") {
@@ -367,7 +367,7 @@ class ChangeRequestManager extends SnDevopsApi {
     validateChangePayload(changePayload) {
       for (var key in changePayload) {
         if (changePayload.hasOwnProperty(key) && !changePayload[key]) {
-           throw new Error(`Change cannot be created as Key: ${key} has a null value.`);
+           throw new Error(`Change request cannot be created as Key: ${key} has a null value.`);
         }
       }
     }

src/api/base/sndevopsApi.js

@@ -16,12 +16,12 @@ class SndevopsApi {
 
     validateMandatoryParams(url, token, toolId) {
         var errorMessage;
-        if(!url) errorMessage = "URL is mandatory.";
-        if(!token) errorMessage += "Token is mandatory.";
-        if(!toolId) errorMessage += "ToolId is mandatory.";
+        if(!url) errorMessage = "SNOW_URL is a required field.";
+        if(!token) errorMessage += "SNOW_TOKEN is a required field.";
+        if(!toolId) errorMessage += "SNOW_TOOLID is a required field.";
 
         if(errorMessage) {
-            errorMessage += " Please check GitLab project level environmental variables.";
+            errorMessage += " Verify that the GitLab project level variables are configured.";
             console.error('\n \x1b[1m\x1b[31m' + errorMessage + '\x1b[0m\x1b[0m');
             process.exit(1);
         }

src/common/baseEnv.js

@@ -12,6 +12,7 @@ module.exports = class BaseEnv{
         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;