TOSCA Compliant Guard Policies

[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / simple / concepts / JpaToscaServiceTemplate.java

diff --git a/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaServiceTemplate.java b/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaServiceTemplate.java
index 31c7df0..e2e27f0 100644 (file)
--- a/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaServiceTemplate.java
+++ b/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaServiceTemplate.java
@@ -23,6 +23,7 @@ package org.onap.policy.models.tosca.simple.concepts;
 
 import com.google.gson.annotations.SerializedName;
 
+import java.util.Collection;
 import java.util.Collections;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -72,7 +73,7 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
         implements PfAuthorative<ToscaServiceTemplate> {
     private static final long serialVersionUID = 8084846046148349401L;
 
-    public static final String DEFAULT_TOSCA_DEFINTIONS_VERISON = "tosca_simple_yaml_1_0_0";
+    public static final String DEFAULT_TOSCA_DEFINTIONS_VERISON = "tosca_simple_yaml_1_1_0";
     public static final String DEFAULT_NAME = "ToscaServiceTemplateSimple";
     public static final String DEFAULT_VERSION = "1.0.0";
 
@@ -101,7 +102,15 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
     @SerializedName("policy_types")
     private JpaToscaPolicyTypes policyTypes;
 
-    @Column
+    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumns(
+            {
+                @JoinColumn(name = "topologyTemplateParentKeyName",    referencedColumnName = "parentKeyName"),
+                @JoinColumn(name = "topologyTemplateParentKeyVersion", referencedColumnName = "parentKeyVersion"),
+                @JoinColumn(name = "topologyTemplateParentLocalName",  referencedColumnName = "parentLocalName"),
+                @JoinColumn(name = "topologyTemplateLocalName",        referencedColumnName = "localName")
+            }
+        )
     @SerializedName("topology_template")
     private JpaToscaTopologyTemplate topologyTemplate;
     // @formatter:on
@@ -272,11 +281,49 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             result = policyTypes.validate(result);
         }
 
-        return (topologyTemplate != null ? topologyTemplate.validate(result) : result);
+        if (topologyTemplate != null) {
+            result = topologyTemplate.validate(result);
+        }
+
+        // No point in validating cross references if the structure of the individual parts are not valid
+        if (!result.isOk()) {
+            return result;
+        }
+
+        validateReferencedDataTypes(result);
+
+        return validatePolicyTypesInPolicies(result);
     }
 
     @Override
     public int compareTo(final PfConcept otherConcept) {
+        int result = compareToWithoutEntities(otherConcept);
+        if (result != 0) {
+            return result;
+        }
+
+        final JpaToscaServiceTemplate other = (JpaToscaServiceTemplate) otherConcept;
+
+        result = ObjectUtils.compare(dataTypes, other.dataTypes);
+        if (result != 0) {
+            return result;
+        }
+
+        result = ObjectUtils.compare(policyTypes, other.policyTypes);
+        if (result != 0) {
+            return result;
+        }
+
+        return ObjectUtils.compare(topologyTemplate, other.topologyTemplate);
+    }
+
+    /**
+     * Compare this service template to another service template, ignoring contained entitites.
+     *
+     * @param otherConcept the other topology template
+     * @return the result of the comparison
+     */
+    public int compareToWithoutEntities(final PfConcept otherConcept) {
         if (otherConcept == null) {
             return -1;
         }
@@ -292,21 +339,77 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             return super.compareTo(other);
         }
 
-        int result = ObjectUtils.compare(toscaDefinitionsVersion, other.toscaDefinitionsVersion);
-        if (result != 0) {
+        return ObjectUtils.compare(toscaDefinitionsVersion, other.toscaDefinitionsVersion);
+    }
+
+    /**
+     * Validate that all data types referenced in policy types exist.
+     *
+     * @param result the validation result object to use for the validation result
+     * @return the validation result object
+     */
+    private PfValidationResult validateReferencedDataTypes(final PfValidationResult result) {
+        if (policyTypes == null) {
             return result;
         }
 
-        result = ObjectUtils.compare(dataTypes, other.dataTypes);
-        if (result != 0) {
+        if (dataTypes != null) {
+            for (JpaToscaDataType dataType : dataTypes.getAll(null)) {
+                validateReferencedDataTypesExists(dataType.getKey(), dataType.getReferencedDataTypes(), result);
+            }
+        }
+
+        for (JpaToscaPolicyType policyType : policyTypes.getAll(null)) {
+            validateReferencedDataTypesExists(policyType.getKey(), policyType.getReferencedDataTypes(), result);
+        }
+
+        return result;
+    }
+
+    /**
+     * Validate that the referenced data types exist for a collection of data type keys.
+     *
+     * @param referencingEntityKey the key of the referencing entity
+     * @param dataTypeKeyCollection the data type key collection
+     * @param result the result of the validation
+     */
+    private void validateReferencedDataTypesExists(final PfConceptKey referencingEntityKey,
+            final Collection<PfConceptKey> dataTypeKeyCollection, final PfValidationResult result) {
+        for (PfConceptKey dataTypeKey : dataTypeKeyCollection) {
+            if (dataTypes == null || dataTypes.get(dataTypeKey) == null) {
+                result.addValidationMessage(new PfValidationMessage(referencingEntityKey, this.getClass(),
+                        ValidationResult.INVALID, "referenced data type " + dataTypeKey.getId() + " not found"));
+            }
+        }
+    }
+
+    /**
+     * Validate that all policy types referenced in policies exist.
+     *
+     * @param result the validation result object to use for the validation result
+     * @return the validation result object
+     */
+    private PfValidationResult validatePolicyTypesInPolicies(PfValidationResult result) {
+        if (topologyTemplate == null || topologyTemplate.getPolicies() == null
+                || topologyTemplate.getPolicies().getConceptMap().isEmpty()) {
             return result;
         }
 
-        result = ObjectUtils.compare(policyTypes, other.policyTypes);
-        if (result != 0) {
+        if (policyTypes == null || policyTypes.getConceptMap().isEmpty()) {
+            result.addValidationMessage(new PfValidationMessage(this.getKey(), this.getClass(),
+                    ValidationResult.INVALID,
+                    "no policy types are defined on the service template for the policies in the topology template"));
             return result;
         }
 
-        return ObjectUtils.compare(topologyTemplate, other.topologyTemplate);
+        for (JpaToscaPolicy policy : topologyTemplate.getPolicies().getAll(null)) {
+            if (policyTypes.get(policy.getType()) == null) {
+                result.addValidationMessage(
+                        new PfValidationMessage(policy.getKey(), this.getClass(), ValidationResult.INVALID,
+                                "policy type " + policy.getType().getId() + " referenced in policy not found"));
+            }
+        }
+
+        return result;
     }
 }