Rewrite JSONSchemaChecker to QT (#128)

* Add files via upload * Update CMakeLists.txt * Add files via upload * Update TestConfigFile.cpp * Update TestConfigFile.cpp * Update TestConfigFile.cpp * Update QJsonFactory.h
2025-03-01 10:33:28 +00:00 · 2016-07-20 17:16:06 +02:00
parent b1d9a041d4
commit 230cf9e970
5 changed files with 721 additions and 23 deletions
--- a/include/utils/jsonschema/QJsonFactory.h
+++ b/include/utils/jsonschema/QJsonFactory.h
@@ -0,0 +1,88 @@
+#pragma once
+
+#include <iostream>
+#include <string>
+#include <stdexcept>
+#include <sstream>
+
+// JSON-Schema includes
+#include <utils/jsonschema/QJsonSchemaChecker.h>
+
+#include <QFile>
+#include <QString>
+#include <QJsonObject>
+#include <QJsonDocument>
+#include <QRegularExpression>
+
+class QJsonFactory
+{
+public:
+
+	static int load(const QString& schema, const QString& config, QJsonObject& json)
+	{
+		// Load the schema and the config trees
+		QJsonObject schemaTree = readJson(schema);
+		QJsonObject configTree = readJson(config);
+
+		// create the validator
+		QJsonSchemaChecker schemaChecker;
+		schemaChecker.setSchema(schemaTree);
+
+		bool valid = schemaChecker.validate(configTree);
+		
+		for (std::list<std::string>::const_iterator i = schemaChecker.getMessages().begin(); i != schemaChecker.getMessages().end(); ++i)
+		{
+			std::cout << *i << std::endl;
+		}
+		
+		if (!valid)
+		{
+			std::cerr << "Validation failed for configuration file: " << config.toStdString() << std::endl;
+			return -3;
+		}
+
+		json = configTree;
+		return 0;
+	}
+	
+	static QJsonObject readJson(const QString& path)
+	{
+		QFile file(path);
+		QJsonParseError error;
+		
+		if (!file.open(QIODevice::ReadOnly))
+		{
+			std::stringstream sstream;
+			sstream << "Configuration file not found: " << file.errorString().toStdString();
+			throw std::runtime_error(sstream.str());
+		}
+
+		QString config = QString(file.readAll());
+		config.remove(QRegularExpression("([^:]?\\/\\/.*)"));
+		
+		QJsonDocument doc = QJsonDocument::fromJson(config.toUtf8(), &error);
+		
+		if (error.error != QJsonParseError::NoError)
+		{
+			// report to the user the failure and their locations in the document.
+			int errorLine(0), errorColumn(0);
+			
+			for( int i=0, count=qMin( error.offset,config.size()); i<count; ++i )
+			{
+				++errorColumn;
+				if(config.at(i) == '\n' )
+				{
+					errorColumn = 0;
+					++errorLine;
+				}
+			}
+			
+			std::stringstream sstream;
+			sstream << "Failed to parse configuration: " << error.errorString().toStdString() << " at Line: " << errorLine << ", Column: " << errorColumn;
+			throw std::runtime_error(sstream.str());
+		}
+		
+		file.close();
+		return doc.object();
+	}
+};
--- a/include/utils/jsonschema/QJsonSchemaChecker.h
+++ b/include/utils/jsonschema/QJsonSchemaChecker.h
@@ -0,0 +1,190 @@
+#pragma once
+
+// stl includes
+#include <string>
+#include <list>
+
+#include <QJsonDocument>
+#include <QJsonObject>
+#include <QJsonValue>
+#include <QJsonArray>
+#include <QStringList>
+
+/// JsonSchemaChecker is a very basic implementation of json schema.
+/// The json schema definition draft can be found at
+/// http://tools.ietf.org/html/draft-zyp-json-schema-03
+///
+/// The following keywords are supported:
+/// - type
+/// - required
+/// - properties
+/// - items
+/// - enum
+/// - minimum
+/// - maximum
+/// - addtionalProperties
+/// - minItems
+/// - maxItems
+
+class QJsonSchemaChecker
+{
+public:
+	QJsonSchemaChecker();
+	virtual ~QJsonSchemaChecker();
+
+	///
+	/// @param schema The schema to use
+	/// @return true upon succes
+	///
+	bool setSchema(const QJsonObject & schema);
+	
+	///
+	/// @brief Validate a JSON structure
+	/// @param value The JSON value to check
+	/// @return true when the arguments is valid according to the schema
+	///
+	bool validate(const QJsonObject & value);
+
+	///
+	/// @return A list of error messages
+	///
+	const std::list<std::string> & getMessages() const;
+
+private:
+	///
+	/// Validates a json-value against a given schema. Results are stored in the members of this
+	/// class (_error & _messages)
+	///
+	/// @param[in] value The value to validate
+	/// @param[in] schema The schema against which the value is validated
+	///
+	void validate(const QJsonValue &value, const QJsonObject & schema);
+
+	///
+	/// Adds the given message to the message-queue (with reference to current line-number)
+	///
+	/// @param[in] message The message to add to the queue
+	///
+	void setMessage(const std::string & message);
+
+	///
+	/// Retrieves all references from the json-value as specified by the schema
+	///
+	/// @param[in] value The json-value
+	/// @param[in] schema The schema
+	///
+	void collectDependencies(const QJsonValue & value, const QJsonObject &schema);
+
+private:
+	// attribute check functions
+	///
+	/// Checks if the given value is of the specified type. If the type does not match _error is set
+	/// to true and an error-message is added to the message-queue
+	///
+	/// @param[in] value The given value
+	/// @param[in] schema The specified type (as json-value)
+	///
+	void checkType(const QJsonValue & value, const QJsonValue & schema);
+	
+	///
+	/// Checks is required properties of an json-object exist and if all properties are of the
+	/// correct format. If this is not the case _error is set to true and an error-message is added
+	/// to the message-queue.
+	///
+	/// @param[in] value The given json-object
+	/// @param[in] schema The schema of the json-object
+	///
+	void checkProperties(const QJsonObject & value, const QJsonObject & schema);
+
+	///
+	/// Verifies the additional configured properties of an json-object. If this is not the case
+	/// _error is set to true and an error-message is added to the message-queue.
+	///
+	/// @param value The given json-object
+	/// @param schema The schema for the json-object
+	/// @param ignoredProperties The properties that were ignored
+	///
+	void checkAdditionalProperties(const QJsonObject & value, const QJsonValue & schema, const QStringList & ignoredProperties);
+
+	///
+	/// Checks if references are configued and used correctly. If this is not the case _error is set
+	/// to true and an error-message is added to the message-queue.
+	///
+	/// @param value The given json-object
+	/// @param schemaLink The schema of the json-object
+	///
+	void checkDependencies(const QJsonValue & value, const QJsonValue & schemaLink);
+
+	///
+	/// Checks if the given value is larger or equal to the specified value. If this is not the case
+	/// _error is set to true and an error-message is added to the message-queue.
+	///
+	/// @param[in] value The given value
+	/// @param[in] schema The minimum value (as json-value)
+	///
+	void checkMinimum(const QJsonValue & value, const QJsonValue & schema);
+
+	///
+	/// Checks if the given value is smaller or equal to the specified value. If this is not the
+	/// case _error is set to true and an error-message is added to the message-queue.
+	///
+	/// @param[in] value The given value
+	/// @param[in] schema The maximum value (as json-value)
+	///
+	void checkMaximum(const QJsonValue & value, const QJsonValue & schema);
+
+	///
+	/// Validates all the items of an array.
+	///
+	/// @param value The json-array
+	/// @param schema The schema for the items in the array
+	///
+	void checkItems(const QJsonValue & value, const QJsonObject & schema);
+
+	///
+	/// Checks if a given array has at least a minimum number of items. If this is not the case
+	/// _error is set to true and an error-message is added to the message-queue.
+	///
+	/// @param value The json-array
+	/// @param schema The minimum size specification (as json-value)
+	///
+	void checkMinItems(const QJsonValue & value, const QJsonValue & schema);
+
+	///
+	/// Checks if a given array has at most a maximum number of items. If this is not the case
+	/// _error is set to true and an error-message is added to the message-queue.
+	///
+	/// @param value The json-array
+	/// @param schema The maximum size specification (as json-value)
+	///
+	void checkMaxItems(const QJsonValue & value, const QJsonValue & schema);
+
+	///
+	/// Checks if a given array contains only unique items. If this is not the case
+	/// _error is set to true and an error-message is added to the message-queue.
+	///
+	/// @param value The json-array
+	/// @param schema Bool to enable the check (as json-value)
+	///
+	void checkUniqueItems(const QJsonValue & value, const QJsonValue & schema);
+
+	///
+	/// Checks if an enum value is actually a valid value for that enum. If this is not the case
+	/// _error is set to true and an error-message is added to the message-queue.
+	///
+	/// @param value The enum value
+	/// @param schema The enum schema definition
+	///
+	void checkEnum(const QJsonValue & value, const QJsonValue & schema);
+
+private:
+	/// The schema of the entire json-configuration
+	QJsonObject _qSchema;
+
+	/// The current location into a json-configuration structure being checked
+	std::list<std::string> _currentPath;
+	/// The result messages collected during the schema verification
+	std::list<std::string> _messages;
+	/// Flag indicating an error occured during validation
+	bool _error;
+};