summaryrefslogtreecommitdiffstats
path: root/csarvalidation/src/main/java/org/onap/cvc/csar/cc/sol004/VTPValidateCSARR816745.java
blob: ec0b46f176cb6494286b02e411ab21d0c410c264 (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
/*
 * 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.cvc.csar.cc.sol004;

import org.onap.cli.fw.schema.OnapCommandSchema;
import org.onap.cvc.csar.CSARArchive;
import org.onap.cvc.csar.cc.VTPValidateCSARBase;
import org.onap.validation.yaml.YamlContentValidator;
import org.onap.validation.yaml.error.YamlDocumentValidationError;
import org.onap.validation.yaml.exception.YamlProcessingException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.yaml.snakeyaml.error.YAMLException;

import java.nio.file.Path;
import java.util.List;
import java.util.Map;
import java.util.Optional;

@OnapCommandSchema(schema = "vtp-validate-csar-r816745.yaml")
public class VTPValidateCSARR816745 extends VTPValidateCSARBase {

    private static final Logger LOGGER =  LoggerFactory.getLogger(VTPValidateCSARR816745.class);

    private static class CSARPmDictionaryValidationError extends CSARArchive.CSARError {

        CSARPmDictionaryValidationError(int documentNumber, String file, String path, String message) {
            super("0x1000");
            this.message = String.format(
                "Invalid YAML document in PM_Dictionary file. %n" +
                    "In document number %s (excluding document with schema) error occur. %n" +
                    "Path: %s%n" +
                    "%s",
                documentNumber, path, message
            );
            this.file = file;
        }

    }

    private static class CSARPmDictionaryLoadingError extends CSARArchive.CSARError {

        CSARPmDictionaryLoadingError(String file, String message) {
            super("0x2000");
            this.message = String.format(
                "Fail to load PM_Dictionary With error: %s",
                message
            );
            this.file = file;
        }

    }

    private static final String PM_DICTIONARY = "onap_pm_dictionary";
    private static final String SOURCE_ELEMENT_TAG = "Source";

    @Override
    protected void validateCSAR(CSARArchive csar) {
        Map<String, Map<String, List<String>>> nonManoFields = csar.getManifest().getNonMano();
        String rootPath = csar.getWorkspace().getPathToCsarFolder().map(Path::toString).orElse("/");
        if (nonManoFields.containsKey(PM_DICTIONARY)) {
            getLocationOfPmDictionaryFile(nonManoFields, csar.getManifestMfFile().getName()).ifPresent(pmDictionary ->
                validateYamlFile(rootPath+"/",pmDictionary)
            );
        }
    }

    private Optional<String> getLocationOfPmDictionaryFile(Map<String, Map<String, List<String>>> nonManoFields, String manifestFileName) {
        if(nonManoFields.get(PM_DICTIONARY).containsKey(SOURCE_ELEMENT_TAG)) {
            return getPathToPmDictionary(nonManoFields, SOURCE_ELEMENT_TAG);
        } else if(nonManoFields.get(PM_DICTIONARY).containsKey(SOURCE_ELEMENT_TAG.toLowerCase())) {
            return getPathToPmDictionary(nonManoFields, SOURCE_ELEMENT_TAG.toLowerCase());
        } else {
            addPmDictionaryLoadingError(manifestFileName, PM_DICTIONARY +" in manifest does not contains key 'Source'");
            return Optional.empty();
        }
    }

    private Optional<String> getPathToPmDictionary(Map<String, Map<String, List<String>>> nonManoFields, String sourceElementTag) {
        return Optional.ofNullable(nonManoFields.get(PM_DICTIONARY).get(sourceElementTag).get(0));
    }

    private void validateYamlFile(String rootPath, String artifactPath) {
        try {
            List<YamlDocumentValidationError> validationErrors =
                new YamlContentValidator().validate(rootPath+artifactPath);
            addAllErrorsReportedByVaidator(artifactPath, validationErrors);
        } catch (YamlProcessingException | YAMLException e) {
            LOGGER.error("Failed to load PM_Dictionary file.", e);
            addPmDictionaryLoadingError(artifactPath, e);
        }

    }

    private void addPmDictionaryLoadingError(String artifactPath, Exception e) {
        addPmDictionaryLoadingError(artifactPath,e.getMessage());
    }

    private void addPmDictionaryLoadingError(String artifactPath, String message) {
        errors.add(new CSARPmDictionaryLoadingError(
            artifactPath,
            message
        ));
    }

    private void addAllErrorsReportedByVaidator(String artifactPath, List<YamlDocumentValidationError> validationErrors) {
        for(YamlDocumentValidationError validationError: validationErrors) {
            addPmDictionaryValidationError(artifactPath, validationError);
        }
    }

    private void addPmDictionaryValidationError(String artifactPath, YamlDocumentValidationError validationError) {
        errors.add(new CSARPmDictionaryValidationError(
            validationError.getYamlDocumentNumber(),
            artifactPath,
            validationError.getPath(),
            validationError.getMessage()
        ));
    }

    @Override
    protected String getVnfReqsNo() {
        return "R816745";
    }

}