@itentialopensource/adapter-kubernetes 0.6.1 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. package/.eslintignore +1 -0
  2. package/.eslintrc.js +12 -12
  3. package/AUTH.md +39 -0
  4. package/BROKER.md +199 -0
  5. package/CALLS.md +169 -0
  6. package/CHANGELOG.md +54 -19
  7. package/CODE_OF_CONDUCT.md +12 -17
  8. package/CONTRIBUTING.md +88 -74
  9. package/ENHANCE.md +69 -0
  10. package/PROPERTIES.md +641 -0
  11. package/README.md +244 -392
  12. package/SUMMARY.md +9 -0
  13. package/SYSTEMINFO.md +11 -0
  14. package/TROUBLESHOOT.md +47 -0
  15. package/adapter.js +7126 -35
  16. package/adapterBase.js +1331 -50
  17. package/entities/.generic/action.json +214 -0
  18. package/entities/.generic/schema.json +28 -0
  19. package/entities/.system/action.json +1 -1
  20. package/entities/Admissionregistration/action.json +1 -1
  21. package/entities/Admissionregistration_v1beta1/action.json +19 -19
  22. package/entities/Apiextensions/action.json +1 -1
  23. package/entities/Apiextensions_v1beta1/action.json +13 -13
  24. package/entities/Apiregistration/action.json +1 -1
  25. package/entities/Apiregistration_v1/action.json +13 -13
  26. package/entities/Apiregistration_v1beta1/action.json +13 -13
  27. package/entities/Apis/action.json +1 -1
  28. package/entities/Apps/action.json +1 -1
  29. package/entities/Apps_v1/action.json +77 -77
  30. package/entities/Apps_v1beta1/action.json +47 -47
  31. package/entities/Apps_v1beta2/action.json +77 -77
  32. package/entities/Auditregistration/action.json +1 -1
  33. package/entities/Auditregistration_v1alpha1/action.json +10 -10
  34. package/entities/Authentication/action.json +1 -1
  35. package/entities/Authentication_v1/action.json +2 -2
  36. package/entities/Authentication_v1beta1/action.json +2 -2
  37. package/entities/Authorization/action.json +1 -1
  38. package/entities/Authorization_v1/action.json +5 -5
  39. package/entities/Authorization_v1beta1/action.json +5 -5
  40. package/entities/Autoscaling/action.json +1 -1
  41. package/entities/Autoscaling_v1/action.json +15 -15
  42. package/entities/Autoscaling_v2beta1/action.json +15 -15
  43. package/entities/Autoscaling_v2beta2/action.json +15 -15
  44. package/entities/Batch/action.json +1 -1
  45. package/entities/Batch_v1/action.json +15 -15
  46. package/entities/Batch_v1beta1/action.json +15 -15
  47. package/entities/Batch_v2alpha1/action.json +15 -15
  48. package/entities/Certificates/action.json +1 -1
  49. package/entities/Certificates_v1beta1/action.json +14 -14
  50. package/entities/Coordination/action.json +1 -1
  51. package/entities/Coordination_v1/action.json +12 -12
  52. package/entities/Coordination_v1beta1/action.json +12 -12
  53. package/entities/Core/action.json +1 -1
  54. package/entities/Core_v1/action.json +240 -240
  55. package/entities/Events/action.json +1 -1
  56. package/entities/Events_v1beta1/action.json +12 -12
  57. package/entities/Extensions/action.json +1 -1
  58. package/entities/Extensions_v1beta1/action.json +87 -87
  59. package/entities/Logs/action.json +2 -2
  60. package/entities/Networking/action.json +1 -1
  61. package/entities/Networking_v1/action.json +12 -12
  62. package/entities/Networking_v1beta1/action.json +15 -15
  63. package/entities/Node/action.json +1 -1
  64. package/entities/Node_v1alpha1/action.json +10 -10
  65. package/entities/Node_v1beta1/action.json +10 -10
  66. package/entities/Policy/action.json +1 -1
  67. package/entities/Policy_v1beta1/action.json +24 -24
  68. package/entities/RbacAuthorization/action.json +1 -1
  69. package/entities/RbacAuthorization_v1/action.json +41 -41
  70. package/entities/RbacAuthorization_v1alpha1/action.json +41 -41
  71. package/entities/RbacAuthorization_v1beta1/action.json +41 -41
  72. package/entities/Scheduling/action.json +1 -1
  73. package/entities/Scheduling_v1/action.json +10 -10
  74. package/entities/Scheduling_v1alpha1/action.json +10 -10
  75. package/entities/Scheduling_v1beta1/action.json +10 -10
  76. package/entities/Settings/action.json +1 -1
  77. package/entities/Settings_v1alpha1/action.json +12 -12
  78. package/entities/Storage/action.json +1 -1
  79. package/entities/Storage_v1/action.json +22 -22
  80. package/entities/Storage_v1alpha1/action.json +10 -10
  81. package/entities/Storage_v1beta1/action.json +37 -37
  82. package/entities/Version/action.json +1 -1
  83. package/error.json +12 -0
  84. package/package.json +47 -23
  85. package/pronghorn.json +642 -0
  86. package/propertiesDecorators.json +14 -0
  87. package/propertiesSchema.json +505 -11
  88. package/refs?service=git-upload-pack +0 -0
  89. package/report/adapterInfo.json +10 -0
  90. package/report/updateReport1594225120157.json +95 -0
  91. package/report/updateReport1615248177783.json +95 -0
  92. package/report/updateReport1653089036005.json +120 -0
  93. package/sampleProperties.json +110 -6
  94. package/test/integration/adapterTestBasicGet.js +85 -0
  95. package/test/integration/adapterTestConnectivity.js +93 -0
  96. package/test/integration/adapterTestIntegration.js +33 -96
  97. package/test/unit/adapterBaseTestUnit.js +949 -0
  98. package/test/unit/adapterTestUnit.js +643 -104
  99. package/utils/adapterInfo.js +206 -0
  100. package/utils/addAuth.js +94 -0
  101. package/utils/artifactize.js +9 -14
  102. package/utils/basicGet.js +50 -0
  103. package/utils/checkMigrate.js +63 -0
  104. package/utils/entitiesToDB.js +179 -0
  105. package/utils/findPath.js +74 -0
  106. package/utils/modify.js +154 -0
  107. package/utils/packModificationScript.js +1 -1
  108. package/utils/patches2bundledDeps.js +90 -0
  109. package/utils/pre-commit.sh +4 -1
  110. package/utils/removeHooks.js +20 -0
  111. package/utils/tbScript.js +184 -0
  112. package/utils/tbUtils.js +469 -0
  113. package/utils/testRunner.js +16 -16
  114. package/utils/troubleshootingAdapter.js +190 -0
  115. package/gl-code-quality-report.json +0 -1
package/adapterBase.js CHANGED
@@ -6,11 +6,16 @@
6
6
  /* eslint import/no-dynamic-require: warn */
7
7
  /* eslint no-loop-func: warn */
8
8
  /* eslint no-cond-assign: warn */
9
+ /* eslint global-require: warn */
10
+ /* eslint no-unused-vars: warn */
11
+ /* eslint prefer-destructuring: warn */
9
12
 
10
13
  /* Required libraries. */
11
14
  const fs = require('fs-extra');
12
15
  const path = require('path');
16
+ const jsonQuery = require('json-query');
13
17
  const EventEmitterCl = require('events').EventEmitter;
18
+ const { execSync } = require('child_process');
14
19
 
15
20
  /* The schema validator */
16
21
  const AjvCl = require('ajv');
@@ -19,6 +24,148 @@ const AjvCl = require('ajv');
19
24
  const PropUtilCl = require('@itentialopensource/adapter-utils').PropertyUtility;
20
25
  const RequestHandlerCl = require('@itentialopensource/adapter-utils').RequestHandler;
21
26
 
27
+ const entitiesToDB = require(path.join(__dirname, 'utils/entitiesToDB'));
28
+ const troubleshootingAdapter = require(path.join(__dirname, 'utils/troubleshootingAdapter'));
29
+ const tbUtils = require(path.join(__dirname, 'utils/tbUtils'));
30
+
31
+ let propUtil = null;
32
+
33
+ /*
34
+ * INTERNAL FUNCTION: force fail the adapter - generally done to cause restart
35
+ */
36
+ function forceFail(packChg) {
37
+ if (packChg !== undefined && packChg !== null && packChg === true) {
38
+ execSync(`rm -rf ${__dirname}/node modules`, { encoding: 'utf-8' });
39
+ execSync(`rm -rf ${__dirname}/package-lock.json`, { encoding: 'utf-8' });
40
+ execSync('npm install', { encoding: 'utf-8' });
41
+ }
42
+ log.error('NEED TO RESTART ADAPTER - FORCE FAIL');
43
+ const errorObj = {
44
+ origin: 'adapter-forceFail',
45
+ type: 'Force Fail so adapter will restart',
46
+ vars: []
47
+ };
48
+ setTimeout(() => {
49
+ throw new Error(JSON.stringify(errorObj));
50
+ }, 1000);
51
+ }
52
+
53
+ /*
54
+ * INTERNAL FUNCTION: update the action.json
55
+ */
56
+ function updateAction(entityPath, action, changes) {
57
+ // if the action file does not exist - error
58
+ const actionFile = path.join(entityPath, '/action.json');
59
+ if (!fs.existsSync(actionFile)) {
60
+ return 'Missing Action File';
61
+ }
62
+
63
+ // read in the file as a json object
64
+ const ajson = require(path.resolve(entityPath, 'action.json'));
65
+ let chgAct = {};
66
+
67
+ // get the action we need to change
68
+ for (let a = 0; a < ajson.actions.length; a += 1) {
69
+ if (ajson.actions[a].name === action) {
70
+ chgAct = ajson.actions[a];
71
+ break;
72
+ }
73
+ }
74
+ // merge the changes into the desired action
75
+ chgAct = propUtil.mergeProperties(changes, chgAct);
76
+
77
+ fs.writeFileSync(actionFile, JSON.stringify(ajson, null, 2));
78
+ return null;
79
+ }
80
+
81
+ /*
82
+ * INTERNAL FUNCTION: update the schema file
83
+ */
84
+ function updateSchema(entityPath, configFile, changes) {
85
+ // if the schema file does not exist - error
86
+ const schemaFile = path.join(entityPath, `/${configFile}`);
87
+ if (!fs.existsSync(schemaFile)) {
88
+ return 'Missing Schema File';
89
+ }
90
+
91
+ // read in the file as a json object
92
+ let schema = require(path.resolve(entityPath, configFile));
93
+
94
+ // merge the changes into the schema file
95
+ schema = propUtil.mergeProperties(changes, schema);
96
+
97
+ fs.writeFileSync(schemaFile, JSON.stringify(schema, null, 2));
98
+ return null;
99
+ }
100
+
101
+ /*
102
+ * INTERNAL FUNCTION: update the mock data file
103
+ */
104
+ function updateMock(mockPath, configFile, changes) {
105
+ // if the mock file does not exist - create it
106
+ const mockFile = path.join(mockPath, `/${configFile}`);
107
+ if (!fs.existsSync(mockFile)) {
108
+ const newMock = {};
109
+ fs.writeFileSync(mockFile, JSON.stringify(newMock, null, 2));
110
+ }
111
+
112
+ // read in the file as a json object
113
+ let mock = require(path.resolve(mockPath, configFile));
114
+
115
+ // merge the changes into the mock file
116
+ mock = propUtil.mergeProperties(changes, mock);
117
+
118
+ fs.writeFileSync(mockFile, JSON.stringify(mock, null, 2));
119
+ return null;
120
+ }
121
+
122
+ /*
123
+ * INTERNAL FUNCTION: update the package dependencies
124
+ */
125
+ function updatePackage(changes) {
126
+ // if the schema file does not exist - error
127
+ const packFile = path.join(__dirname, '/package.json');
128
+ if (!fs.existsSync(packFile)) {
129
+ return 'Missing Pacakge File';
130
+ }
131
+
132
+ // read in the file as a json object
133
+ const pack = require(path.resolve(__dirname, 'package.json'));
134
+
135
+ // only certain changes are allowed
136
+ if (changes.dependencies) {
137
+ const keys = Object.keys(changes.dependencies);
138
+
139
+ for (let k = 0; k < keys.length; k += 1) {
140
+ pack.dependencies[keys[k]] = changes.dependencies[keys[k]];
141
+ }
142
+ }
143
+
144
+ fs.writeFileSync(packFile, JSON.stringify(pack, null, 2));
145
+ return null;
146
+ }
147
+
148
+ /*
149
+ * INTERNAL FUNCTION: get data from source(s) - nested
150
+ */
151
+ function getDataFromSources(loopField, sources) {
152
+ let fieldValue = loopField;
153
+
154
+ // go through the sources to find the field
155
+ for (let s = 0; s < sources.length; s += 1) {
156
+ // find the field value using jsonquery
157
+ const nestedValue = jsonQuery(loopField, { data: sources[s] }).value;
158
+
159
+ // if we found in source - set and no need to check other sources
160
+ if (nestedValue) {
161
+ fieldValue = nestedValue;
162
+ break;
163
+ }
164
+ }
165
+
166
+ return fieldValue;
167
+ }
168
+
22
169
  /* GENERAL ADAPTER FUNCTIONS THESE SHOULD NOT BE DIRECTLY MODIFIED */
23
170
  /* IF YOU NEED MODIFICATIONS, REDEFINE THEM IN adapter.js!!! */
24
171
  class AdapterBase extends EventEmitterCl {
@@ -30,13 +177,19 @@ class AdapterBase extends EventEmitterCl {
30
177
  // Instantiate the EventEmitter super class
31
178
  super();
32
179
 
180
+ // IAP home directory injected by core when running the adapter within IAP
181
+ [, , , process.env.iap_home] = process.argv;
182
+
33
183
  try {
34
184
  // Capture the adapter id
35
185
  this.id = prongid;
36
186
  this.propUtilInst = new PropUtilCl(prongid, __dirname);
37
-
187
+ propUtil = this.propUtilInst;
188
+ this.initProps = properties;
38
189
  this.alive = false;
39
190
  this.healthy = false;
191
+ this.suspended = false;
192
+ this.suspendMode = 'pause';
40
193
  this.caching = false;
41
194
  this.repeatCacheCount = 0;
42
195
  this.allowFailover = 'AD.300';
@@ -54,7 +207,6 @@ class AdapterBase extends EventEmitterCl {
54
207
  }
55
208
  }
56
209
 
57
-
58
210
  /**
59
211
  * @callback healthCallback
60
212
  * @param {Object} result - the result of the get request (contains an id and a status)
@@ -80,7 +232,6 @@ class AdapterBase extends EventEmitterCl {
80
232
  * @param {String} error - any error that occured
81
233
  */
82
234
 
83
-
84
235
  /**
85
236
  * refreshProperties is used to set up all of the properties for the connector.
86
237
  * It allows properties to be changed later by simply calling refreshProperties rather
@@ -110,14 +261,20 @@ class AdapterBase extends EventEmitterCl {
110
261
 
111
262
  // if invalid properties throw an error
112
263
  if (!result) {
113
- const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Properties', [JSON.stringify(validate.errors)], null, null, null);
114
- log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
115
- throw new Error(JSON.stringify(errorObj));
264
+ if (this.requestHandlerInst) {
265
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Properties', [JSON.stringify(validate.errors)], null, null, null);
266
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
267
+ throw new Error(JSON.stringify(errorObj));
268
+ } else {
269
+ log.error(`${origin}: ${JSON.stringify(validate.errors)}`);
270
+ throw new Error(`${origin}: ${JSON.stringify(validate.errors)}`);
271
+ }
116
272
  }
117
273
 
118
274
  // properties that this code cares about
119
275
  this.healthcheckType = this.allProps.healthcheck.type;
120
276
  this.healthcheckInterval = this.allProps.healthcheck.frequency;
277
+ this.healthcheckQuery = this.allProps.healthcheck.query_object;
121
278
 
122
279
  // set the failover codes from properties
123
280
  if (this.allProps.request.failover_codes) {
@@ -162,9 +319,11 @@ class AdapterBase extends EventEmitterCl {
162
319
  // if there is no healthcheck just change the emit to ONLINE
163
320
  // We do not recommend no healthcheck!!!
164
321
  if (this.healthcheckType === 'none') {
165
- // validate all of the action files - normally done in healthcheck
166
- this.emit('ONLINE', { id: this.id });
167
- this.healthy = true;
322
+ log.error(`${origin}: Waiting 1 Seconds to emit Online`);
323
+ setTimeout(() => {
324
+ this.emit('ONLINE', { id: this.id });
325
+ this.healthy = true;
326
+ }, 1000);
168
327
  }
169
328
 
170
329
  // is the healthcheck only suppose to run on startup
@@ -197,8 +356,22 @@ class AdapterBase extends EventEmitterCl {
197
356
  const origin = `${this.id}-adapterBase-healthCheck`;
198
357
  log.trace(origin);
199
358
 
359
+ // if there is healthcheck query_object property, it needs to be added to the adapter
360
+ let myRequest = reqObj;
361
+ if (this.healthcheckQuery && Object.keys(this.healthcheckQuery).length > 0) {
362
+ if (myRequest && myRequest.uriQuery) {
363
+ myRequest.uriQuery = { ...myRequest.uriQuery, ...this.healthcheckQuery };
364
+ } else if (myRequest) {
365
+ myRequest.uriQuery = this.healthcheckQuery;
366
+ } else {
367
+ myRequest = {
368
+ uriQuery: this.healthcheckQuery
369
+ };
370
+ }
371
+ }
372
+
200
373
  // call to the healthcheck in connector
201
- return this.requestHandlerInst.identifyHealthcheck(reqObj, (res, error) => {
374
+ return this.requestHandlerInst.identifyHealthcheck(myRequest, (res, error) => {
202
375
  // unhealthy
203
376
  if (error) {
204
377
  // if we were healthy, toggle health
@@ -242,7 +415,7 @@ class AdapterBase extends EventEmitterCl {
242
415
  // find the functions in this class
243
416
  do {
244
417
  const l = Object.getOwnPropertyNames(obj)
245
- .concat(Object.getOwnPropertySymbols(obj).map(s => s.toString()))
418
+ .concat(Object.getOwnPropertySymbols(obj).map((s) => s.toString()))
246
419
  .sort()
247
420
  .filter((p, i, arr) => typeof obj[p] === 'function' && p !== 'constructor' && (i === 0 || p !== arr[i - 1]) && myfunctions.indexOf(p) === -1);
248
421
  myfunctions = myfunctions.concat(l);
@@ -254,30 +427,6 @@ class AdapterBase extends EventEmitterCl {
254
427
  return myfunctions;
255
428
  }
256
429
 
257
- /**
258
- * getWorkflowFunctions is used to get all of the workflow function in the adapter
259
- *
260
- * @function getAllFunctions
261
- */
262
- getWorkflowFunctions() {
263
- const myfunctions = this.getAllFunctions();
264
- const wffunctions = [];
265
-
266
- // remove the functions that should not be in a Workflow
267
- for (let m = 0; m < myfunctions.length; m += 1) {
268
- if (myfunctions[m] === 'addEntityCache') {
269
- // got to the second tier (adapterBase)
270
- break;
271
- }
272
- if (myfunctions[m] !== 'hasEntity' && myfunctions[m] !== 'verifyCapability'
273
- && myfunctions[m] !== 'updateEntityCache') {
274
- wffunctions.push(myfunctions[m]);
275
- }
276
- }
277
-
278
- return wffunctions;
279
- }
280
-
281
430
  /**
282
431
  * checkActionFiles is used to update the validation of the action files.
283
432
  *
@@ -313,19 +462,6 @@ class AdapterBase extends EventEmitterCl {
313
462
  }
314
463
  }
315
464
 
316
- /**
317
- * getQueue is used to get information for all of the requests currently in the queue.
318
- *
319
- * @function getQueue
320
- * @param {Callback} callback - a callback function to return the result (Queue) or the error
321
- */
322
- getQueue(callback) {
323
- const origin = `${this.id}-adapterBase-getQueue`;
324
- log.trace(origin);
325
-
326
- return this.requestHandlerInst.getQueue(callback);
327
- }
328
-
329
465
  /**
330
466
  * @summary Takes in property text and an encoding/encryption and returns the resulting
331
467
  * encoded/encrypted string
@@ -346,6 +482,422 @@ class AdapterBase extends EventEmitterCl {
346
482
  return this.requestHandlerInst.encryptProperty(property, technique, callback);
347
483
  }
348
484
 
485
+ /**
486
+ * iapGetAdapterWorkflowFunctions is used to get all of the workflow function in the adapter
487
+ * @param {array} ignoreThese - additional methods to ignore (optional)
488
+ *
489
+ * @function iapGetAdapterWorkflowFunctions
490
+ */
491
+ iapGetAdapterWorkflowFunctions(ignoreThese) {
492
+ const myfunctions = this.getAllFunctions();
493
+ const wffunctions = [];
494
+
495
+ // remove the functions that should not be in a Workflow
496
+ for (let m = 0; m < myfunctions.length; m += 1) {
497
+ if (myfunctions[m] === 'addEntityCache') {
498
+ // got to the second tier (adapterBase)
499
+ break;
500
+ }
501
+ if (!(myfunctions[m].endsWith('Emit') || myfunctions[m].match(/Emit__v[0-9]+/))) {
502
+ let found = false;
503
+ if (ignoreThese && Array.isArray(ignoreThese)) {
504
+ for (let i = 0; i < ignoreThese.length; i += 1) {
505
+ if (myfunctions[m].toUpperCase() === ignoreThese[i].toUpperCase()) {
506
+ found = true;
507
+ }
508
+ }
509
+ }
510
+ if (!found) {
511
+ wffunctions.push(myfunctions[m]);
512
+ }
513
+ }
514
+ }
515
+
516
+ return wffunctions;
517
+ }
518
+
519
+ /**
520
+ * iapUpdateAdapterConfiguration is used to update any of the adapter configuration files. This
521
+ * allows customers to make changes to adapter configuration without having to be on the
522
+ * file system.
523
+ *
524
+ * @function iapUpdateAdapterConfiguration
525
+ * @param {string} configFile - the name of the file being updated (required)
526
+ * @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
527
+ * @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
528
+ * @param {string} type - the type of entity file to change, (action, schema, mock) (optional)
529
+ * @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
530
+ * @param {Callback} callback - The results of the call
531
+ */
532
+ iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
533
+ const meth = 'adapterBase-iapUpdateAdapterConfiguration';
534
+ const origin = `${this.id}-${meth}`;
535
+ log.trace(origin);
536
+
537
+ // verify the parameters are valid
538
+ if (changes === undefined || changes === null || typeof changes !== 'object'
539
+ || Object.keys(changes).length === 0) {
540
+ const result = {
541
+ response: 'No configuration updates to make'
542
+ };
543
+ log.info(result.response);
544
+ return callback(result, null);
545
+ }
546
+ if (configFile === undefined || configFile === null || configFile === '') {
547
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['configFile'], null, null, null);
548
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
549
+ return callback(null, errorObj);
550
+ }
551
+
552
+ // take action based on configFile being changed
553
+ if (configFile === 'package.json') {
554
+ const pres = updatePackage(changes);
555
+ if (pres) {
556
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${pres}`, [], null, null, null);
557
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
558
+ return callback(null, errorObj);
559
+ }
560
+ const result = {
561
+ response: 'Package updates completed - restarting adapter'
562
+ };
563
+ log.info(result.response);
564
+ forceFail(true);
565
+ return callback(result, null);
566
+ }
567
+ if (entity === undefined || entity === null || entity === '') {
568
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Unsupported Configuration Change or Missing Entity', [], null, null, null);
569
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
570
+ return callback(null, errorObj);
571
+ }
572
+
573
+ // this means we are changing an entity file so type is required
574
+ if (type === undefined || type === null || type === '') {
575
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['type'], null, null, null);
576
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
577
+ return callback(null, errorObj);
578
+ }
579
+
580
+ // if the entity does not exist - error
581
+ const epath = `${__dirname}/entities/${entity}`;
582
+ if (!fs.existsSync(epath)) {
583
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Invalid Entity - ${entity}`, [], null, null, null);
584
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
585
+ return callback(null, errorObj);
586
+ }
587
+
588
+ // take action based on type of file being changed
589
+ if (type === 'action') {
590
+ // BACKUP???
591
+ const ares = updateAction(epath, action, changes);
592
+ if (ares) {
593
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${ares}`, [], null, null, null);
594
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
595
+ return callback(null, errorObj);
596
+ }
597
+ // AJV CHECK???
598
+ // RESTORE IF NEEDED???
599
+ const result = {
600
+ response: `Action updates completed to entity: ${entity} - ${action}`
601
+ };
602
+ log.info(result.response);
603
+ return callback(result, null);
604
+ }
605
+ if (type === 'schema') {
606
+ const sres = updateSchema(epath, configFile, changes);
607
+ if (sres) {
608
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${sres}`, [], null, null, null);
609
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
610
+ return callback(null, errorObj);
611
+ }
612
+ const result = {
613
+ response: `Schema updates completed to entity: ${entity} - ${configFile}`
614
+ };
615
+ log.info(result.response);
616
+ return callback(result, null);
617
+ }
618
+ if (type === 'mock') {
619
+ // if the mock directory does not exist - error
620
+ const mpath = `${__dirname}/entities/${entity}/mockdatafiles`;
621
+ if (!fs.existsSync(mpath)) {
622
+ fs.mkdirSync(mpath);
623
+ }
624
+
625
+ const mres = updateMock(mpath, configFile, changes);
626
+ if (mres) {
627
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${mres}`, [], null, null, null);
628
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
629
+ return callback(null, errorObj);
630
+ }
631
+ const result = {
632
+ response: `Mock data updates completed to entity: ${entity} - ${configFile}`
633
+ };
634
+ log.info(result.response);
635
+ return callback(result, null);
636
+ }
637
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Unsupported Type - ${type}`, [], null, null, null);
638
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
639
+ return callback(null, errorObj);
640
+ }
641
+
642
+ /**
643
+ * See if the API path provided is found in this adapter
644
+ *
645
+ * @function iapFindAdapterPath
646
+ * @param {string} apiPath - the api path to check on
647
+ * @param {Callback} callback - The results of the call
648
+ */
649
+ iapFindAdapterPath(apiPath, callback) {
650
+ const result = {
651
+ apiPath
652
+ };
653
+
654
+ // verify the path was provided
655
+ if (!apiPath) {
656
+ log.error('NO API PATH PROVIDED!');
657
+ result.found = false;
658
+ result.message = 'NO PATH PROVIDED!';
659
+ return callback(null, result);
660
+ }
661
+
662
+ // make sure the entities directory exists
663
+ const entitydir = path.join(__dirname, 'entities');
664
+ if (!fs.statSync(entitydir).isDirectory()) {
665
+ log.error('Could not find the entities directory');
666
+ result.found = false;
667
+ result.message = 'Could not find the entities directory';
668
+ return callback(null, result);
669
+ }
670
+
671
+ const entities = fs.readdirSync(entitydir);
672
+ const fitems = [];
673
+
674
+ // need to go through each entity in the entities directory
675
+ for (let e = 0; e < entities.length; e += 1) {
676
+ // make sure the entity is a directory - do not care about extra files
677
+ // only entities (dir)
678
+ if (fs.statSync(`${entitydir}/${entities[e]}`).isDirectory()) {
679
+ // see if the action file exists in the entity
680
+ if (fs.existsSync(`${entitydir}/${entities[e]}/action.json`)) {
681
+ // Read the entity actions from the file system
682
+ const actions = require(`${entitydir}/${entities[e]}/action.json`);
683
+
684
+ // go through all of the actions set the appropriate info in the newActions
685
+ for (let a = 0; a < actions.actions.length; a += 1) {
686
+ if (actions.actions[a].entitypath.indexOf(apiPath) >= 0) {
687
+ log.info(` Found - entity: ${entities[e]} action: ${actions.actions[a].name}`);
688
+ log.info(` method: ${actions.actions[a].method} path: ${actions.actions[a].entitypath}`);
689
+ const fitem = {
690
+ entity: entities[e],
691
+ action: actions.actions[a].name,
692
+ method: actions.actions[a].method,
693
+ path: actions.actions[a].entitypath
694
+ };
695
+ fitems.push(fitem);
696
+ }
697
+ }
698
+ } else {
699
+ log.error(`Could not find entities ${entities[e]} action.json file`);
700
+ result.found = false;
701
+ result.message = `Could not find entities ${entities[e]} action.json file`;
702
+ return callback(null, result);
703
+ }
704
+ } else {
705
+ log.error(`Could not find entities ${entities[e]} directory`);
706
+ result.found = false;
707
+ result.message = `Could not find entities ${entities[e]} directory`;
708
+ return callback(null, result);
709
+ }
710
+ }
711
+
712
+ if (fitems.length === 0) {
713
+ log.info('PATH NOT FOUND!');
714
+ result.found = false;
715
+ result.message = 'API PATH NOT FOUND!';
716
+ return callback(null, result);
717
+ }
718
+
719
+ result.foundIn = fitems;
720
+ result.found = true;
721
+ result.message = 'API PATH FOUND!';
722
+ return callback(result, null);
723
+ }
724
+
725
+ /**
726
+ * @summary Suspends the adapter
727
+ * @param {Callback} callback - The adapater suspension status
728
+ * @function iapSuspendAdapter
729
+ */
730
+ iapSuspendAdapter(mode, callback) {
731
+ const origin = `${this.id}-adapterBase-iapSuspendAdapter`;
732
+ if (this.suspended) {
733
+ throw new Error(`${origin}: Adapter is already suspended`);
734
+ }
735
+ try {
736
+ this.suspended = true;
737
+ this.suspendMode = mode;
738
+ if (this.suspendMode === 'pause') {
739
+ const props = JSON.parse(JSON.stringify(this.initProps));
740
+ // To suspend adapter, enable throttling and set concurrent max to 0
741
+ props.throttle.throttle_enabled = true;
742
+ props.throttle.concurrent_max = 0;
743
+ this.refreshProperties(props);
744
+ }
745
+ return callback({ suspended: true });
746
+ } catch (error) {
747
+ return callback(null, error);
748
+ }
749
+ }
750
+
751
+ /**
752
+ * @summary Unsuspends the adapter
753
+ * @param {Callback} callback - The adapater suspension status
754
+ *
755
+ * @function iapUnsuspendAdapter
756
+ */
757
+ iapUnsuspendAdapter(callback) {
758
+ const origin = `${this.id}-adapterBase-iapUnsuspendAdapter`;
759
+ if (!this.suspended) {
760
+ throw new Error(`${origin}: Adapter is not suspended`);
761
+ }
762
+ if (this.suspendMode === 'pause') {
763
+ const props = JSON.parse(JSON.stringify(this.initProps));
764
+ // To unsuspend adapter, keep throttling enabled and begin processing queued requests in order
765
+ props.throttle.throttle_enabled = true;
766
+ props.throttle.concurrent_max = 1;
767
+ this.refreshProperties(props);
768
+ setTimeout(() => {
769
+ this.getQueue((q, error) => {
770
+ // console.log("Items in queue: " + String(q.length))
771
+ if (q.length === 0) {
772
+ // if queue is empty, return to initial properties state
773
+ this.refreshProperties(this.initProps);
774
+ this.suspended = false;
775
+ return callback({ suspended: false });
776
+ }
777
+ // recursive call to check queue again every second
778
+ return this.iapUnsuspendAdapter(callback);
779
+ });
780
+ }, 1000);
781
+ } else {
782
+ this.suspended = false;
783
+ callback({ suspend: false });
784
+ }
785
+ }
786
+
787
+ /**
788
+ * iapGetAdapterQueue is used to get information for all of the requests currently in the queue.
789
+ *
790
+ * @function iapGetAdapterQueue
791
+ * @param {Callback} callback - a callback function to return the result (Queue) or the error
792
+ */
793
+ iapGetAdapterQueue(callback) {
794
+ const origin = `${this.id}-adapterBase-iapGetAdapterQueue`;
795
+ log.trace(origin);
796
+
797
+ return this.requestHandlerInst.getQueue(callback);
798
+ }
799
+
800
+ /**
801
+ * @summary runs troubleshoot scripts for adapter
802
+ *
803
+ * @function iapTroubleshootAdapter
804
+ * @param {Object} props - the connection, healthcheck and authentication properties
805
+ * @param {boolean} persistFlag - whether the adapter properties should be updated
806
+ * @param {Adapter} adapter - adapter instance to troubleshoot
807
+ * @param {Callback} callback - callback function to return troubleshoot results
808
+ */
809
+ async iapTroubleshootAdapter(props, persistFlag, adapter, callback) {
810
+ try {
811
+ const result = await troubleshootingAdapter.troubleshoot(props, false, persistFlag, adapter);
812
+ if (result.healthCheck && result.connectivity.failCount === 0 && result.basicGet.failCount === 0) {
813
+ return callback(result);
814
+ }
815
+ return callback(null, result);
816
+ } catch (error) {
817
+ return callback(null, error);
818
+ }
819
+ }
820
+
821
+ /**
822
+ * @summary runs healthcheck script for adapter
823
+ *
824
+ * @function iapRunAdapterHealthcheck
825
+ * @param {Adapter} adapter - adapter instance to troubleshoot
826
+ * @param {Callback} callback - callback function to return healthcheck status
827
+ */
828
+ async iapRunAdapterHealthcheck(adapter, callback) {
829
+ try {
830
+ const result = await tbUtils.healthCheck(adapter);
831
+ if (result) {
832
+ return callback(result);
833
+ }
834
+ return callback(null, result);
835
+ } catch (error) {
836
+ return callback(null, error);
837
+ }
838
+ }
839
+
840
+ /**
841
+ * @summary runs connectivity check script for adapter
842
+ *
843
+ * @function iapRunAdapterConnectivity
844
+ * @param {Adapter} adapter - adapter instance to troubleshoot
845
+ * @param {Callback} callback - callback function to return connectivity status
846
+ */
847
+ async iapRunAdapterConnectivity(callback) {
848
+ try {
849
+ const { serviceItem } = await tbUtils.getAdapterConfig();
850
+ const { host } = serviceItem.properties.properties;
851
+ const result = tbUtils.runConnectivity(host, false);
852
+ if (result.failCount > 0) {
853
+ return callback(null, result);
854
+ }
855
+ return callback(result);
856
+ } catch (error) {
857
+ return callback(null, error);
858
+ }
859
+ }
860
+
861
+ /**
862
+ * @summary runs basicGet script for adapter
863
+ *
864
+ * @function iapRunAdapterBasicGet
865
+ * @param {Callback} callback - callback function to return basicGet result
866
+ */
867
+ iapRunAdapterBasicGet(callback) {
868
+ try {
869
+ const result = tbUtils.runBasicGet(false);
870
+ if (result.failCount > 0) {
871
+ return callback(null, result);
872
+ }
873
+ return callback(result);
874
+ } catch (error) {
875
+ return callback(null, error);
876
+ }
877
+ }
878
+
879
+ /**
880
+ * @summary moves entities to mongo database
881
+ *
882
+ * @function iapMoveAdapterEntitiesToDB
883
+ *
884
+ * @return {Callback} - containing the response from the mongo transaction
885
+ */
886
+ async iapMoveAdapterEntitiesToDB(callback) {
887
+ const meth = 'adapterBase-iapMoveAdapterEntitiesToDB';
888
+ const origin = `${this.id}-${meth}`;
889
+ log.trace(origin);
890
+
891
+ try {
892
+ const result = await entitiesToDB.moveEntitiesToDB(__dirname, { pronghornProps: this.allProps, id: this.id });
893
+ return callback(result, null);
894
+ } catch (err) {
895
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, err);
896
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
897
+ return callback(null, err.message);
898
+ }
899
+ }
900
+
349
901
  /**
350
902
  * @summary take the entities and add them to the cache
351
903
  *
@@ -406,7 +958,7 @@ class AdapterBase extends EventEmitterCl {
406
958
  const resEntity = [];
407
959
 
408
960
  for (let e = 0; e < entityId.length; e += 1) {
409
- if (data.includes(entityId)) {
961
+ if (data.includes(entityId[e])) {
410
962
  resEntity.push(true);
411
963
  } else {
412
964
  resEntity.push(false);
@@ -430,7 +982,7 @@ class AdapterBase extends EventEmitterCl {
430
982
  * desired capability or an error
431
983
  */
432
984
  capabilityResults(results, callback) {
433
- const meth = 'adapterBase-getQueue';
985
+ const meth = 'adapterBase-capabilityResults';
434
986
  const origin = `${this.id}-${meth}`;
435
987
  log.trace(origin);
436
988
  let locResults = results;
@@ -496,6 +1048,735 @@ class AdapterBase extends EventEmitterCl {
496
1048
  return [];
497
1049
  }
498
1050
  }
1051
+
1052
+ /**
1053
+ * @summary Determines if this adapter supports any in a list of entities
1054
+ *
1055
+ * @function hasEntities
1056
+ * @param {String} entityType - the entity type to check for
1057
+ * @param {Array} entityList - the list of entities we are looking for
1058
+ *
1059
+ * @param {Callback} callback - A map where the entity is the key and the
1060
+ * value is true or false
1061
+ */
1062
+ hasEntities(entityType, entityList, callback) {
1063
+ const origin = `${this.id}-adapter-hasEntities`;
1064
+ log.trace(origin);
1065
+
1066
+ switch (entityType) {
1067
+ case 'Device':
1068
+ return this.hasDevices(entityList, callback);
1069
+ default:
1070
+ return callback(null, `${this.id} does not support entity ${entityType}`);
1071
+ }
1072
+ }
1073
+
1074
+ /**
1075
+ * @summary Helper method for hasEntities for the specific device case
1076
+ *
1077
+ * @param {Array} deviceList - array of unique device identifiers
1078
+ * @param {Callback} callback - A map where the device is the key and the
1079
+ * value is true or false
1080
+ */
1081
+ hasDevices(deviceList, callback) {
1082
+ const origin = `${this.id}-adapter-hasDevices`;
1083
+ log.trace(origin);
1084
+
1085
+ const findings = deviceList.reduce((map, device) => {
1086
+ // eslint-disable-next-line no-param-reassign
1087
+ map[device] = false;
1088
+ log.debug(`In reduce: ${JSON.stringify(map)}`);
1089
+ return map;
1090
+ }, {});
1091
+ const apiCalls = deviceList.map((device) => new Promise((resolve) => {
1092
+ this.getDevice(device, (result, error) => {
1093
+ if (error) {
1094
+ log.debug(`In map error: ${JSON.stringify(device)}`);
1095
+ return resolve({ name: device, found: false });
1096
+ }
1097
+ log.debug(`In map: ${JSON.stringify(device)}`);
1098
+ return resolve({ name: device, found: true });
1099
+ });
1100
+ }));
1101
+ Promise.all(apiCalls).then((results) => {
1102
+ results.forEach((device) => {
1103
+ findings[device.name] = device.found;
1104
+ });
1105
+ log.debug(`FINDINGS: ${JSON.stringify(findings)}`);
1106
+ return callback(findings);
1107
+ }).catch((errors) => {
1108
+ log.error('Unable to do device lookup.');
1109
+ return callback(null, { code: 503, message: 'Unable to do device lookup.', error: errors });
1110
+ });
1111
+ }
1112
+
1113
+ /**
1114
+ * @summary Make one of the needed Broker calls - could be one of many
1115
+ *
1116
+ * @function iapMakeBrokerCall
1117
+ * @param {string} brokCall - the name of the broker call (required)
1118
+ * @param {object} callProps - the proeprties for the broker call (required)
1119
+ * @param {object} devResp - the device details to extract needed inputs (required)
1120
+ * @param {string} filterName - any filter to search on (required)
1121
+ *
1122
+ * @param {getCallback} callback - a callback function to return the result of the call
1123
+ */
1124
+ iapMakeBrokerCall(brokCall, callProps, devResp, filterName, callback) {
1125
+ const meth = 'adapterBase-iapMakeBrokerCall';
1126
+ const origin = `${this.id}-${meth}`;
1127
+ log.trace(origin);
1128
+
1129
+ try {
1130
+ let uriPath = '';
1131
+ let uriMethod = 'GET';
1132
+ let callQuery = {};
1133
+ let callBody = {};
1134
+ let callHeaders = {};
1135
+ let handleFail = 'fail';
1136
+ let ostypePrefix = '';
1137
+ let statusValue = 'true';
1138
+ if (callProps.path) {
1139
+ uriPath = `${callProps.path}`;
1140
+
1141
+ // make any necessary changes to the path
1142
+ if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
1143
+ const rqKeys = Object.keys(callProps.requestFields);
1144
+
1145
+ // get the field from the provided device
1146
+ for (let rq = 0; rq < rqKeys.length; rq += 1) {
1147
+ const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
1148
+
1149
+ // put the value into the path - if it has been specified in the path
1150
+ uriPath = uriPath.replace(`{${rqKeys[rq]}}`, fieldValue);
1151
+ }
1152
+ }
1153
+ }
1154
+ if (callProps.method) {
1155
+ uriMethod = callProps.method;
1156
+ }
1157
+ if (callProps.query) {
1158
+ callQuery = callProps.query;
1159
+
1160
+ // go through the query params to check for variable values
1161
+ const cpKeys = Object.keys(callQuery);
1162
+ for (let cp = 0; cp < cpKeys.length; cp += 1) {
1163
+ if (callQuery[cpKeys[cp]].startsWith('{') && callQuery[cpKeys[cp]].endsWith('}')) {
1164
+ // make any necessary changes to the query params
1165
+ if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
1166
+ const rqKeys = Object.keys(callProps.requestFields);
1167
+
1168
+ // get the field from the provided device
1169
+ for (let rq = 0; rq < rqKeys.length; rq += 1) {
1170
+ if (cpKeys[cp] === rqKeys[rq]) {
1171
+ const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
1172
+
1173
+ // put the value into the query - if it has been specified in the query
1174
+ callQuery[cpKeys[cp]] = fieldValue;
1175
+ }
1176
+ }
1177
+ }
1178
+ }
1179
+ }
1180
+ }
1181
+ if (callProps.body) {
1182
+ callBody = callProps.body;
1183
+
1184
+ // go through the body fields to check for variable values
1185
+ const cbKeys = Object.keys(callBody);
1186
+ for (let cb = 0; cb < cbKeys.length; cb += 1) {
1187
+ if (callBody[cbKeys[cb]].startsWith('{') && callBody[cbKeys[cb]].endsWith('}')) {
1188
+ // make any necessary changes to the query params
1189
+ if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
1190
+ const rqKeys = Object.keys(callProps.requestFields);
1191
+
1192
+ // get the field from the provided device
1193
+ for (let rq = 0; rq < rqKeys.length; rq += 1) {
1194
+ if (cbKeys[cb] === rqKeys[rq]) {
1195
+ const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
1196
+
1197
+ // put the value into the query - if it has been specified in the query
1198
+ callBody[cbKeys[cb]] = fieldValue;
1199
+ }
1200
+ }
1201
+ }
1202
+ }
1203
+ }
1204
+ }
1205
+ if (callProps.headers) {
1206
+ callHeaders = callProps.headers;
1207
+
1208
+ // go through the body fields to check for variable values
1209
+ const chKeys = Object.keys(callHeaders);
1210
+ for (let ch = 0; ch < chKeys.length; ch += 1) {
1211
+ if (callHeaders[chKeys[ch]].startsWith('{') && callHeaders[chKeys[ch]].endsWith('}')) {
1212
+ // make any necessary changes to the query params
1213
+ if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
1214
+ const rqKeys = Object.keys(callProps.requestFields);
1215
+
1216
+ // get the field from the provided device
1217
+ for (let rq = 0; rq < rqKeys.length; rq += 1) {
1218
+ if (chKeys[ch] === rqKeys[rq]) {
1219
+ const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
1220
+
1221
+ // put the value into the query - if it has been specified in the query
1222
+ callHeaders[chKeys[ch]] = fieldValue;
1223
+ }
1224
+ }
1225
+ }
1226
+ }
1227
+ }
1228
+ }
1229
+ if (callProps.handleFailure) {
1230
+ handleFail = callProps.handleFailure;
1231
+ }
1232
+ if (callProps.responseFields && callProps.responseFields.ostypePrefix) {
1233
+ ostypePrefix = callProps.responseFields.ostypePrefix;
1234
+ }
1235
+ if (callProps.responseFields && callProps.responseFields.statusValue) {
1236
+ statusValue = callProps.responseFields.statusValue;
1237
+ }
1238
+
1239
+ // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
1240
+ // !! you can also replace with a specific call if that is easier
1241
+ return this.genericAdapterRequest(uriPath, uriMethod, callQuery, callBody, callHeaders, (result, error) => {
1242
+ // if we received an error or their is no response on the results return an error
1243
+ if (error) {
1244
+ if (handleFail === 'fail') {
1245
+ return callback(null, error);
1246
+ }
1247
+ return callback({}, null);
1248
+ }
1249
+ if (!result.response) {
1250
+ if (handleFail === 'fail') {
1251
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', [brokCall], null, null, null);
1252
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1253
+ return callback(null, errorObj);
1254
+ }
1255
+ return callback({}, null);
1256
+ }
1257
+
1258
+ // get the response piece we care about from the response
1259
+ const myResult = result;
1260
+ if (callProps.responseDatakey) {
1261
+ myResult.response = jsonQuery(callProps.responseDatakey, { data: myResult.response }).value;
1262
+ }
1263
+
1264
+ // get the keys for the response fields
1265
+ let rfKeys = [];
1266
+ if (callProps.responseFields && Object.keys(callProps.responseFields).length > 0) {
1267
+ rfKeys = Object.keys(callProps.responseFields);
1268
+ }
1269
+
1270
+ // if we got an array returned (e.g. getDevicesFitered)
1271
+ if (Array.isArray(myResult.response)) {
1272
+ const listDevices = [];
1273
+ for (let a = 0; a < myResult.response.length; a += 1) {
1274
+ const thisDevice = myResult.response[a];
1275
+ for (let rf = 0; rf < rfKeys.length; rf += 1) {
1276
+ if (rfKeys[rf] !== 'ostypePrefix') {
1277
+ let fieldValue = getDataFromSources(callProps.responseFields[rfKeys[rf]], [thisDevice, devResp, callProps.requestFields]);
1278
+
1279
+ // if the field is ostype - need to add prefix
1280
+ if (rfKeys[rf] === 'ostype' && typeof fieldValue === 'string') {
1281
+ fieldValue = ostypePrefix + fieldValue;
1282
+ }
1283
+ // if there is a status to set, set it
1284
+ if (rfKeys[rf] === 'status') {
1285
+ // if really looking for just a good response
1286
+ if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && myResult.icode === statusValue.toString()) {
1287
+ thisDevice.isAlive = true;
1288
+ } else if (fieldValue.toString() === statusValue.toString()) {
1289
+ thisDevice.isAlive = true;
1290
+ } else {
1291
+ thisDevice.isAlive = false;
1292
+ }
1293
+ }
1294
+ // if we found a good value
1295
+ thisDevice[rfKeys[rf]] = fieldValue;
1296
+ }
1297
+ }
1298
+
1299
+ // if there is no filter - add the device to the list
1300
+ if (!filterName || filterName.length === 0) {
1301
+ listDevices.push(thisDevice);
1302
+ } else {
1303
+ // if we have to match a filter
1304
+ let found = false;
1305
+ for (let f = 0; f < filterName.length; f += 1) {
1306
+ if (thisDevice.name.indexOf(filterName[f]) >= 0) {
1307
+ found = true;
1308
+ break;
1309
+ }
1310
+ }
1311
+ // matching device
1312
+ if (found) {
1313
+ listDevices.push(thisDevice);
1314
+ }
1315
+ }
1316
+ }
1317
+
1318
+ // return the array of devices
1319
+ return callback(listDevices, null);
1320
+ }
1321
+
1322
+ // if this is not an array - just about everything else, just handle as a single object
1323
+ let thisDevice = myResult.response;
1324
+ for (let rf = 0; rf < rfKeys.length; rf += 1) {
1325
+ // skip ostypePrefix since it is not a field
1326
+ if (rfKeys[rf] !== 'ostypePrefix') {
1327
+ let fieldValue = getDataFromSources(callProps.responseFields[rfKeys[rf]], [thisDevice, devResp, callProps.requestFields]);
1328
+
1329
+ // if the field is ostype - need to add prefix
1330
+ if (rfKeys[rf] === 'ostype' && typeof fieldValue === 'string') {
1331
+ fieldValue = ostypePrefix + fieldValue;
1332
+ }
1333
+ // if there is a status to set, set it
1334
+ if (rfKeys[rf] === 'status') {
1335
+ // if really looking for just a good response
1336
+ if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && myResult.icode === statusValue.toString()) {
1337
+ thisDevice.isAlive = true;
1338
+ } else if (fieldValue.toString() === statusValue.toString()) {
1339
+ thisDevice.isAlive = true;
1340
+ } else {
1341
+ thisDevice.isAlive = false;
1342
+ }
1343
+ }
1344
+ // if we found a good value
1345
+ thisDevice[rfKeys[rf]] = fieldValue;
1346
+ }
1347
+ }
1348
+
1349
+ // if there is a filter - check the device is in the list
1350
+ if (filterName && filterName.length > 0) {
1351
+ let found = false;
1352
+ for (let f = 0; f < filterName.length; f += 1) {
1353
+ if (thisDevice.name.indexOf(filterName[f]) >= 0) {
1354
+ found = true;
1355
+ break;
1356
+ }
1357
+ }
1358
+ // no matching device - clear the device
1359
+ if (!found) {
1360
+ thisDevice = {};
1361
+ }
1362
+ }
1363
+
1364
+ return callback(thisDevice, null);
1365
+ });
1366
+ } catch (e) {
1367
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, e);
1368
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1369
+ return callback(null, errorObj);
1370
+ }
1371
+ }
1372
+
1373
+ /**
1374
+ * @summary Get Appliance that match the deviceName
1375
+ *
1376
+ * @function getDevice
1377
+ * @param {String} deviceName - the deviceName to find (required)
1378
+ *
1379
+ * @param {getCallback} callback - a callback function to return the result
1380
+ * (appliance) or the error
1381
+ */
1382
+ getDevice(deviceName, callback) {
1383
+ const meth = 'adapterBase-getDevice';
1384
+ const origin = `${this.id}-${meth}`;
1385
+ log.trace(origin);
1386
+
1387
+ // make sure we are set up for device broker getDevice
1388
+ if (!this.allProps.devicebroker || !this.allProps.devicebroker.getDevice || this.allProps.devicebroker.getDevice.length === 0 || !this.allProps.devicebroker.getDevice[0].path) {
1389
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getDevice.path'], null, null, null);
1390
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1391
+ return callback(null, errorObj);
1392
+ }
1393
+
1394
+ /* HERE IS WHERE YOU VALIDATE DATA */
1395
+ if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
1396
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
1397
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1398
+ return callback(null, errorObj);
1399
+ }
1400
+
1401
+ try {
1402
+ // need to get the device so we can convert the deviceName to an id
1403
+ // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
1404
+ const opts = {
1405
+ filter: {
1406
+ name: deviceName
1407
+ }
1408
+ };
1409
+ return this.getDevicesFiltered(opts, (devs, ferr) => {
1410
+ // if we received an error or their is no response on the results return an error
1411
+ if (ferr) {
1412
+ return callback(null, ferr);
1413
+ }
1414
+ if (devs.list.length < 1) {
1415
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
1416
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1417
+ return callback(null, errorObj);
1418
+ }
1419
+
1420
+ const callPromises = [];
1421
+ for (let i = 0; i < this.allProps.devicebroker.getDevice.length; i += 1) {
1422
+ // Perform component calls here.
1423
+ callPromises.push(
1424
+ new Promise((resolve, reject) => {
1425
+ this.iapMakeBrokerCall('getDevice', this.allProps.devicebroker.getDevice[i], [devs.list[0]], null, (callRet, callErr) => {
1426
+ // return an error
1427
+ if (callErr) {
1428
+ reject(callErr);
1429
+ } else {
1430
+ // return the data
1431
+ resolve(callRet);
1432
+ }
1433
+ });
1434
+ })
1435
+ );
1436
+ }
1437
+
1438
+ // return an array of repsonses
1439
+ return Promise.all(callPromises).then((results) => {
1440
+ let myResult = {};
1441
+ results.forEach((result) => {
1442
+ myResult = { ...myResult, ...result };
1443
+ });
1444
+
1445
+ return callback(myResult, null);
1446
+ });
1447
+ });
1448
+ } catch (ex) {
1449
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1450
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1451
+ return callback(null, errorObj);
1452
+ }
1453
+ }
1454
+
1455
+ /**
1456
+ * @summary Get Appliances that match the filter
1457
+ *
1458
+ * @function getDevicesFiltered
1459
+ * @param {Object} options - the data to use to filter the appliances (optional)
1460
+ *
1461
+ * @param {getCallback} callback - a callback function to return the result
1462
+ * (appliances) or the error
1463
+ */
1464
+ getDevicesFiltered(options, callback) {
1465
+ const meth = 'adapterBase-getDevicesFiltered';
1466
+ const origin = `${this.id}-${meth}`;
1467
+ log.trace(origin);
1468
+
1469
+ // make sure we are set up for device broker getDevicesFiltered
1470
+ if (!this.allProps.devicebroker || !this.allProps.devicebroker.getDevicesFiltered || this.allProps.devicebroker.getDevicesFiltered.length === 0 || !this.allProps.devicebroker.getDevicesFiltered[0].path) {
1471
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getDevicesFiltered.path'], null, null, null);
1472
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1473
+ return callback(null, errorObj);
1474
+ }
1475
+
1476
+ // verify the required fields have been provided
1477
+ if (options === undefined || options === null || options === '' || options.length === 0) {
1478
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['options'], null, null, null);
1479
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1480
+ return callback(null, errorObj);
1481
+ }
1482
+ log.debug(`Device Filter Options: ${JSON.stringify(options)}`);
1483
+
1484
+ try {
1485
+ // TODO - get pagination working
1486
+ // const nextToken = options.start;
1487
+ // const maxResults = options.limit;
1488
+
1489
+ // set up the filter of Device Names
1490
+ let filterName = [];
1491
+ if (options && options.filter && options.filter.name) {
1492
+ // when this hack is removed, remove the lint ignore above
1493
+ if (Array.isArray(options.filter.name)) {
1494
+ // eslint-disable-next-line prefer-destructuring
1495
+ filterName = options.filter.name;
1496
+ } else {
1497
+ filterName = [options.filter.name];
1498
+ }
1499
+ }
1500
+
1501
+ // TODO - get sort and order working
1502
+ /*
1503
+ if (options && options.sort) {
1504
+ reqObj.uriOptions.sort = JSON.stringify(options.sort);
1505
+ }
1506
+ if (options && options.order) {
1507
+ reqObj.uriOptions.order = options.order;
1508
+ }
1509
+ */
1510
+ const callPromises = [];
1511
+ for (let i = 0; i < this.allProps.devicebroker.getDevicesFiltered.length; i += 1) {
1512
+ // Perform component calls here.
1513
+ callPromises.push(
1514
+ new Promise((resolve, reject) => {
1515
+ this.iapMakeBrokerCall('getDevicesFiltered', this.allProps.devicebroker.getDevicesFiltered[i], [{ fake: 'fakedata' }], filterName, (callRet, callErr) => {
1516
+ // return an error
1517
+ if (callErr) {
1518
+ reject(callErr);
1519
+ } else {
1520
+ // return the data
1521
+ resolve(callRet);
1522
+ }
1523
+ });
1524
+ })
1525
+ );
1526
+ }
1527
+
1528
+ // return an array of repsonses
1529
+ return Promise.all(callPromises).then((results) => {
1530
+ let myResult = [];
1531
+ results.forEach((result) => {
1532
+ if (Array.isArray(result)) {
1533
+ myResult = [...myResult, ...result];
1534
+ } else if (Object.keys(result).length > 0) {
1535
+ myResult.push(result);
1536
+ }
1537
+ });
1538
+
1539
+ log.debug(`${origin}: Found #${myResult.length} devices.`);
1540
+ log.debug(`Devices: ${JSON.stringify(myResult)}`);
1541
+ return callback({ total: myResult.length, list: myResult });
1542
+ });
1543
+ } catch (ex) {
1544
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1545
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1546
+ return callback(null, errorObj);
1547
+ }
1548
+ }
1549
+
1550
+ /**
1551
+ * @summary Gets the status for the provided appliance
1552
+ *
1553
+ * @function isAlive
1554
+ * @param {String} deviceName - the deviceName of the appliance. (required)
1555
+ *
1556
+ * @param {configCallback} callback - callback function to return the result
1557
+ * (appliance isAlive) or the error
1558
+ */
1559
+ isAlive(deviceName, callback) {
1560
+ const meth = 'adapterBase-isAlive';
1561
+ const origin = `${this.id}-${meth}`;
1562
+ log.trace(origin);
1563
+
1564
+ // make sure we are set up for device broker isAlive
1565
+ if (!this.allProps.devicebroker || !this.allProps.devicebroker.isAlive || this.allProps.devicebroker.isAlive.length === 0 || !this.allProps.devicebroker.isAlive[0].path) {
1566
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.isAlive.path'], null, null, null);
1567
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1568
+ return callback(null, errorObj);
1569
+ }
1570
+
1571
+ // verify the required fields have been provided
1572
+ if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
1573
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
1574
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1575
+ return callback(null, errorObj);
1576
+ }
1577
+
1578
+ try {
1579
+ // need to get the device so we can convert the deviceName to an id
1580
+ // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
1581
+ const opts = {
1582
+ filter: {
1583
+ name: deviceName
1584
+ }
1585
+ };
1586
+ return this.getDevicesFiltered(opts, (devs, ferr) => {
1587
+ // if we received an error or their is no response on the results return an error
1588
+ if (ferr) {
1589
+ return callback(null, ferr);
1590
+ }
1591
+ if (devs.list.length < 1) {
1592
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
1593
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1594
+ return callback(null, errorObj);
1595
+ }
1596
+
1597
+ const callPromises = [];
1598
+ for (let i = 0; i < this.allProps.devicebroker.isAlive.length; i += 1) {
1599
+ // Perform component calls here.
1600
+ callPromises.push(
1601
+ new Promise((resolve, reject) => {
1602
+ this.iapMakeBrokerCall('isAlive', this.allProps.devicebroker.isAlive[i], [devs.list[0]], null, (callRet, callErr) => {
1603
+ // return an error
1604
+ if (callErr) {
1605
+ reject(callErr);
1606
+ } else {
1607
+ // return the data
1608
+ resolve(callRet);
1609
+ }
1610
+ });
1611
+ })
1612
+ );
1613
+ }
1614
+
1615
+ // return an array of repsonses
1616
+ return Promise.all(callPromises).then((results) => {
1617
+ let myResult = {};
1618
+ results.forEach((result) => {
1619
+ myResult = { ...myResult, ...result };
1620
+ });
1621
+
1622
+ let response = true;
1623
+ if (myResult.isAlive !== null && myResult.isAlive !== undefined && myResult.isAlive === false) {
1624
+ response = false;
1625
+ }
1626
+ return callback(response);
1627
+ });
1628
+ });
1629
+ } catch (ex) {
1630
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1631
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1632
+ return callback(null, errorObj);
1633
+ }
1634
+ }
1635
+
1636
+ /**
1637
+ * @summary Gets a config for the provided Appliance
1638
+ *
1639
+ * @function getConfig
1640
+ * @param {String} deviceName - the deviceName of the appliance. (required)
1641
+ * @param {String} format - the desired format of the config. (optional)
1642
+ *
1643
+ * @param {configCallback} callback - callback function to return the result
1644
+ * (appliance config) or the error
1645
+ */
1646
+ getConfig(deviceName, format, callback) {
1647
+ const meth = 'adapterBase-getConfig';
1648
+ const origin = `${this.id}-${meth}`;
1649
+ log.trace(origin);
1650
+
1651
+ // make sure we are set up for device broker getConfig
1652
+ if (!this.allProps.devicebroker || !this.allProps.devicebroker.getConfig || this.allProps.devicebroker.getConfig.length === 0 || !this.allProps.devicebroker.getConfig[0].path) {
1653
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getConfig.path'], null, null, null);
1654
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1655
+ return callback(null, errorObj);
1656
+ }
1657
+
1658
+ // verify the required fields have been provided
1659
+ if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
1660
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
1661
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1662
+ return callback(null, errorObj);
1663
+ }
1664
+
1665
+ try {
1666
+ // need to get the device so we can convert the deviceName to an id
1667
+ // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
1668
+ const opts = {
1669
+ filter: {
1670
+ name: deviceName
1671
+ }
1672
+ };
1673
+ return this.getDevicesFiltered(opts, (devs, ferr) => {
1674
+ // if we received an error or their is no response on the results return an error
1675
+ if (ferr) {
1676
+ return callback(null, ferr);
1677
+ }
1678
+ if (devs.list.length < 1) {
1679
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
1680
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1681
+ return callback(null, errorObj);
1682
+ }
1683
+
1684
+ const callPromises = [];
1685
+ for (let i = 0; i < this.allProps.devicebroker.getConfig.length; i += 1) {
1686
+ // Perform component calls here.
1687
+ callPromises.push(
1688
+ new Promise((resolve, reject) => {
1689
+ this.iapMakeBrokerCall('getConfig', this.allProps.devicebroker.getConfig[i], [devs.list[0]], null, (callRet, callErr) => {
1690
+ // return an error
1691
+ if (callErr) {
1692
+ reject(callErr);
1693
+ } else {
1694
+ // return the data
1695
+ resolve(callRet);
1696
+ }
1697
+ });
1698
+ })
1699
+ );
1700
+ }
1701
+
1702
+ // return an array of repsonses
1703
+ return Promise.all(callPromises).then((results) => {
1704
+ let myResult = {};
1705
+ results.forEach((result) => {
1706
+ myResult = { ...myResult, ...result };
1707
+ });
1708
+
1709
+ // return the result
1710
+ const newResponse = {
1711
+ response: JSON.stringify(myResult, null, 2)
1712
+ };
1713
+ return callback(newResponse, null);
1714
+ });
1715
+ });
1716
+ } catch (ex) {
1717
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1718
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1719
+ return callback(null, errorObj);
1720
+ }
1721
+ }
1722
+
1723
+ /**
1724
+ * @summary Gets the device count from the system
1725
+ *
1726
+ * @function iapGetDeviceCount
1727
+ *
1728
+ * @param {getCallback} callback - callback function to return the result
1729
+ * (count) or the error
1730
+ */
1731
+ iapGetDeviceCount(callback) {
1732
+ const meth = 'adapterBase-iapGetDeviceCount';
1733
+ const origin = `${this.id}-${meth}`;
1734
+ log.trace(origin);
1735
+
1736
+ // make sure we are set up for device broker getCount
1737
+ if (!this.allProps.devicebroker || !this.allProps.devicebroker.getCount || this.allProps.devicebroker.getCount.length === 0 || !this.allProps.devicebroker.getCount[0].path) {
1738
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getCount.path'], null, null, null);
1739
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1740
+ return callback(null, errorObj);
1741
+ }
1742
+
1743
+ // verify the required fields have been provided
1744
+
1745
+ try {
1746
+ const callPromises = [];
1747
+ for (let i = 0; i < this.allProps.devicebroker.getCount.length; i += 1) {
1748
+ // Perform component calls here.
1749
+ callPromises.push(
1750
+ new Promise((resolve, reject) => {
1751
+ this.iapMakeBrokerCall('getCount', this.allProps.devicebroker.getCount[i], null, null, (callRet, callErr) => {
1752
+ // return an error
1753
+ if (callErr) {
1754
+ reject(callErr);
1755
+ } else {
1756
+ // return the data
1757
+ resolve(callRet);
1758
+ }
1759
+ });
1760
+ })
1761
+ );
1762
+ }
1763
+
1764
+ // return an array of repsonses
1765
+ return Promise.all(callPromises).then((results) => {
1766
+ let myResult = {};
1767
+ results.forEach((result) => {
1768
+ myResult = { ...myResult, ...result };
1769
+ });
1770
+
1771
+ // return the result
1772
+ return callback({ count: myResult.length });
1773
+ });
1774
+ } catch (ex) {
1775
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1776
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1777
+ return callback(null, errorObj);
1778
+ }
1779
+ }
499
1780
  }
500
1781
 
501
1782
  module.exports = AdapterBase;