@itentialopensource/adapter-apic 0.3.4 → 0.5.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 +36 -0
- package/BROKER.md +199 -0
- package/CALLS.md +242 -0
- package/CHANGELOG.md +46 -28
- 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 +239 -507
- package/SUMMARY.md +9 -0
- package/SYSTEMINFO.md +20 -0
- package/TROUBLESHOOT.md +47 -0
- package/adapter.js +391 -272
- package/adapterBase.js +843 -397
- package/changelogs/changelog.md +78 -0
- package/entities/.generic/action.json +110 -5
- package/entities/.generic/schema.json +6 -1
- package/error.json +12 -0
- package/metadata.json +51 -0
- package/package.json +29 -22
- package/pronghorn.json +691 -88
- package/propertiesDecorators.json +14 -0
- package/propertiesSchema.json +833 -6
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +180 -0
- package/report/adapter-openapi.yaml +141 -0
- package/report/adapterInfo.json +10 -0
- package/report/updateReport1653418391508.json +120 -0
- package/report/updateReport1691508801991.json +120 -0
- package/report/updateReport1692203261139.json +120 -0
- package/report/updateReport1694468837016.json +120 -0
- package/sampleProperties.json +157 -4
- package/test/integration/adapterTestBasicGet.js +4 -6
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +165 -111
- package/test/unit/adapterBaseTestUnit.js +393 -310
- package/test/unit/adapterTestUnit.js +928 -174
- package/utils/adapterInfo.js +206 -0
- package/utils/addAuth.js +94 -0
- package/utils/artifactize.js +1 -1
- package/utils/basicGet.js +1 -14
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +179 -0
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +260 -0
- package/utils/modify.js +14 -16
- package/utils/packModificationScript.js +2 -2
- package/utils/patches2bundledDeps.js +90 -0
- package/utils/pre-commit.sh +5 -0
- package/utils/removeHooks.js +20 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +129 -53
- package/utils/tbUtils.js +152 -35
- package/utils/testRunner.js +17 -17
- package/utils/troubleshootingAdapter.js +10 -31
- package/workflows/README.md +0 -3
|
@@ -3,12 +3,15 @@
|
|
|
3
3
|
// Set globals
|
|
4
4
|
/* global describe it log pronghornProps */
|
|
5
5
|
/* eslint no-unused-vars: warn */
|
|
6
|
+
/* eslint no-underscore-dangle: warn */
|
|
7
|
+
/* eslint import/no-dynamic-require:warn */
|
|
6
8
|
|
|
7
9
|
// include required items for testing & logging
|
|
8
10
|
const assert = require('assert');
|
|
9
11
|
const fs = require('fs');
|
|
10
|
-
const mocha = require('mocha');
|
|
11
12
|
const path = require('path');
|
|
13
|
+
const util = require('util');
|
|
14
|
+
const mocha = require('mocha');
|
|
12
15
|
const winston = require('winston');
|
|
13
16
|
const { expect } = require('chai');
|
|
14
17
|
const { use } = require('chai');
|
|
@@ -18,20 +21,33 @@ const anything = td.matchers.anything();
|
|
|
18
21
|
|
|
19
22
|
// stub and attemptTimeout are used throughout the code so set them here
|
|
20
23
|
let logLevel = 'none';
|
|
21
|
-
const stub = true;
|
|
22
24
|
const isRapidFail = false;
|
|
23
25
|
const isSaveMockData = false;
|
|
24
|
-
|
|
26
|
+
|
|
27
|
+
// read in the properties from the sampleProperties files
|
|
28
|
+
let adaptdir = __dirname;
|
|
29
|
+
if (adaptdir.endsWith('/test/integration')) {
|
|
30
|
+
adaptdir = adaptdir.substring(0, adaptdir.length - 17);
|
|
31
|
+
} else if (adaptdir.endsWith('/test/unit')) {
|
|
32
|
+
adaptdir = adaptdir.substring(0, adaptdir.length - 10);
|
|
33
|
+
}
|
|
34
|
+
const samProps = require(`${adaptdir}/sampleProperties.json`).properties;
|
|
25
35
|
|
|
26
36
|
// these variables can be changed to run in integrated mode so easier to set them here
|
|
27
37
|
// always check these in with bogus data!!!
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
38
|
+
samProps.stub = true;
|
|
39
|
+
samProps.host = 'replace.hostorip.here';
|
|
40
|
+
samProps.authentication.username = 'username';
|
|
41
|
+
samProps.authentication.password = 'password';
|
|
42
|
+
samProps.protocol = 'http';
|
|
43
|
+
samProps.port = 80;
|
|
44
|
+
samProps.ssl.enabled = false;
|
|
45
|
+
samProps.ssl.accept_invalid_cert = false;
|
|
46
|
+
if (samProps.request.attempt_timeout < 30000) {
|
|
47
|
+
samProps.request.attempt_timeout = 30000;
|
|
48
|
+
}
|
|
49
|
+
const attemptTimeout = samProps.request.attempt_timeout;
|
|
50
|
+
const { stub } = samProps;
|
|
35
51
|
|
|
36
52
|
// these are the adapter properties. You generally should not need to alter
|
|
37
53
|
// any of these after they are initially set up
|
|
@@ -41,101 +57,9 @@ global.pronghornProps = {
|
|
|
41
57
|
},
|
|
42
58
|
adapterProps: {
|
|
43
59
|
adapters: [{
|
|
44
|
-
id: '
|
|
60
|
+
id: 'Test-apic',
|
|
45
61
|
type: 'Apic',
|
|
46
|
-
properties:
|
|
47
|
-
host,
|
|
48
|
-
port,
|
|
49
|
-
base_path: '/',
|
|
50
|
-
version: '',
|
|
51
|
-
cache_location: 'none',
|
|
52
|
-
encode_pathvars: true,
|
|
53
|
-
save_metric: false,
|
|
54
|
-
stub,
|
|
55
|
-
protocol,
|
|
56
|
-
authentication: {
|
|
57
|
-
auth_method: 'basic user_password',
|
|
58
|
-
username,
|
|
59
|
-
password,
|
|
60
|
-
token: '',
|
|
61
|
-
invalid_token_error: 401,
|
|
62
|
-
token_timeout: -1,
|
|
63
|
-
token_cache: 'local',
|
|
64
|
-
auth_field: 'header.auth',
|
|
65
|
-
auth_field_format: '{username}:{password}',
|
|
66
|
-
auth_logging: false
|
|
67
|
-
},
|
|
68
|
-
healthcheck: {
|
|
69
|
-
type: 'startup',
|
|
70
|
-
frequency: 60000,
|
|
71
|
-
query_object: {}
|
|
72
|
-
},
|
|
73
|
-
throttle: {
|
|
74
|
-
throttle_enabled: false,
|
|
75
|
-
number_pronghorns: 1,
|
|
76
|
-
sync_async: 'sync',
|
|
77
|
-
max_in_queue: 1000,
|
|
78
|
-
concurrent_max: 1,
|
|
79
|
-
expire_timeout: 0,
|
|
80
|
-
avg_runtime: 200,
|
|
81
|
-
priorities: [
|
|
82
|
-
{
|
|
83
|
-
value: 0,
|
|
84
|
-
percent: 100
|
|
85
|
-
}
|
|
86
|
-
]
|
|
87
|
-
},
|
|
88
|
-
request: {
|
|
89
|
-
number_redirects: 0,
|
|
90
|
-
number_retries: 3,
|
|
91
|
-
limit_retry_error: 0,
|
|
92
|
-
failover_codes: [],
|
|
93
|
-
attempt_timeout: attemptTimeout,
|
|
94
|
-
global_request: {
|
|
95
|
-
payload: {},
|
|
96
|
-
uriOptions: {},
|
|
97
|
-
addlHeaders: {},
|
|
98
|
-
authData: {}
|
|
99
|
-
},
|
|
100
|
-
healthcheck_on_timeout: true,
|
|
101
|
-
return_raw: true,
|
|
102
|
-
archiving: false,
|
|
103
|
-
return_request: false
|
|
104
|
-
},
|
|
105
|
-
proxy: {
|
|
106
|
-
enabled: false,
|
|
107
|
-
host: '',
|
|
108
|
-
port: 1,
|
|
109
|
-
protocol: 'http',
|
|
110
|
-
username: '',
|
|
111
|
-
password: ''
|
|
112
|
-
},
|
|
113
|
-
ssl: {
|
|
114
|
-
ecdhCurve: '',
|
|
115
|
-
enabled: sslenable,
|
|
116
|
-
accept_invalid_cert: sslinvalid,
|
|
117
|
-
ca_file: '',
|
|
118
|
-
key_file: '',
|
|
119
|
-
cert_file: '',
|
|
120
|
-
secure_protocol: '',
|
|
121
|
-
ciphers: ''
|
|
122
|
-
},
|
|
123
|
-
mongo: {
|
|
124
|
-
host: '',
|
|
125
|
-
port: 0,
|
|
126
|
-
database: '',
|
|
127
|
-
username: '',
|
|
128
|
-
password: '',
|
|
129
|
-
replSet: '',
|
|
130
|
-
db_ssl: {
|
|
131
|
-
enabled: false,
|
|
132
|
-
accept_invalid_cert: false,
|
|
133
|
-
ca_file: '',
|
|
134
|
-
key_file: '',
|
|
135
|
-
cert_file: ''
|
|
136
|
-
}
|
|
137
|
-
}
|
|
138
|
-
}
|
|
62
|
+
properties: samProps
|
|
139
63
|
}]
|
|
140
64
|
}
|
|
141
65
|
};
|
|
@@ -310,7 +234,7 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
|
|
|
310
234
|
}
|
|
311
235
|
|
|
312
236
|
// require the adapter that we are going to be using
|
|
313
|
-
const Apic = require('../../adapter
|
|
237
|
+
const Apic = require('../../adapter');
|
|
314
238
|
|
|
315
239
|
// begin the testing - these should be pretty well defined between the describe and the it!
|
|
316
240
|
describe('[integration] Apic Adapter Test', () => {
|
|
@@ -341,6 +265,8 @@ describe('[integration] Apic Adapter Test', () => {
|
|
|
341
265
|
try {
|
|
342
266
|
assert.notEqual(null, a);
|
|
343
267
|
assert.notEqual(undefined, a);
|
|
268
|
+
const checkId = global.pronghornProps.adapterProps.adapters[0].id;
|
|
269
|
+
assert.equal(checkId, a.id);
|
|
344
270
|
assert.notEqual(null, a.allProps);
|
|
345
271
|
const check = global.pronghornProps.adapterProps.adapters[0].properties.healthcheck.type;
|
|
346
272
|
assert.equal(check, a.healthcheckType);
|
|
@@ -409,6 +335,134 @@ describe('[integration] Apic Adapter Test', () => {
|
|
|
409
335
|
}).timeout(attemptTimeout);
|
|
410
336
|
});
|
|
411
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-apic-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-apic-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
|
+
});
|
|
412
466
|
/*
|
|
413
467
|
-----------------------------------------------------------------------
|
|
414
468
|
-----------------------------------------------------------------------
|
|
@@ -429,7 +483,7 @@ describe('[integration] Apic Adapter Test', () => {
|
|
|
429
483
|
try {
|
|
430
484
|
if (stub) {
|
|
431
485
|
const displayE = 'Error 400 received on request';
|
|
432
|
-
runErrorAsserts(data, error, 'AD.500', '
|
|
486
|
+
runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
|
|
433
487
|
} else {
|
|
434
488
|
runCommonAsserts(data, error);
|
|
435
489
|
}
|
|
@@ -454,7 +508,7 @@ describe('[integration] Apic Adapter Test', () => {
|
|
|
454
508
|
try {
|
|
455
509
|
if (stub) {
|
|
456
510
|
const displayE = 'Error 400 received on request';
|
|
457
|
-
runErrorAsserts(data, error, 'AD.500', '
|
|
511
|
+
runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
|
|
458
512
|
} else {
|
|
459
513
|
runCommonAsserts(data, error);
|
|
460
514
|
}
|
|
@@ -479,7 +533,7 @@ describe('[integration] Apic Adapter Test', () => {
|
|
|
479
533
|
try {
|
|
480
534
|
if (stub) {
|
|
481
535
|
const displayE = 'Error 400 received on request';
|
|
482
|
-
runErrorAsserts(data, error, 'AD.500', '
|
|
536
|
+
runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
|
|
483
537
|
} else {
|
|
484
538
|
runCommonAsserts(data, error);
|
|
485
539
|
}
|
|
@@ -504,7 +558,7 @@ describe('[integration] Apic Adapter Test', () => {
|
|
|
504
558
|
try {
|
|
505
559
|
if (stub) {
|
|
506
560
|
const displayE = 'Error 400 received on request';
|
|
507
|
-
runErrorAsserts(data, error, 'AD.500', '
|
|
561
|
+
runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
|
|
508
562
|
} else {
|
|
509
563
|
runCommonAsserts(data, error);
|
|
510
564
|
}
|
|
@@ -529,7 +583,7 @@ describe('[integration] Apic Adapter Test', () => {
|
|
|
529
583
|
try {
|
|
530
584
|
if (stub) {
|
|
531
585
|
const displayE = 'Error 400 received on request';
|
|
532
|
-
runErrorAsserts(data, error, 'AD.500', '
|
|
586
|
+
runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
|
|
533
587
|
} else {
|
|
534
588
|
runCommonAsserts(data, error);
|
|
535
589
|
}
|
|
@@ -554,7 +608,7 @@ describe('[integration] Apic Adapter Test', () => {
|
|
|
554
608
|
try {
|
|
555
609
|
if (stub) {
|
|
556
610
|
const displayE = 'Error 400 received on request';
|
|
557
|
-
runErrorAsserts(data, error, 'AD.500', '
|
|
611
|
+
runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
|
|
558
612
|
} else {
|
|
559
613
|
runCommonAsserts(data, error);
|
|
560
614
|
}
|