@itentialopensource/adapter-nokia_altiplano 0.1.1 → 0.3.0

package/pronghorn.json

@@ -386,6 +386,198 @@
       },
       "task": true
     },
+    {
+      "name": "moveEntitiesToDB",
+      "summary": "Moves entities from an adapter into the IAP database",
+      "description": "Moves entities from an adapter into the IAP database",
+      "input": [],
+      "output": {
+        "name": "res",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
+        "schema": {
+          "title": "res",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/moveEntitiesToDB"
+      },
+      "task": true
+    },
+    {
+      "name": "getDevice",
+      "summary": "Get the Appliance",
+      "description": "Get the Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/getDevice"
+      },
+      "task": false
+    },
+    {
+      "name": "getDevicesFiltered",
+      "summary": "Get Appliances that match the filter",
+      "description": "Get Appliances that match the filter",
+      "input": [
+        {
+          "name": "options",
+          "type": "object",
+          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
+          "required": true,
+          "schema": {
+            "title": "options",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "array",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "array"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevicesFiltered"
+      },
+      "task": false
+    },
+    {
+      "name": "isAlive",
+      "summary": "Checks the status for the provided Appliance",
+      "description": "Checks the status for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "boolean"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/isAlive"
+      },
+      "task": false
+    },
+    {
+      "name": "getConfig",
+      "summary": "Gets a config for the provided Appliance",
+      "description": "Gets a config for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        },
+        {
+          "name": "format",
+          "type": "string",
+          "info": "The format to be returned - this is ignored as we always return json",
+          "required": false,
+          "schema": {
+            "title": "format",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/getConfig"
+      },
+      "task": false
+    },
+    {
+      "name": "getCount",
+      "summary": "Gets a device count from the system",
+      "description": "Gets a device count from the system",
+      "input": [],
+      "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": "/getCount"
+      },
+      "task": false
+    },
     {
       "name": "getAccessToken",
       "summary": "GetAccessToken",
@@ -795,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/propertiesSchema.json

@@ -837,4 +837,4 @@
       }
     }
   }
-}
+}

package/report/updateReport1647623246588.json

@@ -0,0 +1,95 @@
+{
+  "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": 30
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 13
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 23
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.44.11"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 64
+    },
+    {
+      "owner": "readmeMd",
+      "description": "Number of lines in the README.md",
+      "value": 688
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 1822
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 86
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 859
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 20
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1029
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 34
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 3710
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 106
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -7,7 +7,7 @@
     "base_path": "/rest",
     "version": "",
     "cache_location": "none",
-    "encode_pathvars": true,
+    "encode_pathvars": false,
     "save_metric": true,
     "stub": true,
     "protocol": "https",
@@ -20,7 +20,7 @@
       "token_cache": "local",
       "invalid_token_error": 401,
       "auth_field": "header.headers.Authorization",
-      "auth_field_format": "{token}",
+      "auth_field_format": "Bearer {token}",
       "auth_logging": false,
       "client_id": "",
       "client_secret": "",

package/test/integration/adapterTestIntegration.js

@@ -13,7 +13,10 @@ const winston = require('winston');
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
+const util = require('util');
+const pronghorn = require('../../pronghorn.json');
 
+pronghorn.methodsByName = pronghorn.methods.reduce((result, meth) => ({ ...result, [meth.name]: meth }), {});
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
@@ -468,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 {
@@ -493,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/adapterBaseTestUnit.js

@@ -317,7 +317,7 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should return a list of functions', (done) => {
         const returnedFunctions = ['addEntityCache', 'capabilityResults', 'checkActionFiles', 'checkProperties', 'connect', 'encryptProperty',
-          'entityInList', 'findPath', 'getAllCapabilities', 'getAllFunctions', 'getQueue', 'getWorkflowFunctions', 'healthCheck',
+          'entityInList', 'findPath', 'getAllCapabilities', 'getAllFunctions', 'getQueue', 'getWorkflowFunctions', 'healthCheck', 'moveEntitiesToDB',
           'refreshProperties', 'runBasicGet', 'runConnectivity', 'runHealthcheck', 'suspend', 'troubleshoot', 'unsuspend', 'updateAdapterConfiguration', 'addListener',
           'emit', 'eventNames', 'getMaxListeners', 'listenerCount', 'listeners', 'off', 'on', 'once', 'prependListener',
           'prependOnceListener', 'rawListeners', 'removeAllListeners', 'removeListener', 'setMaxListeners'];