@itentialopensource/adapter-f5_bigiq 0.3.4 → 0.3.5

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.3.5 [09-28-2023]
+
+* Adds device upgrade methods for updating and retrieving device upgrades.
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!8
+
+---
+
 ## 0.3.4 [09-26-2023]
 
 * Add device upgrade calls

package/adapter.js

@@ -28914,6 +28914,246 @@ class F5BigIQ extends AdapterBaseCl {
       return callback(null, errorObj);
     }
   }
+
+  /**
+   * @function updateDeviceUpgrade
+   * @pronghornType method
+   * @name updateDeviceUpgrade
+   * @summary Update Device Upgrade
+   *
+   * @param {object} body - body param
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /updateDeviceUpgrade
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  updateDeviceUpgrade(body, callback) {
+    const meth = 'adapter-updateDeviceUpgrade';
+    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 (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);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [];
+    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('DeviceUpgrades', 'updateDeviceUpgrade', 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', ['updateDeviceUpgrade'], 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 getAllUpgradeInstances
+   * @pronghornType method
+   * @name getAllUpgradeInstances
+   * @summary Get All Upgrade Instances
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {GET} /getAllUpgradeInstances
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getAllUpgradeInstances(callback) {
+    const meth = 'adapter-getAllUpgradeInstances';
+    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 */
+
+    /* 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('DeviceUpgrades', 'getAllUpgradeInstances', 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', ['getAllUpgradeInstances'], 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 getUpgradeInstancesById
+   * @pronghornType method
+   * @name getUpgradeInstancesById
+   * @summary Get Upgrade Instance By Id
+   *
+   * @param {string} upgradeTaskId - upgradeTaskId param
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /getUpgradeInstancesById
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getUpgradeInstancesById(upgradeTaskId, callback) {
+    const meth = 'adapter-getUpgradeInstancesById';
+    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 (upgradeTaskId === undefined || upgradeTaskId === null || upgradeTaskId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['upgradeTaskId'], 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 = [upgradeTaskId];
+    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('DeviceUpgrades', 'getUpgradeInstancesById', 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', ['getUpgradeInstancesById'], 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 = F5BigIQ;

package/entities/DeviceUpgrades/action.json

@@ -142,6 +142,68 @@
           "mockFile": "mockdatafiles/getRemoveDeviceTrustStatusById-default.json"
         }
       ]
+    },
+    {
+      "name": "updateDeviceUpgrade",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/mgmt/cm/device/upgrade-backups?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateDeviceUpgrade-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getAllUpgradeInstances",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/mgmt/cm/device/upgrade-backups?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getAllUpgradeInstances-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getUpgradeInstancesById",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/mgmt/cm/device/upgrade-backups/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getUpgradeInstancesById-default.json"
+        }
+      ]
     }
   ]
 }

package/entities/DeviceUpgrades/mockdatafiles/getAllUpgradeInstances-default.json

@@ -0,0 +1,58 @@
+{
+  "items": [
+    {
+      "id": "3a010684-47c5-48f0-ba4a-82eece96aa3a",
+      "kind": "cm:device:upgrade-backups:prepostupgradebackupstate",
+      "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups/3a010684-47c5-48f0-ba4a-82eece96aa3a",
+      "generation": 4,
+      "hasPreBackup": true,
+      "hasPostBackup": false,
+      "needPreBackup": true,
+      "taskReference": {
+        "link": "https://localhost/mgmt/cm/device/upgrades/dbc4369f-8e33-4364-a612-4cfc6756b8da"
+      },
+      "needPostBackup": false,
+      "lastUpdateMicros": 1695828377417472,
+      "preBackupRecords": [
+        {
+          "backupReference": {
+            "link": "https://localhost/mgmt/cm/system/backup-restore/e34e6090-b5db-4973-8cb6-fe9217d3b394"
+          },
+          "deviceReference": {
+            "link": "https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/3fd9cf87-17ff-44b3-afc8-461c115bc5c8"
+          }
+        }
+      ],
+      "includePrivateKeys": true
+    },
+    {
+      "id": "03e01c63-44cd-44f5-ae2f-446391ae436f",
+      "kind": "cm:device:upgrade-backups:prepostupgradebackupstate",
+      "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups/03e01c63-44cd-44f5-ae2f-446391ae436f",
+      "generation": 3,
+      "hasPreBackup": true,
+      "hasPostBackup": false,
+      "needPreBackup": true,
+      "taskReference": {
+        "link": "https://localhost/mgmt/cm/device/upgrades/e577fed5-17ea-4bf6-b811-3045890173ab"
+      },
+      "needPostBackup": false,
+      "lastUpdateMicros": 1695272987904849,
+      "preBackupRecords": [
+        {
+          "backupReference": {
+            "link": "https://localhost/mgmt/cm/system/backup-restore/83c3b188-3172-4639-b665-2196a08b9fd4"
+          },
+          "deviceReference": {
+            "link": "https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/b14fc503-0fa0-4597-9042-cb43809b50e5"
+          }
+        }
+      ],
+      "includePrivateKeys": false
+    }
+  ],
+  "generation": 18,
+  "kind": "cm:device:upgrade-backups:prepostupgradebackupcollectionstate",
+  "lastUpdateMicros": 1695830761033292,
+  "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups"
+}

package/entities/DeviceUpgrades/mockdatafiles/getUpgradeInstancesById-default.json

@@ -0,0 +1,15 @@
+{
+  "id": "538c14b3-0331-45df-8663-11caab266c0a",
+  "kind": "cm:device:upgrade-backups:prepostupgradebackupstate",
+  "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups/538c14b3-0331-45df-8663-11caab266c0a",
+  "generation": 1,
+  "hasPreBackup": false,
+  "hasPostBackup": false,
+  "needPreBackup": true,
+  "taskReference": {
+    "link": "https://localhost/mgmt/cm/device/upgrades/48b1368c-765c-4e1a-b049-d8ed0ba02c60"
+  },
+  "needPostBackup": false,
+  "lastUpdateMicros": 1695830761023352,
+  "includePrivateKeys": true
+}

package/entities/DeviceUpgrades/mockdatafiles/updateDeviceUpgrade-default.json

@@ -0,0 +1,15 @@
+{
+  "id": "538c14b3-0331-45df-8663-11caab266c0a",
+  "includePrivateKeys": true,
+  "needPreBackup": true,
+  "hasPreBackup": false,
+  "needPostBackup": false,
+  "hasPostBackup": false,
+  "taskReference": {
+    "link": "https://localhost/mgmt/cm/device/upgrades/48b1368c-765c-4e1a-b049-d8ed0ba02c60"
+  },
+  "generation": 1,
+  "lastUpdateMicros": 1695830761023352,
+  "kind": "cm:device:upgrade-backups:prepostupgradebackupstate",
+  "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups/538c14b3-0331-45df-8663-11caab266c0a"
+}

package/entities/DeviceUpgrades/schema.json

@@ -16,7 +16,10 @@
         "removeDeviceServices",
         "getRemoveDeviceServicesStatusById",
         "removeDeviceTrust",
-        "getRemoveDeviceTrustStatusById"
+        "getRemoveDeviceTrustStatusById",
+        "updateDeviceUpgrade",
+        "getAllUpgradeInstances",
+        "getUpgradeInstancesById"
       ],
       "external_name": "ph_request_type"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-f5_bigiq",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "This adapter integrates with system described as: f5Big-iqApi.",
   "main": "adapter.js",
   "systemName": "f5 BIG-IQ",
@@ -63,7 +63,7 @@
     "json-query": "^2.2.2",
     "mocha": "^9.0.1",
     "mocha-param": "^2.0.1",
-    "mongodb": "^4.1.0",
+    "mongodb": "^4.17.1",
     "network-diagnostics": "^0.5.3",
     "nyc": "^15.1.0",
     "readline-sync": "^1.4.10",

package/pronghorn.json

@@ -12995,6 +12995,97 @@
         "path": "/getRemoveDeviceTrustStatusById"
       },
       "task": true
+    },
+    {
+      "name": "updateDeviceUpgrade",
+      "summary": "Update Device Upgrade",
+      "description": "Update Device Upgrade",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "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": "/updateDeviceUpgrade"
+      },
+      "task": true
+    },
+    {
+      "name": "getAllUpgradeInstances",
+      "summary": "Get All Upgrade Instances",
+      "description": "Get All Upgrade Instances",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "body",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/getAllUpgradeInstances"
+      },
+      "task": true
+    },
+    {
+      "name": "getUpgradeInstancesById",
+      "summary": "Get Upgrade Instance By Id",
+      "description": "Get Upgrade Instance By Id",
+      "input": [
+        {
+          "name": "upgradeTaskId",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "upgradeTaskId",
+            "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": "/getUpgradeInstancesById"
+      },
+      "task": true
     }
   ],
   "views": []

package/test/integration/adapterTestIntegration.js

@@ -9130,5 +9130,107 @@ describe('[integration] F5BigIQ Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    const deviceUpgradesUpdateDeviceUpgradeBodyParam = {
+      hasPostBackup: false,
+      hasPreBackup: false,
+      needPostBackup: false,
+      needPreBackup: true,
+      includePrivateKeys: false,
+      taskReference: {
+        link: 'https://localhost/mgmt/cm/device/upgrades/774a7160-1920-4ff6-b2fc-30c586fc12c8'
+      }
+    };
+    describe('#updateDeviceUpgrade - errors', () => {
+      it('should work if integrated or standalone with mockdata', (done) => {
+        try {
+          a.updateDeviceUpgrade(deviceUpgradesUpdateDeviceUpgradeBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                runCommonAsserts(data, error);
+                assert.equal('538c14b3-0331-45df-8663-11caab266c0a', data.response.id);
+                assert.equal(true, data.response.includePrivateKeys);
+                assert.equal(true, data.response.needPreBackup);
+                assert.equal(false, data.response.hasPreBackup);
+                assert.equal(false, data.response.needPostBackup);
+                assert.equal(false, data.response.hasPostBackup);
+                assert.equal('object', typeof data.response.taskReference);
+                assert.equal(1, data.response.generation);
+                assert.equal(1695830761023352, data.response.lastUpdateMicros);
+                assert.equal('cm:device:upgrade-backups:prepostupgradebackupstate', data.response.kind);
+                assert.equal('https://localhost/mgmt/cm/device/upgrade-backups/538c14b3-0331-45df-8663-11caab266c0a', data.response.selfLink);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('DeviceUpgrades', 'updateDeviceUpgrade', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#getAllUpgradeInstances - errors', () => {
+      it('should work if integrated or standalone with mockdata', (done) => {
+        try {
+          a.getAllUpgradeInstances((data, error) => {
+            try {
+              if (stub) {
+                runCommonAsserts(data, error);
+                assert.equal(true, Array.isArray(data.response.items));
+                assert.equal(18, data.response.generation);
+                assert.equal('cm:device:upgrade-backups:prepostupgradebackupcollectionstate', data.response.kind);
+                assert.equal(1695830761033292, data.response.lastUpdateMicros);
+                assert.equal('https://localhost/mgmt/cm/device/upgrade-backups', data.response.selfLink);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('DeviceUpgrades', 'getAllUpgradeInstances', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#getUpgradeInstancesById - errors', () => {
+      it('should work if integrated or standalone with mockdata', (done) => {
+        try {
+          a.getUpgradeInstancesById('fakedata', (data, error) => {
+            try {
+              if (stub) {
+                runCommonAsserts(data, error);
+                assert.equal(1, data.response.generation);
+                assert.equal('cm:device:upgrade-backups:prepostupgradebackupstate', data.response.kind);
+                assert.equal(1695830761023352, data.response.lastUpdateMicros);
+                assert.equal('https://localhost/mgmt/cm/device/upgrade-backups/538c14b3-0331-45df-8663-11caab266c0a', data.response.selfLink);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('DeviceUpgrades', 'getUpgradeInstancesById', '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

@@ -12258,5 +12258,75 @@ describe('[unit] F5BigIQ Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#updateDeviceUpgrade - errors', () => {
+      it('should have a updateDeviceUpgrade function', (done) => {
+        try {
+          assert.equal(true, typeof a.updateDeviceUpgrade === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing body', (done) => {
+        try {
+          a.updateDeviceUpgrade(null, (data, error) => {
+            try {
+              const displayE = 'body is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-f5_bigiq-adapter-updateDeviceUpgrade', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#getAllUpgradeInstances - errors', () => {
+      it('should have a getAllUpgradeInstances function', (done) => {
+        try {
+          assert.equal(true, typeof a.getAllUpgradeInstances === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#getUpgradeInstancesById - errors', () => {
+      it('should have a getUpgradeInstancesById function', (done) => {
+        try {
+          assert.equal(true, typeof a.getUpgradeInstancesById === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing upgradeTaskId', (done) => {
+        try {
+          a.getUpgradeInstancesById(null, (data, error) => {
+            try {
+              const displayE = 'upgradeTaskId is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-f5_bigiq-adapter-getUpgradeInstancesById', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });