@itentialopensource/adapter-infoblox 1.12.2 → 1.12.4

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 1.12.4 [05-18-2023]
+
+* added call to list network containers
+
+See merge request itentialopensource/adapters/inventory/adapter-infoblox!28
+
+---
+
+## 1.12.3 [04-06-2023]
+
+* updated adapter utils version
+
+See merge request itentialopensource/adapters/inventory/adapter-infoblox!26
+
+---
+
 ## 1.12.2 [03-24-2023]
 
 * updated adapter utils version

package/adapter.js

@@ -1495,6 +1495,72 @@ class Infoblox extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @summary This function will get the list of network containers
+   *
+   * @function listNetworkContainers
+   * @param {object} query - optional query params for request
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (entities) or the error
+   */
+  listNetworkContainers(query, callback) {
+    const meth = 'adapter-listNetworkContainers';
+    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 SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [];
+    const bodyVars = {};
+    if (query) {
+      Object.assign(queryParamsAvailable, query);
+    }
+
+    // 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
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Networks', 'listNetworkContainers', 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);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData);
+      });
+    } 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 This function will get the auth zone details
    *

package/entities/Networks/action.json

@@ -104,6 +104,27 @@
         }
       ]
     },
+    {
+      "name": "listNetworkContainers",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/networkcontainer?{query}",
+      "requestSchema": "requestSchema.json",
+      "responseSchema": "responseSchema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listNetworkContainers.json"
+        }
+      ]
+    },
     {
       "name": "createNetworkContainer",
       "protocol": "REST",

package/entities/Networks/mockdatafiles/listNetworkContainers.json

@@ -0,0 +1,6 @@
+[{
+    "_ref": "network/ZG5zLm5ldHdvcmskMy4xLjEuMC8yNC8w:3.1.1.0/24/default",
+    "comment": "For test purpose",
+    "network": "3.1.1.0/24",
+    "network_view": "default"
+  }]

package/entities/Networks/requestSchema.json

@@ -29,7 +29,8 @@
         "getNetworkContainerNextNetworkIps",
         "getIpv6NetworkContainerNextNetworkIps",
         "getNetworkZoneAssociations",
-        "addNetworkZoneAssociation"
+        "addNetworkZoneAssociation",
+        "listNetworkContainers"
       ],
       "external_name": "ph_request_type"
     },

package/entities/Networks/responseSchema.json

@@ -27,7 +27,8 @@
         "getNetworkContainerNextNetworkIps",
         "getIpv6NetworkContainerNextNetworkIps",
         "getNetworkZoneAssociations",
-        "addNetworkZoneAssociation"
+        "addNetworkZoneAssociation",
+        "listNetworkContainers"
       ],
       "external_name": "ph_request_type"
     },

package/entities/Networks/schema.json

@@ -15,6 +15,7 @@
         "getNetworkDetails",
         "createNetwork",
         "getNetworkContainerDetails",
+        "listNetworkContainers",
         "createNetworkContainer",
         "deleteNetworkContainer",
         "genericCreateNextAvailableNetwork",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-infoblox",
-  "version": "1.12.2",
+  "version": "1.12.4",
   "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.48.10",
+    "@itentialopensource/adapter-utils": "^4.48.13",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",

package/pronghorn.json

@@ -1213,6 +1213,40 @@
       },
       "task": true
     },
+    {
+      "name": "listNetworkContainers",
+      "summary": "listNetworkContainers",
+      "description": "listNetworkContainers will get a list of containers",
+      "input": [        {
+        "name": "query",
+        "type": "object",
+        "info": "query parameters for the request, e.g.: _schema, _return_type, _return_fields, _method...",
+        "required": false,
+        "schema": {
+          "title": "query",
+          "type": "object"
+        }
+      }
+      ],
+      "output": {
+        "type": "object",
+        "name": "result",
+        "description": "",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin",
+        "pronghorn_admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/listNetworkContainers"
+      },
+      "task": true
+    },
     {
       "name": "getNetworkContainerDetailsWithQuery",
       "summary": "getNetworkContainerDetails",

package/test/integration/adapterTestIntegration.js

@@ -1188,6 +1188,29 @@ describe('[integration] Infoblox Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+    describe('#listNetworkContainers - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.listNetworkContainers({ key: 'fakedata' }, (data, error) => {
+            try {
+              if (stub) {
+                runCommonAsserts(data, error);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('Networks', 'listNetworkContainers', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
 
     const networksObjectReference = 'fakedata';
 

package/test/unit/adapterTestUnit.js

@@ -2225,6 +2225,18 @@ describe('[unit] Infoblox Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#listNetworkContainers - errors', () => {
+      it('should have a listNetworkContainers function', (done) => {
+        try {
+          assert.equal(true, typeof a.listNetworkContainers === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#createNetworkContainer - errors', () => {
       it('should have a createNetworkContainer function', (done) => {
         try {