@itentialopensource/adapter-bmc_helix_itsm 0.3.3 → 0.3.5

package/CALLS.md

@@ -310,5 +310,17 @@ Specific adapter calls are built based on the API of the Bmc_helix_itsm. The Ada
     <td style="padding:15px">{base_path}/{version}/entry/CHG:ChangeInterface/{pathv1}?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">getChangeRequestWorklogs(q, iapMetadata, callback)</td>
+    <td style="padding:15px">Retrieve change request worklog entries</td>
+    <td style="padding:15px">{base_path}/{version}/entry/CHG:WorkLog?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createChangeRequestWorklog(body, iapMetadata, callback)</td>
+    <td style="padding:15px">createChangeRequestWorklog</td>
+    <td style="padding:15px">{base_path}/{version}/entry/CHG:WorkLog?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
 </table>
 <br>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.3.5 [10-22-2024]
+
+* Add worklog calls
+
+See merge request itentialopensource/adapters/adapter-bmc_helix_itsm!13
+
+---
+
+## 0.3.4 [10-15-2024]
+
+* Changes made at 2024.10.14_19:48PM
+
+See merge request itentialopensource/adapters/adapter-bmc_helix_itsm!15
+
+---
+
 ## 0.3.3 [08-24-2024]
 
 * update dependencies and metadata

package/adapter.js

@@ -2205,6 +2205,207 @@ class BmcHelixItsm extends AdapterBaseCl {
       return callback(null, errorObj);
     }
   }
+
+  /**
+   * @function getChangeRequestWorklogs
+   * @pronghornType method
+   * @name getChangeRequestWorklogs
+   * @summary Retrieve change request worklog entries
+   *
+   * @param {string} [q] - Used to filter worklog entries
+   * @param {object} iapMetadata - IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /getChangeRequestWorklogs
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getChangeRequestWorklogs(q, iapMetadata, callback) {
+    const meth = 'adapter-getChangeRequestWorklogs';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = { q };
+    const queryParams = {};
+    const pathVars = [];
+    const bodyVars = {};
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    const reqFields = ['payload', 'uriPathVars', 'uriQuery', 'uriOptions', 'addlHeaders', 'authData', 'callProperties', 'filter', 'priority', 'event'];
+
+    // Merge and add new iapMetadata fields in reqObj
+    if (iapMetadata && typeof iapMetadata === 'object') {
+      Object.keys(iapMetadata).forEach((iapField) => {
+        if (reqFields.includes(iapField) && iapMetadata[iapField]) {
+          if (typeof reqObj[iapField] === 'object' && typeof iapMetadata[iapField] === 'object') {
+            reqObj[iapField] = { ...reqObj[iapField], ...iapMetadata[iapField] }; // Merge objects
+          } else if (Array.isArray(reqObj[iapField]) && Array.isArray(iapMetadata[iapField])) {
+            reqObj[iapField] = reqObj[iapField].concat(iapMetadata[iapField]); // Merge arrays
+          } else {
+            // Otherwise, add new iapMetadata fields to reqObj
+            reqObj[iapField] = iapMetadata[iapField];
+          }
+        }
+      });
+      // Add iapMetadata to reqObj for further work
+      reqObj.iapMetadata = iapMetadata;
+    }
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('ChangeRequest', 'getChangeRequestWorklogs', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getChangeRequestWorklogs'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @function createChangeRequestWorklog
+   * @pronghornType method
+   * @name createChangeRequestWorklog
+   * @summary createChangeRequestWorklog
+   *
+   * @param {object} body - Request body
+   * @param {object} iapMetadata - IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /createChangeRequestWorklog
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  createChangeRequestWorklog(body, iapMetadata, callback) {
+    const meth = 'adapter-createChangeRequestWorklog';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (body === undefined || body === null || body === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [];
+    const bodyVars = body;
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    const reqFields = ['payload', 'uriPathVars', 'uriQuery', 'uriOptions', 'addlHeaders', 'authData', 'callProperties', 'filter', 'priority', 'event'];
+
+    // Merge and add new iapMetadata fields in reqObj
+    if (iapMetadata && typeof iapMetadata === 'object') {
+      Object.keys(iapMetadata).forEach((iapField) => {
+        if (reqFields.includes(iapField) && iapMetadata[iapField]) {
+          if (typeof reqObj[iapField] === 'object' && typeof iapMetadata[iapField] === 'object') {
+            reqObj[iapField] = { ...reqObj[iapField], ...iapMetadata[iapField] }; // Merge objects
+          } else if (Array.isArray(reqObj[iapField]) && Array.isArray(iapMetadata[iapField])) {
+            reqObj[iapField] = reqObj[iapField].concat(iapMetadata[iapField]); // Merge arrays
+          } else {
+            // Otherwise, add new iapMetadata fields to reqObj
+            reqObj[iapField] = iapMetadata[iapField];
+          }
+        }
+      });
+      // Add iapMetadata to reqObj for further work
+      reqObj.iapMetadata = iapMetadata;
+    }
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('ChangeRequest', 'createChangeRequestWorklog', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['createChangeRequestWorklog'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
 }
 
 module.exports = BmcHelixItsm;

package/entities/ChangeRequest/action.json

@@ -79,6 +79,47 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name": "getChangeRequestWorklogs",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/entry/CHG:WorkLog?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "createChangeRequestWorklog",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/entry/CHG:WorkLog?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
     }
   ]
 }

package/entities/ChangeRequest/schema.json

@@ -13,7 +13,9 @@
         "createChangeRequest",
         "updateChangeRequest",
         "getChangeRequest",
-        "getChangeRequests"
+        "getChangeRequests",
+        "getChangeRequestWorklogs",
+        "createChangeRequestWorklog"
       ],
       "external_name": "ph_request_type"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-bmc_helix_itsm",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "This adapter integrates with system described as: bmc_helix_itsm",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
@@ -55,7 +55,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-bmc_helix_itsm#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.7.0",
+    "@itentialopensource/adapter-utils": "^5.9.4",
     "acorn": "^8.12.1",
     "ajv": "^8.17.1",
     "axios": "^1.7.4",

package/pronghorn.json

@@ -64,13 +64,13 @@
           }
         },
         {
-          "name" : "replace",
+          "name": "replace",
           "type": "boolean",
           "info": "True to replace entire mock data, false to merge/append",
           "required": false,
           "schema": {
             "title": "replace",
-            "type" : "boolean"
+            "type": "boolean"
           }
         }
       ],
@@ -1729,7 +1729,95 @@
         "path": "/getChangeRequests"
       },
       "task": true
-    }    
+    },
+    {
+      "name": "getChangeRequestWorklogs",
+      "summary": "Retrieve change request worklog entries",
+      "description": "Retrieve change request worklog entries",
+      "input": [
+        {
+          "name": "q",
+          "type": "string",
+          "info": "Used to filter worklog entries: string",
+          "required": false,
+          "schema": {
+            "title": "q",
+            "type": "string"
+          }
+        },
+        {
+          "name": "iapMetadata",
+          "type": "object",
+          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "required": false,
+          "schema": {
+            "title": "iapMetadata",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getChangeRequestWorklogs"
+      },
+      "task": true
+    },
+    {
+      "name": "createChangeRequestWorklog",
+      "summary": "createChangeRequestWorklog",
+      "description": "createChangeRequestWorklog",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Request body: object",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "object"
+          }
+        },
+        {
+          "name": "iapMetadata",
+          "type": "object",
+          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "required": false,
+          "schema": {
+            "title": "iapMetadata",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/createChangeRequestWorklog"
+      },
+      "task": true
+    }
   ],
   "views": []
 }

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.3.2",
-  "configLines": 3591,
+  "version": "0.3.3",
+  "configLines": 3679,
   "scriptLines": 1783,
-  "codeLines": 3664,
-  "testLines": 3788,
-  "testCases": 178,
-  "totalCodeLines": 9235,
-  "wfTasks": 43
+  "codeLines": 3865,
+  "testLines": 3880,
+  "testCases": 183,
+  "totalCodeLines": 9528,
+  "wfTasks": 45
 }

package/test/integration/adapterTestIntegration.js

@@ -702,5 +702,56 @@ describe('[integration] Bmc_helix_itsm Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#getChangeRequestWorklogs - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.getChangeRequestWorklogs(null, null, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-bmc_helix_itsm-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('ChangeRequest', 'getChangeRequestWorklogs', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    const changeRequestcreateChangeRequestWorklogBodyParam = {};
+    describe('#createChangeRequestWorklog - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.createChangeRequestWorklog(changeRequestcreateChangeRequestWorklogBodyParam, null, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-bmc_helix_itsm-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('ChangeRequest', 'createChangeRequestWorklog', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });

package/test/unit/adapterTestUnit.js

@@ -1848,5 +1848,46 @@ describe('[unit] Bmc_helix_itsm Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#getChangeRequestWorklogs - errors', () => {
+      it('should have a getChangeRequestWorklogs function', (done) => {
+        try {
+          assert.equal(true, typeof a.getChangeRequestWorklogs === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#createChangeRequestWorklog - errors', () => {
+      it('should have a createChangeRequestWorklog function', (done) => {
+        try {
+          assert.equal(true, typeof a.createChangeRequestWorklog === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing body', (done) => {
+        try {
+          a.createChangeRequestWorklog(null, null, (data, error) => {
+            try {
+              const displayE = 'body is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-bmc_helix_itsm-adapter-createChangeRequestWorklog', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });

package/compliance-report.json

@@ -1,9 +0,0 @@
-{
-  "ComplianceEntries": [
-    {
-      "name": "Compliance Summary",
-      "numInvalidProjects": 0,
-      "numValidProjects": 0
-    }
-  ]
-}

package/compliance-report.txt

@@ -1,5 +0,0 @@
----------------------------------------------------------------------------------------------
-**** Project Compliance Summary ****
-0 project(s) are not valid
-0 project(s) are valid
----------------------------------------------------------------------------------------------