Merge pull request #2 from ServiceNow/scratch/STRY56337138

Scratch/STRY56337138: GitLab Docker - ChangeCustomTask changes

Author: smruti-mishra-sn

Dockerfile

@@ -0,0 +1,75 @@
+## ===========================================================> The common stage
+FROM node:20 AS base
+ENV NODE_ENV=production
+
+WORKDIR /app
+
+COPY package*.json ./
+RUN npm ci --only=production 
+
+## Remove unnecessary files from `node_modules` directory
+RUN ( wget -q -O /dev/stdout https://gobinaries.com/tj/node-prune | sh ) \
+ && node-prune
+
+
+## ======================================================> The build image stage
+FROM base AS build
+ENV NODE_ENV=development
+
+COPY . .
+## This step could install only the missing dependencies (ie., development deps ones)
+## but there's no way to do that with this NPM version
+RUN npm ci --only=production 
+## Compile the TypeScript source code
+# RUN npm link 
+
+
+## =================================================> The production image stage
+FROM node:20-alpine AS prod
+ENV NODE_ENV=production
+
+WORKDIR /app
+## Copy required file to run the production application
+COPY --from=base --chown=node:node /app/node_modules ./node_modules
+COPY --from=base --chown=node:node /app/*.json ./
+COPY --from=build --chown=node:node /app/src /app/src
+# COPY --from=build --chown=node:node  /app/sndevopscli.js /app/
+RUN npm link
+# COPY --from=build --chown=node:node /usr/local/lib/node_modules/sndevopscli /usr/local/bin/sndevopscli
+
+
+
+## https://engineeringblog.yelp.com/2016/01/dumb-init-an-init-for-docker.html
+# RUN apk add --no-cache dumb-init
+# RUN npm link
+# RUN chmod +x sndevopscli.js
+## Dropping privileges
+USER node
+## Running the app wrapped by the init system for helping on graceful shutdowns
+CMD [ "sndevopscli" ]
+
+# FROM node:20-alpine as builder
+
+# # Create app directory
+# WORKDIR /app
+
+# ENV NODE_ENV=production
+
+# COPY  sndevopscli.js package*.json ./
+
+# COPY . /app
+
+# RUN npm ci --only=production
+
+# FROM node:20-alpine
+
+
+# WORKDIR /app
+
+# COPY . .
+# RUN npm install .
+# RUN npm link
+# RUN chmod +x sndevopscli.js
+# RUN ln sndevopscli.js sndevopscli
+# # USER node
+# CMD [ "echo Get a command" ]

README.md

@@ -1 +1,118 @@
-# app-devops-gitlab
+# CLI example using npm modules
+
+## Build and install
+
+```sh
+npm install .
+```
+
+## Running the cli commands
+
+```sh
+node src/index.js
+```
+
+Follow the prompts to create a package or type --help to get more informaiton
+
+```sh
+node src/index.js --help
+```
+
+## Creating a bin executable 
+
+To create a symlink sndevopscli, run the following commmand
+
+```sh
+
+npm link
+
+```
+OR
+
+```sh
+npm install -g .
+```
+
+This will create a executable sndevopscli in bin folder ( /usr/loca/bin/)
+
+**Running CLI**
+
+```sh
+sndevopscli create package --help
+```
+### Removing symlink
+
+```sh
+npm unlink .
+```
+
+## Creating Docker image
+
+### Building docker image
+
+```sh
+docker build -t servicenowdocker/sndevops-cli:0.01 .
+```
+
+```sh
+docker push servicenowdocker/sndevops-cli:0.01
+```
+
+## Integrating with gitlab
+
+[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 commandline**
+
+```yaml
+
+stages:
+  - package
+
+package:
+  stage: 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"}]
+
+```
+
+### Env variables 
+
+```
+SNOW_URL = <servicenow-instance-url>
+SNOW_TOKEN = <servicenow-tool-token>
+SNOW_TOOLID = <servicenow-tool-id>
+```
+
+**Example with passing all ServiceNow info via commandline**
+```yaml
+
+stages:
+  - package
+
+package:
+  stage: package
+  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"}]
+
+```
+
+**Example of change creation for ServiceNow via commandline**
+```yaml
+
+stages:
+  - DevOpsChangeApproval
+
+ServiceNow DevOps Change:
+  stage: DevOpsChangeApproval
+  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-lock.json

@@ -0,0 +1,20 @@
+{
+  "name": "sndevopscli",
+  "version": "1.0.0",
+  "description": "ServiceNow DevOps CLI interface",
+  "main": "src/index.js",
+  "scripts": {
+    "sndevopscli": "node src/index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "sndevopscli": "src/index.js"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.6.0",
+    "commander": "^11.0.0",
+    "dotenv": "^16.3.1"
+  }
+}

package.json

@@ -0,0 +1,83 @@
+const SnDevopsApi = require('../base/sndevopsApi.js')
+
+const API_PACKAGE_PATH = 'api/sn_devops/devops/package/registration';
+const API_ARTIFACT_PATH = 'api/sn_devops/devops/artifact/registration';
+const BaseEnv = require('../../common/baseEnv.js')
+
+
+class ArtifactManager 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());
+        
+    }
+
+
+    createArtifacts(artifacts) {
+
+        let url = new URL(API_ARTIFACT_PATH, this.url);
+        url.searchParams.append("orchestrationToolId", this.toolId)
+        console.log("Computed path ServiceNow url " + url.toString())
+
+
+        let artifactJson = JSON.parse(artifacts);
+        let payload = this._getRequestBodyForArtifactRegistration(artifactJson)
+
+        let response = this.post(url.toString(), payload, this._getAuthHeaderWithToken());
+        console.log("Response for Package Creation" + response);
+
+    }
+
+    _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;
+
+    }
+
+    _getRequestBodyForArtifactRegistration(artifacts) {
+
+        let requestPayload = {
+            "taskExecutionNumber": BaseEnv.CI_JOB_ID,
+            "pipelineName": BaseEnv.CI_PROJECT_PATH,
+            "stageName": BaseEnv.CI_JOB_NAME,
+            "artifacts": artifacts
+        };
+        return requestPayload;
+
+    }
+
+
+}
+
+module.exports = ArtifactManager;