@itentialopensource/adapter-nokia_nsp_device_configurator 0.3.0 → 0.3.2

package/CALLS.md

@@ -311,9 +311,9 @@ Specific adapter calls are built based on the API of the Nokia_nsp_device_config
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">fieldquerytoretrieveasinglechildnodeunderthetargetresource(neType, neVersion, callback)</td>
+    <td style="padding:15px">fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource(fields, neId, port, callback)</td>
     <td style="padding:15px">Field query to retrieve a single child node under the target resource</td>
-    <td style="padding:15px">{base_path}/{version}/restconf/meta/api/v1/model/schema/{pathv1}/{pathv2}/nokia-conf:/configure/filter?{query}</td>
+    <td style="padding:15px">{base_path}/{version}/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:/configure/{pathv2}?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.3.2 [08-06-2024]
+
+* Changes made at 2024.08.06_18:32PM
+
+See merge request itentialopensource/adapters/adapter-nokia_nsp_device_configurator!11
+
+---
+
+## 0.3.1 [05-30-2024]
+
+* Updated incorrect call
+
+See merge request itentialopensource/adapters/adapter-nokia_nsp_device_configurator!10
+
+---
+
 ## 0.3.0 [05-09-2024]
 
 * Minor/2024 auto migration

package/TAB2.md

@@ -314,7 +314,7 @@ Sample Properties can be used to help you configure the adapter in the Itential
     }
   }
 ```
-### [Swagger](https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-nokia_nsp_device_configurator/-/blob/master/report/adapter-openapi.json) 
+### [Swagger](https://gitlab.com/itentialopensource/adapters/adapter-nokia_nsp_device_configurator/-/blob/master/report/adapter-openapi.json) 
 
-## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-nokia_nsp_device_configurator/-/blob/master/README.md) 
+## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/adapter-nokia_nsp_device_configurator/-/blob/master/README.md) 
 

package/adapter.js

@@ -2526,23 +2526,24 @@ class NokiaNspDeviceConfigurator extends AdapterBaseCl {
   }
 
   /**
-   * @function fieldquerytoretrieveasinglechildnodeunderthetargetresource
+   * @function fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
    * @pronghornType method
-   * @name fieldquerytoretrieveasinglechildnodeunderthetargetresource
+   * @name fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
    * @summary Field query to retrieve a single child node under the target resource
    *
-   * @param {string} neType - neType param
-   * @param {string} neVersion - neVersion param
+   * @param {string} fields - fields param
+   * @param {string} neId - neId (network device) param
+   * @param {string} port - port param
    * @param {getCallback} callback - a callback function to return the result
    * @return {object} results - An object containing the response of the action
    *
-   * @route {POST} /fieldquerytoretrieveasinglechildnodeunderthetargetresource
+   * @route {POST} /fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
    * @roles admin
    * @task true
    */
   /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
-  fieldquerytoretrieveasinglechildnodeunderthetargetresource(neType, neVersion, callback) {
-    const meth = 'adapter-fieldquerytoretrieveasinglechildnodeunderthetargetresource';
+  fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource(fields, neId, port, callback) {
+    const meth = 'adapter-fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -2553,21 +2554,26 @@ class NokiaNspDeviceConfigurator extends AdapterBaseCl {
     }
 
     /* HERE IS WHERE YOU VALIDATE DATA */
-    if (neType === undefined || neType === null || neType === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['neType'], null, null, null);
+    if (fields === undefined || fields === null || fields === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['fields'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (neId === undefined || neId === null || neId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['neId'], null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
-    if (neVersion === undefined || neVersion === null || neVersion === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['neVersion'], null, null, null);
+    if (port === undefined || port === null || port === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['port'], null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = {};
+    const queryParamsAvailable = { fields };
     const queryParams = {};
-    const pathVars = [`neType=${neType}`, `neVersion=${neVersion}`];
+    const pathVars = [`network-device=${neId}`, `port=${port}`];
     const bodyVars = {};
 
     // loop in template. long callback arg name to avoid identifier conflicts
@@ -2606,7 +2612,7 @@ class NokiaNspDeviceConfigurator extends AdapterBaseCl {
     try {
       // Make the call -
       // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
-      return this.requestHandlerInst.identifyRequest('Search', 'fieldquerytoretrieveasinglechildnodeunderthetargetresource', reqObj, true, (irReturnData, irReturnError) => {
+      return this.requestHandlerInst.identifyRequest('Search', 'fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource', reqObj, true, (irReturnData, irReturnError) => {
         // if we received an error or their is no response on the results
         // return an error
         if (irReturnError) {
@@ -2614,7 +2620,7 @@ class NokiaNspDeviceConfigurator extends AdapterBaseCl {
           return callback(null, irReturnError);
         }
         if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['fieldquerytoretrieveasinglechildnodeunderthetargetresource'], null, null, null);
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource'], null, null, null);
           log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
           return callback(null, errorObj);
         }

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/entities/Search/action.json

@@ -43,10 +43,10 @@
       ]
     },
     {
-      "name": "fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+      "name": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/restconf/meta/api/v1/model/schema/{pathv1}/{pathv2}/nokia-conf:/configure/filter?{query}",
+      "entitypath": "{base_path}/{version}/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:/configure/{pathv2}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,

package/entities/Search/schema.json

@@ -12,7 +12,7 @@
       "enum": [
         "fieldquerytoselectmultiplefieldsunderthetargetresource",
         "fieldquerywithsubSelectorsofanodeunderthetargetresource",
-        "fieldquerytoretrieveasinglechildnodeunderthetargetresource"
+        "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource"
       ],
       "external_name": "ph_request_type"
     }

package/metadata.json

@@ -85,5 +85,6 @@
     "workflowProjects": [],
     "transformationProjects": [],
     "exampleProjects": []
-  }
+  },
+  "supportLevel": "community"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-nokia_nsp_device_configurator",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "This adapter integrates with system described as: 22.11Modeled-deviceConfiguratorRestconfApis.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
@@ -52,22 +52,22 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-nokia_nsp_device_configurator#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",
     "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/pronghorn.json

@@ -4023,27 +4023,37 @@
       "task": true
     },
     {
-      "name": "fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+      "name": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
       "summary": "Field query to retrieve a single child node under the target resource",
       "description": "Field query to retrieve a single child node under the target resource",
       "input": [
         {
-          "name": "neType",
+          "name": "fields",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "fields",
+            "type": "string"
+          }
+        },
+        {
+          "name": "neId",
           "type": "string",
           "info": ": string",
           "required": true,
           "schema": {
-            "title": "neType",
+            "title": "neId",
             "type": "string"
           }
         },
         {
-          "name": "neVersion",
+          "name": "port",
           "type": "string",
           "info": ": string",
           "required": true,
           "schema": {
-            "title": "neVersion",
+            "title": "port",
             "type": "string"
           }
         }
@@ -4055,7 +4065,7 @@
         "schema": {
           "allOf": [
             {
-              "title": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+              "title": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
               "required": [
                 "nokia-conf:port"
               ],
@@ -4254,7 +4264,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/fieldquerytoretrieveasinglechildnodeunderthetargetresource"
+        "path": "/fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource"
       },
       "task": true
     },

package/report/22.11Modeled-DeviceConfiguratorRestCONFAPIs.postman_collection.json-OpenApi3Json.json

@@ -3792,7 +3792,7 @@
         ],
         "summary": "Field query to retrieve a single child node under the target resource",
         "description": "Field query to retrieve a single child node under the target resource",
-        "operationId": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+        "operationId": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
         "parameters": [
           {
             "name": "Content-Type",
@@ -3962,7 +3962,7 @@
                 "schema": {
                   "allOf": [
                     {
-                      "$ref": "#/components/schemas/Fieldquerytoretrieveasinglechildnodeunderthetargetresource"
+                      "$ref": "#/components/schemas/fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource"
                     },
                     {
                       "example": {
@@ -8368,8 +8368,8 @@
           "mda-type": "m60-10/100eth-tx"
         }
       },
-      "Fieldquerytoretrieveasinglechildnodeunderthetargetresource": {
-        "title": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+      "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource": {
+        "title": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
         "required": [
           "nokia-conf:port"
         ],

package/report/adapter-openapi.json

@@ -3792,7 +3792,7 @@
         ],
         "summary": "Field query to retrieve a single child node under the target resource",
         "description": "Field query to retrieve a single child node under the target resource",
-        "operationId": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+        "operationId": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
         "parameters": [
           {
             "name": "Content-Type",
@@ -3962,7 +3962,7 @@
                 "schema": {
                   "allOf": [
                     {
-                      "$ref": "#/components/schemas/Fieldquerytoretrieveasinglechildnodeunderthetargetresource"
+                      "$ref": "#/components/schemas/fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource"
                     },
                     {
                       "example": {
@@ -8368,8 +8368,8 @@
           "mda-type": "m60-10/100eth-tx"
         }
       },
-      "Fieldquerytoretrieveasinglechildnodeunderthetargetresource": {
-        "title": "Fieldquerytoretrieveasinglechildnodeunderthetargetresource",
+      "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource": {
+        "title": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource",
         "required": [
           "nokia-conf:port"
         ],

package/report/adapter-openapi.yaml

@@ -2482,9 +2482,9 @@ paths:
     get:
       tags:
       - Search
-      summary: Fieldquerytoretrieveasinglechildnodeunderthetargetresource
+      summary: fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
       description: Field query to retrieve a single child node under the target resource
-      operationId: Fieldquerytoretrieveasinglechildnodeunderthetargetresource
+      operationId: fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
       parameters:
       - name: Content-Type
         in: header
@@ -2604,7 +2604,7 @@ paths:
             application/json;charset=UTF-8:
               schema:
                 allOf:
-                - $ref: '#/components/schemas/Fieldquerytoretrieveasinglechildnodeunderthetargetresource'
+                - $ref: '#/components/schemas/fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource'
                 - example:
                     nokia-conf:port:
                     - ethernet:
@@ -5788,8 +5788,8 @@ components:
       example:
         mda-slot: 1
         mda-type: m60-10/100eth-tx
-    Fieldquerytoretrieveasinglechildnodeunderthetargetresource:
-      title: Fieldquerytoretrieveasinglechildnodeunderthetargetresource
+    fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource:
+      title: fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource
       required:
       - nokia-conf:port
       type: object

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.2.3",
-  "configLines": 8378,
+  "version": "0.3.0",
+  "configLines": 8388,
   "scriptLines": 1783,
-  "codeLines": 4492,
-  "testLines": 4837,
-  "testCases": 231,
-  "totalCodeLines": 11112,
+  "codeLines": 4498,
+  "testLines": 4853,
+  "testCases": 232,
+  "totalCodeLines": 11134,
   "wfTasks": 48
 }

package/test/integration/adapterTestIntegration.js

@@ -955,12 +955,11 @@ describe('[integration] Nokia_nsp_device_configurator Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    const searchNeType = 'fakedata';
-    const searchNeVersion = 'fakedata';
-    describe('#fieldquerytoretrieveasinglechildnodeunderthetargetresource - errors', () => {
+    const searchPort = 'fakedata';
+    describe('#fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource - errors', () => {
       it('should work if integrated or standalone with mockdata', (done) => {
         try {
-          a.fieldquerytoretrieveasinglechildnodeunderthetargetresource(searchNeType, searchNeVersion, (data, error) => {
+          a.fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource(searchFields, searchNeId, searchPort, (data, error) => {
             try {
               if (stub) {
                 runCommonAsserts(data, error);
@@ -968,7 +967,7 @@ describe('[integration] Nokia_nsp_device_configurator Adapter Test', () => {
               } else {
                 runCommonAsserts(data, error);
               }
-              saveMockData('Search', 'fieldquerytoretrieveasinglechildnodeunderthetargetresource', 'default', data);
+              saveMockData('Search', 'fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource', 'default', data);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);

package/test/unit/adapterTestUnit.js

@@ -314,16 +314,16 @@ describe('[unit] Nokia_nsp_device_configurator 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('^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}`);
@@ -2263,22 +2263,39 @@ describe('[unit] Nokia_nsp_device_configurator Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    describe('#fieldquerytoretrieveasinglechildnodeunderthetargetresource - errors', () => {
-      it('should have a fieldquerytoretrieveasinglechildnodeunderthetargetresource function', (done) => {
+    describe('#fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource - errors', () => {
+      it('should have a fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource function', (done) => {
         try {
-          assert.equal(true, typeof a.fieldquerytoretrieveasinglechildnodeunderthetargetresource === 'function');
+          assert.equal(true, typeof a.fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
           done(error);
         }
       }).timeout(attemptTimeout);
-      it('should error if - missing neType', (done) => {
+      it('should error if - missing fields', (done) => {
         try {
-          a.fieldquerytoretrieveasinglechildnodeunderthetargetresource(null, null, (data, error) => {
+          a.fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource(null, null, null, (data, error) => {
             try {
-              const displayE = 'neType is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-nokia_nsp_device_configurator-adapter-fieldquerytoretrieveasinglechildnodeunderthetargetresource', displayE);
+              const displayE = 'fields is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-nokia_nsp_device_configurator-adapter-fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing neId', (done) => {
+        try {
+          a.fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource('fakeparam', null, null, (data, error) => {
+            try {
+              const displayE = 'neId is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-nokia_nsp_device_configurator-adapter-fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);
@@ -2290,12 +2307,12 @@ describe('[unit] Nokia_nsp_device_configurator Adapter Test', () => {
           done(error);
         }
       }).timeout(attemptTimeout);
-      it('should error if - missing neVersion', (done) => {
+      it('should error if - missing port', (done) => {
         try {
-          a.fieldquerytoretrieveasinglechildnodeunderthetargetresource('fakeparam', null, (data, error) => {
+          a.fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource('fakeparam', 'neId', null, (data, error) => {
             try {
-              const displayE = 'neVersion is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-nokia_nsp_device_configurator-adapter-fieldquerytoretrieveasinglechildnodeunderthetargetresource', displayE);
+              const displayE = 'port is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-nokia_nsp_device_configurator-adapter-fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);