@itentialopensource/adapter-oracle_cloud 0.1.1 → 0.3.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.
- package/AUTH.md +39 -0
- package/BROKER.md +199 -0
- package/CALLS.md +859 -0
- package/CHANGELOG.md +17 -2
- package/CODE_OF_CONDUCT.md +12 -17
- package/CONTRIBUTING.md +3 -148
- package/ENHANCE.md +69 -0
- package/PROPERTIES.md +641 -0
- package/README.md +235 -576
- package/SUMMARY.md +9 -0
- package/SYSTEMINFO.md +11 -0
- package/TROUBLESHOOT.md +47 -0
- package/adapter.js +371 -270
- package/adapterBase.js +843 -419
- package/changelogs/changelog.md +16 -0
- package/entities/.generic/action.json +105 -0
- package/entities/.generic/schema.json +6 -1
- package/error.json +6 -0
- package/metadata.json +49 -0
- package/package.json +24 -24
- package/pronghorn.json +680 -100
- package/propertiesDecorators.json +14 -0
- package/propertiesSchema.json +830 -9
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +11867 -0
- package/report/adapter-openapi.yaml +11966 -0
- package/report/adapterInfo.json +10 -0
- package/report/updateReport1653049581192.json +120 -0
- package/report/updateReport1691507422430.json +120 -0
- package/report/updateReport1692202455354.json +120 -0
- package/report/updateReport1694460824360.json +120 -0
- package/report/updateReport1698420559437.json +120 -0
- package/sampleProperties.json +153 -3
- package/test/integration/adapterTestBasicGet.js +3 -5
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +176 -127
- package/test/unit/adapterBaseTestUnit.js +388 -308
- package/test/unit/adapterTestUnit.js +643 -402
- package/utils/adapterInfo.js +206 -0
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +12 -57
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +273 -0
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- package/utils/patches2bundledDeps.js +90 -0
- package/utils/pre-commit.sh +5 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +123 -53
- package/utils/tbUtils.js +92 -48
- package/utils/testRunner.js +17 -17
- package/utils/troubleshootingAdapter.js +9 -6
- package/workflows/README.md +0 -3
package/adapterBase.js
CHANGED
|
@@ -8,15 +8,21 @@
|
|
|
8
8
|
/* eslint no-cond-assign: warn */
|
|
9
9
|
/* eslint global-require: warn */
|
|
10
10
|
/* eslint no-unused-vars: warn */
|
|
11
|
+
/* eslint prefer-destructuring: warn */
|
|
11
12
|
|
|
12
13
|
/* Required libraries. */
|
|
13
|
-
const fs = require('fs-extra');
|
|
14
14
|
const path = require('path');
|
|
15
|
-
const EventEmitterCl = require('events').EventEmitter;
|
|
16
15
|
const { execSync } = require('child_process');
|
|
16
|
+
const { spawnSync } = require('child_process');
|
|
17
|
+
const EventEmitterCl = require('events').EventEmitter;
|
|
18
|
+
const fs = require('fs-extra');
|
|
19
|
+
const jsonQuery = require('json-query');
|
|
20
|
+
|
|
21
|
+
const sampleProperties = require(`${__dirname}/sampleProperties.json`).properties;
|
|
17
22
|
|
|
18
23
|
/* The schema validator */
|
|
19
24
|
const AjvCl = require('ajv');
|
|
25
|
+
const { Test } = require('mocha');
|
|
20
26
|
|
|
21
27
|
/* Fetch in the other needed components for the this Adaptor */
|
|
22
28
|
const PropUtilCl = require('@itentialopensource/adapter-utils').PropertyUtility;
|
|
@@ -25,8 +31,10 @@ const RequestHandlerCl = require('@itentialopensource/adapter-utils').RequestHan
|
|
|
25
31
|
const entitiesToDB = require(path.join(__dirname, 'utils/entitiesToDB'));
|
|
26
32
|
const troubleshootingAdapter = require(path.join(__dirname, 'utils/troubleshootingAdapter'));
|
|
27
33
|
const tbUtils = require(path.join(__dirname, 'utils/tbUtils'));
|
|
34
|
+
const taskMover = require(path.join(__dirname, 'utils/taskMover'));
|
|
28
35
|
|
|
29
36
|
let propUtil = null;
|
|
37
|
+
let choosepath = null;
|
|
30
38
|
|
|
31
39
|
/*
|
|
32
40
|
* INTERNAL FUNCTION: force fail the adapter - generally done to cause restart
|
|
@@ -99,7 +107,7 @@ function updateSchema(entityPath, configFile, changes) {
|
|
|
99
107
|
/*
|
|
100
108
|
* INTERNAL FUNCTION: update the mock data file
|
|
101
109
|
*/
|
|
102
|
-
function updateMock(mockPath, configFile, changes) {
|
|
110
|
+
function updateMock(mockPath, configFile, changes, replace) {
|
|
103
111
|
// if the mock file does not exist - create it
|
|
104
112
|
const mockFile = path.join(mockPath, `/${configFile}`);
|
|
105
113
|
if (!fs.existsSync(mockFile)) {
|
|
@@ -111,7 +119,11 @@ function updateMock(mockPath, configFile, changes) {
|
|
|
111
119
|
let mock = require(path.resolve(mockPath, configFile));
|
|
112
120
|
|
|
113
121
|
// merge the changes into the mock file
|
|
114
|
-
|
|
122
|
+
if (replace === true) {
|
|
123
|
+
mock = changes;
|
|
124
|
+
} else {
|
|
125
|
+
mock = propUtil.mergeProperties(changes, mock);
|
|
126
|
+
}
|
|
115
127
|
|
|
116
128
|
fs.writeFileSync(mockFile, JSON.stringify(mock, null, 2));
|
|
117
129
|
return null;
|
|
@@ -154,6 +166,9 @@ class AdapterBase extends EventEmitterCl {
|
|
|
154
166
|
// Instantiate the EventEmitter super class
|
|
155
167
|
super();
|
|
156
168
|
|
|
169
|
+
// IAP home directory injected by core when running the adapter within IAP
|
|
170
|
+
[, , , process.env.iap_home] = process.argv;
|
|
171
|
+
|
|
157
172
|
try {
|
|
158
173
|
// Capture the adapter id
|
|
159
174
|
this.id = prongid;
|
|
@@ -229,7 +244,7 @@ class AdapterBase extends EventEmitterCl {
|
|
|
229
244
|
this.allProps = this.propUtilInst.mergeProperties(properties, defProps);
|
|
230
245
|
|
|
231
246
|
// validate the entity against the schema
|
|
232
|
-
const ajvInst = new AjvCl();
|
|
247
|
+
const ajvInst = new AjvCl({ strictSchema: false, allowUnionTypes: true });
|
|
233
248
|
const validate = ajvInst.compile(propertiesSchema);
|
|
234
249
|
const result = validate(this.allProps);
|
|
235
250
|
|
|
@@ -277,129 +292,6 @@ class AdapterBase extends EventEmitterCl {
|
|
|
277
292
|
}
|
|
278
293
|
}
|
|
279
294
|
|
|
280
|
-
/**
|
|
281
|
-
* updateAdapterConfiguration is used to update any of the adapter configuration files. This
|
|
282
|
-
* allows customers to make changes to adapter configuration without having to be on the
|
|
283
|
-
* file system.
|
|
284
|
-
*
|
|
285
|
-
* @function updateAdapterConfiguration
|
|
286
|
-
* @param {string} configFile - the name of the file being updated (required)
|
|
287
|
-
* @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
|
|
288
|
-
* @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
|
|
289
|
-
* @param {string} type - the type of entity file to change, (action, schema, mock) (optional)
|
|
290
|
-
* @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
|
|
291
|
-
* @param {Callback} callback - The results of the call
|
|
292
|
-
*/
|
|
293
|
-
updateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
|
|
294
|
-
const meth = 'adapterBase-updateAdapterConfiguration';
|
|
295
|
-
const origin = `${this.id}-${meth}`;
|
|
296
|
-
log.trace(origin);
|
|
297
|
-
|
|
298
|
-
// verify the parameters are valid
|
|
299
|
-
if (changes === undefined || changes === null || typeof changes !== 'object'
|
|
300
|
-
|| Object.keys(changes).length === 0) {
|
|
301
|
-
const result = {
|
|
302
|
-
response: 'No configuration updates to make'
|
|
303
|
-
};
|
|
304
|
-
log.info(result.response);
|
|
305
|
-
return callback(result, null);
|
|
306
|
-
}
|
|
307
|
-
if (configFile === undefined || configFile === null || configFile === '') {
|
|
308
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['configFile'], null, null, null);
|
|
309
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
310
|
-
return callback(null, errorObj);
|
|
311
|
-
}
|
|
312
|
-
|
|
313
|
-
// take action based on configFile being changed
|
|
314
|
-
if (configFile === 'package.json') {
|
|
315
|
-
const pres = updatePackage(changes);
|
|
316
|
-
if (pres) {
|
|
317
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${pres}`, [], null, null, null);
|
|
318
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
319
|
-
return callback(null, errorObj);
|
|
320
|
-
}
|
|
321
|
-
const result = {
|
|
322
|
-
response: 'Package updates completed - restarting adapter'
|
|
323
|
-
};
|
|
324
|
-
log.info(result.response);
|
|
325
|
-
forceFail(true);
|
|
326
|
-
return callback(result, null);
|
|
327
|
-
}
|
|
328
|
-
if (entity === undefined || entity === null || entity === '') {
|
|
329
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Unsupported Configuration Change or Missing Entity', [], null, null, null);
|
|
330
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
331
|
-
return callback(null, errorObj);
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
// this means we are changing an entity file so type is required
|
|
335
|
-
if (type === undefined || type === null || type === '') {
|
|
336
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['type'], null, null, null);
|
|
337
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
338
|
-
return callback(null, errorObj);
|
|
339
|
-
}
|
|
340
|
-
|
|
341
|
-
// if the entity does not exist - error
|
|
342
|
-
const epath = `${__dirname}/entities/${entity}`;
|
|
343
|
-
if (!fs.existsSync(epath)) {
|
|
344
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Invalid Entity - ${entity}`, [], null, null, null);
|
|
345
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
346
|
-
return callback(null, errorObj);
|
|
347
|
-
}
|
|
348
|
-
|
|
349
|
-
// take action based on type of file being changed
|
|
350
|
-
if (type === 'action') {
|
|
351
|
-
// BACKUP???
|
|
352
|
-
const ares = updateAction(epath, action, changes);
|
|
353
|
-
if (ares) {
|
|
354
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${ares}`, [], null, null, null);
|
|
355
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
356
|
-
return callback(null, errorObj);
|
|
357
|
-
}
|
|
358
|
-
// AJV CHECK???
|
|
359
|
-
// RESTORE IF NEEDED???
|
|
360
|
-
const result = {
|
|
361
|
-
response: `Action updates completed to entity: ${entity} - ${action}`
|
|
362
|
-
};
|
|
363
|
-
log.info(result.response);
|
|
364
|
-
return callback(result, null);
|
|
365
|
-
}
|
|
366
|
-
if (type === 'schema') {
|
|
367
|
-
const sres = updateSchema(epath, configFile, changes);
|
|
368
|
-
if (sres) {
|
|
369
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${sres}`, [], null, null, null);
|
|
370
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
371
|
-
return callback(null, errorObj);
|
|
372
|
-
}
|
|
373
|
-
const result = {
|
|
374
|
-
response: `Schema updates completed to entity: ${entity} - ${configFile}`
|
|
375
|
-
};
|
|
376
|
-
log.info(result.response);
|
|
377
|
-
return callback(result, null);
|
|
378
|
-
}
|
|
379
|
-
if (type === 'mock') {
|
|
380
|
-
// if the mock directory does not exist - error
|
|
381
|
-
const mpath = `${__dirname}/entities/${entity}/mockdatafiles`;
|
|
382
|
-
if (!fs.existsSync(mpath)) {
|
|
383
|
-
fs.mkdirSync(mpath);
|
|
384
|
-
}
|
|
385
|
-
|
|
386
|
-
const mres = updateMock(mpath, configFile, changes);
|
|
387
|
-
if (mres) {
|
|
388
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${mres}`, [], null, null, null);
|
|
389
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
390
|
-
return callback(null, errorObj);
|
|
391
|
-
}
|
|
392
|
-
const result = {
|
|
393
|
-
response: `Mock data updates completed to entity: ${entity} - ${configFile}`
|
|
394
|
-
};
|
|
395
|
-
log.info(result.response);
|
|
396
|
-
return callback(result, null);
|
|
397
|
-
}
|
|
398
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Unsupported Type - ${type}`, [], null, null, null);
|
|
399
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
400
|
-
return callback(null, errorObj);
|
|
401
|
-
}
|
|
402
|
-
|
|
403
295
|
/**
|
|
404
296
|
* @summary Connect function is used during Pronghorn startup to provide instantiation feedback.
|
|
405
297
|
*
|
|
@@ -468,7 +360,7 @@ class AdapterBase extends EventEmitterCl {
|
|
|
468
360
|
}
|
|
469
361
|
|
|
470
362
|
// call to the healthcheck in connector
|
|
471
|
-
return this.requestHandlerInst.identifyHealthcheck(
|
|
363
|
+
return this.requestHandlerInst.identifyHealthcheck(myRequest, (res, error) => {
|
|
472
364
|
// unhealthy
|
|
473
365
|
if (error) {
|
|
474
366
|
// if we were healthy, toggle health
|
|
@@ -476,9 +368,15 @@ class AdapterBase extends EventEmitterCl {
|
|
|
476
368
|
this.emit('OFFLINE', { id: this.id });
|
|
477
369
|
this.emit('DEGRADED', { id: this.id });
|
|
478
370
|
this.healthy = false;
|
|
479
|
-
|
|
480
|
-
|
|
371
|
+
if (typeof error === 'object') {
|
|
372
|
+
log.error(`${origin}: HEALTH CHECK - Error ${JSON.stringify(error)}`);
|
|
373
|
+
} else {
|
|
374
|
+
log.error(`${origin}: HEALTH CHECK - Error ${error}`);
|
|
375
|
+
}
|
|
376
|
+
} else if (typeof error === 'object') {
|
|
481
377
|
// still log but set the level to trace
|
|
378
|
+
log.trace(`${origin}: HEALTH CHECK - Still Errors ${JSON.stringify(error)}`);
|
|
379
|
+
} else {
|
|
482
380
|
log.trace(`${origin}: HEALTH CHECK - Still Errors ${error}`);
|
|
483
381
|
}
|
|
484
382
|
|
|
@@ -500,68 +398,6 @@ class AdapterBase extends EventEmitterCl {
|
|
|
500
398
|
});
|
|
501
399
|
}
|
|
502
400
|
|
|
503
|
-
/**
|
|
504
|
-
* @summary Suspends the adapter
|
|
505
|
-
* @param {Callback} callback - The adapater suspension status
|
|
506
|
-
* @function suspend
|
|
507
|
-
*/
|
|
508
|
-
suspend(mode, callback) {
|
|
509
|
-
const origin = `${this.id}-adapterBase-suspend`;
|
|
510
|
-
if (this.suspended) {
|
|
511
|
-
throw new Error(`${origin}: Adapter is already suspended`);
|
|
512
|
-
}
|
|
513
|
-
try {
|
|
514
|
-
this.suspended = true;
|
|
515
|
-
this.suspendMode = mode;
|
|
516
|
-
if (this.suspendMode === 'pause') {
|
|
517
|
-
const props = JSON.parse(JSON.stringify(this.initProps));
|
|
518
|
-
// To suspend adapter, enable throttling and set concurrent max to 0
|
|
519
|
-
props.throttle.throttle_enabled = true;
|
|
520
|
-
props.throttle.concurrent_max = 0;
|
|
521
|
-
this.refreshProperties(props);
|
|
522
|
-
}
|
|
523
|
-
return callback({ suspended: true });
|
|
524
|
-
} catch (error) {
|
|
525
|
-
return callback(null, error);
|
|
526
|
-
}
|
|
527
|
-
}
|
|
528
|
-
|
|
529
|
-
/**
|
|
530
|
-
* @summary Unsuspends the adapter
|
|
531
|
-
* @param {Callback} callback - The adapater suspension status
|
|
532
|
-
*
|
|
533
|
-
* @function unsuspend
|
|
534
|
-
*/
|
|
535
|
-
unsuspend(callback) {
|
|
536
|
-
const origin = `${this.id}-adapterBase-unsuspend`;
|
|
537
|
-
if (!this.suspended) {
|
|
538
|
-
throw new Error(`${origin}: Adapter is not suspended`);
|
|
539
|
-
}
|
|
540
|
-
if (this.suspendMode === 'pause') {
|
|
541
|
-
const props = JSON.parse(JSON.stringify(this.initProps));
|
|
542
|
-
// To unsuspend adapter, keep throttling enabled and begin processing queued requests in order
|
|
543
|
-
props.throttle.throttle_enabled = true;
|
|
544
|
-
props.throttle.concurrent_max = 1;
|
|
545
|
-
this.refreshProperties(props);
|
|
546
|
-
setTimeout(() => {
|
|
547
|
-
this.getQueue((q, error) => {
|
|
548
|
-
// console.log("Items in queue: " + String(q.length))
|
|
549
|
-
if (q.length === 0) {
|
|
550
|
-
// if queue is empty, return to initial properties state
|
|
551
|
-
this.refreshProperties(this.initProps);
|
|
552
|
-
this.suspended = false;
|
|
553
|
-
return callback({ suspended: false });
|
|
554
|
-
}
|
|
555
|
-
// recursive call to check queue again every second
|
|
556
|
-
return this.unsuspend(callback);
|
|
557
|
-
});
|
|
558
|
-
}, 1000);
|
|
559
|
-
} else {
|
|
560
|
-
this.suspended = false;
|
|
561
|
-
callback({ suspend: false });
|
|
562
|
-
}
|
|
563
|
-
}
|
|
564
|
-
|
|
565
401
|
/**
|
|
566
402
|
* getAllFunctions is used to get all of the exposed function in the adapter
|
|
567
403
|
*
|
|
@@ -587,24 +423,22 @@ class AdapterBase extends EventEmitterCl {
|
|
|
587
423
|
}
|
|
588
424
|
|
|
589
425
|
/**
|
|
590
|
-
*
|
|
426
|
+
* iapGetAdapterWorkflowFunctions is used to get all of the workflow function in the adapter
|
|
591
427
|
* @param {array} ignoreThese - additional methods to ignore (optional)
|
|
592
428
|
*
|
|
593
|
-
* @function
|
|
429
|
+
* @function iapGetAdapterWorkflowFunctions
|
|
594
430
|
*/
|
|
595
|
-
|
|
431
|
+
iapGetAdapterWorkflowFunctions(ignoreThese) {
|
|
596
432
|
const myfunctions = this.getAllFunctions();
|
|
597
433
|
const wffunctions = [];
|
|
598
434
|
|
|
599
435
|
// remove the functions that should not be in a Workflow
|
|
600
436
|
for (let m = 0; m < myfunctions.length; m += 1) {
|
|
601
|
-
if (myfunctions[m] === '
|
|
437
|
+
if (myfunctions[m] === 'checkActionFiles') {
|
|
602
438
|
// got to the second tier (adapterBase)
|
|
603
439
|
break;
|
|
604
440
|
}
|
|
605
|
-
if (myfunctions[m]
|
|
606
|
-
&& myfunctions[m] !== 'healthCheck' && myfunctions[m] !== 'getWorkflowFunctions'
|
|
607
|
-
&& !(myfunctions[m].endsWith('Emit') || myfunctions[m].match(/Emit__v[0-9]+/))) {
|
|
441
|
+
if (!(myfunctions[m].endsWith('Emit') || myfunctions[m].match(/Emit__v[0-9]+/))) {
|
|
608
442
|
let found = false;
|
|
609
443
|
if (ignoreThese && Array.isArray(ignoreThese)) {
|
|
610
444
|
for (let i = 0; i < ignoreThese.length; i += 1) {
|
|
@@ -640,59 +474,329 @@ class AdapterBase extends EventEmitterCl {
|
|
|
640
474
|
}
|
|
641
475
|
|
|
642
476
|
/**
|
|
643
|
-
*
|
|
477
|
+
* checkProperties is used to validate the adapter properties.
|
|
644
478
|
*
|
|
645
|
-
* @function
|
|
646
|
-
* @param {
|
|
647
|
-
* @param {Callback} callback - The results of the call
|
|
479
|
+
* @function checkProperties
|
|
480
|
+
* @param {Object} properties - an object containing all of the properties
|
|
648
481
|
*/
|
|
649
|
-
|
|
650
|
-
const
|
|
651
|
-
|
|
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
|
-
}
|
|
482
|
+
checkProperties(properties) {
|
|
483
|
+
const origin = `${this.myid}-adapterBase-checkProperties`;
|
|
484
|
+
log.trace(origin);
|
|
661
485
|
|
|
662
|
-
//
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
result.message = 'Could not find the entities directory';
|
|
668
|
-
return callback(null, result);
|
|
486
|
+
// validate the properties for the adapter
|
|
487
|
+
try {
|
|
488
|
+
return this.requestHandlerInst.checkProperties(properties);
|
|
489
|
+
} catch (e) {
|
|
490
|
+
return { exception: 'Exception increase log level' };
|
|
669
491
|
}
|
|
492
|
+
}
|
|
670
493
|
|
|
671
|
-
|
|
672
|
-
|
|
494
|
+
/**
|
|
495
|
+
* @summary Takes in property text and an encoding/encryption and returns the resulting
|
|
496
|
+
* encoded/encrypted string
|
|
497
|
+
*
|
|
498
|
+
* @function encryptProperty
|
|
499
|
+
* @param {String} property - the property to encrypt
|
|
500
|
+
* @param {String} technique - the technique to use to encrypt
|
|
501
|
+
*
|
|
502
|
+
* @param {Callback} callback - a callback function to return the result
|
|
503
|
+
* Encrypted String or the Error
|
|
504
|
+
*/
|
|
505
|
+
encryptProperty(property, technique, callback) {
|
|
506
|
+
const origin = `${this.id}-adapterBase-encryptProperty`;
|
|
507
|
+
log.trace(origin);
|
|
673
508
|
|
|
674
|
-
//
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
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`);
|
|
509
|
+
// Make the call -
|
|
510
|
+
// encryptProperty(property, technique, callback)
|
|
511
|
+
return this.requestHandlerInst.encryptProperty(property, technique, callback);
|
|
512
|
+
}
|
|
683
513
|
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
514
|
+
/**
|
|
515
|
+
* iapUpdateAdapterConfiguration is used to update any of the adapter configuration files. This
|
|
516
|
+
* allows customers to make changes to adapter configuration without having to be on the
|
|
517
|
+
* file system.
|
|
518
|
+
*
|
|
519
|
+
* @function iapUpdateAdapterConfiguration
|
|
520
|
+
* @param {string} configFile - the name of the file being updated (required)
|
|
521
|
+
* @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
|
|
522
|
+
* @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
|
|
523
|
+
* @param {string} type - the type of entity file to change, (action, schema, mock) (optional)
|
|
524
|
+
* @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
|
|
525
|
+
* @param {boolean} replace - true to replace entire mock data, false to merge/append (optional)
|
|
526
|
+
* @param {Callback} callback - The results of the call
|
|
527
|
+
*/
|
|
528
|
+
iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, replace, callback) {
|
|
529
|
+
const meth = 'adapterBase-iapUpdateAdapterConfiguration';
|
|
530
|
+
const origin = `${this.id}-${meth}`;
|
|
531
|
+
log.trace(origin);
|
|
532
|
+
|
|
533
|
+
// verify the parameters are valid
|
|
534
|
+
if (changes === undefined || changes === null || typeof changes !== 'object'
|
|
535
|
+
|| Object.keys(changes).length === 0) {
|
|
536
|
+
const result = {
|
|
537
|
+
response: 'No configuration updates to make'
|
|
538
|
+
};
|
|
539
|
+
log.info(result.response);
|
|
540
|
+
return callback(result, null);
|
|
541
|
+
}
|
|
542
|
+
if (configFile === undefined || configFile === null || configFile === '') {
|
|
543
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['configFile'], null, null, null);
|
|
544
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
545
|
+
return callback(null, errorObj);
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
// take action based on configFile being changed
|
|
549
|
+
if (configFile === 'package.json') {
|
|
550
|
+
const pres = updatePackage(changes);
|
|
551
|
+
if (pres) {
|
|
552
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${pres}`, [], null, null, null);
|
|
553
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
554
|
+
return callback(null, errorObj);
|
|
555
|
+
}
|
|
556
|
+
const result = {
|
|
557
|
+
response: 'Package updates completed - restarting adapter'
|
|
558
|
+
};
|
|
559
|
+
log.info(result.response);
|
|
560
|
+
forceFail(true);
|
|
561
|
+
return callback(result, null);
|
|
562
|
+
}
|
|
563
|
+
if (entity === undefined || entity === null || entity === '') {
|
|
564
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Unsupported Configuration Change or Missing Entity', [], null, null, null);
|
|
565
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
566
|
+
return callback(null, errorObj);
|
|
567
|
+
}
|
|
568
|
+
|
|
569
|
+
// this means we are changing an entity file so type is required
|
|
570
|
+
if (type === undefined || type === null || type === '') {
|
|
571
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['type'], null, null, null);
|
|
572
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
573
|
+
return callback(null, errorObj);
|
|
574
|
+
}
|
|
575
|
+
|
|
576
|
+
// if the entity does not exist - error
|
|
577
|
+
const epath = `${__dirname}/entities/${entity}`;
|
|
578
|
+
if (!fs.existsSync(epath)) {
|
|
579
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Invalid Entity - ${entity}`, [], null, null, null);
|
|
580
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
581
|
+
return callback(null, errorObj);
|
|
582
|
+
}
|
|
583
|
+
|
|
584
|
+
// take action based on type of file being changed
|
|
585
|
+
if (type === 'action') {
|
|
586
|
+
// BACKUP???
|
|
587
|
+
const ares = updateAction(epath, action, changes);
|
|
588
|
+
if (ares) {
|
|
589
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${ares}`, [], null, null, null);
|
|
590
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
591
|
+
return callback(null, errorObj);
|
|
592
|
+
}
|
|
593
|
+
// AJV CHECK???
|
|
594
|
+
// RESTORE IF NEEDED???
|
|
595
|
+
const result = {
|
|
596
|
+
response: `Action updates completed to entity: ${entity} - ${action}`
|
|
597
|
+
};
|
|
598
|
+
log.info(result.response);
|
|
599
|
+
return callback(result, null);
|
|
600
|
+
}
|
|
601
|
+
if (type === 'schema') {
|
|
602
|
+
const sres = updateSchema(epath, configFile, changes);
|
|
603
|
+
if (sres) {
|
|
604
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${sres}`, [], null, null, null);
|
|
605
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
606
|
+
return callback(null, errorObj);
|
|
607
|
+
}
|
|
608
|
+
const result = {
|
|
609
|
+
response: `Schema updates completed to entity: ${entity} - ${configFile}`
|
|
610
|
+
};
|
|
611
|
+
log.info(result.response);
|
|
612
|
+
return callback(result, null);
|
|
613
|
+
}
|
|
614
|
+
if (type === 'mock') {
|
|
615
|
+
// if the mock directory does not exist - error
|
|
616
|
+
const mpath = `${__dirname}/entities/${entity}/mockdatafiles`;
|
|
617
|
+
if (!fs.existsSync(mpath)) {
|
|
618
|
+
fs.mkdirSync(mpath);
|
|
619
|
+
}
|
|
620
|
+
// this means we are changing a mock data file so replace is required
|
|
621
|
+
if (replace === undefined || replace === null || replace === '') {
|
|
622
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['replace'], null, null, null);
|
|
623
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
624
|
+
return callback(null, errorObj);
|
|
625
|
+
}
|
|
626
|
+
const mres = updateMock(mpath, configFile, changes, replace);
|
|
627
|
+
|
|
628
|
+
if (mres) {
|
|
629
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${mres}`, [], null, null, null);
|
|
630
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
631
|
+
return callback(null, errorObj);
|
|
632
|
+
}
|
|
633
|
+
const result = {
|
|
634
|
+
response: `Mock data updates completed to entity: ${entity} - ${configFile}`
|
|
635
|
+
};
|
|
636
|
+
log.info(result.response);
|
|
637
|
+
return callback(result, null);
|
|
638
|
+
}
|
|
639
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Unsupported Type - ${type}`, [], null, null, null);
|
|
640
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
641
|
+
return callback(null, errorObj);
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
/**
|
|
645
|
+
* @summary Suspends the adapter
|
|
646
|
+
* @param {Callback} callback - The adapater suspension status
|
|
647
|
+
* @function iapSuspendAdapter
|
|
648
|
+
*/
|
|
649
|
+
iapSuspendAdapter(mode, callback) {
|
|
650
|
+
const origin = `${this.id}-adapterBase-iapSuspendAdapter`;
|
|
651
|
+
if (this.suspended) {
|
|
652
|
+
throw new Error(`${origin}: Adapter is already suspended`);
|
|
653
|
+
}
|
|
654
|
+
try {
|
|
655
|
+
this.suspended = true;
|
|
656
|
+
this.suspendMode = mode;
|
|
657
|
+
if (this.suspendMode === 'pause') {
|
|
658
|
+
const props = JSON.parse(JSON.stringify(this.initProps));
|
|
659
|
+
// To suspend adapter, enable throttling and set concurrent max to 0
|
|
660
|
+
props.throttle.throttle_enabled = true;
|
|
661
|
+
props.throttle.concurrent_max = 0;
|
|
662
|
+
this.refreshProperties(props);
|
|
663
|
+
}
|
|
664
|
+
return callback({ suspended: true });
|
|
665
|
+
} catch (error) {
|
|
666
|
+
return callback(null, error);
|
|
667
|
+
}
|
|
668
|
+
}
|
|
669
|
+
|
|
670
|
+
/**
|
|
671
|
+
* @summary Unsuspends the adapter
|
|
672
|
+
* @param {Callback} callback - The adapater suspension status
|
|
673
|
+
*
|
|
674
|
+
* @function iapUnsuspendAdapter
|
|
675
|
+
*/
|
|
676
|
+
iapUnsuspendAdapter(callback) {
|
|
677
|
+
const origin = `${this.id}-adapterBase-iapUnsuspendAdapter`;
|
|
678
|
+
if (!this.suspended) {
|
|
679
|
+
throw new Error(`${origin}: Adapter is not suspended`);
|
|
680
|
+
}
|
|
681
|
+
if (this.suspendMode === 'pause') {
|
|
682
|
+
const props = JSON.parse(JSON.stringify(this.initProps));
|
|
683
|
+
// To unsuspend adapter, keep throttling enabled and begin processing queued requests in order
|
|
684
|
+
props.throttle.throttle_enabled = true;
|
|
685
|
+
props.throttle.concurrent_max = 1;
|
|
686
|
+
this.refreshProperties(props);
|
|
687
|
+
setTimeout(() => {
|
|
688
|
+
this.getQueue((q, error) => {
|
|
689
|
+
// console.log("Items in queue: " + String(q.length))
|
|
690
|
+
if (q.length === 0) {
|
|
691
|
+
// if queue is empty, return to initial properties state
|
|
692
|
+
this.refreshProperties(this.initProps);
|
|
693
|
+
this.suspended = false;
|
|
694
|
+
return callback({ suspended: false });
|
|
695
|
+
}
|
|
696
|
+
// recursive call to check queue again every second
|
|
697
|
+
return this.iapUnsuspendAdapter(callback);
|
|
698
|
+
});
|
|
699
|
+
}, 1000);
|
|
700
|
+
} else {
|
|
701
|
+
this.suspended = false;
|
|
702
|
+
callback({ suspend: false });
|
|
703
|
+
}
|
|
704
|
+
}
|
|
705
|
+
|
|
706
|
+
/**
|
|
707
|
+
* iapGetAdapterQueue is used to get information for all of the requests currently in the queue.
|
|
708
|
+
*
|
|
709
|
+
* @function iapGetAdapterQueue
|
|
710
|
+
* @param {Callback} callback - a callback function to return the result (Queue) or the error
|
|
711
|
+
*/
|
|
712
|
+
iapGetAdapterQueue(callback) {
|
|
713
|
+
const origin = `${this.id}-adapterBase-iapGetAdapterQueue`;
|
|
714
|
+
log.trace(origin);
|
|
715
|
+
|
|
716
|
+
return this.requestHandlerInst.getQueue(callback);
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
/* ********************************************** */
|
|
720
|
+
/* */
|
|
721
|
+
/* EXPOSES ADAPTER SCRIPTS */
|
|
722
|
+
/* */
|
|
723
|
+
/* ********************************************** */
|
|
724
|
+
/**
|
|
725
|
+
* See if the API path provided is found in this adapter
|
|
726
|
+
*
|
|
727
|
+
* @function iapFindAdapterPath
|
|
728
|
+
* @param {string} apiPath - the api path to check on
|
|
729
|
+
* @param {Callback} callback - The results of the call
|
|
730
|
+
*/
|
|
731
|
+
iapFindAdapterPath(apiPath, callback) {
|
|
732
|
+
const result = {
|
|
733
|
+
apiPath
|
|
734
|
+
};
|
|
735
|
+
|
|
736
|
+
// verify the path was provided
|
|
737
|
+
if (!apiPath) {
|
|
738
|
+
log.error('NO API PATH PROVIDED!');
|
|
739
|
+
result.found = false;
|
|
740
|
+
result.message = 'NO PATH PROVIDED!';
|
|
741
|
+
return callback(null, result);
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
if (typeof this.allProps.choosepath === 'string') {
|
|
745
|
+
choosepath = this.allProps.choosepath;
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
// make sure the entities directory exists
|
|
749
|
+
const entitydir = path.join(__dirname, 'entities');
|
|
750
|
+
if (!fs.statSync(entitydir).isDirectory()) {
|
|
751
|
+
log.error('Could not find the entities directory');
|
|
752
|
+
result.found = false;
|
|
753
|
+
result.message = 'Could not find the entities directory';
|
|
754
|
+
return callback(null, result);
|
|
755
|
+
}
|
|
756
|
+
|
|
757
|
+
const entities = fs.readdirSync(entitydir);
|
|
758
|
+
const fitems = [];
|
|
759
|
+
|
|
760
|
+
// need to go through each entity in the entities directory
|
|
761
|
+
for (let e = 0; e < entities.length; e += 1) {
|
|
762
|
+
// make sure the entity is a directory - do not care about extra files
|
|
763
|
+
// only entities (dir)
|
|
764
|
+
if (fs.statSync(`${entitydir}/${entities[e]}`).isDirectory()) {
|
|
765
|
+
// see if the action file exists in the entity
|
|
766
|
+
if (fs.existsSync(`${entitydir}/${entities[e]}/action.json`)) {
|
|
767
|
+
// Read the entity actions from the file system
|
|
768
|
+
const actions = require(`${entitydir}/${entities[e]}/action.json`);
|
|
769
|
+
|
|
770
|
+
// go through all of the actions set the appropriate info in the newActions
|
|
771
|
+
for (let a = 0; a < actions.actions.length; a += 1) {
|
|
772
|
+
if (actions.actions[a].entitypath && typeof actions.actions[a].entitypath === 'object') {
|
|
773
|
+
const entityKeys = Object.keys(actions.actions[a].entitypath);
|
|
774
|
+
if (entityKeys.length > 0) {
|
|
775
|
+
for (let entityKey = 0; entityKey < entityKeys.length; entityKey += 1) {
|
|
776
|
+
if (choosepath && entityKeys[entityKey] === choosepath && actions.actions[a].entitypath[entityKeys[entityKey]].indexOf(apiPath) >= 0) {
|
|
777
|
+
log.info(` Found - entity: ${entities[e]} action: ${actions.actions[a].name}`);
|
|
778
|
+
log.info(` method: ${actions.actions[a].method} path: ${actions.actions[a].entitypath[entityKeys[entityKey]]}`);
|
|
779
|
+
const fitem = {
|
|
780
|
+
entity: entities[e],
|
|
781
|
+
action: actions.actions[a].name,
|
|
782
|
+
method: actions.actions[a].method,
|
|
783
|
+
path: actions.actions[a].entitypath[entityKeys[entityKey]]
|
|
784
|
+
};
|
|
785
|
+
fitems.push(fitem);
|
|
786
|
+
break;
|
|
787
|
+
}
|
|
788
|
+
}
|
|
789
|
+
}
|
|
790
|
+
} else if (actions.actions[a].entitypath.indexOf(apiPath) >= 0) {
|
|
791
|
+
log.info(` Found - entity: ${entities[e]} action: ${actions.actions[a].name}`);
|
|
792
|
+
log.info(` method: ${actions.actions[a].method} path: ${actions.actions[a].entitypath}`);
|
|
793
|
+
const fitem = {
|
|
794
|
+
entity: entities[e],
|
|
795
|
+
action: actions.actions[a].name,
|
|
796
|
+
method: actions.actions[a].method,
|
|
797
|
+
path: actions.actions[a].entitypath
|
|
798
|
+
};
|
|
799
|
+
fitems.push(fitem);
|
|
696
800
|
}
|
|
697
801
|
}
|
|
698
802
|
} else {
|
|
@@ -722,67 +826,16 @@ class AdapterBase extends EventEmitterCl {
|
|
|
722
826
|
return callback(result, null);
|
|
723
827
|
}
|
|
724
828
|
|
|
725
|
-
/**
|
|
726
|
-
* checkProperties is used to validate the adapter properties.
|
|
727
|
-
*
|
|
728
|
-
* @function checkProperties
|
|
729
|
-
* @param {Object} properties - an object containing all of the properties
|
|
730
|
-
*/
|
|
731
|
-
checkProperties(properties) {
|
|
732
|
-
const origin = `${this.myid}-adapterBase-checkProperties`;
|
|
733
|
-
log.trace(origin);
|
|
734
|
-
|
|
735
|
-
// validate the properties for the adapter
|
|
736
|
-
try {
|
|
737
|
-
return this.requestHandlerInst.checkProperties(properties);
|
|
738
|
-
} catch (e) {
|
|
739
|
-
return { exception: 'Exception increase log level' };
|
|
740
|
-
}
|
|
741
|
-
}
|
|
742
|
-
|
|
743
|
-
/**
|
|
744
|
-
* getQueue is used to get information for all of the requests currently in the queue.
|
|
745
|
-
*
|
|
746
|
-
* @function getQueue
|
|
747
|
-
* @param {Callback} callback - a callback function to return the result (Queue) or the error
|
|
748
|
-
*/
|
|
749
|
-
getQueue(callback) {
|
|
750
|
-
const origin = `${this.id}-adapterBase-getQueue`;
|
|
751
|
-
log.trace(origin);
|
|
752
|
-
|
|
753
|
-
return this.requestHandlerInst.getQueue(callback);
|
|
754
|
-
}
|
|
755
|
-
|
|
756
|
-
/**
|
|
757
|
-
* @summary Takes in property text and an encoding/encryption and returns the resulting
|
|
758
|
-
* encoded/encrypted string
|
|
759
|
-
*
|
|
760
|
-
* @function encryptProperty
|
|
761
|
-
* @param {String} property - the property to encrypt
|
|
762
|
-
* @param {String} technique - the technique to use to encrypt
|
|
763
|
-
*
|
|
764
|
-
* @param {Callback} callback - a callback function to return the result
|
|
765
|
-
* Encrypted String or the Error
|
|
766
|
-
*/
|
|
767
|
-
encryptProperty(property, technique, callback) {
|
|
768
|
-
const origin = `${this.id}-adapterBase-encryptProperty`;
|
|
769
|
-
log.trace(origin);
|
|
770
|
-
|
|
771
|
-
// Make the call -
|
|
772
|
-
// encryptProperty(property, technique, callback)
|
|
773
|
-
return this.requestHandlerInst.encryptProperty(property, technique, callback);
|
|
774
|
-
}
|
|
775
|
-
|
|
776
829
|
/**
|
|
777
830
|
* @summary runs troubleshoot scripts for adapter
|
|
778
831
|
*
|
|
779
|
-
* @function
|
|
832
|
+
* @function iapTroubleshootAdapter
|
|
780
833
|
* @param {Object} props - the connection, healthcheck and authentication properties
|
|
781
834
|
* @param {boolean} persistFlag - whether the adapter properties should be updated
|
|
782
835
|
* @param {Adapter} adapter - adapter instance to troubleshoot
|
|
783
836
|
* @param {Callback} callback - callback function to return troubleshoot results
|
|
784
837
|
*/
|
|
785
|
-
async
|
|
838
|
+
async iapTroubleshootAdapter(props, persistFlag, adapter, callback) {
|
|
786
839
|
try {
|
|
787
840
|
const result = await troubleshootingAdapter.troubleshoot(props, false, persistFlag, adapter);
|
|
788
841
|
if (result.healthCheck && result.connectivity.failCount === 0 && result.basicGet.failCount === 0) {
|
|
@@ -797,17 +850,17 @@ class AdapterBase extends EventEmitterCl {
|
|
|
797
850
|
/**
|
|
798
851
|
* @summary runs healthcheck script for adapter
|
|
799
852
|
*
|
|
800
|
-
* @function
|
|
853
|
+
* @function iapRunAdapterHealthcheck
|
|
801
854
|
* @param {Adapter} adapter - adapter instance to troubleshoot
|
|
802
855
|
* @param {Callback} callback - callback function to return healthcheck status
|
|
803
856
|
*/
|
|
804
|
-
async
|
|
857
|
+
async iapRunAdapterHealthcheck(adapter, callback) {
|
|
805
858
|
try {
|
|
806
859
|
const result = await tbUtils.healthCheck(adapter);
|
|
807
860
|
if (result) {
|
|
808
861
|
return callback(result);
|
|
809
862
|
}
|
|
810
|
-
return callback(null,
|
|
863
|
+
return callback(null, 'Healthcheck failed');
|
|
811
864
|
} catch (error) {
|
|
812
865
|
return callback(null, error);
|
|
813
866
|
}
|
|
@@ -816,14 +869,13 @@ class AdapterBase extends EventEmitterCl {
|
|
|
816
869
|
/**
|
|
817
870
|
* @summary runs connectivity check script for adapter
|
|
818
871
|
*
|
|
819
|
-
* @function
|
|
872
|
+
* @function iapRunAdapterConnectivity
|
|
820
873
|
* @param {Adapter} adapter - adapter instance to troubleshoot
|
|
821
874
|
* @param {Callback} callback - callback function to return connectivity status
|
|
822
875
|
*/
|
|
823
|
-
async
|
|
876
|
+
async iapRunAdapterConnectivity(callback) {
|
|
824
877
|
try {
|
|
825
|
-
const {
|
|
826
|
-
const { host } = serviceItem.properties.properties;
|
|
878
|
+
const { host } = this.allProps;
|
|
827
879
|
const result = tbUtils.runConnectivity(host, false);
|
|
828
880
|
if (result.failCount > 0) {
|
|
829
881
|
return callback(null, result);
|
|
@@ -837,10 +889,10 @@ class AdapterBase extends EventEmitterCl {
|
|
|
837
889
|
/**
|
|
838
890
|
* @summary runs basicGet script for adapter
|
|
839
891
|
*
|
|
840
|
-
* @function
|
|
892
|
+
* @function iapRunAdapterBasicGet
|
|
841
893
|
* @param {Callback} callback - callback function to return basicGet result
|
|
842
894
|
*/
|
|
843
|
-
|
|
895
|
+
iapRunAdapterBasicGet(callback) {
|
|
844
896
|
try {
|
|
845
897
|
const result = tbUtils.runBasicGet(false);
|
|
846
898
|
if (result.failCount > 0) {
|
|
@@ -853,172 +905,544 @@ class AdapterBase extends EventEmitterCl {
|
|
|
853
905
|
}
|
|
854
906
|
|
|
855
907
|
/**
|
|
856
|
-
* @summary
|
|
908
|
+
* @summary moves entities to mongo database
|
|
857
909
|
*
|
|
858
|
-
* @function
|
|
859
|
-
* @param {String} entityType - the type of the entities
|
|
860
|
-
* @param {Array} data - the list of entities
|
|
861
|
-
* @param {String} key - unique key for the entities
|
|
910
|
+
* @function iapMoveAdapterEntitiesToDB
|
|
862
911
|
*
|
|
863
|
-
* @
|
|
864
|
-
* desired capability or an error
|
|
912
|
+
* @return {Callback} - containing the response from the mongo transaction
|
|
865
913
|
*/
|
|
866
|
-
|
|
867
|
-
const meth = 'adapterBase-
|
|
914
|
+
async iapMoveAdapterEntitiesToDB(callback) {
|
|
915
|
+
const meth = 'adapterBase-iapMoveAdapterEntitiesToDB';
|
|
868
916
|
const origin = `${this.id}-${meth}`;
|
|
869
917
|
log.trace(origin);
|
|
870
918
|
|
|
871
|
-
|
|
872
|
-
|
|
919
|
+
try {
|
|
920
|
+
const result = await entitiesToDB.moveEntitiesToDB(__dirname, { pronghornProps: this.allProps, id: this.id });
|
|
921
|
+
return callback(result, null);
|
|
922
|
+
} catch (err) {
|
|
923
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, err);
|
|
924
|
+
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
925
|
+
return callback(null, err.message);
|
|
926
|
+
}
|
|
927
|
+
}
|
|
873
928
|
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
929
|
+
/**
|
|
930
|
+
* @function iapDeactivateTasks
|
|
931
|
+
*
|
|
932
|
+
* @param {Array} tasks - List of tasks to deactivate
|
|
933
|
+
* @param {Callback} callback
|
|
934
|
+
*/
|
|
935
|
+
iapDeactivateTasks(tasks, callback) {
|
|
936
|
+
const meth = 'adapterBase-iapDeactivateTasks';
|
|
937
|
+
const origin = `${this.id}-${meth}`;
|
|
938
|
+
log.trace(origin);
|
|
939
|
+
let data;
|
|
940
|
+
try {
|
|
941
|
+
data = taskMover.deactivateTasks(__dirname, tasks);
|
|
942
|
+
} catch (ex) {
|
|
943
|
+
taskMover.rollbackChanges(__dirname);
|
|
944
|
+
taskMover.deleteBackups(__dirname);
|
|
945
|
+
return callback(null, ex);
|
|
879
946
|
}
|
|
947
|
+
taskMover.deleteBackups(__dirname);
|
|
948
|
+
return callback(data, null);
|
|
949
|
+
}
|
|
880
950
|
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
951
|
+
/**
|
|
952
|
+
* @function iapActivateTasks
|
|
953
|
+
*
|
|
954
|
+
* @param {Array} tasks - List of tasks to deactivate
|
|
955
|
+
* @param {Callback} callback
|
|
956
|
+
*/
|
|
957
|
+
iapActivateTasks(tasks, callback) {
|
|
958
|
+
const meth = 'adapterBase-iapActivateTasks';
|
|
959
|
+
const origin = `${this.id}-${meth}`;
|
|
960
|
+
log.trace(origin);
|
|
961
|
+
let data;
|
|
962
|
+
try {
|
|
963
|
+
data = taskMover.activateTasks(__dirname, tasks);
|
|
964
|
+
} catch (ex) {
|
|
965
|
+
taskMover.rollbackChanges(__dirname);
|
|
966
|
+
taskMover.deleteBackups(__dirname);
|
|
967
|
+
return callback(null, ex);
|
|
968
|
+
}
|
|
969
|
+
taskMover.deleteBackups(__dirname);
|
|
970
|
+
return callback(data, null);
|
|
971
|
+
}
|
|
891
972
|
|
|
892
|
-
|
|
893
|
-
|
|
973
|
+
/* ********************************************** */
|
|
974
|
+
/* */
|
|
975
|
+
/* EXPOSES CACHE CALLS */
|
|
976
|
+
/* */
|
|
977
|
+
/* ********************************************** */
|
|
978
|
+
/**
|
|
979
|
+
* @summary Populate the cache for the given entities
|
|
980
|
+
*
|
|
981
|
+
* @function iapPopulateEntityCache
|
|
982
|
+
* @param {String/Array of Strings} entityType - the entity type(s) to populate
|
|
983
|
+
* @param {Callback} callback - whether the cache was updated or not for each entity type
|
|
984
|
+
* @returns return of the callback
|
|
985
|
+
*/
|
|
986
|
+
iapPopulateEntityCache(entityTypes, callback) {
|
|
987
|
+
const origin = `${this.myid}-adapterBase-iapPopulateEntityCache`;
|
|
988
|
+
log.trace(origin);
|
|
989
|
+
|
|
990
|
+
return this.requestHandlerInst.populateEntityCache(entityTypes, callback);
|
|
894
991
|
}
|
|
895
992
|
|
|
896
993
|
/**
|
|
897
|
-
* @summary
|
|
994
|
+
* @summary Retrieves data from cache for specified entity type
|
|
898
995
|
*
|
|
899
|
-
* @function
|
|
900
|
-
* @param {String
|
|
901
|
-
* @param {
|
|
996
|
+
* @function iapRetrieveEntitiesCache
|
|
997
|
+
* @param {String} entityType - entity of which to retrieve
|
|
998
|
+
* @param {Object} options - settings of which data to return and how to return it
|
|
999
|
+
* @param {Callback} callback - the data if it was retrieved
|
|
1000
|
+
*/
|
|
1001
|
+
iapRetrieveEntitiesCache(entityType, options, callback) {
|
|
1002
|
+
const origin = `${this.myid}-adapterBase-iapRetrieveEntitiesCache`;
|
|
1003
|
+
log.trace(origin);
|
|
1004
|
+
|
|
1005
|
+
return this.requestHandlerInst.retrieveEntitiesCache(entityType, options, callback);
|
|
1006
|
+
}
|
|
1007
|
+
|
|
1008
|
+
/* ********************************************** */
|
|
1009
|
+
/* */
|
|
1010
|
+
/* EXPOSES BROKER CALLS */
|
|
1011
|
+
/* */
|
|
1012
|
+
/* ********************************************** */
|
|
1013
|
+
/**
|
|
1014
|
+
* @summary Determines if this adapter supports any in a list of entities
|
|
902
1015
|
*
|
|
903
|
-
* @
|
|
904
|
-
*
|
|
1016
|
+
* @function hasEntities
|
|
1017
|
+
* @param {String} entityType - the entity type to check for
|
|
1018
|
+
* @param {Array} entityList - the list of entities we are looking for
|
|
1019
|
+
*
|
|
1020
|
+
* @param {Callback} callback - A map where the entity is the key and the
|
|
1021
|
+
* value is true or false
|
|
905
1022
|
*/
|
|
906
|
-
|
|
907
|
-
const origin = `${this.id}-adapterBase-
|
|
1023
|
+
hasEntities(entityType, entityList, callback) {
|
|
1024
|
+
const origin = `${this.id}-adapterBase-hasEntities`;
|
|
908
1025
|
log.trace(origin);
|
|
909
1026
|
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
const resEntity = [];
|
|
1027
|
+
return this.requestHandlerInst.hasEntities(entityType, entityList, callback);
|
|
1028
|
+
}
|
|
913
1029
|
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
1030
|
+
/**
|
|
1031
|
+
* @summary Determines if this adapter supports any in a list of entities
|
|
1032
|
+
*
|
|
1033
|
+
* @function hasEntitiesAuth
|
|
1034
|
+
* @param {String} entityType - the entity type to check for
|
|
1035
|
+
* @param {Array} entityList - the list of entities we are looking for
|
|
1036
|
+
* @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
|
|
1037
|
+
*
|
|
1038
|
+
* @param {Callback} callback - A map where the entity is the key and the
|
|
1039
|
+
* value is true or false
|
|
1040
|
+
*/
|
|
1041
|
+
hasEntitiesAuth(entityType, entityList, callOptions, callback) {
|
|
1042
|
+
const origin = `${this.id}-adapterBase-hasEntitiesAuth`;
|
|
1043
|
+
log.trace(origin);
|
|
921
1044
|
|
|
922
|
-
|
|
923
|
-
|
|
1045
|
+
return this.requestHandlerInst.hasEntitiesAuth(entityType, entityList, callOptions, callback);
|
|
1046
|
+
}
|
|
1047
|
+
|
|
1048
|
+
/**
|
|
1049
|
+
* @summary Get Appliance that match the deviceName
|
|
1050
|
+
*
|
|
1051
|
+
* @function getDevice
|
|
1052
|
+
* @param {String} deviceName - the deviceName to find (required)
|
|
1053
|
+
*
|
|
1054
|
+
* @param {getCallback} callback - a callback function to return the result
|
|
1055
|
+
* (appliance) or the error
|
|
1056
|
+
*/
|
|
1057
|
+
getDevice(deviceName, callback) {
|
|
1058
|
+
const origin = `${this.id}-adapterBase-getDevice`;
|
|
1059
|
+
log.trace(origin);
|
|
1060
|
+
|
|
1061
|
+
return this.requestHandlerInst.getDevice(deviceName, callback);
|
|
1062
|
+
}
|
|
924
1063
|
|
|
925
|
-
|
|
926
|
-
|
|
1064
|
+
/**
|
|
1065
|
+
* @summary Get Appliance that match the deviceName
|
|
1066
|
+
*
|
|
1067
|
+
* @function getDeviceAuth
|
|
1068
|
+
* @param {String} deviceName - the deviceName to find (required)
|
|
1069
|
+
* @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
|
|
1070
|
+
*
|
|
1071
|
+
* @param {getCallback} callback - a callback function to return the result
|
|
1072
|
+
* (appliance) or the error
|
|
1073
|
+
*/
|
|
1074
|
+
getDeviceAuth(deviceName, callOptions, callback) {
|
|
1075
|
+
const origin = `${this.id}-adapterBase-getDeviceAuth`;
|
|
1076
|
+
log.trace(origin);
|
|
1077
|
+
|
|
1078
|
+
return this.requestHandlerInst.getDeviceAuth(deviceName, callOptions, callback);
|
|
927
1079
|
}
|
|
928
1080
|
|
|
929
1081
|
/**
|
|
930
|
-
* @summary
|
|
1082
|
+
* @summary Get Appliances that match the filter
|
|
931
1083
|
*
|
|
932
|
-
* @function
|
|
933
|
-
* @param {
|
|
1084
|
+
* @function getDevicesFiltered
|
|
1085
|
+
* @param {Object} options - the data to use to filter the appliances (optional)
|
|
934
1086
|
*
|
|
935
|
-
* @param {
|
|
936
|
-
*
|
|
1087
|
+
* @param {getCallback} callback - a callback function to return the result
|
|
1088
|
+
* (appliances) or the error
|
|
937
1089
|
*/
|
|
938
|
-
|
|
939
|
-
const
|
|
1090
|
+
getDevicesFiltered(options, callback) {
|
|
1091
|
+
const origin = `${this.id}-adapterBase-getDevicesFiltered`;
|
|
1092
|
+
log.trace(origin);
|
|
1093
|
+
|
|
1094
|
+
return this.requestHandlerInst.getDevicesFiltered(options, callback);
|
|
1095
|
+
}
|
|
1096
|
+
|
|
1097
|
+
/**
|
|
1098
|
+
* @summary Get Appliances that match the filter
|
|
1099
|
+
*
|
|
1100
|
+
* @function getDevicesFilteredAuth
|
|
1101
|
+
* @param {Object} options - the data to use to filter the appliances (optional)
|
|
1102
|
+
* @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
|
|
1103
|
+
*
|
|
1104
|
+
* @param {getCallback} callback - a callback function to return the result
|
|
1105
|
+
* (appliances) or the error
|
|
1106
|
+
*/
|
|
1107
|
+
getDevicesFilteredAuth(options, callOptions, callback) {
|
|
1108
|
+
const origin = `${this.id}-adapterBase-getDevicesFilteredAuth`;
|
|
1109
|
+
log.trace(origin);
|
|
1110
|
+
|
|
1111
|
+
return this.requestHandlerInst.getDevicesFilteredAuth(options, callOptions, callback);
|
|
1112
|
+
}
|
|
1113
|
+
|
|
1114
|
+
/**
|
|
1115
|
+
* @summary Gets the status for the provided appliance
|
|
1116
|
+
*
|
|
1117
|
+
* @function isAlive
|
|
1118
|
+
* @param {String} deviceName - the deviceName of the appliance. (required)
|
|
1119
|
+
*
|
|
1120
|
+
* @param {configCallback} callback - callback function to return the result
|
|
1121
|
+
* (appliance isAlive) or the error
|
|
1122
|
+
*/
|
|
1123
|
+
isAlive(deviceName, callback) {
|
|
1124
|
+
const origin = `${this.id}-adapterBase-isAlive`;
|
|
1125
|
+
log.trace(origin);
|
|
1126
|
+
|
|
1127
|
+
return this.requestHandlerInst.isAlive(deviceName, callback);
|
|
1128
|
+
}
|
|
1129
|
+
|
|
1130
|
+
/**
|
|
1131
|
+
* @summary Gets the status for the provided appliance
|
|
1132
|
+
*
|
|
1133
|
+
* @function isAliveAuth
|
|
1134
|
+
* @param {String} deviceName - the deviceName of the appliance. (required)
|
|
1135
|
+
* @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
|
|
1136
|
+
*
|
|
1137
|
+
* @param {configCallback} callback - callback function to return the result
|
|
1138
|
+
* (appliance isAliveAuth) or the error
|
|
1139
|
+
*/
|
|
1140
|
+
isAliveAuth(deviceName, callOptions, callback) {
|
|
1141
|
+
const origin = `${this.id}-adapterBase-isAliveAuth`;
|
|
1142
|
+
log.trace(origin);
|
|
1143
|
+
|
|
1144
|
+
return this.requestHandlerInst.isAliveAuth(deviceName, callOptions, callback);
|
|
1145
|
+
}
|
|
1146
|
+
|
|
1147
|
+
/**
|
|
1148
|
+
* @summary Gets a config for the provided Appliance
|
|
1149
|
+
*
|
|
1150
|
+
* @function getConfig
|
|
1151
|
+
* @param {String} deviceName - the deviceName of the appliance. (required)
|
|
1152
|
+
* @param {String} format - the desired format of the config. (optional)
|
|
1153
|
+
*
|
|
1154
|
+
* @param {configCallback} callback - callback function to return the result
|
|
1155
|
+
* (appliance config) or the error
|
|
1156
|
+
*/
|
|
1157
|
+
getConfig(deviceName, format, callback) {
|
|
1158
|
+
const origin = `${this.id}-adapterBase-getConfig`;
|
|
1159
|
+
log.trace(origin);
|
|
1160
|
+
|
|
1161
|
+
return this.requestHandlerInst.getConfig(deviceName, format, callback);
|
|
1162
|
+
}
|
|
1163
|
+
|
|
1164
|
+
/**
|
|
1165
|
+
* @summary Gets a config for the provided Appliance
|
|
1166
|
+
*
|
|
1167
|
+
* @function getConfigAuth
|
|
1168
|
+
* @param {String} deviceName - the deviceName of the appliance. (required)
|
|
1169
|
+
* @param {String} format - the desired format of the config. (optional)
|
|
1170
|
+
* @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
|
|
1171
|
+
*
|
|
1172
|
+
* @param {configCallback} callback - callback function to return the result
|
|
1173
|
+
* (appliance config) or the error
|
|
1174
|
+
*/
|
|
1175
|
+
getConfigAuth(deviceName, format, callOptions, callback) {
|
|
1176
|
+
const origin = `${this.id}-adapterBase-getConfigAuth`;
|
|
1177
|
+
log.trace(origin);
|
|
1178
|
+
|
|
1179
|
+
return this.requestHandlerInst.getConfigAuth(deviceName, format, callOptions, callback);
|
|
1180
|
+
}
|
|
1181
|
+
|
|
1182
|
+
/**
|
|
1183
|
+
* @summary Gets the device count from the system
|
|
1184
|
+
*
|
|
1185
|
+
* @function iapGetDeviceCount
|
|
1186
|
+
*
|
|
1187
|
+
* @param {getCallback} callback - callback function to return the result
|
|
1188
|
+
* (count) or the error
|
|
1189
|
+
*/
|
|
1190
|
+
iapGetDeviceCount(callback) {
|
|
1191
|
+
const origin = `${this.id}-adapterBase-iapGetDeviceCount`;
|
|
1192
|
+
log.trace(origin);
|
|
1193
|
+
|
|
1194
|
+
return this.requestHandlerInst.iapGetDeviceCount(callback);
|
|
1195
|
+
}
|
|
1196
|
+
|
|
1197
|
+
/**
|
|
1198
|
+
* @summary Gets the device count from the system
|
|
1199
|
+
*
|
|
1200
|
+
* @function iapGetDeviceCountAuth
|
|
1201
|
+
* @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
|
|
1202
|
+
*
|
|
1203
|
+
* @param {getCallback} callback - callback function to return the result
|
|
1204
|
+
* (count) or the error
|
|
1205
|
+
*/
|
|
1206
|
+
iapGetDeviceCountAuth(callOptions, callback) {
|
|
1207
|
+
const origin = `${this.id}-adapterBase-iapGetDeviceCountAuth`;
|
|
1208
|
+
log.trace(origin);
|
|
1209
|
+
|
|
1210
|
+
return this.requestHandlerInst.iapGetDeviceCountAuth(callOptions, callback);
|
|
1211
|
+
}
|
|
1212
|
+
|
|
1213
|
+
/* ********************************************** */
|
|
1214
|
+
/* */
|
|
1215
|
+
/* EXPOSES GENERIC HANDLER */
|
|
1216
|
+
/* */
|
|
1217
|
+
/* ********************************************** */
|
|
1218
|
+
/**
|
|
1219
|
+
* Makes the requested generic call
|
|
1220
|
+
*
|
|
1221
|
+
* @function iapExpandedGenericAdapterRequest
|
|
1222
|
+
* @param {Object} metadata - metadata for the call (optional).
|
|
1223
|
+
* Can be a stringified Object.
|
|
1224
|
+
* @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (optional)
|
|
1225
|
+
* @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (optional)
|
|
1226
|
+
* @param {Object} pathVars - the parameters to be put within the url path (optional).
|
|
1227
|
+
* Can be a stringified Object.
|
|
1228
|
+
* @param {Object} queryData - the parameters to be put on the url (optional).
|
|
1229
|
+
* Can be a stringified Object.
|
|
1230
|
+
* @param {Object} requestBody - the body to add to the request (optional).
|
|
1231
|
+
* Can be a stringified Object.
|
|
1232
|
+
* @param {Object} addlHeaders - additional headers to be put on the call (optional).
|
|
1233
|
+
* Can be a stringified Object.
|
|
1234
|
+
* @param {getCallback} callback - a callback function to return the result (Generics)
|
|
1235
|
+
* or the error
|
|
1236
|
+
*/
|
|
1237
|
+
iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback) {
|
|
1238
|
+
const origin = `${this.myid}-adapterBase-iapExpandedGenericAdapterRequest`;
|
|
1239
|
+
log.trace(origin);
|
|
1240
|
+
|
|
1241
|
+
return this.requestHandlerInst.expandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback);
|
|
1242
|
+
}
|
|
1243
|
+
|
|
1244
|
+
/**
|
|
1245
|
+
* Makes the requested generic call
|
|
1246
|
+
*
|
|
1247
|
+
* @function genericAdapterRequest
|
|
1248
|
+
* @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
|
|
1249
|
+
* @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
|
|
1250
|
+
* @param {Object} queryData - the parameters to be put on the url (optional).
|
|
1251
|
+
* Can be a stringified Object.
|
|
1252
|
+
* @param {Object} requestBody - the body to add to the request (optional).
|
|
1253
|
+
* Can be a stringified Object.
|
|
1254
|
+
* @param {Object} addlHeaders - additional headers to be put on the call (optional).
|
|
1255
|
+
* Can be a stringified Object.
|
|
1256
|
+
* @param {getCallback} callback - a callback function to return the result (Generics)
|
|
1257
|
+
* or the error
|
|
1258
|
+
*/
|
|
1259
|
+
genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
|
|
1260
|
+
const origin = `${this.myid}-adapterBase-genericAdapterRequest`;
|
|
1261
|
+
log.trace(origin);
|
|
1262
|
+
|
|
1263
|
+
return this.requestHandlerInst.genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback);
|
|
1264
|
+
}
|
|
1265
|
+
|
|
1266
|
+
/**
|
|
1267
|
+
* Makes the requested generic call with no base path or version
|
|
1268
|
+
*
|
|
1269
|
+
* @function genericAdapterRequestNoBasePath
|
|
1270
|
+
* @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
|
|
1271
|
+
* @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
|
|
1272
|
+
* @param {Object} queryData - the parameters to be put on the url (optional).
|
|
1273
|
+
* Can be a stringified Object.
|
|
1274
|
+
* @param {Object} requestBody - the body to add to the request (optional).
|
|
1275
|
+
* Can be a stringified Object.
|
|
1276
|
+
* @param {Object} addlHeaders - additional headers to be put on the call (optional).
|
|
1277
|
+
* Can be a stringified Object.
|
|
1278
|
+
* @param {getCallback} callback - a callback function to return the result (Generics)
|
|
1279
|
+
* or the error
|
|
1280
|
+
*/
|
|
1281
|
+
genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
|
|
1282
|
+
const origin = `${this.myid}-adapterBase-genericAdapterRequestNoBasePath`;
|
|
1283
|
+
log.trace(origin);
|
|
1284
|
+
|
|
1285
|
+
return this.requestHandlerInst.genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback);
|
|
1286
|
+
}
|
|
1287
|
+
|
|
1288
|
+
/* ********************************************** */
|
|
1289
|
+
/* */
|
|
1290
|
+
/* EXPOSES INVENTORY CALLS */
|
|
1291
|
+
/* */
|
|
1292
|
+
/* ********************************************** */
|
|
1293
|
+
/**
|
|
1294
|
+
* @summary run the adapter lint script to return the results.
|
|
1295
|
+
*
|
|
1296
|
+
* @function iapRunAdapterLint
|
|
1297
|
+
*
|
|
1298
|
+
* @return {Object} - containing the results of the lint call.
|
|
1299
|
+
*/
|
|
1300
|
+
iapRunAdapterLint(callback) {
|
|
1301
|
+
const meth = 'adapterBase-iapRunAdapterLint';
|
|
940
1302
|
const origin = `${this.id}-${meth}`;
|
|
941
1303
|
log.trace(origin);
|
|
942
|
-
let
|
|
1304
|
+
let command = null;
|
|
943
1305
|
|
|
944
|
-
if (
|
|
945
|
-
const
|
|
946
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
947
|
-
this.repeatCacheCount += 1;
|
|
948
|
-
return callback(null, errorObj);
|
|
949
|
-
}
|
|
1306
|
+
if (fs.existsSync('package.json')) {
|
|
1307
|
+
const packageData = require('./package.json');
|
|
950
1308
|
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
}
|
|
1309
|
+
// check if 'test', 'test:unit', 'test:integration' exists in package.json file
|
|
1310
|
+
if (!packageData.scripts || !packageData.scripts['lint:errors']) {
|
|
1311
|
+
log.error('The required script does not exist in the package.json file');
|
|
1312
|
+
return callback(null, 'The required script does not exist in the package.json file');
|
|
1313
|
+
}
|
|
957
1314
|
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
// if not an array, just convert the return
|
|
961
|
-
if (!Array.isArray(locResults)) {
|
|
962
|
-
if (locResults === 'found') {
|
|
963
|
-
locResults = [true];
|
|
964
|
-
} else {
|
|
965
|
-
locResults = [false];
|
|
966
|
-
}
|
|
967
|
-
} else {
|
|
968
|
-
const temp = [];
|
|
1315
|
+
// execute 'npm run lint:errors' command
|
|
1316
|
+
command = spawnSync('npm', ['run', 'lint:errors'], { cwd: __dirname, encoding: 'utf-8' });
|
|
969
1317
|
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
}
|
|
978
|
-
locResults = temp;
|
|
1318
|
+
// analyze and format the response
|
|
1319
|
+
const result = {
|
|
1320
|
+
status: 'SUCCESS'
|
|
1321
|
+
};
|
|
1322
|
+
if (command.status !== 0) {
|
|
1323
|
+
result.status = 'FAILED';
|
|
1324
|
+
result.output = command.stdout;
|
|
979
1325
|
}
|
|
1326
|
+
return callback(result);
|
|
980
1327
|
}
|
|
981
1328
|
|
|
982
|
-
|
|
983
|
-
return callback(
|
|
1329
|
+
log.error('Package Not Found');
|
|
1330
|
+
return callback(null, 'Package Not Found');
|
|
984
1331
|
}
|
|
985
1332
|
|
|
986
1333
|
/**
|
|
987
|
-
* @summary
|
|
988
|
-
*
|
|
1334
|
+
* @summary run the adapter test scripts (baseunit and unit) to return the results.
|
|
1335
|
+
* can not run integration as there can be implications with that.
|
|
989
1336
|
*
|
|
990
|
-
* @function
|
|
1337
|
+
* @function iapRunAdapterTests
|
|
991
1338
|
*
|
|
992
|
-
* @return {
|
|
1339
|
+
* @return {Object} - containing the results of the baseunit and unit tests.
|
|
993
1340
|
*/
|
|
994
|
-
|
|
995
|
-
const
|
|
1341
|
+
iapRunAdapterTests(callback) {
|
|
1342
|
+
const meth = 'adapterBase-iapRunAdapterTests';
|
|
1343
|
+
const origin = `${this.id}-${meth}`;
|
|
996
1344
|
log.trace(origin);
|
|
1345
|
+
let basecommand = null;
|
|
1346
|
+
let command = null;
|
|
997
1347
|
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1348
|
+
if (fs.existsSync('package.json')) {
|
|
1349
|
+
const packageData = require('./package.json');
|
|
1350
|
+
|
|
1351
|
+
// check if 'test', 'test:unit', 'test:integration' exists in package.json file
|
|
1352
|
+
if (!packageData.scripts || !packageData.scripts['test:baseunit'] || !packageData.scripts['test:unit']) {
|
|
1353
|
+
log.error('The required scripts do not exist in the package.json file');
|
|
1354
|
+
return callback(null, 'The required scripts do not exist in the package.json file');
|
|
1355
|
+
}
|
|
1356
|
+
|
|
1357
|
+
// run baseunit test
|
|
1358
|
+
basecommand = spawnSync('npm', ['run', 'test:baseunit'], { cwd: __dirname, encoding: 'utf-8' });
|
|
1359
|
+
|
|
1360
|
+
// analyze and format the response to baseunit
|
|
1361
|
+
const baseresult = {
|
|
1362
|
+
status: 'SUCCESS'
|
|
1363
|
+
};
|
|
1364
|
+
if (basecommand.status !== 0) {
|
|
1365
|
+
baseresult.status = 'FAILED';
|
|
1366
|
+
baseresult.output = basecommand.stdout;
|
|
1367
|
+
}
|
|
1368
|
+
|
|
1369
|
+
// run unit test
|
|
1370
|
+
command = spawnSync('npm', ['run', 'test:unit'], { cwd: __dirname, encoding: 'utf-8' });
|
|
1371
|
+
|
|
1372
|
+
// analyze and format the response to unit
|
|
1373
|
+
const unitresult = {
|
|
1374
|
+
status: 'SUCCESS'
|
|
1375
|
+
};
|
|
1376
|
+
if (command.status !== 0) {
|
|
1377
|
+
unitresult.status = 'FAILED';
|
|
1378
|
+
unitresult.output = command.stdout;
|
|
1379
|
+
}
|
|
1380
|
+
|
|
1381
|
+
// format the response and return it
|
|
1382
|
+
const result = {
|
|
1383
|
+
base: baseresult,
|
|
1384
|
+
unit: unitresult
|
|
1385
|
+
};
|
|
1386
|
+
return callback(result);
|
|
1003
1387
|
}
|
|
1388
|
+
|
|
1389
|
+
log.error('Package Not Found');
|
|
1390
|
+
return callback(null, 'Package Not Found');
|
|
1004
1391
|
}
|
|
1005
1392
|
|
|
1006
1393
|
/**
|
|
1007
|
-
* @summary
|
|
1394
|
+
* @summary provide inventory information abbout the adapter
|
|
1008
1395
|
*
|
|
1009
|
-
* @function
|
|
1396
|
+
* @function iapGetAdapterInventory
|
|
1010
1397
|
*
|
|
1011
|
-
* @return {
|
|
1398
|
+
* @return {Object} - containing the adapter inventory information
|
|
1012
1399
|
*/
|
|
1013
|
-
|
|
1014
|
-
const meth = 'adapterBase-
|
|
1400
|
+
iapGetAdapterInventory(callback) {
|
|
1401
|
+
const meth = 'adapterBase-iapGetAdapterInventory';
|
|
1015
1402
|
const origin = `${this.id}-${meth}`;
|
|
1016
1403
|
log.trace(origin);
|
|
1017
1404
|
|
|
1018
1405
|
try {
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1406
|
+
// call to the adapter utils to get inventory
|
|
1407
|
+
return this.requestHandlerInst.getAdapterInventory((res, error) => {
|
|
1408
|
+
const adapterInv = res;
|
|
1409
|
+
|
|
1410
|
+
// get all of the tasks
|
|
1411
|
+
const allTasks = this.getAllFunctions();
|
|
1412
|
+
adapterInv.totalTasks = allTasks.length;
|
|
1413
|
+
|
|
1414
|
+
// get all of the possible workflow tasks
|
|
1415
|
+
const myIgnore = [
|
|
1416
|
+
'healthCheck',
|
|
1417
|
+
'iapGetAdapterWorkflowFunctions',
|
|
1418
|
+
'hasEntities'
|
|
1419
|
+
];
|
|
1420
|
+
adapterInv.totalWorkflowTasks = this.iapGetAdapterWorkflowFunctions(myIgnore).length;
|
|
1421
|
+
|
|
1422
|
+
// TODO: CACHE
|
|
1423
|
+
// CONFIRM CACHE
|
|
1424
|
+
// GET CACHE ENTITIES
|
|
1425
|
+
|
|
1426
|
+
// get the Device Count
|
|
1427
|
+
return this.iapGetDeviceCount((devres, deverror) => {
|
|
1428
|
+
// if call failed assume not broker integrated
|
|
1429
|
+
if (deverror) {
|
|
1430
|
+
adapterInv.brokerDefined = false;
|
|
1431
|
+
adapterInv.deviceCount = -1;
|
|
1432
|
+
} else {
|
|
1433
|
+
// broker confirmed
|
|
1434
|
+
adapterInv.brokerDefined = true;
|
|
1435
|
+
adapterInv.deviceCount = 0;
|
|
1436
|
+
if (devres && devres.count) {
|
|
1437
|
+
adapterInv.deviceCount = devres.count;
|
|
1438
|
+
}
|
|
1439
|
+
}
|
|
1440
|
+
|
|
1441
|
+
return callback(adapterInv);
|
|
1442
|
+
});
|
|
1443
|
+
});
|
|
1444
|
+
} catch (ex) {
|
|
1445
|
+
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
|
|
1022
1446
|
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
1023
1447
|
return callback(null, errorObj);
|
|
1024
1448
|
}
|