@itentialopensource/adapter-nokia_altiplano 0.7.2 → 0.7.4

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.7.4 [10-14-2024]
+
+* Add config for refresh token
+
+See merge request itentialopensource/adapters/adapter-nokia_altiplano!19
+
+---
+
+## 0.7.3 [09-13-2024]
+
+* add workshop and fix vulnerabilities
+
+See merge request itentialopensource/adapters/adapter-nokia_altiplano!16
+
+---
+
 ## 0.7.2 [08-14-2024]
 
 * Changes made at 2024.08.14_18:37PM

package/TAB2.md

@@ -54,7 +54,7 @@ Sample Properties can be used to help you configure the adapter in the Itential
     "host": "localhost",
     "port": 443,
     "choosepath": "",
-    "base_path": "/rest",
+    "base_path": "/nokia-altiplano-ac/rest",
     "version": "",
     "cache_location": "none",
     "encode_pathvars": false,
@@ -89,7 +89,14 @@ Sample Properties can be used to help you configure the adapter in the Itential
           "responseFields": {},
           "successfullResponseCode": 200
         }
-      ]
+      ],
+      "refresh_token_request": {
+        "requestFields": {},
+        "refresh_token": {
+          "placement": "body",
+          "token_timeout": 86400000
+        }
+      }
     },
     "healthcheck": {
       "type": "none",

package/entities/.system/action.json

@@ -29,6 +29,31 @@
         }
       ]
     },
+    {
+      "name": "getRefreshToken",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/auth/refreshAccessToken",
+      "requestSchema": "refreshTokenRequest.json",
+      "responseSchema": "schemaTokenResp.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getRefreshToken-default.json"
+        }
+      ]
+    },
     {
       "name": "healthcheck",
       "protocol": "REST",

package/entities/.system/mockdatafiles/getRefreshToken-default.json

@@ -0,0 +1,6 @@
+{
+  "refreshToken":"refreshtoken1",
+  "token_type":"bearer",
+  "accessToken":"accesstoken1",
+  "expires_in":7200
+}

package/entities/.system/refreshTokenRequest.json

@@ -0,0 +1,30 @@
+{
+  "$id": "refreshTokenRequest.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": false,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "getRefreshToken",
+      "enum": [
+        "getRefreshToken"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "refreshToken": {
+      "type": "string",
+      "description": "refresh token",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "refresh_token"
+    }
+  },
+  "definitions": {}
+}

package/entities/.system/schemaTokenResp.json

@@ -10,7 +10,8 @@
       "description": "type of request (internal to adapter)",
       "default": "getToken",
       "enum": [
-        "getToken"
+        "getToken",
+        "getRefreshToken"
       ],
       "external_name": "ph_request_type"
     },
@@ -47,6 +48,18 @@
         "key": ""
       },
       "external_name": "accessToken"
+    },
+    "refreshToken": {
+      "type": "string",
+      "description": "refresh token returned by system",
+      "parse": false,
+      "encode": false,
+      "placement": "BODY",
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "refreshToken"
     }
   },
   "definitions": {}

package/metadata.json

@@ -1,8 +1,10 @@
 {
   "name": "adapter-nokia_altiplano",
   "webName": "Adapter for Integration to  Nokia Altiplano",
+  "supportLevel": "community",
   "vendor": "Nokia",
   "product": "Altiplano",
+  "techAlliance": false,
   "osVersion": [],
   "apiVersions": [],
   "iapVersions": [
@@ -29,7 +31,7 @@
     "Determine configuration drift",
     "Golden Configuration",
     "Port/VLAN Configuration",
-    "EVPN & VXLA",
+    "EVPN & VXLAN",
     "Port Turn-up",
     "Assign Network & IP",
     "Cloud Managed Networks",
@@ -49,7 +51,7 @@
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-nokia_altiplano",
     "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-nokia_altiplano",
-    "docLink": "https://docs.itential.com/opensource/docs/nokia-altiplano",
+    "docLink": "https://gitlab.com/itentialopensource/adapters/adapter-nokia_altiplano/-/blob/master/README.md?ref_type=heads",
     "demoLinks": [],
     "trainingLinks": [
       {
@@ -81,7 +83,5 @@
     "workflowProjects": [],
     "transformationProjects": [],
     "exampleProjects": []
-  },
-  "supportLevel": "community",
-  "techAlliance": false
+  }
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-nokia_altiplano",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "description": "This adapter integrates with system described as: Nokia Altiplano.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.19",
+  "engineVersion": "1.68.2",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -54,7 +54,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-nokia_altiplano#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.6.0",
+    "@itentialopensource/adapter-utils": "^5.9.4",
     "acorn": "^8.12.1",
     "ajv": "^8.17.1",
     "axios": "^1.7.4",
@@ -69,7 +69,7 @@
     "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",
     "semver": "^7.6.3",
-    "winston": "^3.13.1"
+    "winston": "^3.14.2"
   },
   "devDependencies": {
     "chai": "^4.3.7",

package/propertiesSchema.json

@@ -341,6 +341,29 @@
               }
             }
           }
+        },
+        "refresh_token_request": {
+          "type": "object",
+          "properties": {
+            "requestFields": {
+              "type": "object",
+              "description": "Params used in the refresh token call"
+            },
+            "refresh_token": {
+              "type": "object",
+              "description": "Refresh token fields",
+              "properties": {
+                "placement": {
+                  "type": "string",
+                  "description": "Where to place refresh token"
+                },
+                "token_timeout": {
+                  "type": "integer",
+                  "description": "How long a token is valid (in milliseconds)"
+                }
+              }
+            }
+          }
         }
       },
       "required": [

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.6.3",
-  "configLines": 4352,
+  "version": "0.7.3",
+  "configLines": 4375,
   "scriptLines": 1783,
   "codeLines": 4202,
-  "testLines": 4740,
-  "testCases": 228,
-  "totalCodeLines": 10725,
+  "testLines": 4724,
+  "testCases": 227,
+  "totalCodeLines": 10709,
   "wfTasks": 49
 }

package/sampleProperties.json

@@ -5,7 +5,7 @@
     "host": "localhost",
     "port": 443,
     "choosepath": "",
-    "base_path": "/rest",
+    "base_path": "/nokia-altiplano-ac/rest",
     "version": "",
     "cache_location": "none",
     "encode_pathvars": false,
@@ -40,7 +40,14 @@
           "responseFields": {},
           "successfullResponseCode": 200
         }
-      ]
+      ],
+      "refresh_token_request": {
+        "requestFields": {},
+        "refresh_token": {
+          "placement": "body",
+          "token_timeout": 86400000
+        }
+      }
     },
     "healthcheck": {
       "type": "none",
@@ -135,7 +142,7 @@
             "ostypePrefix": "meraki-",
             "port": "{port}",
             "ipaddress": "{ip_addr}",
-            "serial" : "{serial}"
+            "serial": "{serial}"
           }
         }
       ],
@@ -161,7 +168,7 @@
             "ostypePrefix": "meraki-",
             "port": "{port}",
             "ipaddress": "{ip_addr}",
-            "serial" : "{serial}",
+            "serial": "{serial}",
             "id": "{myid}"
           }
         }
@@ -245,7 +252,7 @@
                 "ostypePrefix": "meraki-",
                 "port": "{port}",
                 "ipaddress": "{ip_addr}",
-                "serial" : "{serial}",
+                "serial": "{serial}",
                 "id": "{myid}"
               }
             }

package/test/integration/adapterTestConnectivity.js

@@ -4,7 +4,6 @@
 /* eslint no-unused-vars: warn */
 
 const assert = require('assert');
-const http = require('http');
 const https = require('https');
 const mocha = require('mocha');
 const ping = require('ping');
@@ -53,29 +52,6 @@ describe('[integration] Adapter Test', () => {
         });
     });
 
-    it('Support HTTP on port 80', (done) => {
-      const requestOptions = {
-        host,
-        port: 80,
-        method: 'HEAD'
-      };
-
-      const req = http.request(requestOptions, (res) => {
-        try {
-          assert.ok(res.statusCode >= 200 && res.statusCode < 400);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
-
-      req.on('error', (err) => {
-        done(err);
-      });
-
-      req.end();
-    });
-
     it('Support HTTPS on port 443', (done) => {
       const requestOptions = {
         host,

package/test/integration/adapterTestIntegration.js

@@ -36,13 +36,17 @@ const samProps = require(`${adaptdir}/sampleProperties.json`).properties;
 // these variables can be changed to run in integrated mode so easier to set them here
 // always check these in with bogus data!!!
 samProps.stub = true;
-samProps.host = 'replace.hostorip.here';
-samProps.authentication.username = 'username';
-samProps.authentication.password = 'password';
-samProps.protocol = 'http';
-samProps.port = 80;
-samProps.ssl.enabled = false;
-samProps.ssl.accept_invalid_cert = false;
+
+// uncomment if connecting
+// samProps.host = 'replace.hostorip.here';
+// samProps.authentication.username = 'username';
+// samProps.authentication.password = 'password';
+// samProps.authentication.token = 'password';
+// samProps.protocol = 'http';
+// samProps.port = 80;
+// samProps.ssl.enabled = false;
+// samProps.ssl.accept_invalid_cert = false;
+
 if (samProps.request.attempt_timeout < 30000) {
   samProps.request.attempt_timeout = 30000;
 }

package/test/unit/adapterTestUnit.js

@@ -36,13 +36,17 @@ const samProps = require(`${adaptdir}/sampleProperties.json`).properties;
 // these variables can be changed to run in integrated mode so easier to set them here
 // always check these in with bogus data!!!
 samProps.stub = true;
-samProps.host = 'replace.hostorip.here';
-samProps.authentication.username = 'username';
-samProps.authentication.password = 'password';
-samProps.protocol = 'http';
-samProps.port = 80;
-samProps.ssl.enabled = false;
-samProps.ssl.accept_invalid_cert = false;
+
+// uncomment if connecting
+// samProps.host = 'replace.hostorip.here';
+// samProps.authentication.username = 'username';
+// samProps.authentication.password = 'password';
+// samProps.authentication.token = 'password';
+// samProps.protocol = 'http';
+// samProps.port = 80;
+// samProps.ssl.enabled = false;
+// samProps.ssl.accept_invalid_cert = false;
+
 samProps.request.attempt_timeout = 1200000;
 const attemptTimeout = samProps.request.attempt_timeout;
 const { stub } = samProps;
@@ -323,7 +327,7 @@ describe('[unit] Nokia_altiplano Adapter Test', () => {
           assert.equal('^0.4.4', packageDotJson.dependencies.ping);
           assert.equal('^1.4.10', packageDotJson.dependencies['readline-sync']);
           assert.equal('^7.6.3', packageDotJson.dependencies.semver);
-          assert.equal('^3.13.1', packageDotJson.dependencies.winston);
+          assert.equal('^3.14.2', packageDotJson.dependencies.winston);
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -561,7 +565,7 @@ describe('[unit] Nokia_altiplano Adapter Test', () => {
           log.error(`Adapter Exception: ${error}`);
           done(error);
         }
-      });
+      }).timeout(attemptTimeout);
     });
 
     describe('propertiesSchema.json', () => {

package/compliance-report.json

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

package/compliance-report.txt

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