@itentialopensource/adapter-infoblox 1.12.0 → 1.12.2

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 1.12.2 [03-24-2023]
+
+* updated adapter utils version
+
+See merge request itentialopensource/adapters/inventory/adapter-infoblox!26
+
+---
+
+## 1.12.1 [11-30-2022]
+
+* Adapt 2543 Add and Update record calls
+
+See merge request itentialopensource/adapters/inventory/adapter-infoblox!25
+
+---
+
 ## 1.12.0 [08-24-2022]
 
 * Added 2 calls

package/adapter.js

@@ -4930,8 +4930,8 @@ class Infoblox extends AdapterBaseCl {
     }
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = { hostName };
-    const queryParams = {};
+    const queryParamsAvailable = { name: hostName };
+    const queryParams = { _return_fields: 'extattrs,ipv4addrs,name,view' };
     const pathVars = [];
     const bodyVars = {};
     if (query) {
@@ -5014,7 +5014,7 @@ class Infoblox extends AdapterBaseCl {
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
     const queryParamsAvailable = { name };
-    const queryParams = {};
+    const queryParams = { _return_fields: 'extattrs,ipv4addr,name,view' };
     const pathVars = [];
     const bodyVars = {};
     if (query) {
@@ -10247,6 +10247,170 @@ class Infoblox extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @summary Update a plain text file
+   *
+   * @function uploadFile
+   * @param {string} urlFromUploadInitiation - The URI path of the file to upload. E.g. https://1.1.1.1/http_direct_file_io/req_id-UPLOAD-123/import_records
+   * @param {string} filedata - The plain text file data to upload. Usually the CSV text.
+   * @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 */
+  uploadFile(urlFromUploadInitiation, filedata, callback) {
+    const meth = 'adapter-uploadFile';
+    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 (!urlFromUploadInitiation) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['urlFromUploadInitiation'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    if (!filedata) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['filedata'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // Grabs the URL Id from the urlFromUploadInitiation variable
+    // The URL Id can then be templated into the URL path in the action.json file using a pathVar
+    // Example urlFromUploadInitiation -- https://1.1.1.1/http_direct_file_io/req_id-UPLOAD-1111111111111111/import_records
+    let uploadId;
+    try {
+      [uploadId] = urlFromUploadInitiation.match(/req_id-UPLOAD-[0-9]{16}/);
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Unable to parse urlFromUploadInitiation', ['urlFromUploadInitiation'], 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 queryParams = {};
+    const pathVars = [uploadId];
+    const bodyVars = { filedata };
+
+    // 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('FileOps', 'uploadFile', 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', ['uploadFile'], 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);
+    }
+  }
+
+  /**
+   * @summary Update a plain text file
+   *
+   * @function downloadFile
+   * @param {string} urlFromDownloadInitiation - The URI path of the file to upload. E.g. https://1.1.1.1/http_direct_file_io/req_id-DOWNLOAD-111/csv-error.1.csv
+   * @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 */
+  downloadFile(urlFromDownloadInitiation, callback) {
+    const meth = 'adapter-downloadFile';
+    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 (!urlFromDownloadInitiation) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['urlFromDownloadInitiation'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // Grabs the URL Id from the urlFromDownloadInitiation variable
+    // The URL Id can then be templated into the URL path in the action.json file using a pathVar
+    // Example urlFromDownloadInitiation -- https://1.1.1.1/http_direct_file_io/req_id-UPLOAD-1111111111111111/import_records
+    let downloadId;
+    let fileName;
+    try {
+      [downloadId] = urlFromDownloadInitiation.match(/req_id-DOWNLOAD-\d+/);
+      [fileName] = urlFromDownloadInitiation.match(/csv-error\.\d+\.csv/);
+    } catch (ex) {
+      log.info(ex);
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Unable to parse urlFromDownloadInitiation', ['urlFromDownloadInitiation'], 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 queryParams = {};
+    const pathVars = [downloadId, fileName];
+    const bodyVars = {};
+
+    // 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('FileOps', 'downloadFile', 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', ['downloadFile'], 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);
+    }
+  }
+
   /**
    * @summary Delete Extensible Attribute definition
    *

package/entities/FileOps/action.json

@@ -0,0 +1,48 @@
+{
+  "actions": [
+    {
+      "name": "uploadFile",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "/http_direct_file_io/{pathv1}/import_records",
+      "requestSchema": "requestSchema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "FORM",
+      "responseDatatype": "PLAIN",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "downloadFile",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "/http_direct_file_io/{pathv1}/{pathv2}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "",
+      "responseDatatype": "PLAIN",
+      "headers": {
+        "Content-Type": "application/force-download"
+      },
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/FileOps/requestSchema.json

@@ -0,0 +1,31 @@
+{
+    "$id": "fileOps",
+    "type": "object",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "translate": true,
+    "dynamicfields": true,
+    "properties": {
+      "ph_request_type": {
+        "$id": "/properties/ph_request_type",
+        "type": "string",
+        "description": "type of request (internal to adapter)",
+        "default": "uploadFile",
+        "enum": [
+          "uploadFile"
+        ],
+        "external_name": "ph_request_type"
+      },
+      "filedata": {
+        "type": "string",
+        "description": "",
+        "parse": false,
+        "encode": false,
+        "encrypt": {
+          "type": "AES",
+          "key": ""
+        },
+        "external_name": "filedata"
+      }
+    },
+    "definitions": {}
+  }

package/entities/FileOps/schema.json

@@ -0,0 +1,20 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "uploadFile",
+      "enum": [
+        "uploadFile",
+        "downloadFile"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/Records/action.json

@@ -428,7 +428,7 @@
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
-      "sendEmpty": false,
+      "sendEmpty": true,
       "sendGetBody": false,
       "requestDatatype": "JSON",
       "responseDatatype": "JSON",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-infoblox",
-  "version": "1.12.0",
+  "version": "1.12.2",
   "description": "Itential Infoblox Adapter",
   "main": "adapter.js",
   "systemName": "Infoblox",
@@ -57,7 +57,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/inventory/adapter-infoblox#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.45.6",
+    "@itentialopensource/adapter-utils": "^4.48.10",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",

package/pronghorn.json

@@ -6657,6 +6657,84 @@
       },
       "task": true
     },
+    {
+      "name": "uploadFile",
+      "summary": "Uploads a file to infoblox",
+      "description": "Uploads a file to infoblox given a url destination",
+      "input": [
+        {
+          "name": "urlFromUploadInitiation",
+          "type": "string",
+          "info": "The URI path of the file to upload. E.g. https://1.1.1.1/http_direct_file_io/req_id-UPLOAD-123/import_records",
+          "required": true,
+          "schema": {
+            "title": "urlFromUploadInitiation",
+            "type": "string"
+          }
+        },
+        {
+          "name": "filedata",
+          "type": "string",
+          "info": "The plain text file data to upload. Usually the CSV text.",
+          "required": true,
+          "schema": {
+            "title": "filedata",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/uploadFile"
+      },
+      "task": true
+    },
+    {
+      "name": "downloadFile",
+      "summary": "Downloads a file from infoblox",
+      "description": "Downloads a file from infoblox given a url destination",
+      "input": [
+        {
+          "name": "urlFromDownloadInitiation",
+          "type": "string",
+          "info": "The URI path of the file to upload. E.g. https://1.1.1.1/http_direct_file_io/req_id-UPLOAD-123/import_records",
+          "required": true,
+          "schema": {
+            "title": "urlFromDownloadInitiation",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "The resulting file specified in the urlFromDownloadInitiation",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/uploadFile"
+      },
+      "task": true
+    },
     {
       "name": "deleteExtensibleAttributeDefinition",
       "summary": "Delete Extensible Attribute definition",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "1.10.1",
-  "configLines": 22273,
+  "version": "1.12.0",
+  "configLines": 22469,
   "scriptLines": 1707,
-  "codeLines": 30001,
-  "testLines": 22131,
-  "testCases": 1093,
-  "totalCodeLines": 53839,
-  "wfTasks": 394
+  "codeLines": 30363,
+  "testLines": 22420,
+  "testCases": 1109,
+  "totalCodeLines": 54490,
+  "wfTasks": 398
 }

package/test/integration/adapterTestIntegration.js

@@ -3340,6 +3340,61 @@ describe('[integration] Infoblox Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    const urlFromUploadInitiation = 'https://1.1.1.1/http_direct_file_io/req_id-UPLOAD-1111111111111111/import_records';
+    const fileData = 'filedata';
+
+    describe('#uploadFile - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.uploadFile(urlFromUploadInitiation, fileData, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-infoblox-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('FileOps', 'uploadFile', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    const urlFromDownloadInitiation = 'https://1.1.1.1/http_direct_file_io/req_id-DOWNLOAD-111/csv-error.1.csv';
+
+    describe('#downloadFile - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.downloadFile(urlFromDownloadInitiation, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-infoblox-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('FileOps', 'downloadFile', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     const zonesZoneRef = 'fakedata';
 
     describe('#deleteAuthZoneByRef - errors', () => {

package/test/unit/adapterTestUnit.js

@@ -4309,6 +4309,81 @@ describe('[unit] Infoblox Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#uploadFile - errors', () => {
+      it('should have a uploadFile function', (done) => {
+        try {
+          assert.equal(true, typeof a.uploadFile === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing urlFromUploadInitiation', (done) => {
+        try {
+          a.uploadFile(null, 'filedata', (data, error) => {
+            try {
+              const displayE = 'urlFromUploadInitiation is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-infoblox-adapter-uploadFile', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing filedata', (done) => {
+        try {
+          a.uploadFile('https://1.1.1.1/http_direct_file_io/req_id-UPLOAD-1111111111111111/import_records', null, (data, error) => {
+            try {
+              const displayE = 'filedata is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-infoblox-adapter-uploadFile', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#downloadFile - errors', () => {
+      it('should have a downloadFile function', (done) => {
+        try {
+          assert.equal(true, typeof a.downloadFile === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing urlFromDownloadInitiation', (done) => {
+        try {
+          a.downloadFile(null, (data, error) => {
+            try {
+              const displayE = 'urlFromDownloadInitiation is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-infoblox-adapter-downloadFile', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#deleteExtensibleAttributeDefinition - errors', () => {
       it('should have a deleteExtensibleAttributeDefinition function', (done) => {
         try {