/*- * ============LICENSE_START======================================================= * ONAP Policy Engine * ================================================================================ * Copyright (C) 2017 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.policy.controlloop.guard.compiler; import java.io.InputStream; import java.util.HashSet; import java.util.List; import java.util.Set; import org.onap.policy.controlloop.compiler.CompilerException; import org.onap.policy.controlloop.compiler.ControlLoopCompilerCallback; import org.onap.policy.controlloop.policy.guard.Constraint; import org.onap.policy.controlloop.policy.guard.ControlLoopGuard; import org.onap.policy.controlloop.policy.guard.GuardPolicy; import org.yaml.snakeyaml.Yaml; import org.yaml.snakeyaml.constructor.Constructor; public class ControlLoopGuardCompiler { private ControlLoopGuardCompiler(){ // Private Constructor } public static ControlLoopGuard compile(ControlLoopGuard cLGuard, ControlLoopCompilerCallback callback) throws CompilerException { // // Ensure ControlLoopGuard has at least one guard policies // validateControlLoopGuard(cLGuard, callback); // // Ensure each guard policy has at least one constraints and all guard policies are unique // validateGuardPolicies(cLGuard.getGuards(), callback); // // Ensure constraints for each guard policy are unique // validateConstraints(cLGuard.getGuards(), callback); return cLGuard; } public static ControlLoopGuard compile(InputStream yamlSpecification, ControlLoopCompilerCallback callback) throws CompilerException { Yaml yaml = new Yaml(new Constructor(ControlLoopGuard.class)); Object obj = yaml.load(yamlSpecification); if (obj == null) { throw new CompilerException("Could not parse yaml specification."); } if (! (obj instanceof ControlLoopGuard)) { throw new CompilerException("Yaml could not parse specification into required ControlLoopGuard object"); } return ControlLoopGuardCompiler.compile((ControlLoopGuard) obj, callback); } private static void validateControlLoopGuard(ControlLoopGuard cLGuard, ControlLoopCompilerCallback callback) throws CompilerException { if (cLGuard == null) { if (callback != null) { callback.onError("ControlLoop Guard cannot be null"); } throw new CompilerException("ControlLoop Guard cannot be null"); } if (cLGuard.getGuard() == null && callback != null) { callback.onError("Guard version cannot be null"); } if (cLGuard.getGuards() == null) { if (callback != null) { callback.onError("ControlLoop Guard should have at least one guard policies"); } } else if (cLGuard.getGuards().isEmpty() && callback != null) { callback.onError("ControlLoop Guard should have at least one guard policies"); } } private static void validateGuardPolicies(List policies, ControlLoopCompilerCallback callback) throws CompilerException { if (policies == null) { if (callback != null) { callback.onError("Guard policies should not be null"); } throw new CompilerException("Guard policies should not be null"); } // // Ensure all guard policies are unique // Set newSet = new HashSet<>(policies); if (newSet.size() != policies.size() && callback != null) { callback.onWarning("There are duplicate guard policies"); } // // Ensure each guard policy has at least one constraints // for (GuardPolicy policy : policies) { if (policy.getLimit_constraints() == null || policy.getLimit_constraints().isEmpty()) { if (callback != null) { callback.onError("Guard policy " + policy.getName() + " does not have any limit constraint"); } throw new CompilerException("Guard policy " + policy.getName() + " does not have any limit constraint"); } } } private static void validateConstraints(List policies, ControlLoopCompilerCallback callback) throws CompilerException { if (policies == null) { if (callback != null) { callback.onError("Guard policies should not be null"); } throw new CompilerException("Guard policies should not be null"); } for (GuardPolicy policy : policies) { Set newSet = new HashSet<>(policy.getLimit_constraints()); if (newSet.size() != policy.getLimit_constraints().size() && callback != null) { callback.onWarning("Guard policy " + policy.getName() + " has duplicate limit constraints"); } } } }