gerrit.onap Code Review - policy/drools-applications.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * policy-yaml
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.guard.compiler;
  22
  23
  24 import java.io.InputStream;
  25 import java.util.HashSet;
  26 import java.util.List;
  27 import java.util.Set;
  28
  29 import org.onap.policy.controlloop.compiler.CompilerException;
  30 import org.onap.policy.controlloop.compiler.ControlLoopCompilerCallback;
  31 import org.onap.policy.controlloop.policy.guard.Constraint;
  32 import org.onap.policy.controlloop.policy.guard.ControlLoopGuard;
  33 import org.onap.policy.controlloop.policy.guard.GuardPolicy;
  34 import org.yaml.snakeyaml.Yaml;
  35 import org.yaml.snakeyaml.constructor.Constructor;
  36
  37 public class ControlLoopGuardCompiler {
  38
  39     private static final String GUARD_POLICIES_SHOULD_NOT_BE_NULL = "Guard policies should not be null";
  40         private static final String GUARD_POLICY = "Guard policy ";
  41
  42         private ControlLoopGuardCompiler(){
  43         // Private Constructor
  44     }
  45
  46     public static ControlLoopGuard compile(ControlLoopGuard cLGuard, ControlLoopCompilerCallback callback) throws CompilerException {
  47         //
  48         // Ensure ControlLoopGuard has at least one guard policies
  49         //
  50         validateControlLoopGuard(cLGuard, callback);
  51         //
  52         // Ensure each guard policy has at least one constraints and all guard policies are unique
  53         //
  54         validateGuardPolicies(cLGuard.getGuards(), callback);
  55         //
  56         // Ensure constraints for each guard policy are unique
  57         //
  58         validateConstraints(cLGuard.getGuards(), callback);
  59
  60         return cLGuard;
  61     }
  62
  63     public static ControlLoopGuard  compile(InputStream yamlSpecification, ControlLoopCompilerCallback callback) throws CompilerException {
  64         Yaml yaml = new Yaml(new Constructor(ControlLoopGuard.class));
  65         Object obj = yaml.load(yamlSpecification);
  66         if (obj == null) {
  67             throw new CompilerException("Could not parse yaml specification.");
  68         }
  69         if (! (obj instanceof ControlLoopGuard)) {
  70             throw new CompilerException("Yaml could not parse specification into required ControlLoopGuard object");
  71         }
  72         return ControlLoopGuardCompiler.compile((ControlLoopGuard) obj, callback);
  73     }
  74
  75     private static void validateControlLoopGuard(ControlLoopGuard cLGuard, ControlLoopCompilerCallback callback) throws CompilerException {
  76         if (cLGuard == null) {
  77             if (callback != null) {
  78                 callback.onError("ControlLoop Guard cannot be null");
  79             }
  80             throw new CompilerException("ControlLoop Guard cannot be null");
  81         }
  82         if (cLGuard.getGuard() == null && callback != null) {
  83             callback.onError("Guard version cannot be null");
  84         }
  85         if (cLGuard.getGuards() == null) {
  86             if (callback != null) {
  87                 callback.onError("ControlLoop Guard should have at least one guard policies");
  88             }
  89         } else if (cLGuard.getGuards().isEmpty() && callback != null) {
  90             callback.onError("ControlLoop Guard should have at least one guard policies");
  91         }
  92     }
  93
  94     private static void validateGuardPolicies(List<GuardPolicy> policies, ControlLoopCompilerCallback callback) throws CompilerException {
  95         if (policies == null) {
  96             if (callback != null) {
  97                 callback.onError(GUARD_POLICIES_SHOULD_NOT_BE_NULL);
  98             }
  99             throw new CompilerException(GUARD_POLICIES_SHOULD_NOT_BE_NULL);
 100         }
 101         //
 102         // Ensure all guard policies are unique
 103         //
 104         Set<GuardPolicy> newSet = new HashSet<>(policies);
 105         if (newSet.size() != policies.size() && callback != null) {
 106             callback.onWarning("There are duplicate guard policies");
 107         }
 108         //
 109         // Ensure each guard policy has at least one constraints
 110         //
 111         for (GuardPolicy policy : policies) {
 112             if (policy.getLimit_constraints() == null || policy.getLimit_constraints().isEmpty()) {
 113                 if (callback != null) {
 114                     callback.onError(GUARD_POLICY + policy.getName() + " does not have any limit constraint");
 115                 }
 116                 throw new CompilerException(GUARD_POLICY + policy.getName() + " does not have any limit constraint");
 117             }
 118         }
 119     }
 120
 121     private static void validateConstraints(List<GuardPolicy> policies, ControlLoopCompilerCallback callback) throws CompilerException {
 122         if (policies == null) {
 123             if (callback != null) {
 124                 callback.onError(GUARD_POLICIES_SHOULD_NOT_BE_NULL);
 125             }
 126             throw new CompilerException(GUARD_POLICIES_SHOULD_NOT_BE_NULL);
 127         }
 128         for (GuardPolicy policy : policies) {
 129             Set<Constraint> newSet = new HashSet<>(policy.getLimit_constraints());
 130             if (newSet.size() != policy.getLimit_constraints().size() && callback != null) {
 131                 callback.onWarning(GUARD_POLICY + policy.getName() + " has duplicate limit constraints");
 132             }
 133         }
 134     }
 135
 136 }