summaryrefslogtreecommitdiffstats
path: root/pmdictionaryvalidation/src/test/java/org/onap/validation/yaml/YamlContentValidatorTest.java
blob: 1412085ebda78f8d0820616d71dcc0e41141898b (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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
 * 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.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.onap.validation.yaml.error.YamlDocumentValidationError;
import org.onap.validation.yaml.exception.YamlProcessingException;
import org.yaml.snakeyaml.parser.ParserException;

import java.io.IOException;
import java.util.List;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.onap.validation.yaml.YamlLoadingUtils.PATH_TO_MULTI_DOCUMENT_INVALID_YAML;
import static org.onap.validation.yaml.YamlLoadingUtils.PATH_TO_VALID_JSON_STYLE_YAML;
import static org.onap.validation.yaml.YamlLoadingUtils.PATH_TO_YAML_WITH_WRONG_VALUES;
import static org.onap.validation.yaml.YamlLoadingUtils.readFile;

class YamlContentValidatorTest {

    final YamlContentValidator yamlContentValidator = new YamlContentValidator();

    @Nested
    class FromStringPathValidator {
        @Test
        void shouldReturnCorrectErrorsWhenGivenPathToValidPmDictionaryFile() throws YamlProcessingException {
            // given
            String path = getFullPathForGivenResources(PATH_TO_YAML_WITH_WRONG_VALUES);

            // when
            List<YamlDocumentValidationError> validationErrors = new YamlContentValidator().validate(path);

            // then
            assertValidationReturnedExpectedErrors(validationErrors);
        }

        @Test
        void shouldReturnCorrectErrorsWhenGivenPathToValidJsonStylePmDictionaryFile() throws YamlProcessingException {
            // given
            String path = getFullPathForGivenResources(PATH_TO_VALID_JSON_STYLE_YAML);

            // when
            List<YamlDocumentValidationError> validationErrors = new YamlContentValidator().validate(path);

            // then
            assertValidationReturnedExpectedErrors(validationErrors);
        }

        @Test
        void shouldThrowErrorWhenGivenPathToInvalidPmDictionaryFile() {
            // given
            String path = getFullPathForGivenResources(PATH_TO_MULTI_DOCUMENT_INVALID_YAML);

            //when then
            assertThatThrownBy(() -> yamlContentValidator.validate(path))
                    .isInstanceOf(ParserException.class)
                    .hasMessageContaining("expected the node content, but found '<document end>'");
        }

        @Test
        void shouldThrowErrorWhenGivenInvalidPath() {
            // given
            String path = "invalid/path/to/pm_dictionary";

            //when then
            assertThatThrownBy(() -> yamlContentValidator.validate(path))
                    .isInstanceOf(YamlProcessingException.class)
                    .hasMessageContaining("PM_Dictionary YAML file is empty");
        }
    }

    @Nested
    class FromByteArrayValidator {
        @Test
        void shouldReturnCorrectErrorsWhenGivenPmDictionaryFileWithErrors() throws YamlProcessingException, IOException {
            // given
            byte[] yaml = readFile(PATH_TO_YAML_WITH_WRONG_VALUES);

            // when
            List<YamlDocumentValidationError> validationErrors = new YamlContentValidator().validate(yaml);

            // then
            assertValidationReturnedExpectedErrors(validationErrors);
        }

        @Test
        void shouldReturnCorrectErrorsWhenGivenValidJsonStylePmDictionary() throws YamlProcessingException, IOException {
            // given
            byte[] yaml = readFile(PATH_TO_VALID_JSON_STYLE_YAML);

            // when
            List<YamlDocumentValidationError> validationErrors = new YamlContentValidator().validate(yaml);

            // then
            assertValidationReturnedExpectedErrors(validationErrors);
        }

        @Test
        void shouldThrowErrorWhenGivenInvalidPmDictionary() throws IOException {
            // given
            byte[] yaml = readFile(PATH_TO_MULTI_DOCUMENT_INVALID_YAML);

            //when then
            assertThatThrownBy(() -> new YamlContentValidator().validate(yaml))
                    .isInstanceOf(ParserException.class)
                    .hasMessageContaining("expected the node content, but found '<document end>'");
        }

        @Test
        void shouldThrowErrorWhenGivenEmptyPmDictionary() {
            //when then
            assertThatThrownBy(() -> new YamlContentValidator().validate(new byte[0]))
                    .isInstanceOf(YamlProcessingException.class)
                    .hasMessageContaining("PM_Dictionary YAML file is empty");
        }
    }

    private void assertValidationReturnedExpectedErrors(List<YamlDocumentValidationError> validationErrors) {
        assertThat(validationErrors)
                .isNotNull()
                .hasSize(4)
                .usingRecursiveFieldByFieldElementComparator()
                .containsAll(
                        List.of(
                                new YamlDocumentValidationError(1,
                                        "/pmMetaData/pmFields/measResultType",
                                        "Value(s) is/are not in array of accepted values.\n" +
                                                " value(s):  integer\n" +
                                                "  accepted value(s):  [float, uint32, uint64]"),
                                new YamlDocumentValidationError(1,
                                        "/pmMetaData/pmFields/",
                                        "Key not found: measChangeType"),
                                new YamlDocumentValidationError(2,
                                        "/pmMetaData/pmFields/",
                                        "Key not found: measChangeType"),
                                new YamlDocumentValidationError(3,
                                        "/pmMetaData/pmFields/measAdditionalFields/vendorField1",
                                        "Value(s) is/are not in array of accepted values.\n" +
                                                " value(s):  [Z, A]\n" +
                                                "  accepted value(s):  [X, Y, Z]")
                        )
                );
    }

    private String getFullPathForGivenResources(String pathToValidYaml) {
        return this.getClass().getClassLoader().getResource(pathToValidYaml).getPath();
    }
}