@itentialopensource/adapter-gcp_compute 1.5.0 → 1.5.1

package/CALLS.md

@@ -19,7 +19,7 @@ These are adapter methods that IAP or you might use. There are some other method
   </tr>
   <tr>
     <td style="padding:15px">healthCheck(callback)</td>
-    <td style="padding:15px">This call ensures that the adapter can communicate with GcpCompute. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
+    <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for Google Cloud Platform Compute. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
     <td style="padding:15px">No</td>
   </tr>
   <tr>
@@ -29,7 +29,7 @@ These are adapter methods that IAP or you might use. There are some other method
   </tr>
   <tr>
     <td style="padding:15px">encryptProperty(property, technique, callback)</td>
-    <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with GcpCompute.</td>
+    <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Google Cloud Platform Compute.</td>
     <td style="padding:15px">No</td>
   </tr>
   <tr>
@@ -37,11 +37,6 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
     <td style="padding:15px">Yes</td>
   </tr>
-  <tr>
-    <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
-    <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
-    <td style="padding:15px">Yes</td>
-  </tr>
   <tr>
     <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
     <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
@@ -57,12 +52,16 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
+    <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
     <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
     <td style="padding:15px">Yes</td>
   </tr>
-
   <tr>
     <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
     <td style="padding:15px">This call will return the results of a healthcheck.</td>
@@ -83,6 +82,21 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
+    <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
+    <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
     <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
@@ -94,19 +108,42 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">iapHasAdapterEntity(entityType, entityId, callback)</td>
-    <td style="padding:15px">This call verifies the adapter has the specific entity.</td>
-    <td style="padding:15px">No</td>
+    <td style="padding:15px">iapRunAdapterLint(callback)</td>
+    <td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
+    <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">iapVerifyAdapterCapability(entityType, actionType, entityId, callback)</td>
-    <td style="padding:15px">This call verifies the adapter can perform the provided action on the specific entity.</td>
-    <td style="padding:15px">No</td>
+    <td style="padding:15px">iapRunAdapterTests(callback)</td>
+    <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
+    <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">iapUpdateAdapterEntityCache()</td>
-    <td style="padding:15px">This call will update the entity cache.</td>
-    <td style="padding:15px">No</td>
+    <td style="padding:15px">iapGetAdapterInventory(callback)</td>
+    <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>
+  
+### Adapter Cache Calls
+
+These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
+    <td style="padding:15px">This call populates the adapter cache.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
+    <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
+    <td style="padding:15px">Yes</td>
   </tr>
 </table>
 <br>
@@ -129,27 +166,27 @@ These are adapter methods that are used to integrate to IAP Brokers. This adapte
   <tr>
     <td style="padding:15px">getDevice(deviceName, callback)</td>
     <td style="padding:15px">This call returns the details of the requested device.</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
   <tr>
     <td style="padding:15px">getDevicesFiltered(options, callback)</td>
     <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
   <tr>
     <td style="padding:15px">isAlive(deviceName, callback)</td>
     <td style="padding:15px">This call returns whether the device status is active</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
   <tr>
     <td style="padding:15px">getConfig(deviceName, format, callback)</td>
     <td style="padding:15px">This call returns the configuration for the selected device.</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
   <tr>
     <td style="padding:15px">iapGetDeviceCount(callback)</td>
     <td style="padding:15px">This call returns the count of devices.</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
 </table>
 <br>

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 1.5.1 [09-11-2023]
+
+* more migration & metadata changes
+
+See merge request itentialopensource/adapters/cloud/adapter-gcp_compute!11
+
+---
+
 ## 1.5.0 [08-16-2023]
 
 * 2023 Adapter Migration

package/README.md

@@ -14,6 +14,7 @@ Some of the page links in this document and links to other GitLab files do not w
   - [Testing](#testing)
 - [Configuration](./PROPERTIES.md)
 - [Using this Adapter](./CALLS.md)
+  - [Authentication](./AUTH.md)
 - [Additional Information](#additional-information)
   - [Enhancements](./ENHANCE.md)
   - [Contributing](./CONTRIBUTING.md)
@@ -47,17 +48,20 @@ These instructions will help you get a copy of the project on your local machine
 
 ### Helpful Background Information
 
-There is adapter documentation available on the Itential Developer Site <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">HERE</a>. This documentation includes information and examples that are helpful for:
+There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
 
 ```text
 Authentication
-Properties
+IAP Service Instance Configuration
 Code Files
-Action Files
-Schema Files
-Mock Data Files
+Endpoint Configuration (Action & Schema)
+Mock Data
+Adapter Generic Methods
+Headers
+Security
 Linting and Testing
-Troubleshooting
+Build an Adapter
+Troubleshooting an Adapter
 ```
 
 Others will be added over time.

package/adapterBase.js

@@ -1027,6 +1027,24 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.hasEntities(entityType, entityList, callback);
   }
 
+  /**
+   * @summary Determines if this adapter supports any in a list of entities
+   *
+   * @function hasEntitiesAuth
+   * @param {String} entityType - the entity type to check for
+   * @param {Array} entityList - the list of entities we are looking for
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {Callback} callback - A map where the entity is the key and the
+   *                              value is true or false
+   */
+  hasEntitiesAuth(entityType, entityList, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-hasEntitiesAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.hasEntitiesAuth(entityType, entityList, callOptions, callback);
+  }
+
   /**
    * @summary Get Appliance that match the deviceName
    *
@@ -1043,6 +1061,23 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.getDevice(deviceName, callback);
   }
 
+  /**
+   * @summary Get Appliance that match the deviceName
+   *
+   * @function getDeviceAuth
+   * @param {String} deviceName - the deviceName to find (required)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliance) or the error
+   */
+  getDeviceAuth(deviceName, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getDeviceAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDeviceAuth(deviceName, callOptions, callback);
+  }
+
   /**
    * @summary Get Appliances that match the filter
    *
@@ -1059,6 +1094,23 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.getDevicesFiltered(options, callback);
   }
 
+  /**
+   * @summary Get Appliances that match the filter
+   *
+   * @function getDevicesFilteredAuth
+   * @param {Object} options - the data to use to filter the appliances (optional)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliances) or the error
+   */
+  getDevicesFilteredAuth(options, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getDevicesFilteredAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDevicesFilteredAuth(options, callOptions, callback);
+  }
+
   /**
    * @summary Gets the status for the provided appliance
    *
@@ -1075,6 +1127,23 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.isAlive(deviceName, callback);
   }
 
+  /**
+   * @summary Gets the status for the provided appliance
+   *
+   * @function isAliveAuth
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance isAliveAuth) or the error
+   */
+  isAliveAuth(deviceName, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-isAliveAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.isAliveAuth(deviceName, callOptions, callback);
+  }
+
   /**
    * @summary Gets a config for the provided Appliance
    *
@@ -1092,6 +1161,24 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.getConfig(deviceName, format, callback);
   }
 
+  /**
+   * @summary Gets a config for the provided Appliance
+   *
+   * @function getConfigAuth
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {String} format - the desired format of the config. (optional)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance config) or the error
+   */
+  getConfigAuth(deviceName, format, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getConfigAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getConfigAuth(deviceName, format, callOptions, callback);
+  }
+
   /**
    * @summary Gets the device count from the system
    *
@@ -1107,6 +1194,22 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.iapGetDeviceCount(callback);
   }
 
+  /**
+   * @summary Gets the device count from the system
+   *
+   * @function iapGetDeviceCountAuth
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - callback function to return the result
+   *                                    (count) or the error
+   */
+  iapGetDeviceCountAuth(callOptions, callback) {
+    const origin = `${this.id}-adapterBase-iapGetDeviceCountAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.iapGetDeviceCountAuth(callOptions, callback);
+  }
+
   /* ********************************************** */
   /*                                                */
   /*          EXPOSES GENERIC HANDLER               */

package/metadata.json

@@ -1,5 +1,6 @@
 {
   "name": "adapter-gcp_compute",
+  "webName": "Adapter for Integration to Google Cloud Platform Compute",
   "vendor": "Google",
   "product": "Cloud Platform Compute",
   "osVersion": [],
@@ -12,9 +13,8 @@
     "2022.1.x",
     "2023.1.x"
   ],
-  "method": "REST API",
+  "method": "REST",
   "type": "Adapter",
-  "example": "",
   "domains": [
     "Cloud",
     "Inventory"
@@ -22,6 +22,9 @@
   "tags": [
     "Virtual Compute"
   ],
+  "useCases": [
+    "Create Virtual Server"
+  ],
   "deprecated": {
     "isDeprecated": false
   },
@@ -31,6 +34,10 @@
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-gcp_compute",
     "repoLink": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-gcp_compute",
     "docLink": "https://docs.itential.com/opensource/docs/google-cloud-compute",
+    "demoLinks": [
+      "https://www.itential.com/automations/sd-wan-branch-management",
+      "https://www.itential.com/solutions/sdwan-automation-orchestration/"
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
@@ -42,11 +49,14 @@
       "https://cloud.google.com/vision/docs/reference/rest/?apix=true"
     ]
   },
+  "assets": [],
   "relatedItems": {
     "adapters": [
       {
         "name": "adapter-google_drive",
+        "webName": "Adapter for Integration to Google Drive",
         "overview": "This adapter is used to integrate the Itential Automation Platform (IAP) with the Google Drive System.",
+        "isDependency": false,
         "versions": [],
         "repoLink": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-google_drive",
         "docLink": "https://docs.itential.com/opensource/docs/google-drive",
@@ -55,8 +65,8 @@
     ],
     "integrations": [],
     "ecosystemApplications": [],
-    "automations": [],
-    "transformations": [],
-    "useCases": []
+    "workflowProjects": [],
+    "transformationProjects": [],
+    "exampleProjects": []
   }
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-gcp_compute",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "This adapter integrates with system described as: computeEngineApi.",
   "main": "adapter.js",
   "systemName": "Google Cloud Platform Compute",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.5",
+  "engineVersion": "1.67.8",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -56,12 +56,12 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-gcp_compute#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.1.0",
+    "@itentialopensource/adapter-utils": "^5.1.7",
+    "acorn": "^8.10.0",
     "ajv": "^8.12.0",
     "axios": "^1.4.0",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
-    "esprima": "^4.0.1",
     "fs-extra": "^11.1.1",
     "gtoken": "^5.2.1",
     "json-query": "^2.2.2",

package/propertiesSchema.json

@@ -1109,6 +1109,38 @@
                 "description": "The method of the call to getDevicesFiltered",
                 "default": "GET"
               },
+              "pagination": {
+                "type": "object",
+                "description": "todo",
+                "properties": {
+                  "offsetVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines how to go to next set of results"
+                  },
+                  "limitVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines the max results returned in a request"
+                  },
+                  "incrementBy": {
+                    "type": "string",
+                    "enum": [
+                      "limit",
+                      "page"
+                    ],
+                    "description": "How to incremenet offset. Default limit",
+                    "default": "limit"
+                  },
+                  "requestLocation": {
+                    "type": "string",
+                    "enum": [
+                      "query",
+                      "body"
+                    ],
+                    "description": "Where in request the pagination data goes",
+                    "default": "query"
+                  }
+                }
+              },
               "query": {
                 "type": "object",
                 "description": "The json object with query parameters of the call to getDevicesFiltered",
@@ -1533,6 +1565,38 @@
                       "description": "The method of the call to getDevice",
                       "default": "GET"
                     },
+                    "pagination": {
+                      "type": "object",
+                      "description": "todo",
+                      "properties": {
+                        "offsetVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines how to go to next set of results"
+                        },
+                        "limitVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines the max results returned in a request"
+                        },
+                        "incrementBy": {
+                          "type": "string",
+                          "enum": [
+                            "limit",
+                            "page"
+                          ],
+                          "description": "How to incremenet offset. Default limit",
+                          "default": "limit"
+                        },
+                        "requestLocation": {
+                          "type": "string",
+                          "enum": [
+                            "query",
+                            "body"
+                          ],
+                          "description": "Where in request the pagination data goes",
+                          "default": "query"
+                        }
+                      }
+                    },
                     "query": {
                       "type": "object",
                       "description": "The json object with query parameters of the call to getDevice",