@itentialopensource/adapter-gcp_compute 1.5.1 → 1.6.0

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 1.6.0 [11-06-2023]
+
+* More migration changes
+
+See merge request itentialopensource/adapters/cloud/adapter-gcp_compute!13
+
+---
+
+## 1.5.2 [09-18-2023]
+
+* Patch/adapt 2852
+
+See merge request itentialopensource/adapters/cloud/adapter-gcp_compute!12
+
+---
+
 ## 1.5.1 [09-11-2023]
 
 * more migration & metadata changes

package/adapter.js

@@ -134,7 +134,8 @@ class GcpCompute extends AdapterBaseCl {
       'refreshAuthorizationHeader',
       'refreshAuthorizationAndIdentifyRequest',
       'getToken',
-      'generateKeyObjFromProps'
+      'generateKeyObjFromProps',
+      'refreshAuthorizationBroker'
     ];
     if (!inIgnore && Array.isArray(inIgnore)) {
       myIgnore = inIgnore;
@@ -442,7 +443,7 @@ class GcpCompute extends AdapterBaseCl {
     log.trace(origin);
 
     try {
-      return super.hasEntities(entityType, entityList, callback);
+      return this.refreshAuthorizationBroker().then(() => super.hasEntities(entityType, entityList, callback));
     } catch (err) {
       log.error(`${origin}: ${err}`);
       return callback(null, err);
@@ -464,7 +465,7 @@ class GcpCompute extends AdapterBaseCl {
     log.trace(origin);
 
     try {
-      return super.getDevice(deviceName, callback);
+      return this.refreshAuthorizationBroker().then(() => super.getDevice(deviceName, callback));
     } catch (err) {
       log.error(`${origin}: ${err}`);
       return callback(null, err);
@@ -484,9 +485,8 @@ class GcpCompute extends AdapterBaseCl {
     const meth = 'adapter-getDevicesFiltered';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
-
     try {
-      return super.getDevicesFiltered(options, callback);
+      return this.refreshAuthorizationBroker().then(() => super.getDevicesFiltered(options, callback));
     } catch (err) {
       log.error(`${origin}: ${err}`);
       return callback(null, err);
@@ -508,7 +508,7 @@ class GcpCompute extends AdapterBaseCl {
     log.trace(origin);
 
     try {
-      return super.isAlive(deviceName, callback);
+      return this.refreshAuthorizationBroker().then(() => super.isAlive(deviceName, callback));
     } catch (err) {
       log.error(`${origin}: ${err}`);
       return callback(null, err);
@@ -531,7 +531,7 @@ class GcpCompute extends AdapterBaseCl {
     log.trace(origin);
 
     try {
-      return super.getConfig(deviceName, format, callback);
+      return this.refreshAuthorizationBroker().then(() => super.getConfig(deviceName, format, callback));
     } catch (err) {
       log.error(`${origin}: ${err}`);
       return callback(null, err);
@@ -552,7 +552,7 @@ class GcpCompute extends AdapterBaseCl {
     log.trace(origin);
 
     try {
-      return super.iapGetDeviceCount(callback);
+      return this.refreshAuthorizationBroker().then(() => super.iapGetDeviceCount(callback));
     } catch (err) {
       log.error(`${origin}: ${err}`);
       return callback(null, err);
@@ -845,6 +845,19 @@ class GcpCompute extends AdapterBaseCl {
     }
   }
 
+  async refreshAuthorizationBroker() {
+    const meth = 'adapter-refreshAuthorizationBroker';
+    const origin = `${this.id}-${meth}`;
+    try {
+      const token = await this.gtoken.getToken();
+      this.refreshAuthorizationHeader(token);
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString} ${ex.message}`);
+      throw new Error(errorObj);
+    }
+  }
+
   /**
    * configureGtoken accepts the options for the gtoken library documented in the website below,
    * plus keyFileContents in order to facilitate convenient retrieval from Hashicorp Vault

package/metadata.json

@@ -23,7 +23,14 @@
     "Virtual Compute"
   ],
   "useCases": [
-    "Create Virtual Server"
+    "Add or remove Virtual Machine Images",
+    "Instantiate, manage, remove Virtual Machine Instances",
+    "Deploy Virtual Services and Functions",
+    "Determine available Cloud Resources",
+    "Assign resources to Virtual Machine Instances",
+    "Add or remove Virtual Networks",
+    "Management of Cloud Network Assignments",
+    "Management of Cloud Storage"
   ],
   "deprecated": {
     "isDeprecated": false
@@ -35,7 +42,7 @@
     "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/automations/sd-wan-branch-management/",
       "https://www.itential.com/solutions/sdwan-automation-orchestration/"
     ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-gcp_compute",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "This adapter integrates with system described as: computeEngineApi.",
   "main": "adapter.js",
   "systemName": "Google Cloud Platform Compute",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.8",
+  "engineVersion": "1.67.10",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -56,7 +56,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-gcp_compute#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.1.7",
+    "@itentialopensource/adapter-utils": "^5.3.0",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
     "axios": "^1.4.0",

package/propertiesSchema.json

@@ -109,6 +109,14 @@
     },
     "cache": {
       "$ref": "#/definitions/cache"
+    },
+    "service": {
+      "type": "string",
+      "description": "Service we are integrating with -- used with AWS Authentication",
+      "examples": [
+        "ec2",
+        "route53"
+      ]
     }
   },
   "required": [
@@ -131,7 +139,8 @@
             "jwt_token",
             "request_token",
             "no_authentication",
-            "multi_step_authentication"
+            "multi_step_authentication",
+            "aws_authentication"
           ]
         },
         "username": {

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "1.5.0",
-  "configLines": 77484,
+  "version": "1.5.2",
+  "configLines": 77493,
   "scriptLines": 1783,
-  "codeLines": 57378,
+  "codeLines": 57391,
   "testLines": 61729,
   "testCases": 2510,
-  "totalCodeLines": 120890,
+  "totalCodeLines": 120903,
   "wfTasks": 583
 }

package/report/updateReport1698420667915.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.3.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 78
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 347
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 29172
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1865
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 31305
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 567
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 61930
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 2432
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/utils/methodDocumentor.js

@@ -77,6 +77,7 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
   // parsing the file to get the function and class declarations.
   const aFileFuncArgs = acorn.parse(aFile, { ecmaVersion: 2020 });
 
+  let callName = 'identifyRequest';
   // Looping through all the declarations parsed:
   aFileFuncArgs.body.forEach((e) => {
     // Getting only the class declaration as it has our required functions.
@@ -89,8 +90,10 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         method.value.params.forEach((param) => {
           if (param.type === 'Identifier') {
             funcArgs.push(param.name);
+          } else if (param.type === 'RestElement') {
+            funcArgs.push(`...${param.argument.name}`);
           } else {
-            const args = `${param.left.name} = ${param.right.value}`;
+            const args = `${param.left.name} = ${param.right.raw}`;
             funcArgs.push(args);
           }
         });
@@ -102,7 +105,7 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         });
         const requests = [];
         for (let i = 0; i < callList.length; i += 1) {
-          if (callList[i].callee.property && callList[i].callee.property.name === 'identifyRequest') {
+          if (callList[i].callee.property && callList[i].callee.property.name === callName) {
             requests.push(callList[i]);
           }
         }
@@ -114,7 +117,16 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
           const entity = expr.arguments[0].value;
           const actionName = expr.arguments[1].value;
           if (expr !== undefined && (expr.arguments[0].type !== 'Literal' || expr.arguments[1].type !== 'Literal')) {
-            throw new Error(`Bad inputs in method ${funcName}`);
+            const param1 = method.value.params[0];
+            const param2 = method.value.params[1];
+            if (param1.type !== 'Identifier' || param2.type !== 'Identifier'
+                || expr.arguments[0].type !== 'Identifier' || expr.arguments[1].type !== 'Identifier'
+                || param1.name !== expr.arguments[0].name || param2.name !== expr.arguments[1].name) {
+              throw new Error(`identifyRequest proxy method ${funcName} unknown format`);
+            } else if (callName !== 'identifyRequest') {
+              throw new Error(`MethodDocumentor not yet programmed to handle multiple helper methods: 1) ${callName}, 2) ${funcName}`);
+            }
+            callName = funcName;
           }
           const entityPath = getPathFromEntity(entity, actionName);
 
@@ -197,6 +209,7 @@ function readMDFile(filename, functionList) {
   // Creating the tags for each method to be appended to the file.
   const tdBeginTag = '    <td style="padding:15px">';
   const tdEndTag = '</td>';
+
   functionList.forEach((func) => {
     const signCommand = `${tdBeginTag}${func.method_signature}${tdEndTag}`;
     const descCommand = `${tdBeginTag}${func.description}${tdEndTag}`;