@itentialopensource/adapter-viptela 0.10.0 → 0.10.3

package/propertiesSchema.json

@@ -51,6 +51,11 @@
       "description": "When true the path variables are encoded in the url",
       "default": true
     },
+    "encode_queryvars": {
+      "type": "boolean",
+      "description": "When true the query parameters are encoded in the url",
+      "default": true
+    },
     "save_metric": {
       "type": [
         "boolean",
@@ -93,6 +98,9 @@
     },
     "mongo": {
       "$ref": "#/definitions/mongo"
+    },
+    "devicebroker": {
+      "$ref": "#/definitions/devicebroker"
     }
   },
   "required": [
@@ -877,7 +885,10 @@
               },
               "handleFailure": {
                 "type": "string",
-                "enum": ["ignore", "fail"],
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
                 "description": "return failure or ignore failure",
                 "default": "ignore"
               },
@@ -889,6 +900,11 @@
                 },
                 "properties": {}
               },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
               "responseFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to getDevice",
@@ -916,7 +932,7 @@
                     "description": "The field in response to getDevice that contains the port of the device",
                     "default": ""
                   },
-                  "ip": {
+                  "ipaddress": {
                     "type": "string",
                     "description": "The field in response to getDevice that contains the ip address of the device",
                     "default": ""
@@ -964,10 +980,26 @@
               },
               "handleFailure": {
                 "type": "string",
-                "enum": ["ignore", "fail"],
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
                 "description": "return failure or ignore failure",
                 "default": "ignore"
               },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
               "responseFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to getDevicesFiltered",
@@ -990,12 +1022,12 @@
                     "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
                     "default": ""
                   },
-                  "port_field": {
+                  "port": {
                     "type": "string",
                     "description": "The field in response to getDevicesFiltered that contains the port of the device",
                     "default": ""
                   },
-                  "ip_field": {
+                  "ipaddress": {
                     "type": "string",
                     "description": "The field in response to getDevicesFiltered that contains the ip address of the device",
                     "default": ""
@@ -1043,15 +1075,13 @@
               },
               "handleFailure": {
                 "type": "string",
-                "enum": ["ignore", "fail"],
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
                 "description": "return failure or ignore isAlive",
                 "default": "ignore"
               },
-              "statusValue": {
-                "type": "string",
-                "description": "The expected value in the status field",
-                "default": "true"
-              },
               "requestFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to getDevice",
@@ -1060,6 +1090,11 @@
                 },
                 "properties": {}
               },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
               "responseFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to isAlive",
@@ -1071,6 +1106,11 @@
                     "type": "string",
                     "description": "The field in response to isAlive that contains the status of the device",
                     "default": "name"
+                  },
+                  "statusValue": {
+                    "type": "string",
+                    "description": "The expected value in the status field",
+                    "default": "true"
                   }
                 }
               }
@@ -1115,7 +1155,10 @@
               },
               "handleFailure": {
                 "type": "string",
-                "enum": ["ignore", "fail"],
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
                 "description": "return failure or ignore getConfig",
                 "default": "ignore"
               },
@@ -1127,14 +1170,18 @@
                 },
                 "properties": {}
               },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
               "responseFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to getConfig",
                 "additionalProperties": {
                   "type": "string"
                 },
-                "properties": {
-                }
+                "properties": {}
               }
             }
           }
@@ -1177,9 +1224,33 @@
               },
               "handleFailure": {
                 "type": "string",
-                "enum": ["ignore", "fail"],
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
                 "description": "return failure or ignore getCount",
                 "default": "ignore"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
               }
             }
           }

package/report/adapterInfo.json

@@ -0,0 +1,10 @@
+{
+  "version": "0.10.2",
+  "configLines": 20359,
+  "scriptLines": 1707,
+  "codeLines": 45295,
+  "testLines": 27464,
+  "testCases": 1439,
+  "totalCodeLines": 74466,
+  "wfTasks": 570
+}

package/report/updateReport1652490573359.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": 14
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.45.4"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 338
+    },
+    {
+      "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": 11723
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 829
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 17128
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 554
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1783
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 30634
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1383
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -8,7 +8,8 @@
     "version": "",
     "cache_location": "none",
     "encode_pathvars": true,
-    "save_metric": true,
+    "encode_queryvars": true,
+    "save_metric": false,
     "stub": true,
     "protocol": "https",
     "authentication": {
@@ -103,6 +104,87 @@
         "key_file": "",
         "cert_file": ""
       }
+    },
+    "devicebroker": {
+      "getDevice": [
+        {
+          "path": "/get/devices/{id}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/get/devices/{id}/status",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "statusValue": "online",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseFields": {
+            "status": "status"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/get/devices/{id}/configPart1",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore"
+        }
+      ]
     }
   },
   "groups": [],

package/test/integration/adapterTestBasicGet.js

@@ -34,7 +34,7 @@ describe('[integration] Adapter BasicGET Test', () => {
   context('Testing GET calls without query parameters', () => {
     before(async () => {
       const iapDir = path.join(__dirname, '../../../../../');
-      if (!utils.withinIAP(iapDir)) {
+      if (!utils.areWeUnderIAPinstallationDirectory()) {
         const sampleProperties = require('../../sampleProperties.json');
         const adapter = { properties: sampleProperties };
         a = basicGet.getAdapterInstance(adapter);