@itentialopensource/adapter-vmware_vcenter 0.13.1 → 0.13.3

package/CALLS.md

@@ -798,5 +798,17 @@ Specific adapter calls are built based on the API of the VMware vCenter. The Ada
     <td style="padding:15px">{base_path}/{version}/vcenter/vm-template/library-items/{pathv1}?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">findLibrary(action, body, callback)</td>
+    <td style="padding:15px">Find Library</td>
+    <td style="padding:15px">{base_path}/{version}/com/vmware/content/library?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">findLibraryItem(action, body, callback)</td>
+    <td style="padding:15px">Find Library Item</td>
+    <td style="padding:15px">{base_path}/{version}/com/vmware/content/library/item?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
 </table>
 <br>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.13.3 [08-15-2024]
+
+* Changes made at 2024.08.14_19:56PM
+
+See merge request itentialopensource/adapters/adapter-vmware_vcenter!28
+
+---
+
+## 0.13.2 [08-14-2024]
+
+* Add library calls
+
+See merge request itentialopensource/adapters/adapter-vmware_vcenter!27
+
+---
+
 ## 0.13.1 [08-07-2024]
 
 * Changes made at 2024.08.06_22:04PM

package/adapter.js

@@ -8082,6 +8082,182 @@ class VmwareVCenter extends AdapterBaseCl {
       return callback(null, errorObj);
     }
   }
+
+  /**
+   * @function findLibrary
+   * @pronghornType method
+   * @name findLibrary
+   * @summary Find Library
+   *
+   * @param {string} action - action param
+   * @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} /findLibrary
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  findLibrary(action, body, callback) {
+    const meth = 'adapter-findLibrary';
+    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 (action === undefined || action === null || action === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['action'], 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);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = { action };
+    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('Library', 'findLibrary', 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', ['findLibrary'], 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 findLibraryItem
+   * @pronghornType method
+   * @name findLibraryItem
+   * @summary Find Library Item
+   *
+   * @param {string} action - action param
+   * @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} /findLibraryItem
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  findLibraryItem(action, body, callback) {
+    const meth = 'adapter-findLibraryItem';
+    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 (action === undefined || action === null || action === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['action'], 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);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = { action };
+    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('Library', 'findLibraryItem', 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', ['findLibraryItem'], 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 = VmwareVCenter;

package/entities/Library/action.json

@@ -0,0 +1,44 @@
+{
+  "actions": [
+    {
+      "name": "findLibrary",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/com/vmware/content/library?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "findLibraryItem",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/com/vmware/content/library/item?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Library/schema.json

@@ -0,0 +1,31 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "findLibrary",
+      "enum": [
+        "findLibrary",
+        "findLibraryItem"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "action": {
+      "type": "string",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "~action"
+    }
+  },
+  "definitions": {}
+}

package/metadata.json

@@ -72,7 +72,9 @@
         "link": "https://developer.vmware.com/apis/vsphere-automation/latest/vcenter/",
         "public": true
       }
-    ]
+    ],
+    "workshopLinks": [],
+    "workshopHomePage": "https://www.itential.com/get-started/"
   },
   "assets": [],
   "relatedItems": {
@@ -83,5 +85,6 @@
     "transformationProjects": [],
     "exampleProjects": []
   },
-  "supportLevel": "community"
+  "supportLevel": "community",
+  "techAlliance": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-vmware_vcenter",
-  "version": "0.13.1",
+  "version": "0.13.3",
   "description": "This adapter integrates with system Vmware_vCenter",
   "main": "adapter.js",
   "systemName": "VMware vCenter",
@@ -57,12 +57,12 @@
     "@itentialopensource/adapter-utils": "^5.6.0",
     "acorn": "^8.12.1",
     "ajv": "^8.17.1",
-    "axios": "^1.7.2",
+    "axios": "^1.7.4",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
     "fs-extra": "^11.2.0",
     "json-query": "^2.2.2",
-    "mocha": "^10.7.0",
+    "mocha": "^10.7.3",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.16.0",
     "ping": "^0.4.4",

package/pronghorn.json

@@ -8,7 +8,7 @@
     "admin"
   ],
   "methods": [
-		{
+    {
       "name": "iapUpdateAdapterConfiguration",
       "summary": "Updates the adapter configuration",
       "description": "Updates the adapter configuration file with the provided changes",
@@ -177,7 +177,7 @@
       },
       "task": true
     },
-		{
+    {
       "name": "iapFindAdapterPath",
       "summary": "Provides the ability to see if a particular API path is supported by the adapter",
       "description": "Provides the ability to see if a particular API path is supported by the adapter",
@@ -212,7 +212,7 @@
       },
       "task": true
     },
-		{
+    {
       "name": "iapTroubleshootAdapter",
       "summary": "Runs troubleshoot script for adapter",
       "description": "Runs troubleshoot script for adapter",
@@ -256,7 +256,7 @@
       },
       "task": true
     },
-		{
+    {
       "name": "iapRunAdapterHealthcheck",
       "summary": "Runs healthcheck script for adapter",
       "description": "Runs healthcheck script for adapter",
@@ -279,7 +279,7 @@
       },
       "task": true
     },
-		{
+    {
       "name": "iapRunAdapterConnectivity",
       "summary": "Runs connectivity check script for adapter",
       "description": "Runs connectivity check script for adapter",
@@ -302,7 +302,7 @@
       },
       "task": true
     },
-		{
+    {
       "name": "iapRunAdapterBasicGet",
       "summary": "Runs basicGet script for adapter",
       "description": "Runs basicGet script for adapter",
@@ -325,7 +325,7 @@
       },
       "task": true
     },
-		{
+    {
       "name": "iapMoveAdapterEntitiesToDB",
       "summary": "Moves entities from an adapter into the IAP database",
       "description": "Moves entities from an adapter into the IAP database",
@@ -762,7 +762,7 @@
       },
       "task": true
     },
-		{
+    {
       "name": "genericAdapterRequest",
       "summary": "Makes the requested generic call",
       "description": "Makes the requested generic call",
@@ -841,7 +841,7 @@
       },
       "task": true
     },
-		{
+    {
       "name": "genericAdapterRequestNoBasePath",
       "summary": "Makes the requested generic call",
       "description": "Makes the requested generic call",
@@ -5138,6 +5138,94 @@
         "path": "/postVcentervmtemplatedeploy"
       },
       "task": true
+    },
+    {
+      "name": "findLibrary",
+      "summary": "Find Library",
+      "description": "Find Library",
+      "input": [
+        {
+          "name": "action",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "action",
+            "type": "string"
+          }
+        },
+        {
+          "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": "/findLibrary"
+      },
+      "task": true
+    },
+    {
+      "name": "findLibraryItem",
+      "summary": "Find Library Item",
+      "description": "Find Library Item",
+      "input": [
+        {
+          "name": "action",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "action",
+            "type": "string"
+          }
+        },
+        {
+          "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": "/findLibraryItem"
+      },
+      "task": true
     }
   ]
 }

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.12.5",
-  "configLines": 6999,
+  "version": "0.13.1",
+  "configLines": 7087,
   "scriptLines": 1783,
-  "codeLines": 9541,
-  "testLines": 9903,
-  "testCases": 479,
-  "totalCodeLines": 21227,
-  "wfTasks": 121
+  "codeLines": 9717,
+  "testLines": 10047,
+  "testCases": 487,
+  "totalCodeLines": 21547,
+  "wfTasks": 123
 }

package/test/integration/adapterTestIntegration.js

@@ -3607,5 +3607,57 @@ describe('[integration] Vmware_vCenter Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    const libraryFindLibraryBodyParam = {};
+    describe('#findLibrary - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.findLibrary('fakedata', libraryFindLibraryBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-vmware_vcenter-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('Library', 'findLibrary', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    const libraryFindLibraryItemBodyParam = {};
+    describe('#findLibraryItem - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.findLibraryItem('fakedata', libraryFindLibraryItemBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-vmware_vcenter-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('Library', 'findLibraryItem', '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

@@ -315,10 +315,10 @@ describe('[unit] Vmware_vCenter Adapter Test', () => {
           assert.notEqual(null, packageDotJson.dependencies);
           assert.notEqual('', packageDotJson.dependencies);
           assert.equal('^8.17.1', packageDotJson.dependencies.ajv);
-          assert.equal('^1.7.2', packageDotJson.dependencies.axios);
+          assert.equal('^1.7.4', packageDotJson.dependencies.axios);
           assert.equal('^11.0.0', packageDotJson.dependencies.commander);
           assert.equal('^11.2.0', packageDotJson.dependencies['fs-extra']);
-          assert.equal('^10.7.0', packageDotJson.dependencies.mocha);
+          assert.equal('^10.7.3', packageDotJson.dependencies.mocha);
           assert.equal('^2.0.1', packageDotJson.dependencies['mocha-param']);
           assert.equal('^0.4.4', packageDotJson.dependencies.ping);
           assert.equal('^1.4.10', packageDotJson.dependencies['readline-sync']);
@@ -5034,5 +5034,97 @@ describe('[unit] Vmware_vCenter Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    describe('#findLibrary - errors', () => {
+      it('should have a findLibrary function', (done) => {
+        try {
+          assert.equal(true, typeof a.findLibrary === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing action', (done) => {
+        try {
+          a.findLibrary(null, null, (data, error) => {
+            try {
+              const displayE = 'action is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-vmware_vcenter-adapter-findLibrary', 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.findLibrary('fakeparam', null, (data, error) => {
+            try {
+              const displayE = 'body is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-vmware_vcenter-adapter-findLibrary', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#findLibraryItem - errors', () => {
+      it('should have a findLibraryItem function', (done) => {
+        try {
+          assert.equal(true, typeof a.findLibraryItem === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing action', (done) => {
+        try {
+          a.findLibraryItem(null, null, (data, error) => {
+            try {
+              const displayE = 'action is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-vmware_vcenter-adapter-findLibraryItem', 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.findLibraryItem('fakeparam', null, (data, error) => {
+            try {
+              const displayE = 'body is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-vmware_vcenter-adapter-findLibraryItem', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });