TOSCA Compliant Guard Policies
[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / simple / concepts / JpaToscaServiceTemplate.java
index 5f50e4a..e2e27f0 100644 (file)
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2019 Nordix Foundation.
+ *  Copyright (C) 2019-2020 Nordix Foundation.
+ *  Modifications Copyright (C) 2019 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.
@@ -22,7 +23,11 @@ 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;
+import java.util.Map;
 
 import javax.persistence.CascadeType;
 import javax.persistence.Column;
@@ -30,6 +35,8 @@ import javax.persistence.Entity;
 import javax.persistence.FetchType;
 import javax.persistence.Inheritance;
 import javax.persistence.InheritanceType;
+import javax.persistence.JoinColumn;
+import javax.persistence.JoinColumns;
 import javax.persistence.OneToOne;
 import javax.persistence.Table;
 
@@ -38,7 +45,6 @@ import lombok.EqualsAndHashCode;
 import lombok.NonNull;
 
 import org.apache.commons.lang3.ObjectUtils;
-import org.onap.policy.common.utils.validation.Assertions;
 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
 import org.onap.policy.models.base.PfAuthorative;
 import org.onap.policy.models.base.PfConcept;
@@ -47,6 +53,8 @@ import org.onap.policy.models.base.PfKey;
 import org.onap.policy.models.base.PfValidationMessage;
 import org.onap.policy.models.base.PfValidationResult;
 import org.onap.policy.models.base.PfValidationResult.ValidationResult;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
 
 /**
@@ -55,6 +63,7 @@ import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  *
  * @author Liam Fallon (liam.fallon@est.tech)
  */
+
 @Entity
 @Table(name = "ToscaServiceTemplate")
 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
@@ -64,25 +73,47 @@ 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_1_0";
     public static final String DEFAULT_NAME = "ToscaServiceTemplateSimple";
     public static final String DEFAULT_VERSION = "1.0.0";
 
+    // @formatter:off
     @Column
     @SerializedName("tosca_definitions_version")
     private String toscaDefinitionsVersion;
 
     @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumns(
+            {
+                @JoinColumn(name = "dataTypesName",    referencedColumnName = "name"),
+                @JoinColumn(name = "dataTypesVersion", referencedColumnName = "version")
+            }
+        )
     @SerializedName("data_types")
     private JpaToscaDataTypes dataTypes;
 
     @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumns(
+            {
+                @JoinColumn(name = "policyTypesName",    referencedColumnName = "name"),
+                @JoinColumn(name = "policyTypesVersion", referencedColumnName = "version")
+            }
+        )
     @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
 
     /**
      * The Default Constructor creates a {@link JpaToscaServiceTemplate} object with a null key.
@@ -97,7 +128,7 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
      * @param key the key
      */
     public JpaToscaServiceTemplate(@NonNull final PfConceptKey key) {
-        this(key, "");
+        this(key, DEFAULT_TOSCA_DEFINTIONS_VERISON);
     }
 
     /**
@@ -118,6 +149,12 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
      */
     public JpaToscaServiceTemplate(final JpaToscaServiceTemplate copyConcept) {
         super(copyConcept);
+        this.toscaDefinitionsVersion = copyConcept.toscaDefinitionsVersion;
+        this.dataTypes = (copyConcept.dataTypes != null ? new JpaToscaDataTypes(copyConcept.dataTypes) : null);
+        this.policyTypes = (copyConcept.policyTypes != null ? new JpaToscaPolicyTypes(copyConcept.policyTypes) : null);
+        this.topologyTemplate =
+                (copyConcept.topologyTemplate != null ? new JpaToscaTopologyTemplate(copyConcept.topologyTemplate)
+                        : null);
     }
 
     /**
@@ -139,11 +176,19 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
         toscaServiceTemplate.setToscaDefinitionsVersion(toscaDefinitionsVersion);
 
         if (dataTypes != null) {
-            toscaServiceTemplate.setDataTypes(dataTypes.toAuthorative());
+            toscaServiceTemplate.setDataTypes(new LinkedHashMap<>());
+            List<Map<String, ToscaDataType>> dataTypeMapList = dataTypes.toAuthorative();
+            for (Map<String, ToscaDataType> dataTypeMap : dataTypeMapList) {
+                toscaServiceTemplate.getDataTypes().putAll(dataTypeMap);
+            }
         }
 
         if (policyTypes != null) {
-            toscaServiceTemplate.setPolicyTypes(policyTypes.toAuthorative());
+            toscaServiceTemplate.setPolicyTypes(new LinkedHashMap<>());
+            List<Map<String, ToscaPolicyType>> policyTypeMapList = policyTypes.toAuthorative();
+            for (Map<String, ToscaPolicyType> policyTypeMap : policyTypeMapList) {
+                toscaServiceTemplate.getPolicyTypes().putAll(policyTypeMap);
+            }
         }
 
         if (topologyTemplate != null) {
@@ -157,11 +202,11 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
     public void fromAuthorative(ToscaServiceTemplate toscaServiceTemplate) {
         super.fromAuthorative(toscaServiceTemplate);
 
-        if (getKey().getName() == PfKey.NULL_KEY_NAME) {
+        if (PfKey.NULL_KEY_NAME.equals(getKey().getName())) {
             getKey().setName(DEFAULT_NAME);
         }
 
-        if (getKey().getVersion() == PfKey.NULL_KEY_VERSION) {
+        if (PfKey.NULL_KEY_VERSION.equals(getKey().getVersion())) {
             getKey().setVersion(DEFAULT_VERSION);
         }
 
@@ -169,15 +214,14 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
 
         if (toscaServiceTemplate.getDataTypes() != null) {
             dataTypes = new JpaToscaDataTypes();
-            dataTypes.fromAuthorative(toscaServiceTemplate.getDataTypes());
+            dataTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getDataTypes()));
         }
 
         if (toscaServiceTemplate.getPolicyTypes() != null) {
             policyTypes = new JpaToscaPolicyTypes();
-            policyTypes.fromAuthorative(toscaServiceTemplate.getPolicyTypes());
+            policyTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getPolicyTypes()));
         }
 
-
         if (toscaServiceTemplate.getToscaTopologyTemplate() != null) {
             topologyTemplate = new JpaToscaTopologyTemplate();
             topologyTemplate.fromAuthorative(toscaServiceTemplate.getToscaTopologyTemplate());
@@ -237,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;
         }
@@ -249,7 +331,7 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             return 0;
         }
         if (getClass() != otherConcept.getClass()) {
-            return this.hashCode() - otherConcept.hashCode();
+            return getClass().getName().compareTo(otherConcept.getClass().getName());
         }
 
         final JpaToscaServiceTemplate other = (JpaToscaServiceTemplate) otherConcept;
@@ -257,37 +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) {
-            return result;
+        if (dataTypes != null) {
+            for (JpaToscaDataType dataType : dataTypes.getAll(null)) {
+                validateReferencedDataTypesExists(dataType.getKey(), dataType.getReferencedDataTypes(), result);
+            }
         }
 
-        result = ObjectUtils.compare(policyTypes, other.policyTypes);
-        if (result != 0) {
-            return result;
+        for (JpaToscaPolicyType policyType : policyTypes.getAll(null)) {
+            validateReferencedDataTypesExists(policyType.getKey(), policyType.getReferencedDataTypes(), result);
         }
 
-        return ObjectUtils.compare(topologyTemplate, other.topologyTemplate);
+        return result;
     }
 
-    @Override
-    public PfConcept copyTo(@NonNull PfConcept target) {
-        final Object copyObject = target;
-        Assertions.instanceOf(copyObject, PfConcept.class);
+    /**
+     * 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"));
+            }
+        }
+    }
 
-        final JpaToscaServiceTemplate copy = ((JpaToscaServiceTemplate) copyObject);
-        super.copyTo(target);
-        copy.setToscaDefinitionsVersion(toscaDefinitionsVersion);
+    /**
+     * 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;
+        }
 
-        copy.setDataTypes(dataTypes != null ? new JpaToscaDataTypes(dataTypes) : null);
-        copy.setPolicyTypes(policyTypes != null ? new JpaToscaPolicyTypes(policyTypes) : null);
-        copy.setTopologyTemplate(topologyTemplate != null ? new JpaToscaTopologyTemplate(topologyTemplate) : null);
+        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;
+        }
+
+        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 copy;
+        return result;
     }
 }