Added the new versioning validation for policy and policy type

[policy/api.git] / main / src / main / java / org / onap / policy / api / main / rest / provider / LegacyGuardPolicyProvider.java

diff --git a/main/src/main/java/org/onap/policy/api/main/rest/provider/LegacyGuardPolicyProvider.java b/main/src/main/java/org/onap/policy/api/main/rest/provider/LegacyGuardPolicyProvider.java
index 978a8c0..2a0874d 100644 (file)
--- a/main/src/main/java/org/onap/policy/api/main/rest/provider/LegacyGuardPolicyProvider.java
+++ b/main/src/main/java/org/onap/policy/api/main/rest/provider/LegacyGuardPolicyProvider.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP Policy API
  * ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019-2020 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.
@@ -33,11 +33,14 @@ import javax.ws.rs.core.Response;
 import org.apache.commons.lang3.tuple.Pair;
 import org.onap.policy.models.base.PfConceptKey;
 import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.base.PfModelRuntimeException;
 import org.onap.policy.models.pdp.concepts.PdpGroup;
 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Class to provide all kinds of legacy guard policy operations.
@@ -46,6 +49,8 @@ import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
  */
 public class LegacyGuardPolicyProvider extends CommonModelProvider {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(LegacyGuardPolicyProvider.class);
+
     private static final String INVALID_POLICY_VERSION = "legacy policy version is not an integer";
     private static final String LEGACY_MINOR_PATCH_SUFFIX = ".0.0";
     private static final Map<String, PfConceptKey> GUARD_POLICY_TYPE_MAP = new LinkedHashMap<>();
@@ -109,6 +114,7 @@ public class LegacyGuardPolicyProvider extends CommonModelProvider {
     public Map<String, LegacyGuardPolicyOutput> createGuardPolicy(LegacyGuardPolicyInput body)
             throws PfModelException {
 
+        validateGuardPolicyVersion(body);
         return modelsProvider.createGuardPolicy(body);
     }
 
@@ -151,6 +157,79 @@ public class LegacyGuardPolicyProvider extends CommonModelProvider {
         }
     }
 
+    /**
+     * Validates the provided guard policy version in the payload.
+     *
+     * @param body the guard policy payload
+     *
+     * @throws PfModelException the PfModel parsing exception
+     */
+    private void validateGuardPolicyVersion(LegacyGuardPolicyInput body) throws PfModelException {
+
+        validateGuardPolicyVersionExist(body);
+        validateNoDuplicateVersionInDb(body);
+    }
+
+    /**
+     * Validates that the guard policy has version specified.
+     *
+     * @param body the guard policy payload
+     *
+     * @throws PfModelException the PfModel parsing exception
+     */
+    private void validateGuardPolicyVersionExist(LegacyGuardPolicyInput body) throws PfModelException {
+
+        if (body.getPolicyVersion() == null) {
+            String errMsg = "mandatory field 'policy-version' is missing in the policy: " + body.getPolicyId();
+            throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errMsg);
+        }
+    }
+
+    /**
+     * Validates that there is no duplicate version already stored in the database.
+     *
+     * @param body the guard policy payload
+     *
+     * @throws PfModelException the PfModel parsing exception
+     */
+    private void validateNoDuplicateVersionInDb(LegacyGuardPolicyInput body) throws PfModelException {
+
+        try {
+            modelsProvider.getGuardPolicy(body.getPolicyId(), body.getPolicyVersion());
+        } catch (PfModelRuntimeException exc) {
+            if (!hasSameGuardPolicyFound(body, exc)) {
+                return;
+            }
+            throw new PfModelException(exc.getErrorResponse().getResponseCode(), "unexpected runtime error", exc);
+        }
+
+        // If it gets here, there is one duplicate version stored in the DB.
+        // Try to get the latest version and return it to the user.
+        Map<String, LegacyGuardPolicyOutput> latest = modelsProvider.getGuardPolicy(body.getPolicyId(), null);
+        final String[] versionArray = latest.values().iterator().next().getVersion().split("\\.");
+        String errMsg = "guard policy " + body.getPolicyId() + ":" + body.getPolicyVersion()
+            + " already exists; its latest version is " + versionArray[0];
+        throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errMsg);
+    }
+
+    /**
+     * Checks if the same guard policy found in the database.
+     *
+     * @param body the legacy guard policy payload
+     * @param exc the thrown runtime exception from policy model provider
+     *
+     * @return a boolean flag indicating the check result
+     */
+    private boolean hasSameGuardPolicyFound(LegacyGuardPolicyInput body, PfModelRuntimeException exc) {
+
+        if (exc.getErrorResponse().getResponseCode() == Response.Status.BAD_REQUEST
+                && exc.getErrorResponse().getErrorMessage().contains("no policy found")) {
+            LOGGER.debug("no duplicate policy {}:{} found in the DB", body.getPolicyId(), body.getPolicyVersion());
+            return false;
+        }
+        return true;
+    }
+
     /**
      * Retrieves guard policy type given guard policy ID.
      *