V1.1 merge to master

LICENSE.md

@@ -1,6 +1,6 @@
 MIT license
 
-Copyright 2020 Technical University of Munich, Associate Professorship of Embedded Systems and Internet of Things
+Copyright 2021 Technical University of Munich, Associate Professorship of Embedded Systems and Internet of Things
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

packages/assertions/README.md

@@ -54,7 +54,7 @@ You can use this package to integrate TD assertion testing in your own Browser/N
 
 ## License
 
-Licensed under the MIT license, see [License](./LICENSE.md).
+Licensed under the MIT license, see [License](../../LICENSE.md).
 
 ## Script based Thing Description Validation
 
@@ -67,6 +67,8 @@ This is a Node.js based tool.
 
 ## Script based Assertion Tester
 
+TODO: Update these numbers
+
 297 out of 349 assertions of the TD specification can be tested with this tool.
 
 This tool checks which assertions are satisfied by a given Thing Description(s). The assertions are modeled as JSON Schema or as scripts. 'AssertionTester/Assertions' has the JSON Schema assertions.
@@ -77,6 +79,8 @@ To use the assertion testing via the command line please use the `cli` package.
 
 ### Contributing
 
+1. Schema based assertions
+
 You can contribute by providing new JSON Schemas for assertions or by correcting them. There are two types of assertions:
 
 * Not-complex: This is generally used to check assertions that are in the Thing instance or mandatory assertions. You simply put the JSON key to be checked in the `required` validation keyword.
@@ -90,6 +94,20 @@ You can contribute by providing new JSON Schemas for assertions or by correcting
 
   This way, the validation will surely fail at the const keyword and display that the JSON data has to be `"td-data-schema_description=pass"` string. This will be then detected by the assertion testing tool which will look for the `=` sign to find the result. If the schema doesn't fail, it implies that this if was false, which in turn implies that the assertion you wanted to test was not implemented in the given TD.
 
+2. Script based assertions
+
+Some assertions cannot be verified just by a schema, even when the complex schemas are used. 
+Examples are checking that all multi language definitions like titles and descriptions contain the same language tags.
+
+When a new one is added, it is advised to add it to the [shared.js](https://github.com/thingweb/thingweb-playground/blob/master/packages/core/shared.js) since such checks can be used by the core package as well.
+
+After adding the function, you should do the following:
+1. Add it to the exports of `shared.js`
+2. Add it to the exports of `index.js` of the core package
+3. Add its name to the details object in `index.js` and its description to the detailComments of the `index.js`
+4. In the assertions package, adding it to the imports at the [assertionTests.js](https://github.com/thingweb/thingweb-playground/blob/master/packages/assertions/assertionTests.js)
+5. In the same file, calling it whenever needed. The other ones are done at around line 80.
+6. Adding it to the expected results of the tests (refResults) at the core package.
 ## Known Bugs
 
 * td-json-open assertion exists multiple times, [see issue 124](https://github.com/thingweb/thingweb-playground/issues/124)

packages/assertions/assertionTests.js

@@ -2,14 +2,17 @@
 const isUtf8 = require('is-utf8')
 
 // The usual library used for validation
-const Ajv = require('ajv')
+
+const Ajv = require("ajv")
 const addFormats = require("ajv-formats")
+const apply = require('ajv-formats-draft2019');
 
 
 // Imports from playground core
 const checkUniqueness = require('@thing-description-playground/core').propUniqueness
 const checkMultiLangConsistency = require("@thing-description-playground/core").multiLangConsistency
 const checkSecurity = require("@thing-description-playground/core").security
+const checkLinksRelTypeCount = require("@thing-description-playground/core").checkLinksRelTypeCount
 const tdSchema = require("@thing-description-playground/core/td-schema.json")
 
 /**
@@ -28,7 +31,8 @@ function validate(tdData, assertions, manualAssertions, logFunc) {
     // a JSON file that will be returned containing the result for each assertion as a JSON Object
     let results = []
     // !!! uses console info on purpose, to be able to deactivate it, without overwriting console.log !!!
-    console.info("=================================================================")
+    // console.info("=================================================================")
+    // it is commented out to make sure that the output to std is also a valid csv file
 
     // check whether it is a valid JSON
     let tdJson
@@ -71,6 +75,7 @@ function validate(tdData, assertions, manualAssertions, logFunc) {
     // additional checks
     results.push(...checkSecurity(tdJson))
     results.push(...checkMultiLangConsistency(tdJson))
+    results.push(...checkLinksRelTypeCount(tdJson))
 
     // Iterating through assertions
     for (let index = 0; index < assertions.length; index++) {
@@ -84,12 +89,14 @@ function validate(tdData, assertions, manualAssertions, logFunc) {
             "$comment" (v) {
                 logFunc("\n!!!! COMMENT", v)
             },
-            "allErrors": true
+            "allErrors": true,
+            "strict":false
         }
-        const ajv = new Ajv(ajvOptions)
+        let ajv = new Ajv(ajvOptions)
+        ajv = addFormats(ajv) // ajv does not support formats by default anymore
+        ajv = apply(ajv) // new formats that include iri
         ajv.addSchema(schema, 'td')
         ajv.addVocabulary(['is-complex', 'also']);
-        addFormats(ajv)
 
 
 
@@ -264,10 +271,11 @@ module.exports = validate
 function checkVocabulary(tdJson) {
 
     const results = []
-    const ajv = new Ajv()
+    let ajv = new Ajv({strict: false})
+    ajv = addFormats(ajv) // ajv does not support formats by default anymore
+    ajv = apply(ajv) // new formats that include iri
     ajv.addSchema(tdSchema, 'td')
     ajv.addVocabulary(['is-complex', 'also']);
-    addFormats(ajv)
 
     const valid = ajv.validate('td', tdJson)
     const otherAssertions = ["td-objects_securityDefinitions", "td-arrays_security", "td-vocab-security--Thing",
@@ -291,6 +299,7 @@ function checkVocabulary(tdJson) {
         return results
 
     } else {
+        console.log(ajv.errorsText())
         throw new Error("invalid TD")
     }
 }

packages/assertions/assertions/td-security-oauth2-client-flow.json

@@ -0,0 +1,77 @@
+{
+    "title": "td-security-oauth2-client-flow",
+    "description": "For the client flow token MUST be included.",
+    "$schema ": "http://json-schema.org/draft/2019-09/schema#",
+    "is-complex": true,
+    "also": ["td-security-oauth2-client-flow-no-auth"],
+    "type": "object",
+    "properties": {
+        "securityDefinitions": {
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": {
+                "$ref": "#/$defs/securityScheme"
+            }
+        }
+    },
+    "required": [
+        "securityDefinitions"
+    ],
+    "additionalProperties": true,
+    "$defs": {
+        "securityScheme": {
+            "if": {
+                "type": "object",
+                "properties": {
+                    "description": {
+                        "type": "string"
+                    },
+                    "proxy": {
+                        "$ref": "#/$defs/url"
+                    },
+                    "scheme": {
+                        "type": "string",
+                        "enum": [
+                            "oauth2"
+                        ]
+                    },
+                    "token": {
+                        "$ref": "#/$defs/url"
+                    },
+                    "refresh": {
+                        "$ref": "#/$defs/url"
+                    },
+                    "scopes": {
+                        "oneOf": [{
+                                "type": "array",
+                                "items": {
+                                    "type": "string"
+                                }
+                            },
+                            {
+                                "type": "string"
+                            }
+                        ]
+                    },
+                    "flow": {
+                        "type": "string",
+                        "const":"client"
+                    }
+                },
+                "required": [
+                    "scheme", "flow", "token"
+                ],
+                "not": {
+                    "required": ["authorization"]
+                }
+            },
+            "then": {
+                "const": "td-security-oauth2-client-flow=pass"
+            }
+        },
+        "url": {
+            "type": "string",
+            "format": "uri-reference"
+        }
+    }
+}