diff options
Diffstat (limited to 'mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation')
3 files changed, 197 insertions, 0 deletions
diff --git a/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ChartTemplateStructureValidator.java b/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ChartTemplateStructureValidator.java new file mode 100644 index 0000000..796ee91 --- /dev/null +++ b/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ChartTemplateStructureValidator.java @@ -0,0 +1,60 @@ +/* + * # ============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 java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +/** + * A class to validate structure of the base helm directory + */ +public class ChartTemplateStructureValidator { + + /** + * validates base helm chart directory and throws error if the structure is not proper. + * @param chartTemplateLocation base helm chart dir location + */ + public static void validateChartTemplateStructure(String chartTemplateLocation) { + checkBaseDirectory(chartTemplateLocation); + } + + private static void checkBaseDirectory(String chartTemplateLocation) { + Path base = Paths.get(chartTemplateLocation, "base"); + Path charts = Paths.get(chartTemplateLocation, "base/charts"); + Path templates = Paths.get(chartTemplateLocation, "base/templates"); + Path chart = Paths.get(chartTemplateLocation, "base/Chart.yaml"); + Path values = Paths.get(chartTemplateLocation, "base/values.yaml"); + if(!Files.exists(base)){ + throw new RuntimeException("base directory not found in chart template location"); + } + if(!Files.exists(charts)){ + throw new RuntimeException("charts directory not found in base directory"); + } + if(!Files.exists(templates)){ + throw new RuntimeException("templates directory not found in base directory"); + } + if(!Files.exists(chart)){ + throw new RuntimeException("chart.yaml not found in base directory"); + } + if(!Files.exists(values)){ + throw new RuntimeException("values.yaml not found in base directory"); + } + } +} diff --git a/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ComponentSpecValidator.java b/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ComponentSpecValidator.java new file mode 100644 index 0000000..dfda935 --- /dev/null +++ b/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ComponentSpecValidator.java @@ -0,0 +1,29 @@ +/* + * # ============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 java.io.IOException; + +/** + * An interface for Component specification validator + * @author Dhrumin Desai + */ +public interface ComponentSpecValidator { + void validateSpecFile(String specFileLocation, String specSchemaLocation) throws IOException; +} diff --git a/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ComponentSpecValidatorImpl.java b/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ComponentSpecValidatorImpl.java new file mode 100644 index 0000000..a74cab1 --- /dev/null +++ b/mod2/helm-generator/helmchartgenerator-core/src/main/java/org/onap/dcaegen2/platform/helmchartgenerator/validation/ComponentSpecValidatorImpl.java @@ -0,0 +1,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"); + } + } +} |