/*- * ============LICENSE_START======================================================= * ECOMP 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.openecomp.policy.controlloop.compiler; import java.io.InputStream; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import org.jgrapht.DirectedGraph; import org.jgrapht.graph.ClassBasedEdgeFactory; import org.jgrapht.graph.DefaultEdge; import org.jgrapht.graph.DirectedMultigraph; import org.openecomp.policy.controlloop.policy.ControlLoop; import org.openecomp.policy.controlloop.policy.ControlLoopPolicy; import org.openecomp.policy.controlloop.policy.FinalResult; import org.openecomp.policy.controlloop.policy.Policy; import org.openecomp.policy.controlloop.policy.PolicyResult; import org.openecomp.policy.controlloop.policy.TargetType; import org.yaml.snakeyaml.Yaml; import org.yaml.snakeyaml.constructor.Constructor; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMap; public class ControlLoopCompiler { public static ControlLoopPolicy compile(ControlLoopPolicy policy, ControlLoopCompilerCallback callback) throws CompilerException { // // Ensure the control loop is sane // validateControlLoop(policy.controlLoop, callback); // // Validate the policies // validatePolicies(policy, callback); return policy; } public static ControlLoopPolicy compile(InputStream yamlSpecification, ControlLoopCompilerCallback callback) throws CompilerException { Yaml yaml = new Yaml(new Constructor(ControlLoopPolicy.class)); Object obj = yaml.load(yamlSpecification); if (obj == null) { throw new CompilerException("Could not parse yaml specification."); } if (! (obj instanceof ControlLoopPolicy)) { throw new CompilerException("Yaml could not parse specification into required ControlLoopPolicy object"); } return ControlLoopCompiler.compile((ControlLoopPolicy) obj, callback); } private static void validateControlLoop(ControlLoop controlLoop, ControlLoopCompilerCallback callback) throws CompilerException { if (controlLoop == null) { if (callback != null) { callback.onError("controlLoop cannot be null"); } } if (controlLoop.controlLoopName == null | controlLoop.controlLoopName.length() < 1) { if (callback != null) { callback.onError("Missing controlLoopName"); } } if (! controlLoop.version.contentEquals(ControlLoop.VERSION)) { if (callback != null) { callback.onError("Unsupported version for this compiler"); } } if (controlLoop.trigger_policy == null || controlLoop.trigger_policy.length() < 1) { throw new CompilerException("trigger_policy is not valid"); } // } private static void validatePolicies(ControlLoopPolicy policy, ControlLoopCompilerCallback callback) throws CompilerException { if (policy == null) { throw new CompilerException("policy cannot be null"); } // // verify controlLoop overall timeout should be no less than the sum of operational policy timeouts // if (policy.policies == null) { callback.onWarning("controlLoop is an open loop."); } else{ int sum = 0; for (Policy operPolicy : policy.policies) { sum += operPolicy.timeout.intValue(); } if (policy.controlLoop.timeout.intValue() < sum) { if (callback != null) { callback.onError("controlLoop overall timeout is less than the sum of operational policy timeouts."); } } // // For this version we can use a directed multigraph, in the future we may not be able to // DirectedGraph graph = new DirectedMultigraph(new ClassBasedEdgeFactory(LabeledEdge.class)); // // Check to see if the trigger Event is for OpenLoop, we do so by // attempting to create a FinalResult object from it. If its a policy id, this should // return null. // FinalResult triggerResult = FinalResult.toResult(policy.controlLoop.trigger_policy); TriggerNodeWrapper triggerNode; // // Did this turn into a FinalResult object? // if (triggerResult != null) { // // Ensure they didn't use some other FinalResult code // if (triggerResult != FinalResult.FINAL_OPENLOOP) { throw new CompilerException("Unexpected Final Result for trigger_policy, should only be " + FinalResult.FINAL_OPENLOOP.toString() + " or a valid Policy ID"); } // // They really shouldn't have any policies attached. // if (policy.policies != null || policy.policies.size() > 0) { if (callback != null) { callback.onWarning("Open Loop policy contains policies. The policies will never be invoked."); } } return; // } else { // // Ok, not a FinalResult object so let's assume that it is a Policy. Which it should be. // triggerNode = new TriggerNodeWrapper(policy.controlLoop.controlLoopName); } // // Add in the trigger node // graph.addVertex(triggerNode); // // Add in our Final Result nodes. All paths should end to these nodes. // FinalResultNodeWrapper finalSuccess = new FinalResultNodeWrapper(FinalResult.FINAL_SUCCESS); FinalResultNodeWrapper finalFailure = new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE); FinalResultNodeWrapper finalFailureTimeout = new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE_TIMEOUT); FinalResultNodeWrapper finalFailureRetries = new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE_RETRIES); FinalResultNodeWrapper finalFailureException = new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE_EXCEPTION); FinalResultNodeWrapper finalFailureGuard = new FinalResultNodeWrapper(FinalResult.FINAL_FAILURE_GUARD); graph.addVertex(finalSuccess); graph.addVertex(finalFailure); graph.addVertex(finalFailureTimeout); graph.addVertex(finalFailureRetries); graph.addVertex(finalFailureException); graph.addVertex(finalFailureGuard); // // Work through the policies and add them in as nodes. // Map mapNodes = new HashMap(); for (Policy operPolicy : policy.policies) { // // Check the policy id and make sure its sane // boolean okToAdd = true; if (operPolicy.id == null || operPolicy.id.length() < 1) { if (callback != null) { callback.onError("Operational Policy has an bad ID"); } okToAdd = false; } // // Check if they decided to make the ID a result object // if (PolicyResult.toResult(operPolicy.id) != null) { if (callback != null) { callback.onError("Policy id is set to a PolicyResult " + operPolicy.id); } okToAdd = false; } if (FinalResult.toResult(operPolicy.id) != null) { if (callback != null) { callback.onError("Policy id is set to a FinalResult " + operPolicy.id); } okToAdd = false; } // // Check that the actor/recipe/target are valid // if (operPolicy.actor == null) { if (callback != null) { callback.onError("Policy actor is null"); } okToAdd = false; } // // Construct a list for all valid actors // ImmutableList actors = ImmutableList.of("APPC", "AOTS", "MSO", "SDNO", "SDNR", "AAI"); // if (operPolicy.actor != null && (!actors.contains(operPolicy.actor)) ) { if (callback != null) { callback.onError("Policy actor is invalid"); } okToAdd = false; } if (operPolicy.recipe == null) { if (callback != null) { callback.onError("Policy recipe is null"); } okToAdd = false; } // // TODO: // NOTE: We need a way to find the acceptable recipe values (either Enum or a database that has these) // ImmutableMap> recipes = new ImmutableMap.Builder>() .put("APPC", ImmutableList.of("Restart", "Rebuild", "Migrate", "ModifyConfig")) .put("AOTS", ImmutableList.of("checkMaintenanceWindow", "checkENodeBTicketHours", "checkEquipmentStatus", "checkEimStatus", "checkEquipmentMaintenance")) .put("MSO", ImmutableList.of("VF Module Create")) .put("SDNO", ImmutableList.of("health-diagnostic-type", "health-diagnostic", "health-diagnostic-history", "health-diagnostic-commands", "health-diagnostic-aes")) .put("SDNR", ImmutableList.of("Restart", "Reboot")) .build(); // if (operPolicy.recipe != null && (!recipes.getOrDefault(operPolicy.actor, Collections.emptyList()).contains(operPolicy.recipe))) { if (callback != null) { callback.onError("Policy recipe is invalid"); } okToAdd = false; } if (operPolicy.target == null) { if (callback != null) { callback.onError("Policy target is null"); } okToAdd = false; } if (operPolicy.target != null && operPolicy.target.type != TargetType.VM && operPolicy.target.type != TargetType.VFC && operPolicy.target.type != TargetType.PNF) { if (callback != null) { callback.onError("Policy target is invalid"); } okToAdd = false; } // // Check that policy results are connected to either default final * or another policy // if (FinalResult.toResult(operPolicy.success) != null && operPolicy.success != FinalResult.FINAL_SUCCESS.toString()) { if (callback != null) { callback.onError("Policy success is neither another policy nor FINAL_SUCCESS"); } okToAdd = false; } if (FinalResult.toResult(operPolicy.failure) != null && operPolicy.failure != FinalResult.FINAL_FAILURE.toString()) { if (callback != null) { callback.onError("Policy failure is neither another policy nor FINAL_FAILURE"); } okToAdd = false; } if (FinalResult.toResult(operPolicy.failure_retries) != null && operPolicy.failure_retries != FinalResult.FINAL_FAILURE_RETRIES.toString()) { if (callback != null) { callback.onError("Policy failure retries is neither another policy nor FINAL_FAILURE_RETRIES"); } okToAdd = false; } if (FinalResult.toResult(operPolicy.failure_timeout) != null && operPolicy.failure_timeout != FinalResult.FINAL_FAILURE_TIMEOUT.toString()) { if (callback != null) { callback.onError("Policy failure timeout is neither another policy nor FINAL_FAILURE_TIMEOUT"); } okToAdd = false; } if (FinalResult.toResult(operPolicy.failure_exception) != null && operPolicy.failure_exception != FinalResult.FINAL_FAILURE_EXCEPTION.toString()) { if (callback != null) { callback.onError("Policy failure exception is neither another policy nor FINAL_FAILURE_EXCEPTION"); } okToAdd = false; } if (FinalResult.toResult(operPolicy.failure_guard) != null && operPolicy.failure_guard != FinalResult.FINAL_FAILURE_GUARD.toString()) { if (callback != null) { callback.onError("Policy failure guard is neither another policy nor FINAL_FAILURE_GUARD"); } okToAdd = false; } // // Is it still ok to add? // if (okToAdd == false) { // // Do not add it in // continue; } // // Create wrapper policy node and save it into our map so we can // easily retrieve it. // PolicyNodeWrapper node = new PolicyNodeWrapper(operPolicy); mapNodes.put(operPolicy, node); graph.addVertex(node); // // Is this the trigger policy? // if (operPolicy.id.equals(policy.controlLoop.trigger_policy)) { // // Yes add an edge from our trigger event node to this policy // graph.addEdge(triggerNode, node, new LabeledEdge(triggerNode, node, new TriggerEdgeWrapper("ONSET"))); } } // // last sweep to connect remaining edges for policy results // for (Policy operPolicy : policy.policies) { PolicyNodeWrapper node = mapNodes.get(operPolicy); // // Just ensure this has something // if (node == null) { continue; } if (FinalResult.isResult(operPolicy.success, FinalResult.FINAL_SUCCESS)) { graph.addEdge(node, finalSuccess, new LabeledEdge(node, finalSuccess, new FinalResultEdgeWrapper(FinalResult.FINAL_SUCCESS))); } else { PolicyNodeWrapper toNode = findPolicyNode(mapNodes, operPolicy.success); if (toNode == null) { throw new CompilerException("Operation Policy " + operPolicy.id + " success is connected to unknown policy " + operPolicy.success); } else { graph.addEdge(node, toNode, new LabeledEdge(node, toNode, new PolicyResultEdgeWrapper(PolicyResult.SUCCESS))); } } if (FinalResult.isResult(operPolicy.failure, FinalResult.FINAL_FAILURE)) { graph.addEdge(node, finalFailure, new LabeledEdge(node, finalFailure, new FinalResultEdgeWrapper(FinalResult.FINAL_FAILURE))); } else { PolicyNodeWrapper toNode = findPolicyNode(mapNodes, operPolicy.failure); if (toNode == null) { throw new CompilerException("Operation Policy " + operPolicy.id + " failure is connected to unknown policy " + operPolicy.failure); } else { graph.addEdge(node, toNode, new LabeledEdge(node, toNode, new PolicyResultEdgeWrapper(PolicyResult.FAILURE))); } } if (FinalResult.isResult(operPolicy.failure_timeout, FinalResult.FINAL_FAILURE_TIMEOUT)) { graph.addEdge(node, finalFailureTimeout, new LabeledEdge(node, finalFailureTimeout, new FinalResultEdgeWrapper(FinalResult.FINAL_FAILURE_TIMEOUT))); } else { PolicyNodeWrapper toNode = findPolicyNode(mapNodes, operPolicy.failure_timeout); if (toNode == null) { throw new CompilerException("Operation Policy " + operPolicy.id + " failure_timeout is connected to unknown policy " + operPolicy.failure_timeout); } else { graph.addEdge(node, toNode, new LabeledEdge(node, toNode, new PolicyResultEdgeWrapper(PolicyResult.FAILURE_TIMEOUT))); } } if (FinalResult.isResult(operPolicy.failure_retries, FinalResult.FINAL_FAILURE_RETRIES)) { graph.addEdge(node, finalFailureRetries, new LabeledEdge(node, finalFailureRetries, new FinalResultEdgeWrapper(FinalResult.FINAL_FAILURE_RETRIES))); } else { PolicyNodeWrapper toNode = findPolicyNode(mapNodes, operPolicy.failure_retries); if (toNode == null) { throw new CompilerException("Operation Policy " + operPolicy.id + " failure_retries is connected to unknown policy " + operPolicy.failure_retries); } else { graph.addEdge(node, toNode, new LabeledEdge(node, toNode, new PolicyResultEdgeWrapper(PolicyResult.FAILURE_RETRIES))); } } if (FinalResult.isResult(operPolicy.failure_exception, FinalResult.FINAL_FAILURE_EXCEPTION)) { graph.addEdge(node, finalFailureException, new LabeledEdge(node, finalFailureException, new FinalResultEdgeWrapper(FinalResult.FINAL_FAILURE_EXCEPTION))); } else { PolicyNodeWrapper toNode = findPolicyNode(mapNodes, operPolicy.failure_exception); if (toNode == null) { throw new CompilerException("Operation Policy " + operPolicy.id + " failure_exception is connected to unknown policy " + operPolicy.failure_exception); } else { graph.addEdge(node, toNode, new LabeledEdge(node, toNode, new PolicyResultEdgeWrapper(PolicyResult.FAILURE_EXCEPTION))); } } if (FinalResult.isResult(operPolicy.failure_guard, FinalResult.FINAL_FAILURE_GUARD)) { graph.addEdge(node, finalFailureGuard, new LabeledEdge(node, finalFailureGuard, new FinalResultEdgeWrapper(FinalResult.FINAL_FAILURE_GUARD))); } else { PolicyNodeWrapper toNode = findPolicyNode(mapNodes, operPolicy.failure_guard); if (toNode == null) { throw new CompilerException("Operation Policy " + operPolicy.id + " failure_guard is connected to unknown policy " + operPolicy.failure_guard); } else { graph.addEdge(node, toNode, new LabeledEdge(node, toNode, new PolicyResultEdgeWrapper(PolicyResult.FAILURE_GUARD))); } } } // // Now validate all the nodes/edges // for (NodeWrapper node : graph.vertexSet()) { if (node instanceof TriggerNodeWrapper) { System.out.println("Trigger Node " + node.toString()); if (graph.inDegreeOf(node) > 0 ) { // // Really should NEVER get here unless someone messed up the code above. // throw new CompilerException("No inputs to event trigger"); } // // Should always be 1, except in the future we may support multiple events // if (graph.outDegreeOf(node) > 1) { throw new CompilerException("The event trigger should only go to ONE node"); } } else if (node instanceof FinalResultNodeWrapper) { System.out.println("FinalResult Node " + node.toString()); // // FinalResult nodes should NEVER have an out edge // if (graph.outDegreeOf(node) > 0) { throw new CompilerException("FinalResult nodes should never have any out edges."); } } else if (node instanceof PolicyNodeWrapper) { System.out.println("Policy Node " + node.toString()); // // All Policy Nodes should have the 5 out degrees defined. // if (graph.outDegreeOf(node) != 6) { throw new CompilerException("Policy node should ALWAYS have 6 out degrees."); } // // Chenfei: All Policy Nodes should have at least 1 in degrees // if (graph.inDegreeOf(node) == 0) { if (callback != null) { callback.onWarning("Policy " + node.getID() + " is not reachable."); } } } for (LabeledEdge edge : graph.outgoingEdgesOf(node)){ System.out.println(edge.from.getID() + " invokes " + edge.to.getID() + " upon " + edge.edge.getID()); } } } } private static PolicyNodeWrapper findPolicyNode(Map mapNodes, String id) { for (Policy key : mapNodes.keySet()) { if (key.id.equals(id)) { return mapNodes.get(key); } } return null; } private interface NodeWrapper { public String getID(); } private static class TriggerNodeWrapper implements NodeWrapper { public String closedLoopControlName; public TriggerNodeWrapper(String closedLoopControlName) { this.closedLoopControlName = closedLoopControlName; } @Override public String toString() { return "TriggerNodeWrapper [closedLoopControlName=" + closedLoopControlName + "]"; } @Override public String getID() { return closedLoopControlName; } } private static class FinalResultNodeWrapper implements NodeWrapper { public FinalResult result; public FinalResultNodeWrapper(FinalResult result) { this.result = result; } @Override public String toString() { return "FinalResultNodeWrapper [result=" + result + "]"; } @Override public String getID() { return result.toString(); } } private static class PolicyNodeWrapper implements NodeWrapper { public Policy policy; public PolicyNodeWrapper(Policy operPolicy) { this.policy = operPolicy; } @Override public String toString() { return "PolicyNodeWrapper [policy=" + policy + "]"; } @Override public String getID() { return policy.id; } } private interface EdgeWrapper { public String getID(); } private static class TriggerEdgeWrapper implements EdgeWrapper { private String trigger; public TriggerEdgeWrapper(String trigger) { this.trigger = trigger; } @Override public String getID() { return trigger; } @Override public String toString() { return "TriggerEdgeWrapper [trigger=" + trigger + "]"; } } private static class PolicyResultEdgeWrapper implements EdgeWrapper { public PolicyResult policyResult; public PolicyResultEdgeWrapper(PolicyResult policyResult) { super(); this.policyResult = policyResult; } @Override public String toString() { return "PolicyResultEdgeWrapper [policyResult=" + policyResult + "]"; } @Override public String getID() { return policyResult.toString(); } } private static class FinalResultEdgeWrapper implements EdgeWrapper { public FinalResult finalResult; public FinalResultEdgeWrapper(FinalResult result) { this.finalResult = result; } @Override public String toString() { return "FinalResultEdgeWrapper [finalResult=" + finalResult + "]"; } @Override public String getID() { return finalResult.toString(); } } private static class LabeledEdge extends DefaultEdge { /** * */ private static final long serialVersionUID = 579384429573385524L; private NodeWrapper from; private NodeWrapper to; private EdgeWrapper edge; public LabeledEdge(NodeWrapper from, NodeWrapper to, EdgeWrapper edge) { this.from = from; this.to = to; this.edge = edge; } @SuppressWarnings("unused") public NodeWrapper from() { return from; } @SuppressWarnings("unused") public NodeWrapper to() { return to; } @SuppressWarnings("unused") public EdgeWrapper edge() { return edge; } @Override public String toString() { return "LabeledEdge [from=" + from + ", to=" + to + ", edge=" + edge + "]"; } } }