@itentialopensource/adapter-infoblox 1.11.0 → 1.12.0

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 1.12.0 [08-24-2022]
+
+* Added 2 calls
+
+See merge request itentialopensource/adapters/inventory/adapter-infoblox!24
+
+---
+
 ## 1.11.0 [08-08-2022]
 
 * Add over 200 DNS Calls

package/adapter.js

@@ -28212,6 +28212,204 @@ class Infoblox extends AdapterBaseCl {
       return callback(null, errorObj);
     }
   }
+
+  /**
+   * @function getNetworkZoneAssociations
+   * @pronghornType method
+   * @name getNetworkZoneAssociations
+   * @summary getNetworkZoneAssociations
+   *
+   * @param {string} networkId - The id of the network to get zones for
+   * @param {string} networkView - The network view we are getting zones from
+   * @param {object} [query] - The query parameters to include on the request
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /getNetworkZoneAssociations
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getNetworkZoneAssociations(networkId, networkView, query, callback) {
+    const meth = 'adapter-getNetworkZoneAssociations';
+    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 (networkId === undefined || networkId === null || networkId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['networkId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (networkId.indexOf('/') < 1) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['subnet mask in networkId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    const netParts = networkId.split('/');
+    let netView = 'default';
+    if (networkView) {
+      netView = networkView;
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    let queryParamsAvailable = {};
+    if (query) {
+      queryParamsAvailable = query;
+    }
+    const queryParams = {};
+    const pathVars = [netParts[0], netParts[1], netView];
+    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
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Networks', 'getNetworkZoneAssociations', reqObj, false, (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', ['getNetworkZoneAssociations'], 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 addNetworkZoneAssociation
+   * @pronghornType method
+   * @name addNetworkZoneAssociation
+   * @summary addNetworkZoneAssociation
+   *
+   * @param {string} networkId - The id of the network to get zones for
+   * @param {string} networkView - The network view we are getting zones from
+   * @param {object} [query] - The query parameters to include on the request
+   * @param {object} body - The zone information to include on the request
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /addNetworkZoneAssociation
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  addNetworkZoneAssociation(networkId, networkView, query, body, callback) {
+    const meth = 'adapter-addNetworkZoneAssociation';
+    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 (networkId === undefined || networkId === null || networkId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['networkId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (networkId.indexOf('/') < 1) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['subnet mask in networkId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    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);
+    }
+    const netParts = networkId.split('/');
+    let netView = 'default';
+    if (networkView) {
+      netView = networkView;
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    let queryParamsAvailable = {};
+    if (query) {
+      queryParamsAvailable = query;
+    }
+    const queryParams = {};
+    const pathVars = [netParts[0], netParts[1], netView];
+    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
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Networks', 'addNetworkZoneAssociation', reqObj, false, (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', ['addNetworkZoneAssociation'], 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 = Infoblox;

package/entities/Networks/action.json

@@ -418,6 +418,48 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name": "getNetworkZoneAssociations",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/network/{pathv1}/{pathv2}/{pathv3}?{query}",
+      "requestSchema": "requestSchema.json",
+      "responseSchema": "responseSchema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "addNetworkZoneAssociation",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/network/{pathv1}/{pathv2}/{pathv3}?{query}",
+      "requestSchema": "requestSchema.json",
+      "responseSchema": "responseSchema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
     }
   ]
 }

package/entities/Networks/requestSchema.json

@@ -27,7 +27,9 @@
         "deleteNetwork",
         "modifyNetworkBlock",
         "getNetworkContainerNextNetworkIps",
-        "getIpv6NetworkContainerNextNetworkIps"
+        "getIpv6NetworkContainerNextNetworkIps",
+        "getNetworkZoneAssociations",
+        "addNetworkZoneAssociation"
       ],
       "external_name": "ph_request_type"
     },

package/entities/Networks/responseSchema.json

@@ -25,7 +25,9 @@
         "deleteNetwork",
         "modifyNetworkBlock",
         "getNetworkContainerNextNetworkIps",
-        "getIpv6NetworkContainerNextNetworkIps"
+        "getIpv6NetworkContainerNextNetworkIps",
+        "getNetworkZoneAssociations",
+        "addNetworkZoneAssociation"
       ],
       "external_name": "ph_request_type"
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-infoblox",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "description": "Itential Infoblox Adapter",
   "main": "adapter.js",
   "systemName": "Infoblox",

package/pronghorn.json

@@ -20817,6 +20817,124 @@
         "path": "/deleteZoneStubByReference"
       },
       "task": true
+    },
+    {
+      "name": "getNetworkZoneAssociations",
+      "summary": "getNetworkZoneAssociations",
+      "description": "getNetworkZoneAssociations",
+      "input": [
+        {
+          "name": "networkId",
+          "type": "string",
+          "info": "The id of the network to get zones for",
+          "required": true,
+          "schema": {
+            "title": "networkId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "networkView",
+          "type": "string",
+          "info": "The network view we are getting zones from",
+          "required": false,
+          "schema": {
+            "title": "networkView",
+            "type": "string"
+          }
+        },
+        {
+          "name": "query",
+          "type": "object",
+          "info": "The query parameters to include on the request",
+          "required": false,
+          "schema": {
+            "title": "query",
+            "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": "/getNetworkZoneAssociations"
+      },
+      "task": true
+    },
+    {
+      "name": "addNetworkZoneAssociation",
+      "summary": "addNetworkZoneAssociation",
+      "description": "addNetworkZoneAssociation",
+      "input": [
+        {
+          "name": "networkId",
+          "type": "string",
+          "info": "The id of the network to get zones for",
+          "required": true,
+          "schema": {
+            "title": "networkId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "networkView",
+          "type": "string",
+          "info": "The network view we are getting zones from",
+          "required": false,
+          "schema": {
+            "title": "networkView",
+            "type": "string"
+          }
+        },
+        {
+          "name": "query",
+          "type": "object",
+          "info": "The query parameters to include on the request",
+          "required": false,
+          "schema": {
+            "title": "query",
+            "type": "object"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The zone information to include on the request",
+          "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": "/addNetworkZoneAssociation"
+      },
+      "task": true
     }
   ]
 }

package/test/integration/adapterTestIntegration.js

@@ -10244,5 +10244,55 @@ describe('[integration] Infoblox Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#addNetworkZoneAssociation - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.addNetworkZoneAssociation('fakedata/16', null, null, { key: 'value' }, (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('Networks', 'addNetworkZoneAssociation', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#getNetworkZoneAssociations - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.getNetworkZoneAssociations('fakedata/16', null, null, (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('Networks', 'getNetworkZoneAssociations', '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

@@ -10747,5 +10747,114 @@ describe('[unit] Infoblox Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#getNetworkZoneAssociations - errors', () => {
+      it('should have a getNetworkZoneAssociations function', (done) => {
+        try {
+          assert.equal(true, typeof a.getNetworkZoneAssociations === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing networkId', (done) => {
+        try {
+          a.getNetworkZoneAssociations(null, null, null, (data, error) => {
+            try {
+              const displayE = 'networkId is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-infoblox-adapter-getNetworkZoneAssociations', 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 networkId subnet mask', (done) => {
+        try {
+          a.getNetworkZoneAssociations('fakedata', null, null, (data, error) => {
+            try {
+              const displayE = 'subnet mask in networkId is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-infoblox-adapter-getNetworkZoneAssociations', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#addNetworkZoneAssociation - errors', () => {
+      it('should have a addNetworkZoneAssociation function', (done) => {
+        try {
+          assert.equal(true, typeof a.addNetworkZoneAssociation === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing networkId', (done) => {
+        try {
+          a.addNetworkZoneAssociation(null, null, null, null, (data, error) => {
+            try {
+              const displayE = 'networkId is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-infoblox-adapter-addNetworkZoneAssociation', 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 networkId subnet mask', (done) => {
+        try {
+          a.addNetworkZoneAssociation('fakedata', null, null, null, (data, error) => {
+            try {
+              const displayE = 'subnet mask in networkId is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-infoblox-adapter-addNetworkZoneAssociation', 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 body', (done) => {
+        try {
+          a.addNetworkZoneAssociation('fakedata/16', null, null, null, (data, error) => {
+            try {
+              const displayE = 'body is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-infoblox-adapter-addNetworkZoneAssociation', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });