@itentialopensource/adapter-f5_bigiq 0.4.4 → 0.4.6

package/CALLS.md

@@ -2128,6 +2128,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/shared/user-script-execution/{pathv1}?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">deleteBIGIPscript(scriptId, callback)</td>
+    <td style="padding:15px">Delete BIG-IP script</td>
+    <td style="padding:15px">{base_path}/{version}/mgmt/shared/user-scripts/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">retrieveallSoftwareImages(filter, orderby, callback)</td>
     <td style="padding:15px">Retrieve all Software Images</td>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.4.6 [03-08-2024]
+
+* Adds call to delete script from BIG-IQ
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!13
+
+---
+
+## 0.4.5 [02-28-2024]
+
+* Changes made at 2024.02.28_11:25AM
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!12
+
+---
+
 ## 0.4.4 [12-24-2023]
 
 * update metadata

package/adapter.js

@@ -27433,6 +27433,88 @@ class F5BigIQ extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @function deleteBIGIPscript
+   * @pronghornType method
+   * @name deleteBIGIPscript
+   * @summary Delete BIG-IP script
+   *
+   * @param {string} scriptId - scriptId param
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {DELETE} /deleteBIGIPscript
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  deleteBIGIPscript(scriptId, callback) {
+    const meth = 'adapter-deleteBIGIPscript';
+    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 (scriptId === undefined || scriptId === null || scriptId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['scriptId'], 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 = [scriptId];
+    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('BIGIPTMSHScripting', 'deleteBIGIPscript', 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', ['deleteBIGIPscript'], 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 retrieveallSoftwareImages
    * @pronghornType method

package/entities/BIGIPTMSHScripting/action.json

@@ -102,6 +102,27 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name": "deleteBIGIPscript",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/mgmt/shared/user-scripts/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
     }
   ]
 }

package/entities/BIGIPTMSHScripting/schema.json

@@ -14,7 +14,8 @@
         "retrieveallBIGIPscripts",
         "createaBIGIPscript",
         "executeaBIGIPscript",
-        "queryBIGIPscriptstatus"
+        "queryBIGIPscriptstatus",
+        "deleteBIGIPscript"
       ],
       "external_name": "ph_request_type"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-f5_bigiq",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "description": "This adapter integrates with system described as: f5Big-iqApi.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
@@ -55,15 +55,15 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.3.0",
+    "@itentialopensource/adapter-utils": "^5.3.8",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
-    "axios": "^1.6.2",
+    "axios": "^1.6.7",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
     "fs-extra": "^11.1.1",
     "json-query": "^2.2.2",
-    "mocha": "^10.2.0",
+    "mocha": "^10.3.0",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.17.1",
     "nyc": "^15.1.0",

package/pronghorn.json

@@ -12643,6 +12643,40 @@
       },
       "task": true
     },
+    {
+      "name": "deleteBIGIPscript",
+      "summary": "Delete BIG-IP script",
+      "description": "Delete BIG-IP script",
+      "input": [
+        {
+          "name": "scriptId",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "scriptId",
+            "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": "/deleteBIGIPscript"
+      },
+      "task": true
+    },
     {
       "name": "retrieveallSoftwareImages",
       "summary": "Retrieve all Software Images",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.4.3",
-  "configLines": 15344,
+  "version": "0.4.5",
+  "configLines": 15378,
   "scriptLines": 1783,
-  "codeLines": 30663,
-  "testLines": 23287,
-  "testCases": 1243,
-  "totalCodeLines": 55733,
-  "wfTasks": 368
+  "codeLines": 30745,
+  "testLines": 23341,
+  "testCases": 1246,
+  "totalCodeLines": 55869,
+  "wfTasks": 369
 }

package/test/integration/adapterTestIntegration.js

@@ -8716,6 +8716,31 @@ describe('[integration] F5BigIQ Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#deleteBIGIPscript - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.deleteBIGIPscript('fakedata', (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('BIGIPTMSHScripting', 'deleteBIGIPscript', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#retrieveallSoftwareImages - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
         try {

package/test/unit/adapterTestUnit.js

@@ -316,10 +316,10 @@ describe('[unit] F5BigIQ Adapter Test', () => {
           assert.notEqual(null, packageDotJson.dependencies);
           assert.notEqual('', packageDotJson.dependencies);
           assert.equal('^8.12.0', packageDotJson.dependencies.ajv);
-          assert.equal('^1.6.2', packageDotJson.dependencies.axios);
+          assert.equal('^1.6.7', packageDotJson.dependencies.axios);
           assert.equal('^11.0.0', packageDotJson.dependencies.commander);
           assert.equal('^11.1.1', packageDotJson.dependencies['fs-extra']);
-          assert.equal('^10.2.0', packageDotJson.dependencies.mocha);
+          assert.equal('^10.3.0', packageDotJson.dependencies.mocha);
           assert.equal('^2.0.1', packageDotJson.dependencies['mocha-param']);
           assert.equal('^15.1.0', packageDotJson.dependencies.nyc);
           assert.equal('^0.4.4', packageDotJson.dependencies.ping);
@@ -12072,6 +12072,35 @@ describe('[unit] F5BigIQ Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#deleteBIGIPscript - errors', () => {
+      it('should have a deleteBIGIPscript function', (done) => {
+        try {
+          assert.equal(true, typeof a.deleteBIGIPscript === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing scriptId', (done) => {
+        try {
+          a.deleteBIGIPscript(null, (data, error) => {
+            try {
+              const displayE = 'scriptId is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-f5_bigiq-adapter-deleteBIGIPscript', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#retrieveallSoftwareImages - errors', () => {
       it('should have a retrieveallSoftwareImages function', (done) => {
         try {