@itentialopensource/adapter-nokia_altiplano 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.3.0 [03-25-2022]
+
+* add new call createOntWithQuery
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!4
+
+---
+
 ## 0.2.0 [03-18-2022]
 
 * Migration and creation of md files

package/SYSTEMINFO.md

@@ -0,0 +1,12 @@
+# Nokia Altiplano Access Controller
+
+Vendor: Nokia
+Homepage: https://www.nokia.com/
+
+Product: Altiplano Access Controller
+Product Page: https://www.nokia.com/networks/products/altiplano-access-controller/
+
+## Introduction
+
+## Additional Product Documentation
+

package/adapter.js

@@ -1423,6 +1423,89 @@ class NokiaAltiplano extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @function createOntWithQuery
+   * @pronghornType method
+   * @name createOntWithQuery
+   * @summary Create ont with query params
+   *
+   * @param {object} body - body param
+   * @param {object} query - query param
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /createOntWithQuery
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  createOntWithQuery(body, query, callback) {
+    const meth = 'adapter-createOntWithQuery';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (body === undefined || body === null || body === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], 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 = query;
+    const queryParams = {};
+    const pathVars = [];
+    const bodyVars = body;
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Intent', 'createOnt', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['createOntWithQuery'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
   /**
    * @function getOnt
    * @pronghornType method

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-nokia_altiplano",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "This adapter integrates with system described as: Nokia Altiplano.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",

package/pronghorn.json

@@ -987,6 +987,194 @@
       },
       "task": true
     },
+    {
+      "name": "createOntWithQuery",
+      "summary": "Create ont with query",
+      "description": "Create ont with query",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": {\"ibn:intent\": {\"target\": \"string\", \"intent-type\": \"string\", \"intent-type-version\": \"string\", \"required-network-state\": \"string\", \"intent-specific-data\": {\"ont:ont\": {\"ont-type\": \"string\", \"fiber-name\": \"string\", \"expected-serial-number\": \"string\", \"onu-service-profile\": \"string\", \"uni-service-configuration\": {\"uni-id\": \"string\", \"service-profile\": \"string\"}}}}}",
+          "required": true,
+          "schema": {
+            "title": "CreateontRequest",
+            "required": [
+              "ibn:intent"
+            ],
+            "type": "object",
+            "properties": {
+              "ibn:intent": {
+                "title": "IbnIntent",
+                "required": [
+                  "target",
+                  "intent-type",
+                  "intent-type-version",
+                  "required-network-state",
+                  "intent-specific-data"
+                ],
+                "type": "object",
+                "properties": {
+                  "target": {
+                    "type": "string"
+                  },
+                  "intent-type": {
+                    "type": "string"
+                  },
+                  "intent-type-version": {
+                    "type": "string"
+                  },
+                  "required-network-state": {
+                    "type": "string"
+                  },
+                  "intent-specific-data": {
+                    "title": "IntentSpecificData",
+                    "required": [
+                      "ont:ont"
+                    ],
+                    "type": "object",
+                    "properties": {
+                      "ont:ont": {
+                        "title": "OntOnt",
+                        "required": [
+                          "ont-type",
+                          "fiber-name",
+                          "expected-serial-number",
+                          "onu-service-profile",
+                          "uni-service-configuration"
+                        ],
+                        "type": "object",
+                        "properties": {
+                          "ont-type": {
+                            "type": "string"
+                          },
+                          "fiber-name": {
+                            "type": "string"
+                          },
+                          "expected-serial-number": {
+                            "type": "string"
+                          },
+                          "onu-service-profile": {
+                            "type": "string"
+                          },
+                          "uni-service-configuration": {
+                            "title": "UniServiceConfiguration",
+                            "required": [
+                              "uni-id",
+                              "service-profile"
+                            ],
+                            "type": "object",
+                            "properties": {
+                              "uni-id": {
+                                "type": "string"
+                              },
+                              "service-profile": {
+                                "type": "string"
+                              }
+                            },
+                            "example": {
+                              "uni-id": "LAN1",
+                              "service-profile": "default"
+                            }
+                          }
+                        },
+                        "example": {
+                          "ont-type": "G-010G-Q",
+                          "fiber-name": "INES-1-1-4-3",
+                          "expected-serial-number": "ALCLF846403A",
+                          "onu-service-profile": "default",
+                          "uni-service-configuration": {
+                            "uni-id": "LAN1",
+                            "service-profile": "default"
+                          }
+                        }
+                      }
+                    },
+                    "example": {
+                      "ont:ont": {
+                        "ont-type": "G-010G-Q",
+                        "fiber-name": "INES-1-1-4-3",
+                        "expected-serial-number": "ALCLF846403A",
+                        "onu-service-profile": "default",
+                        "uni-service-configuration": {
+                          "uni-id": "LAN1",
+                          "service-profile": "default"
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "target": "INES-1-1-4-3-a",
+                  "intent-type": "ont",
+                  "intent-type-version": "4",
+                  "required-network-state": "active",
+                  "intent-specific-data": {
+                    "ont:ont": {
+                      "ont-type": "G-010G-Q",
+                      "fiber-name": "INES-1-1-4-3",
+                      "expected-serial-number": "ALCLF846403A",
+                      "onu-service-profile": "default",
+                      "uni-service-configuration": {
+                        "uni-id": "LAN1",
+                        "service-profile": "default"
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "example": {
+              "ibn:intent": {
+                "target": "INES-1-1-4-3-a",
+                "intent-type": "ont",
+                "intent-type-version": "4",
+                "required-network-state": "active",
+                "intent-specific-data": {
+                  "ont:ont": {
+                    "ont-type": "G-010G-Q",
+                    "fiber-name": "INES-1-1-4-3",
+                    "expected-serial-number": "ALCLF846403A",
+                    "onu-service-profile": "default",
+                    "uni-service-configuration": {
+                      "uni-id": "LAN1",
+                      "service-profile": "default"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        {
+          "name": "query",
+          "type": "object",
+          "info": "{\"altiplano-triggerSyncUponSuccess\": \"true\"}",
+          "required": true,
+          "schema": {
+            "title": "query",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/createOntWithQuery"
+      },
+      "task": true
+    },
     {
       "name": "getOnt",
       "summary": "GET ont",

package/test/integration/adapterTestIntegration.js

@@ -471,6 +471,7 @@ describe('[integration] Nokia_altiplano Adapter Test', () => {
         }
       }
     };
+
     describe('#createOnt - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
         try {
@@ -496,6 +497,31 @@ describe('[integration] Nokia_altiplano Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#createOntWithQuery - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.createOntWithQuery(intentCreateOntBodyParam, {}, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-nokia_altiplano-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
+              }
+              saveMockData('Intent', 'createOnt', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     const intentIntent = 'fakedata';
     describe('#dependentsSummaryFiber - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {

package/test/unit/adapterTestUnit.js

@@ -1494,6 +1494,35 @@ describe('[unit] Nokia_altiplano Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#createOntWithQuery - errors', () => {
+      it('should have a createOntWithQuery function', (done) => {
+        try {
+          assert.equal(true, typeof a.createOntWithQuery === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+      it('should error if - missing body', (done) => {
+        try {
+          a.createOntWithQuery(null, null, (data, error) => {
+            try {
+              const displayE = 'body is required';
+              runErrorAsserts(data, error, 'AD.300', 'Test-nokia_altiplano-adapter-createOntWithQuery', displayE);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#getOnt - errors', () => {
       it('should have a getOnt function', (done) => {
         try {