Knock on of changing policy types to map
[policy/api.git] / main / src / test / java / org / onap / policy / api / main / rest / provider / TestLegacyGuardPolicyProvider.java
index 08f7fec..bfd126e 100644 (file)
@@ -3,6 +3,7 @@
  * ONAP Policy API
  * ================================================================================
  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 package org.onap.policy.api.main.rest.provider;
 
+import static org.assertj.core.api.Assertions.assertThatCode;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 
+import java.util.ArrayList;
 import java.util.Base64;
+import java.util.List;
+import java.util.Map;
+
+import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
+import org.onap.policy.api.main.ApiTestSupportUtilities;
 import org.onap.policy.api.main.parameters.ApiParameterGroup;
 import org.onap.policy.common.parameters.ParameterService;
+import org.onap.policy.common.utils.coder.StandardCoder;
+import org.onap.policy.common.utils.resources.ResourceUtils;
 import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.pdp.concepts.Pdp;
+import org.onap.policy.models.pdp.concepts.PdpGroup;
+import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
+import org.onap.policy.models.pdp.concepts.PdpSubGroup;
+import org.onap.policy.models.pdp.enums.PdpHealthStatus;
+import org.onap.policy.models.pdp.enums.PdpState;
+import org.onap.policy.models.provider.PolicyModelsProvider;
+import org.onap.policy.models.provider.PolicyModelsProviderFactory;
 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
+import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
+import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
 
 /**
- * This class performs unit test of {@link LegacyGuardPolicyProvider}
+ * This class performs unit test of {@link LegacyGuardPolicyProvider}.
  *
  * @author Chenfei Gao (cgao@research.att.com)
  */
 public class TestLegacyGuardPolicyProvider {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(TestPolicyProvider.class);
+    private static LegacyGuardPolicyProvider guardPolicyProvider;
+    private static PolicyTypeProvider policyTypeProvider;
+    private static PolicyModelsProviderParameters providerParams;
+    private static ApiParameterGroup apiParamGroup;
+    private static StandardCoder standardCoder;
 
-    private LegacyGuardPolicyProvider guardPolicyProvider;
+    private static final String POLICY_RESOURCE = "policies/vDNS.policy.guard.frequency.input.json";
+    private static final String POLICY_RESOURCE_VER1 = "policies/vDNS.policy.guard.frequency.input.ver1.json";
+    private static final String POLICY_RESOURCE_VER2 = "policies/vDNS.policy.guard.frequency.input.ver2.json";
+    private static final String POLICY_TYPE_RESOURCE =
+            "policytypes/onap.policies.controlloop.guard.FrequencyLimiter.yaml";
+    private static final String POLICY_TYPE_ID = "onap.policies.controlloop.guard.FrequencyLimiter:1.0.0";
+    private static final String POLICY_TYPE_NAME = "onap.policies.controlloop.guard.FrequencyLimiter";
+    private static final String POLICY_TYPE_VERSION = "1.0.0";
+    private static final String POLICY_ID = "guard.frequency.scaleout:1.0.0";
+    private static final String POLICY_NAME = "guard.frequency.scaleout";
+    private static final String POLICY_VERSION = "1";
+    private static final String LEGACY_MINOR_PATCH_SUFFIX = ".0.0";
 
     /**
-     * Initialize parameters.
+     * Initializes parameters.
+     *
+     * @throws PfModelException the PfModel parsing exception
      */
     @Before
     public void setupParameters() throws PfModelException {
 
-        PolicyModelsProviderParameters parameters = new PolicyModelsProviderParameters();
-        parameters.setDatabaseUrl("jdbc:h2:mem:testdb");
-        parameters.setDatabaseUser("policy");
-        parameters.setDatabasePassword(Base64.getEncoder().encodeToString("P01icY".getBytes()));
-        parameters.setPersistenceUnit("ToscaConceptTest");
-        ApiParameterGroup paramGroup = new ApiParameterGroup("ApiGroup", null, parameters);
-        ParameterService.register(paramGroup, true);
+        standardCoder = new StandardCoder();
+        providerParams = new PolicyModelsProviderParameters();
+        providerParams.setDatabaseDriver("org.h2.Driver");
+        providerParams.setDatabaseUrl("jdbc:h2:mem:testdb");
+        providerParams.setDatabaseUser("policy");
+        providerParams.setDatabasePassword(Base64.getEncoder().encodeToString("P01icY".getBytes()));
+        providerParams.setPersistenceUnit("ToscaConceptTest");
+        apiParamGroup = new ApiParameterGroup("ApiGroup", null, providerParams);
+        ParameterService.register(apiParamGroup, true);
         guardPolicyProvider = new LegacyGuardPolicyProvider();
+        policyTypeProvider = new PolicyTypeProvider();
     }
 
+    /**
+     * Closes up DB connections and deregisters API parameter group.
+     *
+     * @throws PfModelException the PfModel parsing exception
+     */
+    @After
+    public void tearDown() throws PfModelException {
+
+        guardPolicyProvider.close();
+        policyTypeProvider.close();
+        ParameterService.deregister(apiParamGroup);
+    }
+
+
     @Test
     public void testFetchGuardPolicy() {
 
+        assertThatThrownBy(() -> {
+            guardPolicyProvider.fetchGuardPolicy("dummy", null);
+        }).hasMessage("no policy found for policy: dummy:null");
+
+        assertThatThrownBy(() -> {
+            guardPolicyProvider.fetchGuardPolicy("dummy", "dummy");
+        }).hasMessage("legacy policy version is not an integer");
+
+        assertThatCode(() -> {
+            String policyTypeString =
+                    ApiTestSupportUtilities.yaml2Json(ResourceUtils.getResourceAsString(POLICY_TYPE_RESOURCE));
+            ToscaServiceTemplate policyTypeServiceTemplate =
+                    standardCoder.decode(policyTypeString, ToscaServiceTemplate.class);
+            policyTypeProvider.createPolicyType(policyTypeServiceTemplate);
+
+            String policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE_VER1);
+            LegacyGuardPolicyInput policyToCreate = standardCoder.decode(policyString, LegacyGuardPolicyInput.class);
+            Map<String, LegacyGuardPolicyOutput> createdPolicy = guardPolicyProvider.createGuardPolicy(policyToCreate);
+            assertNotNull(createdPolicy);
+            assertFalse(createdPolicy.isEmpty());
+
+            policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE_VER2);
+            policyToCreate = standardCoder.decode(policyString, LegacyGuardPolicyInput.class);
+            createdPolicy = guardPolicyProvider.createGuardPolicy(policyToCreate);
+            assertNotNull(createdPolicy);
+            assertFalse(createdPolicy.isEmpty());
+
+            Map<String, LegacyGuardPolicyOutput> firstVersion =
+                    guardPolicyProvider.fetchGuardPolicy("guard.frequency.scaleout", "1");
+            assertNotNull(firstVersion);
+            assertEquals("1",
+                    firstVersion.get("guard.frequency.scaleout").getMetadata().get("policy-version").toString());
+
+            Map<String, LegacyGuardPolicyOutput> latestVersion =
+                    guardPolicyProvider.fetchGuardPolicy("guard.frequency.scaleout", null);
+            assertNotNull(latestVersion);
+            assertEquals("2",
+                    latestVersion.get("guard.frequency.scaleout").getMetadata().get("policy-version").toString());
+        }).doesNotThrowAnyException();
+
+        assertThatThrownBy(() -> {
+            guardPolicyProvider.fetchGuardPolicy("guard.frequency.scaleout", "1.0.0");
+        }).hasMessage("legacy policy version is not an integer");
+
+        assertThatThrownBy(() -> {
+            guardPolicyProvider.fetchGuardPolicy("guard.frequency.scaleout", "latest");
+        }).hasMessage("legacy policy version is not an integer");
+
+        assertThatCode(() -> {
+            guardPolicyProvider.deleteGuardPolicy("guard.frequency.scaleout", "1");
+            guardPolicyProvider.deleteGuardPolicy("guard.frequency.scaleout", "2");
+            policyTypeProvider.deletePolicyType("onap.policies.controlloop.guard.FrequencyLimiter", "1.0.0");
+        }).doesNotThrowAnyException();
+    }
+
+    @Test
+    public void testFetchDeployedGuardPolicies() {
+
+        assertThatThrownBy(() -> {
+            guardPolicyProvider.fetchDeployedGuardPolicies("dummy");
+        }).hasMessage("No policy type defined for dummy");
+
+        try (PolicyModelsProvider databaseProvider =
+                new PolicyModelsProviderFactory().createPolicyModelsProvider(providerParams)) {
+            assertEquals(0, databaseProvider.getPdpGroups("name").size());
+            assertEquals(0, databaseProvider.getFilteredPdpGroups(PdpGroupFilter.builder().build()).size());
+
+            assertNotNull(databaseProvider.createPdpGroups(new ArrayList<>()));
+            assertNotNull(databaseProvider.updatePdpGroups(new ArrayList<>()));
+
+            PdpGroup pdpGroup = new PdpGroup();
+            pdpGroup.setName("group");
+            pdpGroup.setVersion("1.2.3");
+            pdpGroup.setPdpGroupState(PdpState.ACTIVE);
+            pdpGroup.setPdpSubgroups(new ArrayList<>());
+            List<PdpGroup> groupList = new ArrayList<>();
+            groupList.add(pdpGroup);
+
+            PdpSubGroup pdpSubGroup = new PdpSubGroup();
+            pdpSubGroup.setPdpType("type");
+            pdpSubGroup.setDesiredInstanceCount(123);
+            pdpSubGroup.setSupportedPolicyTypes(new ArrayList<>());
+            pdpSubGroup.getSupportedPolicyTypes()
+                    .add(new ToscaPolicyTypeIdentifier(POLICY_TYPE_NAME, POLICY_TYPE_VERSION));
+            pdpGroup.getPdpSubgroups().add(pdpSubGroup);
+
+            Pdp pdp = new Pdp();
+            pdp.setInstanceId("type-0");
+            pdp.setMessage("Hello");
+            pdp.setPdpState(PdpState.ACTIVE);
+            pdp.setHealthy(PdpHealthStatus.UNKNOWN);
+            pdpSubGroup.setPdpInstances(new ArrayList<>());
+            pdpSubGroup.getPdpInstances().add(pdp);
+
+            // Create Pdp Groups
+            assertEquals(123, databaseProvider.createPdpGroups(groupList).get(0).getPdpSubgroups().get(0)
+                    .getDesiredInstanceCount());
+            assertEquals(1, databaseProvider.getPdpGroups("group").size());
+
+            // Create Policy Type
+            assertThatCode(() -> {
+                String policyTypeString =
+                        ApiTestSupportUtilities.yaml2Json(ResourceUtils.getResourceAsString(POLICY_TYPE_RESOURCE));
+                ToscaServiceTemplate policyTypeServiceTemplate =
+                        standardCoder.decode(policyTypeString, ToscaServiceTemplate.class);
+                policyTypeProvider.createPolicyType(policyTypeServiceTemplate);
+            }).doesNotThrowAnyException();
+
+            // Create Policy
+            assertThatCode(() -> {
+                String policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE);
+                LegacyGuardPolicyInput policyToCreate =
+                        standardCoder.decode(policyString, LegacyGuardPolicyInput.class);
+                Map<String, LegacyGuardPolicyOutput> policyCreated =
+                        guardPolicyProvider.createGuardPolicy(policyToCreate);
+                assertFalse(policyCreated.isEmpty());
+            }).doesNotThrowAnyException();
+
+            // Test fetchDeployedPolicies (deployedPolicyMap.isEmpty())==true
+            assertThatThrownBy(() -> {
+                guardPolicyProvider.fetchDeployedGuardPolicies(POLICY_NAME);
+            })  .hasMessage("could not find policy with ID " + POLICY_NAME + " and type " + POLICY_TYPE_ID
+                    + " deployed in any pdp group");
+
+
+            // Update pdpSubGroup
+            pdpSubGroup.setPolicies(new ArrayList<>());
+            pdpSubGroup.getPolicies()
+                    .add(new ToscaPolicyIdentifier(POLICY_NAME, POLICY_VERSION + LEGACY_MINOR_PATCH_SUFFIX));
+            assertEquals(1,
+                    databaseProvider.createPdpGroups(groupList).get(0).getPdpSubgroups().get(0).getPolicies().size());
+
+            // Test fetchDeployedPolicies
+            assertThatCode(() -> {
+                guardPolicyProvider.fetchDeployedGuardPolicies(POLICY_NAME);
+            }).doesNotThrowAnyException();
+
+            // Test validateDeleteEligibility exception path(!pdpGroups.isEmpty())
+            assertThatThrownBy(() -> {
+                guardPolicyProvider.deleteGuardPolicy(POLICY_NAME, POLICY_VERSION);
+            })  .hasMessageContaining("policy with ID " + POLICY_NAME + ":" + POLICY_VERSION
+                    + " cannot be deleted as it is deployed in pdp groups");
+        } catch (Exception exc) {
+            fail("Test should not throw an exception");
+        }
     }
 
     @Test
     public void testCreateGuardPolicy() {
 
+        assertThatThrownBy(() -> {
+            String policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE);
+            LegacyGuardPolicyInput policyToCreate = standardCoder.decode(policyString, LegacyGuardPolicyInput.class);
+            guardPolicyProvider.createGuardPolicy(policyToCreate);
+        }).hasMessage("policy type " + POLICY_TYPE_ID + " for policy " + POLICY_ID + " does not exist");
+
+        assertThatCode(() -> {
+            String policyTypeString =
+                    ApiTestSupportUtilities.yaml2Json(ResourceUtils.getResourceAsString(POLICY_TYPE_RESOURCE));
+            ToscaServiceTemplate policyTypeServiceTemplate =
+                    standardCoder.decode(policyTypeString, ToscaServiceTemplate.class);
+            policyTypeProvider.createPolicyType(policyTypeServiceTemplate);
+
+            String policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE);
+            LegacyGuardPolicyInput policyToCreate = standardCoder.decode(policyString, LegacyGuardPolicyInput.class);
+            Map<String, LegacyGuardPolicyOutput> createdPolicy = guardPolicyProvider.createGuardPolicy(policyToCreate);
+            assertNotNull(createdPolicy);
+            assertFalse(createdPolicy.isEmpty());
+            assertTrue(createdPolicy.containsKey("guard.frequency.scaleout"));
+            assertEquals("onap.policies.controlloop.guard.FrequencyLimiter",
+                    createdPolicy.get("guard.frequency.scaleout").getType());
+            assertEquals("1.0.0", createdPolicy.get("guard.frequency.scaleout").getVersion());
+        }).doesNotThrowAnyException();
+    }
+
+    @Test
+    public void testDeleteGuardPolicyException() {
+        String policyId = "guard.frequency.scaleout";
+        String policyVersion = "1";
+        String policyTypeVersion = "1.0.0";
+        String policyTypeId = "onap.policies.controlloop.guard.FrequencyLimiter";
+        String legacyMinorPatchSuffix = ".0.0";
+
+        try (PolicyModelsProvider databaseProvider =
+                new PolicyModelsProviderFactory().createPolicyModelsProvider(providerParams)) {
+            assertEquals(0, databaseProvider.getPdpGroups("name").size());
+            assertEquals(0, databaseProvider.getFilteredPdpGroups(PdpGroupFilter.builder().build()).size());
+
+            assertNotNull(databaseProvider.createPdpGroups(new ArrayList<>()));
+            assertNotNull(databaseProvider.updatePdpGroups(new ArrayList<>()));
+
+            PdpGroup pdpGroup = new PdpGroup();
+            pdpGroup.setName("group");
+            pdpGroup.setVersion("1.2.3");
+            pdpGroup.setPdpGroupState(PdpState.ACTIVE);
+            pdpGroup.setPdpSubgroups(new ArrayList<>());
+            List<PdpGroup> groupList = new ArrayList<>();
+            groupList.add(pdpGroup);
+
+            PdpSubGroup pdpSubGroup = new PdpSubGroup();
+            pdpSubGroup.setPdpType("type");
+            pdpSubGroup.setDesiredInstanceCount(123);
+            pdpSubGroup.setSupportedPolicyTypes(new ArrayList<>());
+            pdpSubGroup.getSupportedPolicyTypes().add(new ToscaPolicyTypeIdentifier(policyTypeId, policyTypeVersion));
+            pdpGroup.getPdpSubgroups().add(pdpSubGroup);
+
+            Pdp pdp = new Pdp();
+            pdp.setInstanceId("type-0");
+            pdp.setMessage("Hello");
+            pdp.setPdpState(PdpState.ACTIVE);
+            pdp.setHealthy(PdpHealthStatus.UNKNOWN);
+            pdpSubGroup.setPdpInstances(new ArrayList<>());
+            pdpSubGroup.getPdpInstances().add(pdp);
+
+            // Create Pdp Groups
+            assertEquals(123, databaseProvider.createPdpGroups(groupList).get(0).getPdpSubgroups().get(0)
+                    .getDesiredInstanceCount());
+            assertEquals(1, databaseProvider.getPdpGroups("group").size());
+
+            // Create Policy Type
+            assertThatCode(() -> {
+                String policyTypeString =
+                        ApiTestSupportUtilities.yaml2Json(ResourceUtils.getResourceAsString(POLICY_TYPE_RESOURCE));
+                ToscaServiceTemplate policyTypeServiceTemplate =
+                        standardCoder.decode(policyTypeString, ToscaServiceTemplate.class);
+                policyTypeProvider.createPolicyType(policyTypeServiceTemplate);
+            }).doesNotThrowAnyException();
+
+            // Create Policy
+            assertThatCode(() -> {
+                String policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE);
+                LegacyGuardPolicyInput policyToCreate =
+                        standardCoder.decode(policyString, LegacyGuardPolicyInput.class);
+                Map<String, LegacyGuardPolicyOutput> createdPolicy =
+                        guardPolicyProvider.createGuardPolicy(policyToCreate);
+                assertNotNull(createdPolicy);
+                assertFalse(createdPolicy.isEmpty());
+            }).doesNotThrowAnyException();
+
+            // Update pdpSubGroup
+            pdpSubGroup.setPolicies(new ArrayList<>());
+            pdpSubGroup.getPolicies().add(new ToscaPolicyIdentifier(policyId, policyVersion + legacyMinorPatchSuffix));
+            assertEquals(1,
+                    databaseProvider.createPdpGroups(groupList).get(0).getPdpSubgroups().get(0).getPolicies().size());
+            assertThatThrownBy(() -> {
+                guardPolicyProvider.deleteGuardPolicy("guard.frequency.scaleout", "1");
+            }).hasMessageContaining("cannot be deleted as it is deployed in pdp groups");
+        } catch (Exception exc) {
+            fail("Test should not throw an exception");
+        }
     }
 
     @Test
     public void testDeleteGuardPolicy() {
+        assertThatThrownBy(() -> {
+            guardPolicyProvider.deleteGuardPolicy("dummy", null);
+        }).hasMessage("legacy policy version is not an integer");
+
+        assertThatThrownBy(() -> {
+            guardPolicyProvider.deleteGuardPolicy("dummy", "1.0.0");
+        }).hasMessage("legacy policy version is not an integer");
+
+        assertThatCode(() -> {
+            String policyTypeString =
+                    ApiTestSupportUtilities.yaml2Json(ResourceUtils.getResourceAsString(POLICY_TYPE_RESOURCE));
+            ToscaServiceTemplate policyTypeServiceTemplate =
+                    standardCoder.decode(policyTypeString, ToscaServiceTemplate.class);
+            policyTypeProvider.createPolicyType(policyTypeServiceTemplate);
+
+            String policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE);
+            LegacyGuardPolicyInput policyToCreate = standardCoder.decode(policyString, LegacyGuardPolicyInput.class);
+            Map<String, LegacyGuardPolicyOutput> createdPolicy = guardPolicyProvider.createGuardPolicy(policyToCreate);
+            assertNotNull(createdPolicy);
+            assertFalse(createdPolicy.isEmpty());
+
+            Map<String, LegacyGuardPolicyOutput> deletedPolicy =
+                    guardPolicyProvider.deleteGuardPolicy("guard.frequency.scaleout", "1");
+            assertNotNull(deletedPolicy);
+            assertFalse(deletedPolicy.isEmpty());
+            assertTrue(deletedPolicy.containsKey("guard.frequency.scaleout"));
+            assertEquals("onap.policies.controlloop.guard.FrequencyLimiter",
+                    deletedPolicy.get("guard.frequency.scaleout").getType());
+            assertEquals("1",
+                    deletedPolicy.get("guard.frequency.scaleout").getMetadata().get("policy-version").toString());
+
+        }).doesNotThrowAnyException();
+
+        assertThatThrownBy(() -> {
+            guardPolicyProvider.deleteGuardPolicy("guard.frequency.scaleout", "1");
+        }).hasMessage("no policy found for policy: guard.frequency.scaleout:1");
 
+        assertThatCode(() -> {
+            policyTypeProvider.deletePolicyType("onap.policies.controlloop.guard.FrequencyLimiter", "1.0.0");
+        }).doesNotThrowAnyException();
     }
 }