@itentialopensource/adapter-dna_center 0.5.6 → 0.5.7

package/propertiesDecorators.json

@@ -0,0 +1,14 @@
+[
+  {
+    "type": "encryption",
+    "pointer": "/authentication/password"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/authentication/token"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/mongo/password"
+  }
+]

package/propertiesSchema.json

@@ -93,6 +93,9 @@
     },
     "mongo": {
       "$ref": "#/definitions/mongo"
+    },
+    "devicebroker": {
+      "$ref": "#/definitions/devicebroker"
     }
   },
   "required": [
@@ -232,6 +235,21 @@
           "type": "boolean",
           "description": "This property turns on logging of Authentication Information and should only be true when debugging authentication and connectivity",
           "default": false
+        },
+        "client_id": {
+          "type": "string",
+          "description": "The client id for OAuth requests - can also use username depending on schema",
+          "default": ""
+        },
+        "client_secret": {
+          "type": "string",
+          "description": "The client secret for OAuth requests - can also use password depending on schema",
+          "default": ""
+        },
+        "grant_type": {
+          "type": "string",
+          "description": "The grant type for OAuth requests - can also provide in schema",
+          "default": ""
         }
       },
       "required": [
@@ -820,6 +838,370 @@
           }
         }
       }
+    },
+    "devicebroker": {
+      "type": "object",
+      "properties": {
+        "getDevice": {
+          "type": "array",
+          "description": "Broker call(s) to getDevice",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to getDevice",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore failure",
+                "default": "ignore"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The field in response to getDevice that contains the name of the device",
+                    "default": "name"
+                  },
+                  "ostype": {
+                    "type": "string",
+                    "description": "The field in response to getDevice that contains the ostype of the device",
+                    "default": "ostype"
+                  },
+                  "ostypePrefix": {
+                    "type": "string",
+                    "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
+                    "default": ""
+                  },
+                  "port": {
+                    "type": "string",
+                    "description": "The field in response to getDevice that contains the port of the device",
+                    "default": ""
+                  },
+                  "ip": {
+                    "type": "string",
+                    "description": "The field in response to getDevice that contains the ip address of the device",
+                    "default": ""
+                  }
+                }
+              }
+            }
+          }
+        },
+        "getDevicesFiltered": {
+          "type": "array",
+          "description": "Broker call(s) to getDevicesFiltered",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to getDevicesFiltered (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to getDevicesFiltered",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to getDevicesFiltered",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to getDevicesFiltered",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to getDevicesFiltered",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore failure",
+                "default": "ignore"
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevicesFiltered",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The field in response to getDevicesFiltered that contains the name of the device",
+                    "default": "name"
+                  },
+                  "ostype": {
+                    "type": "string",
+                    "description": "The field in response to getDevicesFiltered that contains the ostype of the device",
+                    "default": "ostype"
+                  },
+                  "ostypePrefix": {
+                    "type": "string",
+                    "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
+                    "default": ""
+                  },
+                  "port_field": {
+                    "type": "string",
+                    "description": "The field in response to getDevicesFiltered that contains the port of the device",
+                    "default": ""
+                  },
+                  "ip_field": {
+                    "type": "string",
+                    "description": "The field in response to getDevicesFiltered that contains the ip address of the device",
+                    "default": ""
+                  }
+                }
+              }
+            }
+          }
+        },
+        "isAlive": {
+          "type": "array",
+          "description": "Broker call(s) to determine if the device isAlive",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to isAlive (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to isAlive",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to isAlive",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to isAlive",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to isAlive",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore isAlive",
+                "default": "ignore"
+              },
+              "statusValue": {
+                "type": "string",
+                "description": "The expected value in the status field",
+                "default": "true"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to isAlive",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {
+                  "status": {
+                    "type": "string",
+                    "description": "The field in response to isAlive that contains the status of the device",
+                    "default": "name"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "getConfig": {
+          "type": "array",
+          "description": "Broker call(s) to getConfig",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to getConfig (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to getConfig",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore getConfig",
+                "default": "ignore"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              }
+            }
+          }
+        },
+        "getCount": {
+          "type": "array",
+          "description": "Broker call(s) to getCount",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to getCount (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to getCount",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to getCount",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to getCount",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to getCount",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore getCount",
+                "default": "ignore"
+              }
+            }
+          }
+        }
+      }
     }
   }
 }

package/report/updateReport1651598418513.json

@@ -0,0 +1,114 @@
+{
+  "errors": [
+    {
+      "propertiesSchemaJson": "propertiesSchema.json owner reporting - Create propertiesSchema caught: TypeError: Cannot read property 'properties' of undefined"
+    }
+  ],
+  "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": 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.45.4"
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 258
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 248
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 47
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 7130
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 443
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 5384
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 174
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1300
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 35
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 13814
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 617
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -21,7 +21,10 @@
       "invalid_token_error": 401,
       "auth_field": "header.headers.X-Auth-Token",
       "auth_field_format": "{token}",
-      "auth_logging": false
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": ""
     },
     "healthcheck": {
       "type": "none",

package/test/integration/adapterTestBasicGet.js

@@ -14,7 +14,7 @@ const itParam = require('mocha-param');
 
 const utils = require('../../utils/tbUtils');
 const basicGet = require('../../utils/basicGet');
-const { name } = require('../../package');
+const { name } = require('../../package.json');
 const { methods } = require('../../pronghorn.json');
 
 const getPronghornProps = (iapDir) => {

package/test/integration/adapterTestIntegration.js

@@ -3,6 +3,7 @@
 // Set globals
 /* global describe it log pronghornProps */
 /* eslint no-unused-vars: warn */
+/* eslint no-underscore-dangle: warn  */
 
 // include required items for testing & logging
 const assert = require('assert');
@@ -13,7 +14,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
@@ -63,7 +67,10 @@ global.pronghornProps = {
           invalid_token_error: 401,
           auth_field: 'header.headers.Authorization',
           auth_field_format: 'Basic {b64}{username}:{password}{/b64}',
-          auth_logging: false
+          auth_logging: false,
+          client_id: '',
+          client_secret: '',
+          grant_type: ''
         },
         healthcheck: {
           type: 'startup',
@@ -310,7 +317,7 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
 }
 
 // require the adapter that we are going to be using
-const DnaCenter = require('../../adapter.js');
+const DnaCenter = require('../../adapter');
 
 // begin the testing - these should be pretty well defined between the describe and the it!
 describe('[integration] Dna_center Adapter Test', () => {
@@ -341,6 +348,8 @@ describe('[integration] Dna_center Adapter Test', () => {
         try {
           assert.notEqual(null, a);
           assert.notEqual(undefined, a);
+          const checkId = global.pronghornProps.adapterProps.adapters[0].id;
+          assert.equal(checkId, a.id);
           assert.notEqual(null, a.allProps);
           const check = global.pronghornProps.adapterProps.adapters[0].properties.healthcheck.type;
           assert.equal(check, a.healthcheckType);
@@ -2178,6 +2187,62 @@ describe('[integration] Dna_center Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#postDnasystemapiv1sitesiteIddevice - errors', () => {
+      it('should work if integrated or standalone with mockdata', (done) => {
+        try {
+          a.postDnasystemapiv1sitesiteIddevice('fakedata', 'fakedata', 'fakedata', 'fakedata', 'fakedata', (data, error) => {
+            try {
+              runCommonAsserts(data, error);
+
+              if (stub) {
+                assert.equal('string', data.response.executionId);
+                assert.equal('string', data.response.executionStatusUrl);
+                assert.equal('string', data.response.message);
+              } else {
+                runCommonAsserts(data, error);
+              }
+
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#postDnaintentapiv1site - errors', () => {
+      it('should work if integrated or standalone with mockdata', (done) => {
+        try {
+          a.postDnaintentapiv1site('fakedata', 'fakedata', 'fakedata', 'fakedata', (data, error) => {
+            try {
+              runCommonAsserts(data, error);
+
+              if (stub) {
+                assert.equal('string', data.response.executionId);
+                assert.equal('string', data.response.executionStatusUrl);
+                assert.equal('string', data.response.message);
+              } else {
+                runCommonAsserts(data, error);
+              }
+
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#postDnasystemapiv1site - errors', () => {
       it('should work if integrated or standalone with mockdata', (done) => {
         try {