@itentialopensource/adapter-kentik_v5 0.3.3 → 0.3.5

package/compliance-report.json

@@ -0,0 +1,9 @@
+{
+  "ComplianceEntries": [
+    {
+      "name": "Compliance Summary",
+      "numInvalidProjects": 0,
+      "numValidProjects": 0
+    }
+  ]
+}

package/compliance-report.txt

@@ -0,0 +1,5 @@
+---------------------------------------------------------------------------------------------
+**** Project Compliance Summary ****
+0 project(s) are not valid
+0 project(s) are valid
+---------------------------------------------------------------------------------------------

package/metadata.json

@@ -2,7 +2,7 @@
   "name": "adapter-kentik_v5",
   "webName": "Adapter for Integration to Kentik API v5",
   "vendor": "Kentik",
-  "product": "API v5",
+  "product": "Kentik",
   "osVersion": [],
   "apiVersions": [
     "v5"
@@ -29,34 +29,81 @@
     "isDeprecated": false
   },
   "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "API Key",
+      "primary": true
+    }
+  ],
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-kentik_v5",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/observability/adapter-kentik_v5",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-kentik_v5",
     "docLink": "",
-    "demoLinks": [],
-    "trainingLinks": [],
+    "demoLinks": [
+      {
+        "title": "Itential + Kentik: Integrated Network Observability & Automation",
+        "link": "https://www.itential.com/resource/demo/itential-kentik-integrated-network-observability-automation/"
+      },
+      {
+        "title": "Itential + Kentik: Integrating Observability with Automation for Closed-Loop Remediation of Infrastructure Events",
+        "link": "https://www.itential.com/blog/company/hybrid-cloud-automation/itential-kentik-integrating-observability-with-automation-for-closed-loop-remediation-of-infrastructure-events/"
+      }
+    ],
+    "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/kentik-api-version-5/",
-    "vendorLink": "",
-    "productLink": "",
-    "apiLinks": []
+    "vendorLink": "https://www.kentik.com/",
+    "productLink": "https://www.kentik.com/",
+    "apiLinks": [
+      {
+        "title": "Kentik APIs",
+        "link": "https://kb.kentik.com/v0/Ab09.htm",
+        "public": true
+      }
+    ]
   },
   "assets": [],
   "relatedItems": {
     "adapters": [],
     "integrations": [],
     "ecosystemApplications": [],
-    "workflowProjects": [],
+    "workflowProjects": [
+      {
+        "name": "Kentik - REST",
+        "webName": "Kentik - Device Management",
+        "overview": "The integration of Itential and Kentik enables network teams to build automations that can immediately respond to events and alarms generated by the Kentik observability platform. In addition, Itential also offers a package of Pre-Built Automations to implement multiple use cases with the integration. The Kentik - REST Pre-Built provides automations that help Network Engineers automate common tasks performed in the Kentik platform. This Pre-Built contains multiple automations including:\n\n- Create a Device in Kentik - With this automation, users can create a device for a specific site and provide the device record as output.\n- Run Device Flow Test - With this automation, users can run a device flow test for a specific device, providing the results of the test as output.",
+        "isDependency": false,
+        "versions": [
+          "^1.0.9"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/kentik-rest",
+        "docLink": "",
+        "webLink": "https://www.itential.com/automations/kentik-device-management/"
+      }
+    ],
     "transformationProjects": [],
-    "exampleProjects": []
+    "exampleProjects": [
+      {
+        "name": "Kentik - REST - Example",
+        "webName": "Kentik - Example Use Case Bundle",
+        "overview": "This contains several example use cases that are applicable when the Itential Automation Platform is integrated with the Kentik Platform. Because every environment is different, these use cases are fully functioning examples that can be modified to operate in your IT ecosystem. These workflows have been written with modularity in mind to make them easy to understand and simple to modify to suit your needs.",
+        "isDependency": false,
+        "versions": [
+          "1.1.10"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/kentik-rest-example",
+        "docLink": "",
+        "webLink": "https://www.itential.com/automations/kentik-example-use-case-bundle/"
+      }
+    ]
   },
-  "authMethods": [
-    {
-      "type": "API Key",
-      "primary": true
-    }
-  ]
+  "supportLevel": "community"
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-kentik_v5",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "This adapter integrates with system described as: kentikV5Api.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.14",
+  "engineVersion": "1.67.20",
   "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",
@@ -43,33 +42,32 @@
   ],
   "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/observability/adapter-kentik_v5.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-kentik_v5.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/observability/adapter-kentik_v5#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-kentik_v5#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.3.10",
-    "acorn": "^8.10.0",
-    "ajv": "^8.12.0",
-    "axios": "^1.6.8",
+    "@itentialopensource/adapter-utils": "^5.6.0",
+    "acorn": "^8.12.1",
+    "ajv": "^8.17.1",
+    "axios": "^1.7.2",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
-    "fs-extra": "^11.1.1",
+    "fs-extra": "^11.2.0",
     "json-query": "^2.2.2",
-    "mocha": "^10.3.0",
+    "mocha": "^10.7.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",
-    "semver": "^7.5.3",
-    "winston": "^3.9.0"
+    "semver": "^7.6.3",
+    "winston": "^3.13.1"
   },
   "devDependencies": {
     "chai": "^4.3.7",

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.0",
-  "configLines": 8395,
+  "version": "0.3.3",
+  "configLines": 8400,
   "scriptLines": 1783,
   "codeLines": 7198,
-  "testLines": 7378,
+  "testLines": 7377,
   "testCases": 352,
-  "totalCodeLines": 16359,
+  "totalCodeLines": 16358,
   "wfTasks": 85
 }

package/report/updateReport1719238796757.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.5.0"
+    },
+    {
+      "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": 3672
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 213
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 2453
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 69
+    },
+    {
+      "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": 7578
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 282
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -124,30 +124,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": "",
@@ -162,42 +164,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": {}
@@ -205,7 +209,7 @@
       ],
       "getCount": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
@@ -221,15 +225,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": "",
@@ -243,7 +247,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] Kentik_v5 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);
@@ -315,17 +314,16 @@ describe('[unit] Kentik_v5 Adapter Test', () => {
           assert.notEqual(undefined, packageDotJson.dependencies);
           assert.notEqual(null, packageDotJson.dependencies);
           assert.notEqual('', packageDotJson.dependencies);
-          assert.equal('^8.12.0', packageDotJson.dependencies.ajv);
-          assert.equal('^1.6.8', packageDotJson.dependencies.axios);
+          assert.equal('^8.17.1', packageDotJson.dependencies.ajv);
+          assert.equal('^1.7.2', packageDotJson.dependencies.axios);
           assert.equal('^11.0.0', packageDotJson.dependencies.commander);
-          assert.equal('^11.1.1', packageDotJson.dependencies['fs-extra']);
-          assert.equal('^10.3.0', packageDotJson.dependencies.mocha);
+          assert.equal('^11.2.0', packageDotJson.dependencies['fs-extra']);
+          assert.equal('^10.7.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);
-          assert.equal('^3.9.0', packageDotJson.dependencies.winston);
+          assert.equal('^7.6.3', packageDotJson.dependencies.semver);
+          assert.equal('^3.13.1', packageDotJson.dependencies.winston);
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -563,7 +561,7 @@ describe('[unit] Kentik_v5 Adapter Test', () => {
           log.error(`Adapter Exception: ${error}`);
           done(error);
         }
-      });
+      }).timeout(attemptTimeout);
     });
 
     describe('propertiesSchema.json', () => {