@itentialopensource/adapter-solarwinds 0.6.0 → 0.6.1

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.6.1 [05-04-2023]
+
+* Added new call to create custom property for orion node
+
+See merge request itentialopensource/adapters/telemetry-analytics/adapter-solarwinds!16
+
+---
+
 ## 0.6.0 [05-27-2022]
 
 * Migration to the latest Adapter Foundation

package/adapter.js

@@ -55512,6 +55512,81 @@ class Solarwinds extends AdapterBaseCl {
       return callback(null, errorObj);
     }
   }
+
+  /**
+   * @summary function postCreateOrionNodeCustomProperty
+   *
+   * @function postCreateOrionNodeCustomProperty
+   * @param {string} swisUri - swis uri for node
+   * @param {object} body - body param
+   * @param {getCallback} callback - a callback function to return the result
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  postCreateOrionNodeCustomProperty(swisUri, body, callback) {
+    const meth = 'adapter-postCreateOrionNodeCustomProperty';
+    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 (swisUri === undefined || swisUri === null || swisUri === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['swisUri'], 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 = [swisUri];
+    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
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('CRUD', 'postCreateOrionNodeCustomProperty', 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', ['postCreateOrionNodeCustomProperty'], 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 = Solarwinds;

package/entities/CRUD/action.json

@@ -3443,6 +3443,27 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name" : "postCreateOrionNodeCustomProperty",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/{pathv1}/CustomProperties?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "PLAIN",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
     }
   ]
 }

package/entities/CRUD/schema.json

@@ -173,7 +173,8 @@
         "postCreateOrionWirelessHeatMapMap",
         "postCreateSWISfRemoteSWIS",
         "postCreateSystemSubscription",
-        "postCreateSystemSubscriptionProperty"
+        "postCreateSystemSubscriptionProperty",
+        "postCreateOrionNodeCustomProperty"
       ],
       "external_name": "ph_request_type"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-solarwinds",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "This adapter integrates with system Solarwinds",
   "main": "adapter.js",
   "systemName": "Solarwinds",
@@ -54,7 +54,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/telemetry-analytics/adapter-solarwinds#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.45.6",
+    "@itentialopensource/adapter-utils": "^4.48.13",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",

package/pronghorn.json

@@ -27587,6 +27587,50 @@
         "path": "/postInvokeSystemActiveQueryCancelByClientSessionID"
       },
       "task": true
+    },
+    {
+      "name": "postCreateOrionNodeCustomProperty",
+      "summary": "",
+      "description": "",
+      "input": [
+        {
+          "name" : "swisUri",
+          "type": "string",
+          "info": "",
+          "required": true,
+          "schema" : {
+            "title": "swisUri",
+            "type" : "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "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": "/postCreateOrionNodeCustomProperty"
+      },
+      "task": true
     }
   ]
 }

package/test/integration/adapterTestIntegration.js

@@ -23471,5 +23471,35 @@ describe('[integration] SolarWinds Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#postCreateOrionNodeCustomProperty - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.postCreateOrionNodeCustomProperty('fakedata', 'fakedata', (data, error) => {
+            try {
+              if (stub) {
+                assert.notEqual(undefined, error);
+                assert.notEqual(null, error);
+                assert.equal(null, data);
+                assert.equal('AD.500', error.icode);
+                assert.equal('Error 400 received on request', error.IAPerror.displayString);
+                const temp = 'no mock data for';
+                assert.equal(0, error.IAPerror.raw_response.message.indexOf(temp));
+              } else {
+                runCommonAsserts(data, error);
+              }
+
+              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

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