@itentialopensource/adapter-alkira 0.3.1 → 0.4.0

package/CALLS.md

@@ -983,7 +983,7 @@ Specific adapter calls are built based on the API of the Alkira. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">listofallproducts(type = CXP, category = INFRA, size = SMALL, provider = CISCO, callback)</td>
+    <td style="padding:15px">listofallproducts(type = 'CXP', category = 'INFRA', size = 'SMALL', provider = 'CISCO', callback)</td>
     <td style="padding:15px">List of all products</td>
     <td style="padding:15px">{base_path}/{version}/inventory/products?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -995,13 +995,13 @@ Specific adapter calls are built based on the API of the Alkira. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getResourceUsage(category = UNKNOWN, type = UNKNOWN, scope = UNKNOWN, callback)</td>
+    <td style="padding:15px">getResourceUsage(category = 'UNKNOWN', type = 'UNKNOWN', scope = 'UNKNOWN', callback)</td>
     <td style="padding:15px">getResourceUsage</td>
     <td style="padding:15px">{base_path}/{version}/resourceusage?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getCXPs(name, state = AVAILABLE, callback)</td>
+    <td style="padding:15px">getCXPs(name, state = 'AVAILABLE', callback)</td>
     <td style="padding:15px">getCXPs</td>
     <td style="padding:15px">{base_path}/{version}/inventory/cxps?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -1295,7 +1295,7 @@ Specific adapter calls are built based on the API of the Alkira. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getCloudProviderObjects(offset, limit, cloudProvider = AWS, cloudProviderObjectNativeId, cloudProviderAccountId, cloudProviderObjectType, search, sortBy, callback)</td>
+    <td style="padding:15px">getCloudProviderObjects(offset, limit, cloudProvider = 'AWS', cloudProviderObjectNativeId, cloudProviderAccountId, cloudProviderObjectType, search, sortBy, callback)</td>
     <td style="padding:15px">getCloudProviderObjects</td>
     <td style="padding:15px">{base_path}/{version}/cloud-provider-objects?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -1349,7 +1349,7 @@ Specific adapter calls are built based on the API of the Alkira. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getCloudInsights(offset, limit, cloudProvider = AWS, type = AWS_EIP_UNASSOCIATED, types, category = SECURITY, severity = HIGH, cloudProviderAccountId, expanded, callback)</td>
+    <td style="padding:15px">getCloudInsights(offset, limit, cloudProvider = 'AWS', type = 'AWS_EIP_UNASSOCIATED', types, category = 'SECURITY', severity = 'HIGH', cloudProviderAccountId, expanded, callback)</td>
     <td style="padding:15px">getCloudInsights</td>
     <td style="padding:15px">{base_path}/{version}/cloud-insights?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -1373,13 +1373,13 @@ Specific adapter calls are built based on the API of the Alkira. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getCloudInsightCategorySummaries(cloudProvider = AWS, cloudProviderAccountId, callback)</td>
+    <td style="padding:15px">getCloudInsightCategorySummaries(cloudProvider = 'AWS', cloudProviderAccountId, callback)</td>
     <td style="padding:15px">getCloudInsightCategorySummaries</td>
     <td style="padding:15px">{base_path}/{version}/cloud-insights-summary?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getCloudInsightRefreshRequests(offset, limit, state = PENDING, callback)</td>
+    <td style="padding:15px">getCloudInsightRefreshRequests(offset, limit, state = 'PENDING', callback)</td>
     <td style="padding:15px">getCloudInsightRefreshRequests</td>
     <td style="padding:15px">{base_path}/{version}/cloud-insight-refresh-requests?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -1403,7 +1403,7 @@ Specific adapter calls are built based on the API of the Alkira. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getCloudInsightDefinitions(offset, limit, cloudProvider = AWS, type = AWS_EIP_UNASSOCIATED, category = SECURITY, severity = HIGH, callback)</td>
+    <td style="padding:15px">getCloudInsightDefinitions(offset, limit, cloudProvider = 'AWS', type = 'AWS_EIP_UNASSOCIATED', category = 'SECURITY', severity = 'HIGH', callback)</td>
     <td style="padding:15px">getCloudInsightDefinitions</td>
     <td style="padding:15px">{base_path}/{version}/cloud-insight-definitions?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -1421,7 +1421,7 @@ Specific adapter calls are built based on the API of the Alkira. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getCloudInsightDefinitionSummaries(offset, limit, cloudProvider = AWS, type = AWS_EIP_UNASSOCIATED, category = SECURITY, severity = HIGH, callback)</td>
+    <td style="padding:15px">getCloudInsightDefinitionSummaries(offset, limit, cloudProvider = 'AWS', type = 'AWS_EIP_UNASSOCIATED', category = 'SECURITY', severity = 'HIGH', callback)</td>
     <td style="padding:15px">getCloudInsightDefinitionSummaries</td>
     <td style="padding:15px">{base_path}/{version}/cloud-insight-definitions-summary?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -2537,7 +2537,7 @@ Specific adapter calls are built based on the API of the Alkira. The Adapter Bui
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getRoutes(tenantNetworkId, type = received, cxp, segmentName, segmentId, connectorId, search, lpmPrefix, prefixType, offset, limit, callback)</td>
+    <td style="padding:15px">getRoutes(tenantNetworkId, type = 'received', cxp, segmentName, segmentId, connectorId, search, lpmPrefix, prefixType, offset, limit, callback)</td>
     <td style="padding:15px">getRoutes</td>
     <td style="padding:15px">{base_path}/{version}/tenantnetworks/{pathv1}/routes?{query}</td>
     <td style="padding:15px">Yes</td>

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.4.0 [11-06-2023]
+
+* More migration changes
+
+See merge request itentialopensource/adapters/cloud/adapter-alkira!8
+
+---
+
 ## 0.3.1 [09-12-2023]
 
 * more migration & metadata changes

package/metadata.json

@@ -22,7 +22,9 @@
     "Cloud Networking"
   ],
   "useCases": [
-    "Create Hybrid Cloud Connections"
+    "Add or remove Virtual Networks",
+    "Management of Cloud Network Assignments",
+    "Create, update, manage or remove Hybrid Cloud Connections"
   ],
   "deprecated": {
     "isDeprecated": false

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-alkira",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "This adapter integrates with system described as: alkiraApi.",
   "main": "adapter.js",
   "systemName": "Alkira",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.8",
+  "engineVersion": "1.67.10",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -54,7 +54,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-alkira#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,6 +1,6 @@
 {
-  "version": "0.3.0",
-  "configLines": 46947,
+  "version": "0.3.1",
+  "configLines": 46956,
   "scriptLines": 1783,
   "codeLines": 40401,
   "testLines": 33109,

package/report/updateReport1698420400445.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": 77
+    },
+    {
+      "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": 19318
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1245
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 12539
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 449
+    },
+    {
+      "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": 33310
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1694
+    },
+    {
+      "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}`;