summaryrefslogtreecommitdiffstats
path: root/pmdictionaryvalidation/src/main/java/org/onap/validation/yaml/process/YamlValidationProcess.java
blob: ebd37cece54e54af378f7ba931a86e09fcfcc56b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*
 * 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.error.SchemaValidationError;
import org.onap.validation.yaml.exception.YamlProcessingException;
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().containsAll(
                document.getListOfValues(node.getName()).getParameters()
            );
    }

    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(s) is/are not in array of accepted values.%n value(s):  %s%n  accepted value(s):  %s",
                    document.getValue(node.getName()), node.getAcceptedValues())
            )
        );
    }
}