summaryrefslogtreecommitdiffstats
path: root/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ComponentSpecValidatorImpl.java
blob: a74cab1a05c4c4aefe665874748cffbf899abc78 (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
/*
 * # ============LICENSE_START=======================================================
 * # Copyright (c) 2021 AT&T Intellectual Property. All rights reserved.
 * # ================================================================================
 * # 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.
 * # ============LICENSE_END=========================================================
 */

package org.onap.dcaegen2.platform.helmchartgenerator.validation;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.FileUtils;
import org.everit.json.schema.Schema;
import org.everit.json.schema.loader.SchemaLoader;
import org.json.JSONObject;
import org.json.JSONTokener;
import org.onap.dcaegen2.platform.helmchartgenerator.Utils;
import org.onap.dcaegen2.platform.helmchartgenerator.models.componentspec.base.ComponentSpec;
import org.springframework.core.io.ClassPathResource;
import org.springframework.stereotype.Service;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;

/**
 * A class for Component specification validation.
 * @author Dhrumin Desai
 */
@Service
@Slf4j
public class ComponentSpecValidatorImpl implements ComponentSpecValidator {

    /**
     * Validates the spec json file  against schema and prints errors if found
     * @param specFileLocation specification json file location
     * @param specSchemaLocation json schema file location
     * @throws IOException
     */
    @Override
    public void validateSpecFile(String specFileLocation, String specSchemaLocation) throws IOException {
        File schemaFile = getSchemaFile(specSchemaLocation);
        ComponentSpec cs = Utils.deserializeJsonFileToModel(specFileLocation, ComponentSpec.class);
        validateSpecSchema(new File(specFileLocation), schemaFile);
        validateHelmRequirements(cs);
    }

    private File getSchemaFile(String specSchemaLocation) throws IOException {
        if(specSchemaLocation.isEmpty()){
            return defaultSchemaFile();
        }
        else{
            return new File(specSchemaLocation);
        }
    }

    private File defaultSchemaFile() throws IOException {
        File schemaFile = File.createTempFile("schema", ".json");
        InputStream inputStream = new ClassPathResource("component-spec-schema.json").getInputStream();
        FileUtils.copyInputStreamToFile(inputStream, schemaFile);
        return schemaFile;
    }

    private void validateSpecSchema(File specFile, File schemaFile) {
        try {
            JSONTokener schemaData = new JSONTokener(new FileInputStream(schemaFile));
            JSONObject jsonSchema = new JSONObject(schemaData);

            JSONTokener jsonDataFile = new JSONTokener(new FileInputStream(specFile));
            JSONObject jsonObject = new JSONObject(jsonDataFile);

            Schema schemaValidator = SchemaLoader.load(jsonSchema);
            schemaValidator.validate(jsonObject);
        } catch (FileNotFoundException e) {
            log.error(e.getMessage());
            throw new RuntimeException("Specfile or Schemafile not found.");
        }
    }

    private void validateHelmRequirements(ComponentSpec cs) {
        checkHealthCheckSection(cs);
        checkHelmSection(cs);
    }

    private void checkHealthCheckSection(ComponentSpec cs) {
        if(cs.getAuxilary().getHealthcheck().getPort() == null) {
            throw new RuntimeException("port in healthcheck section is a required field but was not found");
        }
    }

    private void checkHelmSection(ComponentSpec cs) {
        if(cs.getAuxilary().getHelm() == null){
            throw new RuntimeException("helm section in component spec is required but was not found");
        }
    }
}