Merge "Add validation of YAML documents, with use of schema"

4 files changed, 230 insertions, 0 deletions

diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/YamlValidator.java b/csarvalidation/src/main/java/org/onap/validation/yaml/YamlValidator.java
new file mode 100644
index 0000000..17ebd1f
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/YamlValidator.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2020 Nokia
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.onap.validation.yaml;
+
+import org.onap.validation.yaml.exception.YamlProcessingException;
+import org.onap.validation.yaml.model.SchemaValidationError;
+import org.onap.validation.yaml.model.YamlDocument;
+import org.onap.validation.yaml.process.YamlValidationProcess;
+import org.onap.validation.yaml.schema.YamlSchema;
+
+import java.util.List;
+
+public class YamlValidator {
+
+    private final YamlSchema schema;
+
+    YamlValidator(YamlSchema schema) {
+        this.schema = schema;
+    }
+
+    public List<SchemaValidationError> validate(YamlDocument document) throws YamlProcessingException {
+        return new YamlValidationProcess(schema,document).validate();
+    }
+
+}
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/model/SchemaValidationError.java b/csarvalidation/src/main/java/org/onap/validation/yaml/model/SchemaValidationError.java
new file mode 100644
index 0000000..45f1647
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/model/SchemaValidationError.java
@@ -0,0 +1,36 @@
+/*
+ * Copyright 2020 Nokia
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.onap.validation.yaml.model;
+
+public class SchemaValidationError {
+    private final String path;
+    private final String message;
+
+    public String getPath() {
+        return path;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public SchemaValidationError(String path, String message) {
+        this.path = path;
+        this.message = message;
+    }
+}
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/process/YamlValidationProcess.java b/csarvalidation/src/main/java/org/onap/validation/yaml/process/YamlValidationProcess.java
new file mode 100644
index 0000000..f55b729
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/process/YamlValidationProcess.java
@@ -0,0 +1,109 @@
+/*
+ * Copyright 2020 Nokia
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.onap.validation.yaml.process;
+
+import org.onap.validation.yaml.exception.YamlProcessingException;
+import org.onap.validation.yaml.model.SchemaValidationError;
+import org.onap.validation.yaml.model.YamlDocument;
+import org.onap.validation.yaml.schema.YamlSchema;
+import org.onap.validation.yaml.schema.node.YamlSchemaNode;
+
+import java.util.ArrayList;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Queue;
+
+public class YamlValidationProcess {
+
+    private final Queue<YamlValidationStep> validationSteps;
+    private final List<SchemaValidationError> errors;
+    private final YamlSchema schema;
+    private final YamlDocument document;
+
+    public YamlValidationProcess(YamlSchema schema, YamlDocument document) {
+        this.schema = schema;
+        this.document = document;
+        errors = new ArrayList<>();
+        validationSteps = new LinkedList<>();
+    }
+
+    public List<SchemaValidationError> validate() throws YamlProcessingException {
+        validationSteps.add(new YamlValidationStep(schema.getRootNodes(), document));
+        while (!validationSteps.isEmpty()) {
+            YamlValidationStep nextValidationNode = validationSteps.poll();
+            validateStep(nextValidationNode);
+        }
+        return errors;
+    }
+
+    private void validateStep(YamlValidationStep validationNode)
+        throws YamlProcessingException {
+        for (YamlSchemaNode schemaNode : validationNode.getSchemaNodes()) {
+            validateNode(validationNode.getDocument(), schemaNode);
+        }
+    }
+
+    private void validateNode(YamlDocument document, YamlSchemaNode schemaNode)
+        throws YamlProcessingException {
+
+        if (document.containsKey(schemaNode.getName())) {
+            if (schemaNode.isContainingSubStructure()) {
+                addNextLevelNodeToValidationNodesQueue(document, schemaNode);
+            } else if (!isValueOfNodeInAcceptedValuesList(document, schemaNode)) {
+                addIncorrectValueError(document, schemaNode);
+            }
+        } else if (schemaNode.isRequired()) {
+            addRequiredKeyNotFoundError(schemaNode);
+        }
+    }
+
+    private boolean isValueOfNodeInAcceptedValuesList(YamlDocument document, YamlSchemaNode node) {
+        return node.getAcceptedValues().isEmpty() ||
+            node.getAcceptedValues().contains(document.getValue(node.getName()));
+    }
+
+    private void addNextLevelNodeToValidationNodesQueue(YamlDocument document, YamlSchemaNode node)
+        throws YamlProcessingException {
+        validationSteps.add(
+            new YamlValidationStep(
+                node.getNextNodes(),
+                document.getSubStructure(node.getName())
+            )
+        );
+    }
+
+    private void addRequiredKeyNotFoundError(YamlSchemaNode node) {
+        errors.add(
+            new SchemaValidationError(
+                node.getPath(),
+                String.format("Key not found: %s", node.getName())
+            )
+        );
+    }
+
+    private void addIncorrectValueError(YamlDocument document, YamlSchemaNode node) {
+        errors.add(
+            new SchemaValidationError(
+                node.getPath() + node.getName(),
+                String.format(
+                    "Value is not in array of accepted values.%n value:  %s%n  accepted values:  %s",
+                    document.getValue(node.getName()), node.getAcceptedValues())
+            )
+        );
+    }
+}
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/process/YamlValidationStep.java b/csarvalidation/src/main/java/org/onap/validation/yaml/process/YamlValidationStep.java
new file mode 100644
index 0000000..eb5ab8e
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/process/YamlValidationStep.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2020 Nokia
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.onap.validation.yaml.process;
+
+import org.onap.validation.yaml.model.YamlDocument;
+import org.onap.validation.yaml.schema.node.YamlSchemaNode;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+class YamlValidationStep {
+
+    private final List<YamlSchemaNode> schemaNodes;
+    private final YamlDocument document;
+
+    YamlValidationStep(List<YamlSchemaNode> nodes, YamlDocument yaml) {
+        this.schemaNodes = new ArrayList<>(nodes);
+        this.document = yaml;
+    }
+
+    List<YamlSchemaNode> getSchemaNodes() {
+        return Collections.unmodifiableList(schemaNodes);
+    }
+
+    YamlDocument getDocument() {
+        return document;
+    }
+
+}