Merge "Convert yaml schema into tree structure"

9 files changed, 417 insertions, 4 deletions

diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/exception/YamlProcessingException.java b/csarvalidation/src/main/java/org/onap/validation/yaml/exception/YamlProcessingException.java
new file mode 100644
index 0000000..edfdbb8
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/exception/YamlProcessingException.java
@@ -0,0 +1,29 @@
+/*
+ * 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.exception;
+
+public class YamlProcessingException extends Exception {
+
+    public YamlProcessingException(String message, Throwable throwable) {
+        super(message, throwable);
+    }
+
+    public YamlProcessingException(Throwable throwable) {
+        super(throwable);
+    }
+}
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/model/YamlDocumentFactory.java b/csarvalidation/src/main/java/org/onap/validation/yaml/model/YamlDocumentFactory.java
index 1cda34b..16d94a2 100644
--- a/csarvalidation/src/main/java/org/onap/validation/yaml/model/YamlDocumentFactory.java
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/model/YamlDocumentFactory.java
@@ -17,6 +17,8 @@
 
 package org.onap.validation.yaml.model;
 
+import org.onap.validation.yaml.exception.YamlProcessingException;
+
 import java.util.HashMap;
 import java.util.Map;
 
@@ -41,8 +43,7 @@ public class YamlDocumentFactory {
         return parsedYaml;
     }
 
-    public static class YamlDocumentParsingException extends Exception {
-
+    public static class YamlDocumentParsingException extends YamlProcessingException {
         YamlDocumentParsingException(String message, Throwable throwable) {
             super(message, throwable);
         }
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/model/YamlParameterListFactory.java b/csarvalidation/src/main/java/org/onap/validation/yaml/model/YamlParameterListFactory.java
index b85ec7c..4ea5ca2 100644
--- a/csarvalidation/src/main/java/org/onap/validation/yaml/model/YamlParameterListFactory.java
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/model/YamlParameterListFactory.java
@@ -17,6 +17,8 @@
 
 package org.onap.validation.yaml.model;
 
+import org.onap.validation.yaml.exception.YamlProcessingException;
+
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -51,8 +53,7 @@ public class YamlParameterListFactory {
     }
 
 
-    public static class YamlParameterListParsingException extends Exception {
-
+    public static class YamlParameterListParsingException extends YamlProcessingException {
         YamlParameterListParsingException(String message, Throwable throwable) {
             super(message, throwable);
         }
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/schema/YamlSchema.java b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/YamlSchema.java
new file mode 100644
index 0000000..19e6af8
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/YamlSchema.java
@@ -0,0 +1,38 @@
+/*
+ * 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.schema;
+
+import org.onap.validation.yaml.schema.node.YamlSchemaNode;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class YamlSchema {
+
+    private final List<YamlSchemaNode> rootNodes;
+
+    public List<YamlSchemaNode> getRootNodes() {
+        return Collections.unmodifiableList(rootNodes);
+    }
+
+    YamlSchema(List<YamlSchemaNode> rootNodes) {
+        this.rootNodes = new ArrayList<>(rootNodes);
+    }
+}
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/schema/YamlSchemaFactory.java b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/YamlSchemaFactory.java
new file mode 100644
index 0000000..df7d673
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/YamlSchemaFactory.java
@@ -0,0 +1,59 @@
+/*
+ * 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.schema;
+
+import org.onap.validation.yaml.exception.YamlProcessingException;
+import org.onap.validation.yaml.model.YamlDocument;
+import org.onap.validation.yaml.model.YamlDocumentFactory;
+import org.onap.validation.yaml.schema.node.YamlSchemaNode;
+import org.onap.validation.yaml.schema.node.YamlSchemaNodeFactory;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class YamlSchemaFactory {
+
+
+    private static final String ROOT_PATH = "/";
+
+    public YamlSchema createTreeStructuredYamlSchema(YamlDocument schema)
+        throws YamlProcessingException {
+
+        return new YamlSchema(getRootNodes(schema));
+    }
+
+    private List<YamlSchemaNode> getRootNodes(YamlDocument yamlDocument)
+        throws YamlProcessingException {
+
+        List<YamlSchemaNode> nextNodes = new ArrayList<>();
+        for(String nodeName: yamlDocument.getYaml().keySet()) {
+            nextNodes.add(
+                new YamlSchemaNodeFactory().createNode(
+                    nodeName,
+                    ROOT_PATH,
+                    new YamlDocumentFactory().createYamlDocument(
+                        yamlDocument.getYaml().get(nodeName)
+                    )
+                )
+            );
+        }
+        return nextNodes;
+    }
+
+}
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaBranchNode.java b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaBranchNode.java
new file mode 100644
index 0000000..8ff3569
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaBranchNode.java
@@ -0,0 +1,83 @@
+/*
+ * 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.schema.node;
+
+import org.onap.validation.yaml.exception.YamlProcessingException;
+import org.onap.validation.yaml.model.YamlDocument;
+import org.onap.validation.yaml.model.YamlDocumentFactory;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+
+import static org.onap.validation.yaml.model.YamlDocumentFactory.YamlDocumentParsingException;
+import static org.onap.validation.yaml.model.YamlParameterListFactory.YamlParameterListParsingException;
+
+public class YamlSchemaBranchNode extends YamlSchemaNode {
+
+    private final YamlDocument nextNodesInLazyForm;
+    private Optional<List<YamlSchemaNode>> nextNodes;
+
+    YamlSchemaBranchNode(String name, String path, boolean required, String comment,
+                         YamlDocument nextNodesInLazyForm) {
+        super(name, path, required, comment);
+        this.nextNodesInLazyForm = nextNodesInLazyForm;
+        this.nextNodes = Optional.empty();
+    }
+
+    @Override
+    public boolean isContainingSubStructure() {
+        return true;
+    }
+
+    @Override
+    public List<String> getAcceptedValues() {
+        return Collections.emptyList();
+    }
+
+    @Override
+    public synchronized List<YamlSchemaNode> getNextNodes() throws YamlSchemaProcessingException {
+        try {
+            return nextNodes.orElseGet(this::loadNextNodes);
+        } catch (YamlSchemaLazyLoadingException lazyLoadingException) {
+            throw new YamlSchemaProcessingException(lazyLoadingException);
+        }
+    }
+
+    private List<YamlSchemaNode> loadNextNodes() {
+        try {
+            List<YamlSchemaNode> loadedNextNodes = new ArrayList<>();
+            for (String key : nextNodesInLazyForm.getYaml().keySet()) {
+                YamlDocument substructure = new YamlDocumentFactory()
+                    .createYamlDocument(nextNodesInLazyForm.getYaml().get(key));
+                loadedNextNodes.add(new YamlSchemaNodeFactory().createNode(key, getPath() + getName() + "/", substructure));
+            }
+            nextNodes = Optional.of(loadedNextNodes);
+            return loadedNextNodes;
+        } catch (YamlProcessingException e) {
+            throw new YamlSchemaLazyLoadingException("Lazy loading failed, due to yaml parsing exception.",e);
+        }
+    }
+
+    static class YamlSchemaLazyLoadingException extends RuntimeException {
+        YamlSchemaLazyLoadingException(String message, Throwable throwable) {
+            super(message, throwable);
+        }
+    }
+}
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaLeafNode.java b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaLeafNode.java
new file mode 100644
index 0000000..73470d4
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaLeafNode.java
@@ -0,0 +1,50 @@
+/*
+ * 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.schema.node;
+
+import org.onap.validation.yaml.model.YamlParametersList;
+
+import java.util.Collections;
+import java.util.List;
+
+public class YamlSchemaLeafNode extends YamlSchemaNode {
+
+    private YamlParametersList acceptedValues;
+
+    YamlSchemaLeafNode(String name, String path, boolean required, String comment,
+                       YamlParametersList acceptedValues) {
+        super(name, path, required, comment);
+        this.acceptedValues = acceptedValues;
+    }
+
+    @Override
+    public List<String> getAcceptedValues() {
+        return acceptedValues.getParameters();
+    }
+
+    @Override
+    public List<YamlSchemaNode> getNextNodes() {
+        return Collections.emptyList();
+    }
+
+    @Override
+    public boolean isContainingSubStructure() {
+        return false;
+    }
+
+}
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaNode.java b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaNode.java
new file mode 100644
index 0000000..28913a2
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaNode.java
@@ -0,0 +1,66 @@
+/*
+ * 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.schema.node;
+
+import org.onap.validation.yaml.exception.YamlProcessingException;
+
+import java.util.List;
+
+public abstract class YamlSchemaNode {
+
+    private final String path;
+    private final String name;
+    private final boolean required;
+    private final String comment;
+
+
+    public String getName() {
+        return name;
+    }
+
+    public String getPath() {
+        return path;
+    }
+
+    public boolean isRequired() {
+        return required;
+    }
+
+    public abstract List<String> getAcceptedValues();
+
+    public abstract List<YamlSchemaNode> getNextNodes() throws YamlSchemaProcessingException;
+
+    public abstract boolean isContainingSubStructure();
+
+    public String getComment() {
+        return comment;
+    }
+
+    YamlSchemaNode(String name, String path, boolean required, String comment) {
+        this.name = name;
+        this.path = path;
+        this.required = required;
+        this.comment = comment;
+    }
+
+    static class YamlSchemaProcessingException extends YamlProcessingException {
+        YamlSchemaProcessingException(Throwable throwable) {
+            super(throwable);
+        }
+    }
+}
diff --git a/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaNodeFactory.java b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaNodeFactory.java
new file mode 100644
index 0000000..a07935a
--- /dev/null
+++ b/csarvalidation/src/main/java/org/onap/validation/yaml/schema/node/YamlSchemaNodeFactory.java
@@ -0,0 +1,86 @@
+/*
+ * 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.schema.node;
+
+import org.onap.validation.yaml.exception.YamlProcessingException;
+import org.onap.validation.yaml.model.YamlDocument;
+import org.onap.validation.yaml.model.YamlDocumentFactory;
+import org.onap.validation.yaml.model.YamlParameterListFactory;
+import org.onap.validation.yaml.model.YamlParametersList;
+
+import static org.onap.validation.yaml.model.YamlDocumentFactory.YamlDocumentParsingException;
+import static org.onap.validation.yaml.model.YamlParameterListFactory.YamlParameterListParsingException;
+
+public class YamlSchemaNodeFactory {
+
+    public static final String EMPTY_COMMENT = "no comment available";
+    static final String STRUCTURE_KEY = "structure";
+    static final String COMMENT_KEY = "comment";
+    static final String VALUE_KET = "value";
+    static final String PRESENCE_KEY = "presence";
+    static final String PRESENCE_REQUIRED_KEY = "required";
+
+    public YamlSchemaNode createNode(String nodeName, String path, YamlDocument yamlDocument)
+        throws YamlProcessingException {
+
+        YamlSchemaNode yamlSchemaNode;
+        if(isYamlContainingKey(yamlDocument, STRUCTURE_KEY)) {
+            yamlSchemaNode = new YamlSchemaBranchNode(
+                nodeName, path, getIsPresenceRequired(yamlDocument), getComment(yamlDocument),
+                getNextNodes(yamlDocument)
+            );
+        } else {
+            yamlSchemaNode = new YamlSchemaLeafNode(
+                nodeName, path, getIsPresenceRequired(yamlDocument), getComment(yamlDocument),
+                getAcceptedValues(yamlDocument)
+            );
+        }
+        return  yamlSchemaNode;
+    }
+
+    private YamlDocument getNextNodes(YamlDocument yamlDocument)
+        throws YamlDocumentParsingException {
+        return new YamlDocumentFactory().createYamlDocument(yamlDocument.getYaml().get(STRUCTURE_KEY));
+    }
+
+    private String getComment(YamlDocument yamlDocument) {
+
+        return isYamlContainingKey(yamlDocument, COMMENT_KEY)
+            ? yamlDocument.getYaml().get(COMMENT_KEY).toString()
+            : EMPTY_COMMENT;
+    }
+
+    private YamlParametersList getAcceptedValues(YamlDocument yamlDocument)
+        throws YamlParameterListParsingException {
+
+        return isYamlContainingKey(yamlDocument, VALUE_KET)
+            ? new YamlParameterListFactory().createYamlParameterList(yamlDocument.getYaml().get(VALUE_KET))
+            : new YamlParameterListFactory().createEmptyYamlParameterList();
+    }
+
+    private boolean getIsPresenceRequired(YamlDocument yamlDocument) {
+
+        return isYamlContainingKey(yamlDocument, PRESENCE_KEY)
+            && yamlDocument.getYaml().get(PRESENCE_KEY).equals(PRESENCE_REQUIRED_KEY);
+    }
+
+    private boolean isYamlContainingKey(YamlDocument yamlDocument, String structureKey) {
+        return yamlDocument.getYaml().containsKey(structureKey);
+    }
+
+}