From 57ce414ca81682a71288018a4d9001604002ec23 Mon Sep 17 00:00:00 2001
From: Wojtek Kosior <koszko@koszko.org>
Date: Tue, 1 Mar 2022 11:29:26 +0100
Subject: validate repository responses against JSON schemas

* compute_scripts.awk (include_file): don't enforce specific path format on #INCLUDE'd files
* .gitmodules, schemas: add Haketilo JSON schemas subrepo
* html/install.js (InstallView): import schema validator and run it against downloaded mapping and resource definitions
* html/repo_query.js (RepoEntry): import schema validator and run it against obtained query results
* test/haketilo_test/unit/test_install.py (test_install_normal_usage, test_install_dialogs): use underscore instead of hyphen in item identifiers
* test/haketilo_test/unit/test_install.py (test_install_dialogs): adapt error message test cases to new handling method of invalid JSON instanced
* test/haketilo_test/unit/test_repo_query.py (test_repo_query_normal_usage): use underscore instead of hyphen in item identifiers
* test/haketilo_test/unit/test_repo_query.py (test_repo_query_messages): use higher sample unsupported schema version to avoid having to modify the test case soon
* test/haketilo_test/world_wide_library.py: use underscore instead of hyphen in item identifiers
* common/jsonschema.js, common/jsonschema: adapt tdegrunt's jsonschema and include in Haketilo, load schema documents from schemas/
---
 common/jsonschema.js | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 common/jsonschema.js

(limited to 'common/jsonschema.js')

diff --git a/common/jsonschema.js b/common/jsonschema.js
new file mode 100644
index 0000000..cde3fca
--- /dev/null
+++ b/common/jsonschema.js
@@ -0,0 +1,83 @@
+/* SPDX-License-Identifier: MIT AND CC0-1.0
+ *
+ * License text of the original lib/index.js from jsonschema library:
+ *
+ ***************************************
+ *
+ * jsonschema is licensed under MIT license.
+ *
+ * Copyright (C) 2012-2015 Tom de Grunt <tom@degrunt.nl>
+ *
+ * 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:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ *******************************************************************************
+ *
+ * License notice for the adaptation to use in Haketilo:
+ *
+ ***************************************
+ *
+ * Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the CC0 1.0 Universal License as published by
+ * the Creative Commons Corporation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * CC0 1.0 Universal License for more details.
+ */
+
+#FROM common/jsonschema/validator.js IMPORT Validator
+#EXPORT Validator
+
+#FROM common/jsonschema/helpers.js IMPORT ValidatorResult, ValidationError, \
+                                          ValidatorResultError, SchemaError
+
+#EXPORT ValidatorResult
+#EXPORT ValidationError
+#EXPORT ValidatorResultError
+#EXPORT SchemaError
+
+#FROM common/jsonschema/scan.js IMPORT SchemaScanResult, scan
+
+#EXPORT scan
+#EXPORT SchemaScanResult
+
+function validate(instance, schema, options) {
+    var v = new Validator();
+    return v.validate(instance, schema, options);
+};
+#EXPORT validate
+
+const haketilo_schemas = [
+#INCLUDE schemas/api_query_result-1.0.1.schema.json
+    ,
+#INCLUDE schemas/api_mapping_description-1.0.1.schema.json
+    ,
+#INCLUDE schemas/api_resource_description-1.0.1.schema.json
+    ,
+#INCLUDE schemas/common_definitions-1.0.1.schema.json
+].reduce((ac, s) => Object.assign(ac, {[s.$id]: s}), {});
+#EXPORT haketilo_schemas
+
+const haketilo_validator = new Validator();
+Object.values(haketilo_schemas)
+    .forEach(s => haketilo_validator.addSchema(s, s.$id));
+#EXPORT haketilo_validator
-- 
cgit v1.2.3