@itentialopensource/adapter-aruba_airwave 0.3.4 → 0.4.0

package/metadata.json

@@ -1,8 +1,8 @@
 {
   "name": "adapter-aruba_airwave",
-  "webName": "Adapter for Integration to Aruba Airwave",
+  "webName": "Adapter for Integration to Aruba AirWave",
   "vendor": "Aruba Networks",
-  "product": "Airwave",
+  "product": "AirWave",
   "osVersion": [],
   "apiVersions": [],
   "iapVersions": [
@@ -39,20 +39,41 @@
     "isDeprecated": false
   },
   "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "Complex",
+      "subtypes": [
+        "Cookie",
+        "Token"
+      ],
+      "primary": true
+    }
+  ],
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-aruba_airwave",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/controller-orchestrator/adapter-aruba_airwave",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-aruba_airwave",
     "docLink": "https://docs.itential.com/opensource/docs/aruba-airwave",
     "demoLinks": [],
-    "trainingLinks": [],
+    "trainingLinks": [
+      {
+        "title": "Itential Academy",
+        "link": "https://www.itential.com/itential-academy/"
+      }
+    ],
     "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",
     "webLink": "https://www.itential.com/adapters/aruba-airwave/",
-    "vendorLink": "",
-    "productLink": "",
-    "apiLinks": []
+    "vendorLink": "https://www.arubanetworks.com/",
+    "productLink": "https://www.arubanetworks.com/products/network-management-operations/airwave/",
+    "apiLinks": [
+      {
+        "title": "AirWave API Guide",
+        "link": "https://www.arubanetworks.com/techdocs/AirWave/82130/Content/API%20Guide/API%20Guide.htm",
+        "public": true
+      }
+    ]
   },
   "assets": [],
   "relatedItems": {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-aruba_airwave",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "This adapter integrates with system described as: Aruba Airwave",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.14",
+  "engineVersion": "1.67.19",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -15,7 +15,6 @@
     "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
-    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
     "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
@@ -44,15 +43,15 @@
   ],
   "license": "Apache-2.0",
   "engines": {
-    "node": ">= 8.0.0",
+    "node": ">= 14.0.0",
     "npm": ">= 6.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:itentialopensource/adapters/controller-orchestrator/adapter-aruba_airwave.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-aruba_airwave.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/controller-orchestrator/adapter-aruba_airwave#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-aruba_airwave#readme",
   "dependencies": {
     "@itentialopensource/adapter-utils": "^5.3.10",
     "acorn": "^8.10.0",
@@ -65,7 +64,6 @@
     "mocha": "^10.3.0",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.16.0",
-    "nyc": "^15.1.0",
     "ping": "^0.4.4",
     "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",

package/propertiesSchema.json

@@ -945,6 +945,11 @@
     "devicebroker": {
       "type": "object",
       "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether or not the device broker calls have been mapped",
+          "default": false
+        },
         "getDevice": {
           "type": "array",
           "description": "Broker call(s) to getDevice",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.2.1",
-  "configLines": 4215,
+  "version": "0.3.4",
+  "configLines": 4220,
   "scriptLines": 1783,
   "codeLines": 4651,
-  "testLines": 4610,
+  "testLines": 4609,
   "testCases": 221,
-  "totalCodeLines": 11044,
+  "totalCodeLines": 11043,
   "wfTasks": 55
 }

package/report/updateReport1717076081701.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": 16
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 21
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.3.10"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 78
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 344
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 647
+    },
+    {
+      "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": 2171
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 115
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 1186
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 36
+    },
+    {
+      "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": 4810
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 151
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -14,15 +14,21 @@
     "stub": true,
     "protocol": "https",
     "authentication": {
-      "auth_method": "no_authentication",
+      "auth_method": "request_token",
       "username": "username",
       "password": "password",
       "token": "token",
       "token_timeout": 600000,
       "token_cache": "local",
       "invalid_token_error": 401,
-      "auth_field": "header.headers.Authorization",
-      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+      "auth_field": [
+        "header.headers.X-BISCOTTI",
+        "header.headers.Cookie"
+      ],
+      "auth_field_format": [
+        "{token}",
+        "MercuryAuthHandlerCookie_AMPAuth={tokenp2}"
+      ],
       "auth_logging": false,
       "client_id": "",
       "client_secret": "",
@@ -116,30 +122,32 @@
       }
     },
     "devicebroker": {
+      "enabled": false,
       "getDevice": [
         {
-          "path": "/get/devices/{id}",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "insample": "{port}"
           },
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial" : "{serial}"
           }
         }
       ],
       "getDevicesFiltered": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "pagination": {
             "offsetVar": "",
@@ -154,42 +162,44 @@
           "requestFields": {},
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial" : "{serial}",
+            "id": "{myid}"
           }
         }
       ],
       "isAlive": [
         {
-          "path": "/get/devices/{id}/status",
+          "path": "/not/mapped/{devID}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "devID": "{id}"
           },
           "responseDatakey": "",
           "responseFields": {
-            "status": "status",
-            "statusValue": "online"
+            "status": "return2xx",
+            "statusValue": "AD.200"
           }
         }
       ],
       "getConfig": [
         {
-          "path": "/get/devices/{id}/configPart1",
+          "path": "/not/mapped/{devID}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "devID": "{id}"
           },
           "responseDatakey": "",
           "responseFields": {}
@@ -197,7 +207,7 @@
       ],
       "getCount": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
@@ -213,15 +223,15 @@
       "enabled": false,
       "entities": [
         {
-          "entityType": "",
-          "frequency": 1440,
+          "entityType": "device",
+          "frequency": 3600,
           "flushOnFail": false,
-          "limit": 1000,
+          "limit": 10000,
           "retryAttempts": 5,
           "sort": true,
           "populate": [
             {
-              "path": "",
+              "path": "/not/mapped",
               "method": "GET",
               "pagination": {
                 "offsetVar": "",
@@ -235,7 +245,15 @@
               "handleFailure": "ignore",
               "requestFields": {},
               "responseDatakey": "",
-              "responseFields": {}
+              "responseFields": {
+                "name": "{this}{||}{that}",
+                "ostype": "{osfield}",
+                "ostypePrefix": "meraki-",
+                "port": "{port}",
+                "ipaddress": "{ip_addr}",
+                "serial" : "{serial}",
+                "id": "{myid}"
+              }
             }
           ],
           "cachedTasks": [

package/test/integration/adapterTestIntegration.js

@@ -46,6 +46,7 @@ samProps.ssl.accept_invalid_cert = false;
 if (samProps.request.attempt_timeout < 30000) {
   samProps.request.attempt_timeout = 30000;
 }
+samProps.devicebroker.enabled = true;
 const attemptTimeout = samProps.request.attempt_timeout;
 const { stub } = samProps;
 

package/test/unit/adapterTestUnit.js

@@ -284,7 +284,6 @@ describe('[unit] Aruba_airwave Adapter Test', () => {
           assert.equal('mocha test/unit/adapterBaseTestUnit.js --LOG=error', packageDotJson.scripts['test:baseunit']);
           assert.equal('mocha test/unit/adapterTestUnit.js --LOG=error', packageDotJson.scripts['test:unit']);
           assert.equal('mocha test/integration/adapterTestIntegration.js --LOG=error', packageDotJson.scripts['test:integration']);
-          assert.equal('nyc --reporter html --reporter text mocha --reporter dot test/*', packageDotJson.scripts['test:cover']);
           assert.equal('npm run test:baseunit && npm run test:unit && npm run test:integration', packageDotJson.scripts.test);
           assert.equal('npm publish --registry=https://registry.npmjs.org --access=public', packageDotJson.scripts.deploy);
           assert.equal('npm run deploy', packageDotJson.scripts.build);
@@ -321,7 +320,6 @@ describe('[unit] Aruba_airwave Adapter Test', () => {
           assert.equal('^11.1.1', packageDotJson.dependencies['fs-extra']);
           assert.equal('^10.3.0', packageDotJson.dependencies.mocha);
           assert.equal('^2.0.1', packageDotJson.dependencies['mocha-param']);
-          assert.equal('^15.1.0', packageDotJson.dependencies.nyc);
           assert.equal('^0.4.4', packageDotJson.dependencies.ping);
           assert.equal('^1.4.10', packageDotJson.dependencies['readline-sync']);
           assert.equal('^7.5.3', packageDotJson.dependencies.semver);