-
Notifications
You must be signed in to change notification settings - Fork 22
/
index.js
476 lines (426 loc) · 22.3 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
const jsonld = require("jsonld")
const Ajv = require("ajv")
const coreAssertions = require("./shared")
const schema = require("./td-schema.json")
const fullschema = require("./td-schema-full.json")
module.exports = tdValidator
module.exports.propUniqueness = coreAssertions.checkPropUniqueness
module.exports.multiLangConsistency = coreAssertions.checkMultiLangConsistency
module.exports.security = coreAssertions.checkSecurity
const jsonValidator = require('json-dup-key-validator')
/**
* A function that provides the core functionality of the TD Playground.
* @param {string} tdString The Thing Description to check as a string.
* @param {function} logFunc (string) => void; Callback used to log the validation progress.
* @param {object} options additional options, which checks should be executed
* @returns {Promise<object>} Results of the validation as {report, details, detailComments} object
*/
function tdValidator(tdString, logFunc, { checkDefaults=true, checkJsonLd=true }) {
return new Promise( (res, rej) => {
// check input
if (typeof tdString !== "string") {rej("Thing Description input should be a String")}
if (checkDefaults === undefined) {
checkDefaults = true
}
if (checkJsonLd === undefined) {
checkJsonLd = true
}
if (typeof logFunc !== "function") {rej("Expected logFunc to be a function")}
// report that is returned by the function, possible values for every property:
// null -> not tested, "passed", "failed", "warning"
const report = {
json: null,
schema: null,
defaults: null,
jsonld: null,
additional: null
}
const details = {
enumConst: null,
propItems: null,
security: null,
propUniqueness: null,
multiLangConsistency: null,
readWriteOnly: null
}
const detailComments = {
enumConst: "Checking whether a data schema has enum and const at the same time.",
propItems: "Checking whether a data schema has an object but not properties or array but no items.",
security: "Check if used Security definitions are properly defined previously.",
propUniqueness: "Checking whether in one interaction pattern there are duplicate names, e.g. two properties called temp.",
multiLangConsistency: "Checks whether all titles and descriptions have the same language fields.",
readWriteOnly: "Warns if a property has readOnly or writeOnly set to true conflicting with another property."
}
let tdJson
try {
tdJson = JSON.parse(tdString)
report.json = "passed"
}
catch (err) {
report.json = "failed"
logFunc("X JSON validation failed:")
logFunc(err)
res({report, details, detailComments})
}
const ajv = new Ajv() // options can be passed, e.g. {allErrors: true}
ajv.addSchema(schema, 'td')
const valid = ajv.validate('td', tdJson)
// used to be var valid = ajv.validate('td', e.detail);
if (valid) {
report.schema = "passed"
// check with full schema
if (checkDefaults) {
ajv.addSchema(fullschema, 'fulltd')
const fullValid = ajv.validate('fulltd', tdJson)
if (fullValid) {
report.defaults = "passed"
}
else {
report.defaults = "warning"
logFunc("Optional validation failed:")
logFunc("> " + ajv.errorsText(filterErrorMessages(ajv.errors)))
}
}
// do additional checks
checkEnumConst(tdJson)
checkPropItems(tdJson)
checkReadWriteOnly(tdJson)
details.security = evalAssertion(coreAssertions.checkSecurity(tdJson))
details.propUniqueness = evalAssertion(coreAssertions.checkPropUniqueness(tdString))
if (details.propUniqueness === "passed") {
details.propUniqueness = checkSecPropUniqueness(tdString, tdJson)
}
else {
checkSecPropUniqueness(tdString, tdJson)
}
details.multiLangConsistency = evalAssertion(coreAssertions.checkMultiLangConsistency(tdJson))
// determine additional check state
// passed + warning -> warning
// passed AND OR warning + error -> error
report.additional = "passed"
Object.keys(details).forEach( prop => {
if (details[prop] === "warning" && report.additional === "passed") {
report.additional = "warning"
}
else if (details[prop] === "failed" && report.additional !== "failed") {
report.additional = "failed"
}
})
} else {
report.schema = "failed"
logFunc("X JSON Schema validation failed:")
logFunc('> ' + ajv.errorsText(filterErrorMessages(ajv.errors)))
res({report, details, detailComments})
}
// json ld validation
if(checkJsonLd) {
jsonld.toRDF(tdJson, {
format: 'application/nquads'
}).then( nquads => {
report.jsonld = "passed"
res({report, details, detailComments})
}, err => {
report.jsonld = "failed"
logFunc("X JSON-LD validation failed:")
logFunc("Hint: Make sure you have internet connection available.")
logFunc('> ' + err)
res({report, details, detailComments})
})
}
else {
res({report, details, detailComments})
}
// ************ functions ***************
/** checking whether a data schema has enum and const at the same and displaying a warning in case there are */
function checkEnumConst(td) {
details.enumConst = "passed"
if (td.hasOwnProperty("properties")) {
// checking properties
tdProperties = Object.keys(td.properties)
for (let i = 0; i < tdProperties.length; i++) {
const curPropertyName = tdProperties[i]
const curProperty = td.properties[curPropertyName]
if (curProperty.hasOwnProperty("enum") && curProperty.hasOwnProperty("const")) {
details.enumConst = "warning"
logFunc('! Warning: In property ' + curPropertyName +
' enum and const are used at the same time, the values in enum' +
' can never be valid in the received JSON value')
}
}
}
// checking actions
if (td.hasOwnProperty("actions")) {
tdActions = Object.keys(td.actions)
for (let i = 0; i < tdActions.length; i++) {
const curActionName = tdActions[i]
const curAction = td.actions[curActionName]
if (curAction.hasOwnProperty("input")) {
const curInput = curAction.input
if (curInput.hasOwnProperty("enum") && curInput.hasOwnProperty("const")) {
details.enumConst = "warning"
logFunc('! Warning: In the input of action ' + curActionName +
' enum and const are used at the same time, the values in enum can' +
' never be valid in the received JSON value')
}
}
if (curAction.hasOwnProperty("output")) {
const curOutput = curAction.output
if (curOutput.hasOwnProperty("enum") && curOutput.hasOwnProperty("const")) {
details.enumConst = "warning"
logFunc('! Warning: In the output of action ' + curActionName +
' enum and const are used at the same time, the values in enum can' +
' never be valid in the received JSON value')
}
}
}
}
// checking events
if (td.hasOwnProperty("events")) {
tdEvents = Object.keys(td.events)
for (let i = 0; i < tdEvents.length; i++) {
const curEventName = tdEvents[i]
const curEvent = td.events[curEventName]
if (curEvent.hasOwnProperty("enum") && curEvent.hasOwnProperty("const")) {
details.enumConst = "warning"
logFunc('! Warning: In event ' + curEventName +
' enum and const are used at the same time, the' +
' values in enum can never be valid in the received JSON value')
}
}
}
return
}
/**
* checking whether a data schema has object but not properties, array but no items
* @param {object} td The TD under test
*/
function checkPropItems(td) {
details.propItems = "passed"
if (td.hasOwnProperty("properties")) {
// checking properties
tdProperties = Object.keys(td.properties)
for (let i = 0; i < tdProperties.length; i++) {
const curPropertyName = tdProperties[i]
const curProperty = td.properties[curPropertyName]
if (curProperty.hasOwnProperty("type")) {
if ((curProperty.type === "object") && !(curProperty.hasOwnProperty("properties"))) {
details.propItems = "warning"
logFunc('! Warning: In property ' + curPropertyName +
', the type is object but its properties are not specified')
}
if ((curProperty.type === "array") && !(curProperty.hasOwnProperty("items"))) {
details.propItems = "warning"
logFunc('! Warning: In property ' + curPropertyName +
', the type is array but its items are not specified')
}
}
}
}
// checking actions
if (td.hasOwnProperty("actions")) {
tdActions = Object.keys(td.actions)
for (let i = 0; i < tdActions.length; i++) {
const curActionName = tdActions[i]
const curAction = td.actions[curActionName]
if (curAction.hasOwnProperty("input")) {
const curInput = curAction.input
if (curInput.hasOwnProperty("type")) {
if ((curInput.type === "object") && !(curInput.hasOwnProperty("properties"))) {
details.propItems = "warning"
logFunc('! Warning: In the input of action ' + curActionName +
', the type is object but its properties are not specified')
}
if ((curInput.type === "array") && !(curInput.hasOwnProperty("items"))) {
details.propItems = "warning"
logFunc('! Warning: In the output of action ' + curActionName +
', the type is array but its items are not specified')
}
}
}
if (curAction.hasOwnProperty("output")) {
const curOutput = curAction.output
if (curOutput.hasOwnProperty("type")) {
if ((curOutput.type === "object") && !(curOutput.hasOwnProperty("properties"))) {
details.propItems = "warning"
logFunc('! Warning: In the output of action ' + curActionName +
', the type is object but its properties are not specified')
}
if ((curOutput.type === "array") && !(curOutput.hasOwnProperty("items"))) {
details.propItems = "warning"
logFunc('! Warning: In the output of action ' + curActionName +
', the type is array but its items are not specified')
}
}
}
}
}
// checking events
if (td.hasOwnProperty("events")) {
tdEvents = Object.keys(td.events)
for (let i = 0; i < tdEvents.length; i++) {
const curEventName = tdEvents[i]
const curEvent = td.events[curEventName]
if (curEvent.hasOwnProperty("type")) {
if ((curEvent.type === "object") && !(curEvent.hasOwnProperty("properties"))) {
details.propItems = "warning"
logFunc('! Warning: In event ' + curEventName +
', the type is object but its properties are not specified')
}
if ((curEvent.type === "array") && !(curEvent.hasOwnProperty("items"))) {
details.propItems = "warning"
logFunc('! Warning: In event ' + curEventName +
', the type is array but its items are not specified')
}
}
}
}
return
}
/**
* Warns if a property has readOnly or writeOnly set to true conflicting with another property.
* @param {object} td The TD under test
*/
function checkReadWriteOnly(td) {
details.readWriteOnly = "passed"
if (td.hasOwnProperty("properties")) {
// checking properties
tdProperties = Object.keys(td.properties)
for (let i = 0; i < tdProperties.length; i++) {
const curPropertyName = tdProperties[i]
const curProperty = td.properties[curPropertyName]
// if readOnly is set
if (curProperty.hasOwnProperty("readOnly") && curProperty.readOnly === true) {
// check if both readOnly and writeOnly are true
if (curProperty.hasOwnProperty("writeOnly") && curProperty.writeOnly === true) {
details.readWriteOnly = "warning"
logFunc('! Warning: In property ' + curPropertyName +
', both readOnly and writeOnly are set to true!')
}
// check forms if op writeProperty is set
if (curProperty.hasOwnProperty("forms")) {
for(const formElIndex in curProperty.forms) {
if (curProperty.forms.hasOwnProperty(formElIndex)) {
const formEl = curProperty.forms[formElIndex]
if(formEl.hasOwnProperty("op")) {
if ((typeof formEl.op === "string" && formEl.op === "writeproperty") ||
(typeof formEl.op === "object" && formEl.op.some( el => (el === "writeproperty"))))
{
details.readWriteOnly = "warning"
logFunc('! Warning: In property ' + curPropertyName + " in forms[" + formElIndex +
'], readOnly is set but the op property contains "writeproperty"')
}
}
else {
details.readWriteOnly = "warning"
logFunc('! Warning: In property ' + curPropertyName + " in forms[" + formElIndex +
'], readOnly is set but a form op property defaults to ["writeproperty", "readproperty"]')
}
}
}
}
}
// if writeOnly is set
if (curProperty.hasOwnProperty("writeOnly") && curProperty.writeOnly === true) {
// check forms if op readProperty is set
if (curProperty.hasOwnProperty("forms")) {
for(const formElIndex in curProperty.forms) {
if (curProperty.forms.hasOwnProperty(formElIndex)) {
const formEl = curProperty.forms[formElIndex]
if(formEl.hasOwnProperty("op")) {
if ((typeof formEl.op === "string" && formEl.op === "readproperty") ||
(typeof formEl.op === "object" && formEl.op.some( el => (el === "readproperty"))))
{
details.readWriteOnly = "warning"
logFunc('! Warning: In property ' + curPropertyName + " in forms[" + formElIndex +
'], writeOnly is set but the op property contains "readproperty"')
}
else if ((typeof formEl.op === "string" && formEl.op === "observeproperty") ||
(typeof formEl.op === "object" && formEl.op.some( el => (el === "observeproperty"))))
{
details.readWriteOnly = "warning"
logFunc('! Warning: In property ' + curPropertyName + " in forms[" + formElIndex +
'], writeOnly is set but the op property contains "observeproperty"')
}
}
else {
details.readWriteOnly = "warning"
logFunc('! Warning: In property ' + curPropertyName + " in forms[" + formElIndex +
'], writeOnly is set but a form op property defaults to ["writeproperty", "readproperty"]')
}
}
}
}
// check if observable is also set
if (curProperty.hasOwnProperty("observable") && curProperty.observable === true) {
details.readWriteOnly = "warning"
logFunc('! Warning: In property ' + curPropertyName +
', both writeOnly and observable are set to true!')
}
}
}
}
}
/**
* Warns if security Definitions has no unique keys
* @param {object} tdStr The TD under test as string
*/
function checkSecPropUniqueness(tdStr, td) {
let result = "passed"
try {
// checking whether there are securityDefinitions at all
jsonValidator.parse(tdStr, false)
}
catch (error) {
// there is a duplicate somewhere
// convert it into string to be able to process it
// error is of form = Error: Syntax error: duplicated keys "overheating" near ting": {
const errorString = error.toString()
// to get the name, we need to remove the quotes around it
const startQuote = errorString.indexOf('"')
// slice to remove the part before the quote
const restString = errorString.slice(startQuote + 1)
// find where the interaction name ends
const endQuote = restString.indexOf('"')
// finally get the interaction name
const securitySchemeName = restString.slice(0, endQuote)
if (td.securityDefinitions.hasOwnProperty(securitySchemeName)) {
result = "failed"
logFunc("KO Error: The securityDefinitions contain a duplicate")
}
}
return result
}
/**
* Evaluates whether an assertion function contains a failed check
* Whether assertions are not-implemented or passed does not matter
* Logs the comment
* @param {Array} results Array of objects with props "ID", "Status" and optionally "Comment"
* @returns "passed" if no check failed, "failed" if one or more checks failed
*/
function evalAssertion(results) {
let out = "passed"
results.forEach( resultobj => {
if (resultobj.Status === "fail") {
out = "failed"
logFunc("KO Error: Assertion: " + resultobj.ID)
logFunc(resultobj.Comment)
}
})
return out
}
/**
* Removes duplicate error messages, as these are produced
* otherwise, especially for "oneOf" schemes
* @param {ajv.ErrorObject[]} errors
*/
function filterErrorMessages(errors) {
const output = []
errors.forEach( el => {
if(!output.some(ce => (ce.dataPath === el.dataPath && ce.message === el.message))) {
output.push(el)
}
})
return output
}
})
}