@itentialopensource/adapter-f5_bigiq 0.4.0 → 0.4.2

package/CALLS.md

@@ -262,6 +262,12 @@ Specific adapter calls are built based on the API of the f5 BIG-IQ. The Adapter
     <td style="padding:15px">{base_path}/{version}/mgmt/cm/cloud/environments/{pathv1}?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">listCloudEnvironments(callback)</td>
+    <td style="padding:15px">List all Cloud Environments</td>
+    <td style="padding:15px">{base_path}/{version}/mgmt/cm/cloud/environments?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">patchCloudEnvironment(id, body, callback)</td>
     <td style="padding:15px">Patch Cloud Enviornment</td>
@@ -286,6 +292,12 @@ Specific adapter calls are built based on the API of the f5 BIG-IQ. The Adapter
     <td style="padding:15px">{base_path}/{version}/mgmt/cm/cloud/providers/{pathv1}?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">listCloudProviders(callback)</td>
+    <td style="padding:15px">List all Cloud Providers</td>
+    <td style="padding:15px">{base_path}/{version}/mgmt/cm/cloud/providers?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">patchCloudProvider(id, body, callback)</td>
     <td style="padding:15px">Patch Cloud Provider</td>
@@ -1126,6 +1138,12 @@ Specific adapter calls are built based on the API of the f5 BIG-IQ. The Adapter
     <td style="padding:15px">{base_path}/{version}/mgmt/cm/device/ip-pool/pools/{pathv1}?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">listDeviceIPPools(callback)</td>
+    <td style="padding:15px">Get all IP Pools</td>
+    <td style="padding:15px">{base_path}/{version}/mgmt/cm/device/ip-pool/pools?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">postDeviceIPPool(body, callback)</td>
     <td style="padding:15px">Post Device IP Pool</td>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.4.2 [12-14-2023]
+
+* Added new Calls
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!9
+
+---
+
+## 0.4.1 [11-29-2023]
+
+* Added new Calls
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!9
+
+---
+
 ## 0.4.0 [11-08-2023]
 
 * Adapter Engine has been updated and the changes are being migrated to the adapter

package/adapter.js

@@ -1496,6 +1496,80 @@ class F5BigIQ extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @function listCloudEnvironments
+   * @pronghornType method
+   * @name listCloudEnvironments
+   * @summary List all Cloud Environments
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /listCloudEnvironments
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  listCloudEnvironments(callback) {
+    const meth = 'adapter-listCloudEnvironments';
+    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 = {};
+
+    // 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('CloudEdition', 'listCloudEnvironments', 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', ['listCloudEnvironments'], 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 patchCloudEnvironment
    * @pronghornType method
@@ -1830,6 +1904,80 @@ class F5BigIQ extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @function listCloudProviders
+   * @pronghornType method
+   * @name listCloudProviders
+   * @summary Get all Cloud Providers
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /listCloudProviders
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  listCloudProviders(callback) {
+    const meth = 'adapter-listCloudProviders';
+    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 = {};
+
+    // 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('CloudEdition', 'listCloudProviders', 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', ['listCloudProviders'], 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 patchCloudProvider
    * @pronghornType method
@@ -13532,6 +13680,80 @@ class F5BigIQ extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @function listDeviceIPPools
+   * @pronghornType method
+   * @name listDeviceIPPools
+   * @summary Get all IP Pools
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /listDeviceIPPools
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  listDeviceIPPools(callback) {
+    const meth = 'adapter-listDeviceIPPools';
+    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 = {};
+
+    // 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('Device', 'listDeviceIPPools', 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', ['listDeviceIPPools'], 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 postDeviceIPPool
    * @pronghornType method

package/entities/CloudEdition/action.json

@@ -205,6 +205,26 @@
         }
       ]
     },
+    {
+      "name": "listCloudEnvironments",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/mgmt/cm/cloud/environments?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
     {
       "name": "patchCloudEnvironment",
       "protocol": "REST",
@@ -286,6 +306,27 @@
         }
       ]
     },
+    {
+      "name": "listCloudProviders",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/mgmt/cm/cloud/providers?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
     {
       "name": "patchCloudProvider",
       "protocol": "REST",

package/entities/CloudEdition/schema.json

@@ -20,10 +20,12 @@
         "postApplyTemplate",
         "getAllApplicationsList",
         "getCloudEnvironment",
+        "listCloudEnvironments",
         "patchCloudEnvironment",
         "deleteCloudEnvironment",
         "postCloudEnvironment",
         "getCloudProvider",
+        "listCloudProviders",
         "patchCloudProvider",
         "deleteCloudProvider",
         "postCloudProvider",

package/entities/Device/action.json

@@ -61,6 +61,26 @@
         }
       ]
     },
+    {
+      "name": "listDeviceIPPools",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/mgmt/cm/device/ip-pool/pools?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
     {
       "name": "postDeviceIPPool",
       "protocol": "REST",

package/entities/Device/schema.json

@@ -13,6 +13,7 @@
         "getDeviceIPPool",
         "patchDeviceIPPools",
         "deleteDeviceIPPool",
+        "listDeviceIPPools",
         "postDeviceIPPool",
         "postDeviceDiscovery",
         "getAllDeviceDiscoveryTasks",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-f5_bigiq",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "This adapter integrates with system described as: f5Big-iqApi.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",

package/pronghorn.json

@@ -1334,6 +1334,29 @@
       },
       "task": true
     },
+    {
+      "name": "listCloudEnvironments",
+      "summary": "List all Cloud Environments",
+      "description": "List all Cloud Environments",
+      "input": [],
+      "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": "/listCloudEnvironments"
+      },
+      "task": true
+    },
     {
       "name": "patchCloudEnvironment",
       "summary": "Patch Cloud Enviornment",
@@ -1478,6 +1501,29 @@
       },
       "task": true
     },
+    {
+      "name": "listCloudProviders",
+      "summary": "List all Cloud Providers",
+      "description": "List all Cloud Providers",
+      "input": [],
+      "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": "/listCloudProviders"
+      },
+      "task": true
+    },
     {
       "name": "patchCloudProvider",
       "summary": "Patch Cloud Provider",
@@ -6432,6 +6478,29 @@
       },
       "task": true
     },
+    {
+      "name": "listDeviceIPPools",
+      "summary": "Get all IP Pools",
+      "description": "List all pools.",
+      "input": [],
+      "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": "/listDeviceIPPools"
+      },
+      "task": true
+    },
     {
       "name": "getDeviceIPPool",
       "summary": "Get Device IP Pool",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.3.5",
-  "configLines": 15275,
+  "version": "0.4.1",
+  "configLines": 15344,
   "scriptLines": 1783,
-  "codeLines": 30441,
-  "testLines": 23176,
-  "testCases": 1237,
-  "totalCodeLines": 55400,
-  "wfTasks": 365
+  "codeLines": 30663,
+  "testLines": 23287,
+  "testCases": 1243,
+  "totalCodeLines": 55733,
+  "wfTasks": 368
 }

package/test/integration/adapterTestIntegration.js

@@ -705,6 +705,31 @@ describe('[integration] F5BigIQ Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#listCloudEnvironments - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.listCloudEnvironments((data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-f5_bigiq-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('CloudEdition', 'listCloudEnvironments', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     const cloudEditionPatchCloudProviderBodyParam = {};
     describe('#patchCloudProvider - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
@@ -756,6 +781,31 @@ describe('[integration] F5BigIQ Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#listCloudProviders - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.listCloudProviders((data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-f5_bigiq-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('CloudEdition', 'listCloudProviders', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     const cloudEditionPatchServiceScalingGroupBodyParam = {};
     describe('#patchServiceScalingGroup - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
@@ -3851,6 +3901,31 @@ describe('[integration] F5BigIQ Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#listDeviceIPPools - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.listDeviceIPPools((data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-f5_bigiq-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('Device', 'listDeviceIPPools', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     const devicePatchDeviceTemplateBodyParam = {};
     describe('#patchDeviceTemplate - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {

package/test/unit/adapterTestUnit.js

@@ -1812,6 +1812,18 @@ describe('[unit] F5BigIQ Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#listCloudEnvironments - errors', () => {
+      it('should have a listCloudEnvironments function', (done) => {
+        try {
+          assert.equal(true, typeof a.listCloudEnvironments === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#patchCloudEnvironment - errors', () => {
       it('should have a patchCloudEnvironment function', (done) => {
         try {
@@ -1945,6 +1957,18 @@ describe('[unit] F5BigIQ Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#listCloudProviders - errors', () => {
+      it('should have a listCloudProviders function', (done) => {
+        try {
+          assert.equal(true, typeof a.listCloudProviders === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#patchCloudProvider - errors', () => {
       it('should have a patchCloudProvider function', (done) => {
         try {
@@ -6559,6 +6583,18 @@ describe('[unit] F5BigIQ Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#listDeviceIPPools - errors', () => {
+      it('should have a listDeviceIPPools function', (done) => {
+        try {
+          assert.equal(true, typeof a.listDeviceIPPools === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#patchDeviceIPPools - errors', () => {
       it('should have a patchDeviceIPPools function', (done) => {
         try {