feat: add validation of Thing Descriptions

eclipse-thingweb · Jun 5, 2022 · 7af7429 · 7af7429
1 parent 72c1002
commit 7af7429
Show file tree

Hide file tree

Showing 4 changed files with 822 additions and 2 deletions.
diff --git a/lib/definitions.dart b/lib/definitions.dart
@@ -12,3 +12,5 @@
 export 'src/definitions/form.dart';
 export 'src/definitions/thing_description.dart';
 export 'src/definitions/thing_model.dart';
+export 'src/definitions/validation/thing_description_schema.dart'
+    show thingDescriptionSchema;
diff --git a/lib/src/core/exposed_thing.dart b/lib/src/core/exposed_thing.dart
@@ -37,7 +37,8 @@ class ExposedThing implements scripting_api.ExposedThing {
 
   /// Creates a new [ExposedThing] from a [servient] and an [exposedThingInit].
   ExposedThing(this.servient, ExposedThingInit exposedThingInit)
-      : thingDescription = ThingDescription.fromJson(exposedThingInit) {
+      : thingDescription =
+            ThingDescription.fromJson(exposedThingInit, validate: false) {
     title = thingDescription.title;
     id = thingDescription.id;
   }

diff --git a/lib/src/definitions/thing_description.dart b/lib/src/definitions/thing_description.dart
@@ -13,6 +13,7 @@ import 'interaction_affordances/action.dart';
 import 'interaction_affordances/event.dart';
 import 'interaction_affordances/property.dart';
 import 'link.dart';
+import 'validation/thing_description_schema.dart';
 import 'security/apikey_security_scheme.dart';
 import 'security/basic_security_scheme.dart';
 import 'security/bearer_security_scheme.dart';
@@ -110,7 +111,13 @@ class ThingDescription {
   }
 
   /// Creates a [ThingDescription] from a [json] object.
-  ThingDescription.fromJson(Map<String, dynamic> json) {
+  ThingDescription.fromJson(Map<String, dynamic> json, {bool validate = true}) {
+    if (validate) {
+      final validationResult = thingDescriptionSchema.validate(json);
+      if (!validationResult.isValid) {
+        throw ThingDescriptionValidationException(json);
+      }
+    }
     _parseJson(json);
   }