@itentialopensource/adapter-sevone 2.4.0 → 2.5.1
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/CALLS.md +1661 -22
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/adapter.js +158 -668
- package/adapterBase.js +549 -879
- package/changelogs/CHANGELOG.md +118 -0
- package/metadata.json +49 -0
- package/package.json +24 -24
- package/pronghorn.json +980 -641
- package/propertiesSchema.json +431 -31
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +26172 -0
- package/report/adapter-openapi.yaml +11817 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691508994383.json +120 -0
- package/report/updateReport1692202309339.json +120 -0
- package/report/updateReport1692203396464.json +120 -0
- package/report/updateReport1694470055393.json +120 -0
- package/report/updateReport1698423190930.json +120 -0
- package/sampleProperties.json +63 -2
- package/test/integration/adapterTestBasicGet.js +2 -4
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +130 -2
- package/test/unit/adapterBaseTestUnit.js +388 -313
- package/test/unit/adapterTestUnit.js +384 -158
- package/utils/adapterInfo.js +1 -1
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +2 -2
- 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/pre-commit.sh +2 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +89 -34
- package/utils/tbUtils.js +41 -21
- package/utils/testRunner.js +1 -1
- package/utils/troubleshootingAdapter.js +9 -6
- package/workflows/README.md +0 -3
package/sampleProperties.json
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
"properties": {
|
|
5
5
|
"host": "sevone_host",
|
|
6
6
|
"port": 80,
|
|
7
|
+
"choosepath": "",
|
|
7
8
|
"base_path": "/api",
|
|
8
9
|
"version": "v1",
|
|
9
10
|
"cache_location": "local",
|
|
@@ -25,12 +26,27 @@
|
|
|
25
26
|
"auth_logging": false,
|
|
26
27
|
"client_id": "",
|
|
27
28
|
"client_secret": "",
|
|
28
|
-
"grant_type": ""
|
|
29
|
+
"grant_type": "",
|
|
30
|
+
"sensitive": [],
|
|
31
|
+
"sso": {
|
|
32
|
+
"protocol": "",
|
|
33
|
+
"host": "",
|
|
34
|
+
"port": 0
|
|
35
|
+
},
|
|
36
|
+
"multiStepAuthCalls": [
|
|
37
|
+
{
|
|
38
|
+
"name": "",
|
|
39
|
+
"requestFields": {},
|
|
40
|
+
"responseFields": {},
|
|
41
|
+
"successfullResponseCode": 200
|
|
42
|
+
}
|
|
43
|
+
]
|
|
29
44
|
},
|
|
30
45
|
"healthcheck": {
|
|
31
46
|
"type": "startup",
|
|
32
47
|
"frequency": 60000,
|
|
33
|
-
"query_object": {}
|
|
48
|
+
"query_object": {},
|
|
49
|
+
"addlHeaders": {}
|
|
34
50
|
},
|
|
35
51
|
"throttle": {
|
|
36
52
|
"throttle_enabled": false,
|
|
@@ -123,6 +139,12 @@
|
|
|
123
139
|
{
|
|
124
140
|
"path": "/get/devices",
|
|
125
141
|
"method": "GET",
|
|
142
|
+
"pagination": {
|
|
143
|
+
"offsetVar": "",
|
|
144
|
+
"limitVar": "",
|
|
145
|
+
"incrementBy": "limit",
|
|
146
|
+
"requestLocation": "query"
|
|
147
|
+
},
|
|
126
148
|
"query": {},
|
|
127
149
|
"body": {},
|
|
128
150
|
"headers": {},
|
|
@@ -184,6 +206,45 @@
|
|
|
184
206
|
"responseFields": {}
|
|
185
207
|
}
|
|
186
208
|
]
|
|
209
|
+
},
|
|
210
|
+
"cache": {
|
|
211
|
+
"enabled": false,
|
|
212
|
+
"entities": [
|
|
213
|
+
{
|
|
214
|
+
"entityType": "",
|
|
215
|
+
"frequency": 1440,
|
|
216
|
+
"flushOnFail": false,
|
|
217
|
+
"limit": 1000,
|
|
218
|
+
"retryAttempts": 5,
|
|
219
|
+
"sort": true,
|
|
220
|
+
"populate": [
|
|
221
|
+
{
|
|
222
|
+
"path": "",
|
|
223
|
+
"method": "GET",
|
|
224
|
+
"pagination": {
|
|
225
|
+
"offsetVar": "",
|
|
226
|
+
"limitVar": "",
|
|
227
|
+
"incrementBy": "limit",
|
|
228
|
+
"requestLocation": "query"
|
|
229
|
+
},
|
|
230
|
+
"query": {},
|
|
231
|
+
"body": {},
|
|
232
|
+
"headers": {},
|
|
233
|
+
"handleFailure": "ignore",
|
|
234
|
+
"requestFields": {},
|
|
235
|
+
"responseDatakey": "",
|
|
236
|
+
"responseFields": {}
|
|
237
|
+
}
|
|
238
|
+
],
|
|
239
|
+
"cachedTasks": [
|
|
240
|
+
{
|
|
241
|
+
"name": "",
|
|
242
|
+
"filterField": "",
|
|
243
|
+
"filterLoc": ""
|
|
244
|
+
}
|
|
245
|
+
]
|
|
246
|
+
}
|
|
247
|
+
]
|
|
187
248
|
}
|
|
188
249
|
},
|
|
189
250
|
"groups": [],
|
|
@@ -7,9 +7,9 @@
|
|
|
7
7
|
/* eslint import/no-dynamic-require: warn */
|
|
8
8
|
/* eslint import/no-unresolved: warn */
|
|
9
9
|
|
|
10
|
-
const mocha = require('mocha');
|
|
11
10
|
const path = require('path');
|
|
12
11
|
const assert = require('assert');
|
|
12
|
+
const mocha = require('mocha');
|
|
13
13
|
const itParam = require('mocha-param');
|
|
14
14
|
|
|
15
15
|
const utils = require('../../utils/tbUtils');
|
|
@@ -18,12 +18,10 @@ const { name } = require('../../package.json');
|
|
|
18
18
|
const { methods } = require('../../pronghorn.json');
|
|
19
19
|
|
|
20
20
|
const getPronghornProps = (iapDir) => {
|
|
21
|
-
const { Discovery } = require('@itential/itential-utils');
|
|
22
21
|
console.log('Retrieving properties.json file...');
|
|
23
22
|
const rawProps = require(path.join(iapDir, 'properties.json'));
|
|
24
23
|
console.log('Decrypting properties...');
|
|
25
|
-
const
|
|
26
|
-
const pronghornProps = utils.decryptProperties(rawProps, path.join(__dirname, '..'), discovery);
|
|
24
|
+
const pronghornProps = utils.decryptProperties(rawProps, iapDir);
|
|
27
25
|
console.log('Found properties.\n');
|
|
28
26
|
return pronghornProps;
|
|
29
27
|
};
|
|
@@ -3,9 +3,12 @@
|
|
|
3
3
|
/* global describe it context before after */
|
|
4
4
|
/* eslint no-unused-vars: warn */
|
|
5
5
|
|
|
6
|
-
const mocha = require('mocha');
|
|
7
6
|
const assert = require('assert');
|
|
8
|
-
const
|
|
7
|
+
const http = require('http');
|
|
8
|
+
const https = require('https');
|
|
9
|
+
const mocha = require('mocha');
|
|
10
|
+
const ping = require('ping');
|
|
11
|
+
const dnsLookup = require('dns-lookup-promise');
|
|
9
12
|
|
|
10
13
|
let host;
|
|
11
14
|
process.argv.forEach((val) => {
|
|
@@ -16,78 +19,124 @@ process.argv.forEach((val) => {
|
|
|
16
19
|
|
|
17
20
|
describe('[integration] Adapter Test', () => {
|
|
18
21
|
context(`Testing network connection on ${host}`, () => {
|
|
19
|
-
before(() => {
|
|
20
|
-
diagnostics.setTestURL(host);
|
|
21
|
-
});
|
|
22
|
-
|
|
23
22
|
after((done) => {
|
|
24
23
|
done();
|
|
25
24
|
});
|
|
26
25
|
|
|
27
26
|
it('DNS resolve', (done) => {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
27
|
+
dnsLookup(host)
|
|
28
|
+
.then((addresses) => {
|
|
29
|
+
try {
|
|
30
|
+
assert.ok(addresses.length > 0);
|
|
31
|
+
done();
|
|
32
|
+
} catch (error) {
|
|
33
|
+
done(error);
|
|
34
|
+
}
|
|
35
|
+
})
|
|
36
|
+
.catch((err) => {
|
|
37
|
+
done(err);
|
|
38
|
+
});
|
|
36
39
|
});
|
|
37
40
|
|
|
38
41
|
it('Responds to ping', (done) => {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
42
|
+
ping.promise.probe(host)
|
|
43
|
+
.then((result) => {
|
|
44
|
+
try {
|
|
45
|
+
assert.ok(result.alive);
|
|
46
|
+
done();
|
|
47
|
+
} catch (error) {
|
|
48
|
+
done(error);
|
|
49
|
+
}
|
|
50
|
+
})
|
|
51
|
+
.catch((err) => {
|
|
52
|
+
done(err);
|
|
53
|
+
});
|
|
47
54
|
});
|
|
48
55
|
|
|
49
56
|
it('Support HTTP on port 80', (done) => {
|
|
50
|
-
|
|
57
|
+
const requestOptions = {
|
|
58
|
+
host,
|
|
59
|
+
port: 80,
|
|
60
|
+
method: 'HEAD'
|
|
61
|
+
};
|
|
62
|
+
|
|
63
|
+
const req = http.request(requestOptions, (res) => {
|
|
51
64
|
try {
|
|
52
|
-
assert.
|
|
65
|
+
assert.ok(res.statusCode >= 200 && res.statusCode < 400);
|
|
53
66
|
done();
|
|
54
67
|
} catch (error) {
|
|
55
68
|
done(error);
|
|
56
69
|
}
|
|
57
70
|
});
|
|
71
|
+
|
|
72
|
+
req.on('error', (err) => {
|
|
73
|
+
done(err);
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
req.end();
|
|
58
77
|
});
|
|
59
78
|
|
|
60
79
|
it('Support HTTPS on port 443', (done) => {
|
|
61
|
-
|
|
80
|
+
const requestOptions = {
|
|
81
|
+
host,
|
|
82
|
+
port: 443,
|
|
83
|
+
method: 'HEAD'
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
const req = https.request(requestOptions, (res) => {
|
|
62
87
|
try {
|
|
63
|
-
assert.
|
|
88
|
+
assert.ok(res.statusCode >= 200 && res.statusCode < 400);
|
|
64
89
|
done();
|
|
65
90
|
} catch (error) {
|
|
66
91
|
done(error);
|
|
67
92
|
}
|
|
68
93
|
});
|
|
94
|
+
|
|
95
|
+
req.on('error', (err) => {
|
|
96
|
+
done(err);
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
req.end();
|
|
69
100
|
});
|
|
70
101
|
|
|
71
102
|
it('Support IPv4', (done) => {
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
103
|
+
const options = {
|
|
104
|
+
family: 4,
|
|
105
|
+
hints: dnsLookup.ADDRCONFIG
|
|
106
|
+
};
|
|
107
|
+
|
|
108
|
+
dnsLookup.lookup(host, options)
|
|
109
|
+
.then((address, family) => {
|
|
110
|
+
try {
|
|
111
|
+
assert.ok(address !== null && family === 4);
|
|
112
|
+
done();
|
|
113
|
+
} catch (error) {
|
|
114
|
+
done(error);
|
|
115
|
+
}
|
|
116
|
+
})
|
|
117
|
+
.catch((err) => {
|
|
118
|
+
done(err);
|
|
119
|
+
});
|
|
80
120
|
});
|
|
81
121
|
|
|
82
122
|
it('Support IPv6', (done) => {
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
123
|
+
const options = {
|
|
124
|
+
family: 6,
|
|
125
|
+
hints: dnsLookup.ADDRCONFIG
|
|
126
|
+
};
|
|
127
|
+
|
|
128
|
+
dnsLookup.lookup(host, options)
|
|
129
|
+
.then((address, family) => {
|
|
130
|
+
try {
|
|
131
|
+
assert.ok(address !== null && family === 6);
|
|
132
|
+
done();
|
|
133
|
+
} catch (error) {
|
|
134
|
+
done(error);
|
|
135
|
+
}
|
|
136
|
+
})
|
|
137
|
+
.catch((err) => {
|
|
138
|
+
done(err);
|
|
139
|
+
});
|
|
91
140
|
});
|
|
92
141
|
});
|
|
93
142
|
});
|
|
@@ -9,13 +9,13 @@
|
|
|
9
9
|
// include required items for testing & logging
|
|
10
10
|
const assert = require('assert');
|
|
11
11
|
const fs = require('fs');
|
|
12
|
-
const mocha = require('mocha');
|
|
13
12
|
const path = require('path');
|
|
13
|
+
const util = require('util');
|
|
14
|
+
const mocha = require('mocha');
|
|
14
15
|
const winston = require('winston');
|
|
15
16
|
const { expect } = require('chai');
|
|
16
17
|
const { use } = require('chai');
|
|
17
18
|
const td = require('testdouble');
|
|
18
|
-
const util = require('util');
|
|
19
19
|
|
|
20
20
|
const anything = td.matchers.anything();
|
|
21
21
|
|
|
@@ -335,6 +335,134 @@ describe('[integration] SevOne Adapter Test', () => {
|
|
|
335
335
|
}).timeout(attemptTimeout);
|
|
336
336
|
});
|
|
337
337
|
|
|
338
|
+
// broker tests
|
|
339
|
+
describe('#getDevicesFiltered - errors', () => {
|
|
340
|
+
it('should work if integrated but since no mockdata should error when run standalone', (done) => {
|
|
341
|
+
try {
|
|
342
|
+
const opts = {
|
|
343
|
+
filter: {
|
|
344
|
+
name: 'deviceName'
|
|
345
|
+
}
|
|
346
|
+
};
|
|
347
|
+
a.getDevicesFiltered(opts, (data, error) => {
|
|
348
|
+
try {
|
|
349
|
+
if (stub) {
|
|
350
|
+
if (samProps.devicebroker.getDevicesFiltered[0].handleFailure === 'ignore') {
|
|
351
|
+
assert.equal(null, error);
|
|
352
|
+
assert.notEqual(undefined, data);
|
|
353
|
+
assert.notEqual(null, data);
|
|
354
|
+
assert.equal(0, data.total);
|
|
355
|
+
assert.equal(0, data.list.length);
|
|
356
|
+
} else {
|
|
357
|
+
const displayE = 'Error 400 received on request';
|
|
358
|
+
runErrorAsserts(data, error, 'AD.500', 'Test-sevone-connectorRest-handleEndResponse', displayE);
|
|
359
|
+
}
|
|
360
|
+
} else {
|
|
361
|
+
runCommonAsserts(data, error);
|
|
362
|
+
}
|
|
363
|
+
done();
|
|
364
|
+
} catch (err) {
|
|
365
|
+
log.error(`Test Failure: ${err}`);
|
|
366
|
+
done(err);
|
|
367
|
+
}
|
|
368
|
+
});
|
|
369
|
+
} catch (error) {
|
|
370
|
+
log.error(`Adapter Exception: ${error}`);
|
|
371
|
+
done(error);
|
|
372
|
+
}
|
|
373
|
+
}).timeout(attemptTimeout);
|
|
374
|
+
});
|
|
375
|
+
|
|
376
|
+
describe('#iapGetDeviceCount - errors', () => {
|
|
377
|
+
it('should work if integrated but since no mockdata should error when run standalone', (done) => {
|
|
378
|
+
try {
|
|
379
|
+
const opts = {
|
|
380
|
+
filter: {
|
|
381
|
+
name: 'deviceName'
|
|
382
|
+
}
|
|
383
|
+
};
|
|
384
|
+
a.iapGetDeviceCount((data, error) => {
|
|
385
|
+
try {
|
|
386
|
+
if (stub) {
|
|
387
|
+
if (samProps.devicebroker.getDevicesFiltered[0].handleFailure === 'ignore') {
|
|
388
|
+
assert.equal(null, error);
|
|
389
|
+
assert.notEqual(undefined, data);
|
|
390
|
+
assert.notEqual(null, data);
|
|
391
|
+
assert.equal(0, data.count);
|
|
392
|
+
} else {
|
|
393
|
+
const displayE = 'Error 400 received on request';
|
|
394
|
+
runErrorAsserts(data, error, 'AD.500', 'Test-sevone-connectorRest-handleEndResponse', displayE);
|
|
395
|
+
}
|
|
396
|
+
} else {
|
|
397
|
+
runCommonAsserts(data, error);
|
|
398
|
+
}
|
|
399
|
+
done();
|
|
400
|
+
} catch (err) {
|
|
401
|
+
log.error(`Test Failure: ${err}`);
|
|
402
|
+
done(err);
|
|
403
|
+
}
|
|
404
|
+
});
|
|
405
|
+
} catch (error) {
|
|
406
|
+
log.error(`Adapter Exception: ${error}`);
|
|
407
|
+
done(error);
|
|
408
|
+
}
|
|
409
|
+
}).timeout(attemptTimeout);
|
|
410
|
+
});
|
|
411
|
+
|
|
412
|
+
// exposed cache tests
|
|
413
|
+
describe('#iapPopulateEntityCache - errors', () => {
|
|
414
|
+
it('should work if integrated but since no mockdata should error when run standalone', (done) => {
|
|
415
|
+
try {
|
|
416
|
+
a.iapPopulateEntityCache('Device', (data, error) => {
|
|
417
|
+
try {
|
|
418
|
+
if (stub) {
|
|
419
|
+
assert.equal(null, data);
|
|
420
|
+
assert.notEqual(undefined, error);
|
|
421
|
+
assert.notEqual(null, error);
|
|
422
|
+
done();
|
|
423
|
+
} else {
|
|
424
|
+
assert.equal(undefined, error);
|
|
425
|
+
assert.equal('success', data[0]);
|
|
426
|
+
done();
|
|
427
|
+
}
|
|
428
|
+
} catch (err) {
|
|
429
|
+
log.error(`Test Failure: ${err}`);
|
|
430
|
+
done(err);
|
|
431
|
+
}
|
|
432
|
+
});
|
|
433
|
+
} catch (error) {
|
|
434
|
+
log.error(`Adapter Exception: ${error}`);
|
|
435
|
+
done(error);
|
|
436
|
+
}
|
|
437
|
+
}).timeout(attemptTimeout);
|
|
438
|
+
});
|
|
439
|
+
|
|
440
|
+
describe('#iapRetrieveEntitiesCache - errors', () => {
|
|
441
|
+
it('should work if integrated but since no mockdata should error when run standalone', (done) => {
|
|
442
|
+
try {
|
|
443
|
+
a.iapRetrieveEntitiesCache('Device', {}, (data, error) => {
|
|
444
|
+
try {
|
|
445
|
+
if (stub) {
|
|
446
|
+
assert.equal(null, data);
|
|
447
|
+
assert.notEqual(null, error);
|
|
448
|
+
assert.notEqual(undefined, error);
|
|
449
|
+
} else {
|
|
450
|
+
assert.equal(undefined, error);
|
|
451
|
+
assert.notEqual(null, data);
|
|
452
|
+
assert.notEqual(undefined, data);
|
|
453
|
+
}
|
|
454
|
+
done();
|
|
455
|
+
} catch (err) {
|
|
456
|
+
log.error(`Test Failure: ${err}`);
|
|
457
|
+
done(err);
|
|
458
|
+
}
|
|
459
|
+
});
|
|
460
|
+
} catch (error) {
|
|
461
|
+
log.error(`Adapter Exception: ${error}`);
|
|
462
|
+
done(error);
|
|
463
|
+
}
|
|
464
|
+
}).timeout(attemptTimeout);
|
|
465
|
+
});
|
|
338
466
|
/*
|
|
339
467
|
-----------------------------------------------------------------------
|
|
340
468
|
-----------------------------------------------------------------------
|