summaryrefslogtreecommitdiffstats
path: root/csarvalidation/src/main/java/org/onap/cvc/csar/cc/sol004/VTPValidateCSARR01123.java
blob: a7c57370fa5b1e7fbb10b4771a1f415e64586dfb (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
/*
 * Copyright 2017 Huawei Technologies Co., Ltd.
 * Modified 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.CSARArchive.CSARErrorEntryMissing;
import org.onap.cvc.csar.cc.VTPValidateCSARBase;
import org.onap.cvc.csar.parser.SourcesParser;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;

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

    public static class CSARErrorEntryVNFProviderDetailsNotFound extends CSARErrorEntryMissing {
        public CSARErrorEntryVNFProviderDetailsNotFound() {
            super("VNF Vendor details",
                CSARArchive.TOSCA_METADATA + " or " + CSARArchive.TOSCA_METADATA_TOSCA_META_ENTRY_DEFINITIONS + " file");
            this.setCode("0x1000");
        }
    }

    public static class CSARErrorNotAllFilesLocatedInCSARWhereListedInManifest extends CSARErrorEntryMissing {
        CSARErrorNotAllFilesLocatedInCSARWhereListedInManifest(List<String> fileInCsarThatAreNotLocatedInManifest) {
            super("Source",
                CSARArchive.TOSCA_METADATA);
            this.setCode("0x1001");
            this.message = "file(s): ["
                + String.join(", ", fileInCsarThatAreNotLocatedInManifest)
                + "] available in CSAR, but cannot be found in Manifest as Source";
        }
    }

    public static class CSARErrorNotAllFilesLocatedInManifestWhereListedInCsar extends CSARErrorEntryMissing {
        CSARErrorNotAllFilesLocatedInManifestWhereListedInCsar(List<String> fileInCsarThatAreNotLocatedInManifest) {
            super("Source",
                    CSARArchive.TOSCA_METADATA);
            this.setCode("0x1002");
            this.message = "file(s): ["
                    + String.join(", ", fileInCsarThatAreNotLocatedInManifest)
                    + "] defined in Manifest as Source, but cannot be found in CSAR";
        }
    }

    @Override
    protected void validateCSAR(CSARArchive csar) throws Exception {
        verifyThatProviderDataAreDefined(csar);
        verifyPackageFileStructure(csar);
    }

    private void verifyPackageFileStructure(CSARArchive csar) throws IOException {
        Path rootFolder = getRootFolder(csar);
        List<String> filesInCsar = getAllFilesInDirectory(rootFolder);
        List<String> sourcesInManifest = getAllFilesFromManifestSources(csar.getManifest());

        if (areAllFilesDefinedInManifest(filesInCsar, sourcesInManifest)) {
            verifyThatAllFilesFromCsarAreDefinedInManifest(filesInCsar, sourcesInManifest);
            verifyThatAllFilesDefinedInManifestAreAvailableInCsar(sourcesInManifest, filesInCsar);
        }
    }

    private void verifyThatProviderDataAreDefined(CSARArchive csar) {
        if (csar.getVendorName() == null ||
            csar.getVersion() == null) {
            errors.add(new CSARErrorEntryVNFProviderDetailsNotFound());
        }
    }

    private Path getRootFolder(CSARArchive csar) throws IOException {
        return csar.getWorkspace().getPathToCsarFolder()
                .orElseThrow(() -> new IOException("Couldn't find CSAR root catalog"));
    }


    private void verifyThatAllFilesDefinedInManifestAreAvailableInCsar(List<String> sourcesInManifest, List<String> filesInCsar) {
        if(!filesInCsar.containsAll(sourcesInManifest)){
            List<String> sourcesNotAvailableInCsarFile = fetchElementsNotAvailableAtSecondList(sourcesInManifest, filesInCsar);
            errors.add(new CSARErrorNotAllFilesLocatedInManifestWhereListedInCsar(sourcesNotAvailableInCsarFile));
        }
    }

    private void verifyThatAllFilesFromCsarAreDefinedInManifest(List<String> filesInCsar, List<String> sourcesInManifest) {
        if(!sourcesInManifest.containsAll(filesInCsar) ){
            List<String> filesNotDefinedInManifestFile = fetchElementsNotAvailableAtSecondList(filesInCsar, sourcesInManifest);
            errors.add(new CSARErrorNotAllFilesLocatedInCSARWhereListedInManifest(filesNotDefinedInManifestFile));
        }
    }

    private List<String> fetchElementsNotAvailableAtSecondList(List<String> firstList, List<String> secondList) {
        List<String> copyOfFirstList = new ArrayList<>(firstList);
        copyOfFirstList.removeAll(secondList);
        return copyOfFirstList;
    }

    private boolean areAllFilesDefinedInManifest(List<String> filesInCsar, List<String> sourcesInManifest) {
        return filesInCsar.size() != sourcesInManifest.size();
    }

    private List<String> getAllFilesFromManifestSources(CSARArchive.Manifest manifest) {
        return manifest.getSources()
            .stream()
            .map(SourcesParser.Source::getValue)
            .filter(filterOutManifestFile())
            .collect(Collectors.toList());
    }

    private List<String> getAllFilesInDirectory(Path rootPath) throws IOException {
        try (Stream<Path> paths = Files.walk(rootPath, Integer.MAX_VALUE)) {
            return paths
                .filter(filterOutDirectories())
                .map(rootPath::relativize)
                .map(String::valueOf)
                .filter(filterOutManifestFile())
                .collect(Collectors.toList());
        }
    }

    private Predicate<Path> filterOutDirectories() {
        return path -> !Files.isDirectory(path);
    }


    private Predicate<String> filterOutManifestFile() {
        return path -> !path.endsWith(".mf");
    }

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


}