@itentialopensource/adapter-thruk_monitoring 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.
Files changed (55) hide show
  1. package/AUTH.md +39 -0
  2. package/BROKER.md +199 -0
  3. package/CALLS.md +782 -0
  4. package/CHANGELOG.md +17 -2
  5. package/CODE_OF_CONDUCT.md +12 -17
  6. package/CONTRIBUTING.md +3 -148
  7. package/ENHANCE.md +69 -0
  8. package/PROPERTIES.md +641 -0
  9. package/README.md +235 -576
  10. package/SUMMARY.md +9 -0
  11. package/SYSTEMINFO.md +11 -0
  12. package/TROUBLESHOOT.md +47 -0
  13. package/adapter.js +482 -363
  14. package/adapterBase.js +854 -408
  15. package/entities/.generic/action.json +110 -5
  16. package/entities/.generic/schema.json +6 -1
  17. package/error.json +6 -0
  18. package/metadata.json +47 -0
  19. package/package.json +27 -22
  20. package/pronghorn.json +693 -90
  21. package/propertiesDecorators.json +14 -0
  22. package/propertiesSchema.json +828 -7
  23. package/refs?service=git-upload-pack +0 -0
  24. package/report/adapterInfo.json +10 -0
  25. package/report/updateReport1653680220789.json +120 -0
  26. package/report/updateReport1691508933044.json +120 -0
  27. package/report/updateReport1692202249790.json +120 -0
  28. package/report/updateReport1692203343592.json +120 -0
  29. package/report/updateReport1694469545834.json +120 -0
  30. package/report/updateReport1698423037978.json +120 -0
  31. package/sampleProperties.json +154 -4
  32. package/test/integration/adapterTestBasicGet.js +3 -5
  33. package/test/integration/adapterTestConnectivity.js +91 -42
  34. package/test/integration/adapterTestIntegration.js +155 -106
  35. package/test/unit/adapterBaseTestUnit.js +388 -308
  36. package/test/unit/adapterTestUnit.js +484 -243
  37. package/utils/adapterInfo.js +206 -0
  38. package/utils/addAuth.js +94 -0
  39. package/utils/artifactize.js +1 -1
  40. package/utils/basicGet.js +1 -14
  41. package/utils/checkMigrate.js +1 -1
  42. package/utils/entitiesToDB.js +179 -0
  43. package/utils/findPath.js +1 -1
  44. package/utils/methodDocumentor.js +273 -0
  45. package/utils/modify.js +14 -16
  46. package/utils/packModificationScript.js +1 -1
  47. package/utils/patches2bundledDeps.js +90 -0
  48. package/utils/pre-commit.sh +5 -0
  49. package/utils/removeHooks.js +20 -0
  50. package/utils/taskMover.js +309 -0
  51. package/utils/tbScript.js +129 -53
  52. package/utils/tbUtils.js +125 -25
  53. package/utils/testRunner.js +17 -17
  54. package/utils/troubleshootingAdapter.js +10 -31
  55. package/workflows/README.md +0 -3
@@ -0,0 +1,120 @@
1
+ {
2
+ "errors": [],
3
+ "statistics": [
4
+ {
5
+ "owner": "errorJson",
6
+ "description": "New adapter errors available for use",
7
+ "value": 0
8
+ },
9
+ {
10
+ "owner": "errorJson",
11
+ "description": "Adapter errors no longer available for use",
12
+ "value": 0
13
+ },
14
+ {
15
+ "owner": "errorJson",
16
+ "description": "Adapter errors that have been updated (e.g. recommendation changes)",
17
+ "value": 31
18
+ },
19
+ {
20
+ "owner": "packageJson",
21
+ "description": "Number of production dependencies",
22
+ "value": 17
23
+ },
24
+ {
25
+ "owner": "packageJson",
26
+ "description": "Number of development dependencies",
27
+ "value": 6
28
+ },
29
+ {
30
+ "owner": "packageJson",
31
+ "description": "Number of npm scripts",
32
+ "value": 22
33
+ },
34
+ {
35
+ "owner": "packageJson",
36
+ "description": "Runtime Library dependency",
37
+ "value": "^5.3.0"
38
+ },
39
+ {
40
+ "owner": "propertiesSchemaJson",
41
+ "description": "Adapter properties defined in the propertiesSchema file",
42
+ "value": 77
43
+ },
44
+ {
45
+ "owner": "markdown",
46
+ "description": "Number of lines in the README.md",
47
+ "value": 347
48
+ },
49
+ {
50
+ "owner": "markdown",
51
+ "description": "Number of lines in the SUMMARY.md",
52
+ "value": 9
53
+ },
54
+ {
55
+ "owner": "markdown",
56
+ "description": "Number of lines in the PROPERTIES.md",
57
+ "value": 642
58
+ },
59
+ {
60
+ "owner": "markdown",
61
+ "description": "Number of lines in the TROUBLESHOOT.md",
62
+ "value": 48
63
+ },
64
+ {
65
+ "owner": "markdown",
66
+ "description": "Number of lines in the ENHANCE.md",
67
+ "value": 70
68
+ },
69
+ {
70
+ "owner": "markdown",
71
+ "description": "Number of lines in the BROKER.md",
72
+ "value": 70
73
+ },
74
+ {
75
+ "owner": "unitTestJS",
76
+ "description": "Number of lines of code in unit tests",
77
+ "value": 4089
78
+ },
79
+ {
80
+ "owner": "unitTestJS",
81
+ "description": "Number of unit tests",
82
+ "value": 248
83
+ },
84
+ {
85
+ "owner": "integrationTestJS",
86
+ "description": "Number of lines of code in integration tests",
87
+ "value": 2910
88
+ },
89
+ {
90
+ "owner": "integrationTestJS",
91
+ "description": "Number of integration tests",
92
+ "value": 105
93
+ },
94
+ {
95
+ "owner": "staticFile",
96
+ "description": "Number of lines of code in adapterBase.js",
97
+ "value": 1453
98
+ },
99
+ {
100
+ "owner": "staticFile",
101
+ "description": "Number of static files added",
102
+ "value": 36
103
+ },
104
+ {
105
+ "owner": "Overall",
106
+ "description": "Total lines of Code",
107
+ "value": 8452
108
+ },
109
+ {
110
+ "owner": "Overall",
111
+ "description": "Total Tests",
112
+ "value": 353
113
+ },
114
+ {
115
+ "owner": "Overall",
116
+ "description": "Total Files",
117
+ "value": 6
118
+ }
119
+ ]
120
+ }
@@ -4,11 +4,13 @@
4
4
  "properties": {
5
5
  "host": "localhost",
6
6
  "port": 443,
7
+ "choosepath": "",
7
8
  "base_path": "/off/thruk/r",
8
9
  "version": "",
9
10
  "cache_location": "none",
10
11
  "encode_pathvars": true,
11
- "save_metric": true,
12
+ "encode_queryvars": true,
13
+ "save_metric": false,
12
14
  "stub": false,
13
15
  "protocol": "https",
14
16
  "authentication": {
@@ -24,12 +26,27 @@
24
26
  "auth_logging": false,
25
27
  "client_id": "",
26
28
  "client_secret": "",
27
- "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
+ ]
28
44
  },
29
45
  "healthcheck": {
30
46
  "type": "startup",
31
47
  "frequency": 60000,
32
- "query_object": {}
48
+ "query_object": {},
49
+ "addlHeaders": {}
33
50
  },
34
51
  "throttle": {
35
52
  "throttle_enabled": false,
@@ -60,7 +77,7 @@
60
77
  "addlHeaders": {
61
78
  "X-Thruk-Auth-User": "user"
62
79
  },
63
- "authData": {}
80
+ "authData": {}
64
81
  },
65
82
  "healthcheck_on_timeout": true,
66
83
  "return_raw": false,
@@ -99,6 +116,139 @@
99
116
  "key_file": "",
100
117
  "cert_file": ""
101
118
  }
119
+ },
120
+ "devicebroker": {
121
+ "getDevice": [
122
+ {
123
+ "path": "/get/devices/{id}",
124
+ "method": "GET",
125
+ "query": {},
126
+ "body": {},
127
+ "headers": {},
128
+ "handleFailure": "ignore",
129
+ "requestFields": {
130
+ "id": "name"
131
+ },
132
+ "responseDatakey": "",
133
+ "responseFields": {
134
+ "name": "host",
135
+ "ostype": "os",
136
+ "ostypePrefix": "system-",
137
+ "ipaddress": "attributes.ipaddr",
138
+ "port": "443"
139
+ }
140
+ }
141
+ ],
142
+ "getDevicesFiltered": [
143
+ {
144
+ "path": "/get/devices",
145
+ "method": "GET",
146
+ "pagination": {
147
+ "offsetVar": "",
148
+ "limitVar": "",
149
+ "incrementBy": "limit",
150
+ "requestLocation": "query"
151
+ },
152
+ "query": {},
153
+ "body": {},
154
+ "headers": {},
155
+ "handleFailure": "ignore",
156
+ "requestFields": {},
157
+ "responseDatakey": "",
158
+ "responseFields": {
159
+ "name": "host",
160
+ "ostype": "os",
161
+ "ostypePrefix": "system-",
162
+ "ipaddress": "attributes.ipaddr",
163
+ "port": "443"
164
+ }
165
+ }
166
+ ],
167
+ "isAlive": [
168
+ {
169
+ "path": "/get/devices/{id}/status",
170
+ "method": "GET",
171
+ "query": {},
172
+ "body": {},
173
+ "headers": {},
174
+ "handleFailure": "ignore",
175
+ "requestFields": {
176
+ "id": "name"
177
+ },
178
+ "responseDatakey": "",
179
+ "responseFields": {
180
+ "status": "status",
181
+ "statusValue": "online"
182
+ }
183
+ }
184
+ ],
185
+ "getConfig": [
186
+ {
187
+ "path": "/get/devices/{id}/configPart1",
188
+ "method": "GET",
189
+ "query": {},
190
+ "body": {},
191
+ "headers": {},
192
+ "handleFailure": "ignore",
193
+ "requestFields": {
194
+ "id": "name"
195
+ },
196
+ "responseDatakey": "",
197
+ "responseFields": {}
198
+ }
199
+ ],
200
+ "getCount": [
201
+ {
202
+ "path": "/get/devices",
203
+ "method": "GET",
204
+ "query": {},
205
+ "body": {},
206
+ "headers": {},
207
+ "handleFailure": "ignore",
208
+ "requestFields": {},
209
+ "responseDatakey": "",
210
+ "responseFields": {}
211
+ }
212
+ ]
213
+ },
214
+ "cache": {
215
+ "enabled": false,
216
+ "entities": [
217
+ {
218
+ "entityType": "",
219
+ "frequency": 1440,
220
+ "flushOnFail": false,
221
+ "limit": 1000,
222
+ "retryAttempts": 5,
223
+ "sort": true,
224
+ "populate": [
225
+ {
226
+ "path": "",
227
+ "method": "GET",
228
+ "pagination": {
229
+ "offsetVar": "",
230
+ "limitVar": "",
231
+ "incrementBy": "limit",
232
+ "requestLocation": "query"
233
+ },
234
+ "query": {},
235
+ "body": {},
236
+ "headers": {},
237
+ "handleFailure": "ignore",
238
+ "requestFields": {},
239
+ "responseDatakey": "",
240
+ "responseFields": {}
241
+ }
242
+ ],
243
+ "cachedTasks": [
244
+ {
245
+ "name": "",
246
+ "filterField": "",
247
+ "filterLoc": ""
248
+ }
249
+ ]
250
+ }
251
+ ]
102
252
  }
103
253
  },
104
254
  "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 discovery = new Discovery();
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
  };
@@ -34,7 +32,7 @@ describe('[integration] Adapter BasicGET Test', () => {
34
32
  context('Testing GET calls without query parameters', () => {
35
33
  before(async () => {
36
34
  const iapDir = path.join(__dirname, '../../../../../');
37
- if (!utils.withinIAP(iapDir)) {
35
+ if (!utils.areWeUnderIAPinstallationDirectory()) {
38
36
  const sampleProperties = require('../../sampleProperties.json');
39
37
  const adapter = { properties: sampleProperties };
40
38
  a = basicGet.getAdapterInstance(adapter);
@@ -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 diagnostics = require('network-diagnostics');
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
- diagnostics.haveDNS((result) => {
29
- try {
30
- assert.equal(result, true);
31
- done();
32
- } catch (error) {
33
- done(error);
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
- diagnostics.havePing((result) => {
40
- try {
41
- assert.equal(result, true);
42
- done();
43
- } catch (error) {
44
- done(error);
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
- diagnostics.haveHTTP((result) => {
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.equal(result, true);
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
- diagnostics.haveHTTPS((result) => {
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.equal(result, true);
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
- diagnostics.haveIPv4Async((result) => {
73
- try {
74
- assert.equal(result, true);
75
- done();
76
- } catch (error) {
77
- done(error);
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
- diagnostics.haveIPv6Async((result) => {
84
- try {
85
- assert.equal(result, true);
86
- done();
87
- } catch (error) {
88
- done(error);
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
  });