@itentialopensource/adapter-nokia_nsp_nfm_p 0.2.3 → 0.3.1

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.1.2",
-  "configLines": 96986,
+  "version": "0.3.0",
+  "configLines": 96020,
   "scriptLines": 1783,
-  "codeLines": 129500,
-  "testLines": 82567,
-  "testCases": 4211,
-  "totalCodeLines": 213850,
-  "wfTasks": 1615
+  "codeLines": 129808,
+  "testLines": 82718,
+  "testCases": 4219,
+  "totalCodeLines": 214309,
+  "wfTasks": 1619
 }

package/report/nfmpRest-24.4-v3.json

@@ -0,0 +1,208 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "description": "The SAM-O Restful API endpoints allows to :\n<BR>    1) Convert an XML document to JSON. The conversion is a straightforward conversion of the original XML document. \n<BR>    2) Send a JSON formatted request to the NFMP server. This JSON corresponds to what was converted by this REST service.\n<BR><p><b><u>Access Information:</u></b></p>Prior to accessing the API services below the API client must authenticate the NSP user via the NSP REST Gateway's authentication API service.\n<BR>One authentication method is supported:\n<ul><li>\"Bearer\" token authentication.</li></ul><p><b><u>Note: </u></b></p> XML request bodies which contain CDATA formatted text are not supported.<p><b><u>Deprecation notice: </u></b></p>  NFM-P SAM-O (Including SOAP XML, SAM-O REST v1, v2, v3, and JMS Interfaces) are now deprecated. Starting in NSP Release 23, all new greenfield northbound integrations with NSP must be done using the new NSP REST/RESTCONF APIs and Kafka interfaces. <BR>Brownfield upgrades with northbound integrations towards NFM-P SAM-O (SOAP/XML, SAM-O v1,v2,v3 and JMS Interfaces) can continue to use those legacy APIs until end of 2025. NFM-P SAM-O (SOAP/XML, SAM-O v1, v2, v3 and JMS Interfaces) will no longer be available for brownfield upgrades of northbound integrations starting in NSP Release 26. <BR>Customers are encouraged to use the NSP REST/RESTCONF v3 APIs.<BR> <BR>",
+        "title": "SAM-O Restful Api Endpoints",
+        "version": "v3"
+    },
+    "basePath": "/nfmpv3service/api",
+    "tags": [
+        {
+            "name": "API v3"
+        }
+    ],
+    "schemes": [
+        "https",
+        "http"
+    ],
+    "paths": {
+        "/v3/xml-to-json": {
+            "post": {
+                "tags": [
+                    "API v3"
+                ],
+                "summary": "NFMP REST-API v3 convert XML to JSON command",
+                "description": "Use this endpoint to convert any XML or SOAP XML message, and it will return the proper JSON body that you can use for the v3 api.For example, the client makes the following HTTP request:\n   \n\n     POST /v3/xml-to-json HTTP/1.1\n     Host: server.example.com\n     Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n     Content-Type: application/xml\n\n     <find xmlns=\"xmlapi_1.0\"><fullClassName>aclfilter.IpFilter</fullClassName></find>\n   \n\n\n     Which returns:   \n\n     {\"find\": {\"fullClassName\": \"aclfilter.IpFilter\"}}",
+                "operationId": "xmltojsonEndpoint",
+                "consumes": [
+                    "application/xml"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "parameters": [
+                    {
+                        "in": "body",
+                        "name": "body",
+                        "required": false,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Returns a successful object"
+                    },
+                    "401": {
+                        "description": "Unauthorized"
+                    },
+                    "404": {
+                        "description": "Not found"
+                    },
+                    "500": {
+                        "description": "Internal server problems"
+                    }
+                }
+            }
+        },
+        "/v3/xml": {
+            "post": {
+                "tags": [
+                    "API v3"
+                ],
+                "summary": "NFMP REST-API v3 'xml' command",
+                "description": "This is the XML REST_API endpoint. Use this endpoint to send XML directly instead of JSON. For example, the client makes the following HTTP request:\n   \n\n     POST /v3/xml HTTP/1.1\n     Host: server.example.com\n     Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n     Content-Type: application/xml\n\n     <find><fullClassName>aclfilter.IpFilter</fullClassName></find>",
+                "operationId": "xmlEndpoint",
+                "consumes": [
+                    "application/xml"
+                ],
+                "produces": [
+                    "application/xml"
+                ],
+                "parameters": [
+                    {
+                        "in": "body",
+                        "name": "body",
+                        "required": false,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "security": [
+                    {
+                        "api_key": []
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Returns a successful object"
+                    },
+                    "401": {
+                        "description": "Unauthorized"
+                    },
+                    "404": {
+                        "description": "Not found"
+                    },
+                    "500": {
+                        "description": "Internal server problems"
+                    }
+                }
+            }
+        },
+        "/v3/request": {
+            "post": {
+                "tags": [
+                    "API v3"
+                ],
+                "summary": "NFMP REST-API v3 'request' command",
+                "description": "This is the NFMP REST_API endpoint. Use this endpoint to send your converted JSON and obtain a JSON response. For example, the client makes the following HTTP request:\n   \n\n     POST /v3/request HTTP/1.1\n     Host: server.example.com\n     Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n     Content-Type: application/json\n\n     Example that returns JSON response:\n     {\"fullClassName\":[\"netw.NetworkElement\"], \"fileName\": \"myFile.xml\", \"resultFilter\": { \"attributes\": [\"objectFullName\",\"siteId\"] } }\n\n\n<b>Important Note</b>: The /v3/request 'find' response will be in SOAP XML format only. \n                       It is recommended to use the /v3/find request for REST-API v3 'find' requests and it is mandatory for any v3 request that would result in a large response message greater than 12 MB. \n                       The return error code will be 500 if a response message size is too large.  \n\n<b>Deprecation Notice</b>: The /v3/request 'find' request will be removed in NSP 23.03 release because of the above limitation.\n",
+                "operationId": "requestEndpoint",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "parameters": [
+                    {
+                        "in": "body",
+                        "name": "body",
+                        "required": false,
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": {
+                                "type": "object"
+                            }
+                        }
+                    }
+                ],
+                "security": [
+                    {
+                        "api_key": []
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Returns a successful object"
+                    },
+                    "401": {
+                        "description": "Unauthorized"
+                    },
+                    "404": {
+                        "description": "Not found"
+                    },
+                    "500": {
+                        "description": "Internal server problems"
+                    }
+                }
+            }
+        },
+        "/v3/find": {
+            "post": {
+                "tags": [
+                    "API v3"
+                ],
+                "summary": "NFMP REST-API v3 'find' command",
+                "description": "This is the recommended endpoint for performing a REST- API v3 \"find\" requests and it is mandatory for any finds with a large result set. The response is only in XML format. For example, the client makes the following HTTP request:\n   \n   \n     POST /v3/find HTTP/1.1\n     Host: server.example.com\n     Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n     Content-Type: application/json\n\n     {\"find\": {\n      \"fullClassName\": \"security.User\",\n      \"resultFilter\": {\n      \"children\": \"\",\n      \"attribute\": [\n      \"objectFullName\",\n      \"userName\",\n      \"userGroup\"\n      ]\n      }\n      }}\n     \n     XML response:\n       <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n      <result>\n         <security.User>\n             <userName>admin</userName>\n             <userGroup>securityManager:userGroup-admin</userGroup>\n             <objectFullName>securityManager:user-admin</objectFullName>\n         </security.User>\n         <security.User>\n             <userName>SAMqa</userName>\n             <userGroup>securityManager:userGroup-GSAMqa</userGroup>\n             <objectFullName>securityManager:user-SAMqa</objectFullName>\n         </security.User>\n      </result>\n",
+                "operationId": "findEndpoint",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/octet-stream"
+                ],
+                "parameters": [
+                    {
+                        "in": "body",
+                        "name": "body",
+                        "required": false,
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": {
+                                "type": "object"
+                            }
+                        }
+                    }
+                ],
+                "security": [
+                    {
+                        "api_key": []
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Returns a successful object"
+                    },
+                    "401": {
+                        "description": "Unauthorized"
+                    },
+                    "404": {
+                        "description": "Not found"
+                    },
+                    "500": {
+                        "description": "Internal server problems"
+                    }
+                }
+            }
+        }
+    },
+    "securityDefinitions": {
+        "api_key": {
+            "type": "apiKey",
+            "name": "Authorization",
+            "in": "header"
+        }
+    }
+}

package/report/updateReport1715046544506.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": 35615
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 2542
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 45699
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 1599
+    },
+    {
+      "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": 82767
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 4141
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -14,19 +14,19 @@
     "stub": true,
     "protocol": "https",
     "authentication": {
-      "auth_method": "basic user_password",
+      "auth_method": "request_token",
       "username": "username",
       "password": "password",
       "token": "token",
-      "token_timeout": 600000,
+      "token_timeout": 1800000,
       "token_cache": "local",
       "invalid_token_error": 401,
       "auth_field": "header.headers.Authorization",
-      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+      "auth_field_format": "Bearer {token}",
       "auth_logging": false,
       "client_id": "",
       "client_secret": "",
-      "grant_type": "",
+      "grant_type": "client_credentials",
       "sensitive": [],
       "sso": {
         "protocol": "",
@@ -116,30 +116,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 +156,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 +201,7 @@
       ],
       "getCount": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
@@ -213,15 +217,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 +239,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;
 
@@ -45693,5 +45694,109 @@ describe('[integration] Nokia_nsp_nfm_p Adapter Test', () => {
         }
       }).timeout(attemptTimeout);
     });
+
+    const aPIV3XmltojsonEndpointBodyParam = {};
+    describe('#xmltojsonEndpoint - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.xmltojsonEndpoint(aPIV3XmltojsonEndpointBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-nokia_nsp_nfm_p-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('APIV3', 'xmltojsonEndpoint', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    const aPIV3XmlEndpointBodyParam = {};
+    describe('#xmlEndpoint - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.xmlEndpoint(aPIV3XmlEndpointBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-nokia_nsp_nfm_p-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('APIV3', 'xmlEndpoint', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    const aPIV3requestEndpointBodyParam = {};
+    describe('#requestEndpoint - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.requestEndpoint(aPIV3requestEndpointBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-nokia_nsp_nfm_p-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('APIV3', 'requestEndpoint', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    const aPIV3FindBodyParam = {};
+    describe('#findEndpoint - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.findEndpoint(aPIV3FindBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-nokia_nsp_nfm_p-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('APIV3', 'findEndpoint', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
   });
 });