main/src/test/java/org/onap/policy/api/main/rest/provider/TestPolicyProvider.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy API
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.api.main.rest.provider;
  24
  25 import static org.assertj.core.api.Assertions.assertThatCode;
  26 import static org.assertj.core.api.Assertions.assertThatThrownBy;
  27 import static org.junit.Assert.assertEquals;
  28 import static org.junit.Assert.assertFalse;
  29 import static org.junit.Assert.assertNotNull;
  30 import static org.junit.Assert.fail;
  31
  32 import java.util.ArrayList;
  33 import java.util.Base64;
  34 import java.util.List;
  35
  36 import org.junit.After;
  37 import org.junit.Before;
  38 import org.junit.Test;
  39 import org.onap.policy.api.main.parameters.ApiParameterGroup;
  40 import org.onap.policy.common.parameters.ParameterService;
  41 import org.onap.policy.common.utils.coder.StandardCoder;
  42 import org.onap.policy.common.utils.resources.ResourceUtils;
  43 import org.onap.policy.models.base.PfModelException;
  44 import org.onap.policy.models.pdp.concepts.Pdp;
  45 import org.onap.policy.models.pdp.concepts.PdpGroup;
  46 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
  47 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
  48 import org.onap.policy.models.pdp.enums.PdpHealthStatus;
  49 import org.onap.policy.models.pdp.enums.PdpState;
  50 import org.onap.policy.models.provider.PolicyModelsProvider;
  51 import org.onap.policy.models.provider.PolicyModelsProviderFactory;
  52 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  53 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
  54 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
  55 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  56
  57 /**
  58  * This class performs unit test of {@link PolicyProvider}
  59  *
  60  * @author Chenfei Gao (cgao@research.att.com)
  61  */
  62 public class TestPolicyProvider {
  63
  64     private static PolicyProvider policyProvider;
  65     private static PolicyTypeProvider policyTypeProvider;
  66     private static PolicyModelsProviderParameters providerParams;
  67     private static ApiParameterGroup apiParamGroup;
  68     private static StandardCoder standardCoder;
  69
  70     private static final String POLICY_RESOURCE = "policies/vCPE.policy.monitoring.input.tosca.json";
  71     private static final String POLICY_TYPE_RESOURCE = "policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.json";
  72     private static final String POLICY_RESOURCE_WITH_BAD_POLICYTYPE_ID = "policies/vCPE.policy.bad.policytypeid.json";
  73     private static final String POLICY_RESOURCE_WITH_BAD_POLICYTYPE_VERSION =
  74             "policies/vCPE.policy.bad.policytypeversion.json";
  75
  76     /**
  77      * Initializes parameters.
  78      *
  79      * @throws PfModelException the PfModel parsing exception
  80      */
  81     @Before
  82     public void setupParameters() throws PfModelException {
  83
  84         standardCoder = new StandardCoder();
  85         providerParams = new PolicyModelsProviderParameters();
  86         providerParams.setDatabaseDriver("org.h2.Driver");
  87         providerParams.setDatabaseUrl("jdbc:h2:mem:testdb");
  88         providerParams.setDatabaseUser("policy");
  89         providerParams.setDatabasePassword(Base64.getEncoder().encodeToString("P01icY".getBytes()));
  90         providerParams.setPersistenceUnit("ToscaConceptTest");
  91         apiParamGroup = new ApiParameterGroup("ApiGroup", null, providerParams);
  92         ParameterService.register(apiParamGroup, true);
  93         policyTypeProvider = new PolicyTypeProvider();
  94         policyProvider = new PolicyProvider();
  95     }
  96
  97     /**
  98      * Closes up DB connections and deregisters API parameter group.
  99      *
 100      * @throws PfModelException the PfModel parsing exception
 101      */
 102     @After
 103     public void tearDown() throws PfModelException {
 104
 105         policyTypeProvider.close();
 106         policyProvider.close();
 107         ParameterService.deregister(apiParamGroup);
 108     }
 109
 110     @Test
 111     public void testFetchPolicies() {
 112
 113         assertThatThrownBy(() -> {
 114             policyProvider.fetchPolicies("dummy", "1.0.0", null, null);
 115         }).hasMessage("policy with ID null:null and type dummy:1.0.0 does not exist");
 116
 117         assertThatThrownBy(() -> {
 118             policyProvider.fetchPolicies("dummy", "1.0.0", "dummy", null);
 119         }).hasMessage("policy with ID dummy:null and type dummy:1.0.0 does not exist");
 120
 121         assertThatThrownBy(() -> {
 122             policyProvider.fetchPolicies("dummy", "1.0.0", "dummy", "1.0.0");
 123         }).hasMessage("policy with ID dummy:1.0.0 and type dummy:1.0.0 does not exist");
 124     }
 125
 126     @Test
 127     public void testFetchLatestPolicies() {
 128
 129         assertThatThrownBy(() -> {
 130             policyProvider.fetchLatestPolicies("dummy", "dummy", "dummy");
 131         }).hasMessage("policy with ID dummy:null and type dummy:dummy does not exist");
 132     }
 133
 134
 135     @Test
 136     public void testFetchDeployedPolicies() {
 137         String policyId = "onap.restart.tca";
 138         String policyVersion = "1.0.0";
 139         String policyTypeVersion = "1.0.0";
 140         String policyTypeId = "onap.policies.monitoring.cdap.tca.hi.lo.app";
 141
 142         //Basic Exception Throw
 143         assertThatThrownBy(() -> {
 144             policyProvider.fetchDeployedPolicies("dummy", "dummy", "dummy");
 145         }).hasMessage("could not find policy with ID dummy and type dummy:dummy deployed in any pdp group");
 146
 147         try (PolicyModelsProvider databaseProvider =
 148                 new PolicyModelsProviderFactory().createPolicyModelsProvider(providerParams)) {
 149             assertEquals(0, databaseProvider.getPdpGroups("name").size());
 150             assertEquals(0, databaseProvider.getFilteredPdpGroups(PdpGroupFilter.builder().build()).size());
 151
 152             assertNotNull(databaseProvider.createPdpGroups(new ArrayList<>()));
 153             assertNotNull(databaseProvider.updatePdpGroups(new ArrayList<>()));
 154
 155             PdpGroup pdpGroup = new PdpGroup();
 156             pdpGroup.setName("group");
 157             pdpGroup.setVersion("1.2.3");
 158             pdpGroup.setPdpGroupState(PdpState.ACTIVE);
 159             pdpGroup.setPdpSubgroups(new ArrayList<>());
 160             List<PdpGroup> groupList = new ArrayList<>();
 161             groupList.add(pdpGroup);
 162
 163             PdpSubGroup pdpSubGroup = new PdpSubGroup();
 164             pdpSubGroup.setPdpType("type");
 165             pdpSubGroup.setDesiredInstanceCount(123);
 166             pdpSubGroup.setSupportedPolicyTypes(new ArrayList<>());
 167             pdpSubGroup.getSupportedPolicyTypes().add(new ToscaPolicyTypeIdentifier(
 168                     policyTypeId, policyTypeVersion));
 169             pdpGroup.getPdpSubgroups().add(pdpSubGroup);
 170
 171             Pdp pdp = new Pdp();
 172             pdp.setInstanceId("type-0");
 173             pdp.setMessage("Hello");
 174             pdp.setPdpState(PdpState.ACTIVE);
 175             pdp.setHealthy(PdpHealthStatus.UNKNOWN);
 176             pdpSubGroup.setPdpInstances(new ArrayList<>());
 177             pdpSubGroup.getPdpInstances().add(pdp);
 178
 179             // Create Pdp Groups
 180             assertEquals(123, databaseProvider.createPdpGroups(groupList).get(0).getPdpSubgroups().get(0)
 181                     .getDesiredInstanceCount());
 182             assertEquals(1, databaseProvider.getPdpGroups("group").size());
 183
 184             // Create Policy Type
 185             assertThatCode(() -> {
 186                 String policyTypeString = ResourceUtils.getResourceAsString(POLICY_TYPE_RESOURCE);
 187                 ToscaServiceTemplate policyTypeServiceTemplate =
 188                         standardCoder.decode(policyTypeString, ToscaServiceTemplate.class);
 189                 policyTypeProvider.createPolicyType(policyTypeServiceTemplate);
 190             }).doesNotThrowAnyException();
 191
 192             // Create Policy
 193             assertThatCode(() -> {
 194                 String policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE);
 195                 ToscaServiceTemplate policyServiceTemplate =
 196                         standardCoder.decode(policyString, ToscaServiceTemplate.class);
 197                 ToscaServiceTemplate serviceTemplate = policyProvider
 198                         .createPolicy(policyTypeId, policyTypeVersion, policyServiceTemplate);
 199                 assertFalse(serviceTemplate.getToscaTopologyTemplate().getPolicies().get(0).isEmpty());
 200             }).doesNotThrowAnyException();
 201
 202             // Test fetchDeployedPolicies (deployedPolicyMap.isEmpty())==true
 203             assertThatThrownBy(
 204                 () -> {
 205                     policyProvider.fetchDeployedPolicies(
 206                         policyTypeId, policyTypeVersion, policyId);
 207                 }).hasMessage("could not find policy with ID " + policyId + " and type "
 208                     + policyTypeId + ":" + policyTypeVersion + " deployed in any pdp group");
 209
 210
 211             // Update pdpSubGroup
 212             pdpSubGroup.setPolicies(new ArrayList<>());
 213             pdpSubGroup.getPolicies().add(new ToscaPolicyIdentifier(policyId, policyVersion));
 214             assertEquals(1, databaseProvider.createPdpGroups(groupList).get(0).getPdpSubgroups().get(0)
 215                     .getPolicies().size());
 216
 217             // Test fetchDeployedPolicies
 218             assertThatCode(
 219                 () -> {
 220                     policyProvider.fetchDeployedPolicies(
 221                             policyTypeId, policyTypeVersion, policyId);
 222                 }).doesNotThrowAnyException();
 223
 224             // Test validateDeleteEligibility exception path(!pdpGroups.isEmpty())
 225             assertThatThrownBy(
 226                 () -> {
 227                     policyProvider.deletePolicy(
 228                             "onap.policies.monitoring.cdap.tca.hi.lo.app", "1.0.0",
 229                             "onap.restart.tca", "1.0.0");
 230                 }).hasMessageContaining("policy with ID " + policyId + ":" + policyVersion
 231                     + " cannot be deleted as it is deployed in pdp groups");
 232         }
 233         catch (Exception exc) {
 234             fail("Test should not throw an exception");
 235         }
 236     }
 237
 238     @Test
 239     public void testCreatePolicy() {
 240
 241         assertThatThrownBy(() -> {
 242             policyProvider.createPolicy("dummy", "1.0.0", new ToscaServiceTemplate());
 243         }).hasMessage("policy type with ID dummy:1.0.0 does not exist");
 244
 245         assertThatCode(() -> {
 246             String policyTypeString = ResourceUtils.getResourceAsString(POLICY_TYPE_RESOURCE);
 247             ToscaServiceTemplate policyTypeServiceTemplate =
 248                     standardCoder.decode(policyTypeString, ToscaServiceTemplate.class);
 249             policyTypeProvider.createPolicyType(policyTypeServiceTemplate);
 250         }).doesNotThrowAnyException();
 251
 252         assertThatThrownBy(() -> {
 253             String badPolicyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE_WITH_BAD_POLICYTYPE_ID);
 254             ToscaServiceTemplate badPolicyServiceTemplate =
 255                     standardCoder.decode(badPolicyString, ToscaServiceTemplate.class);
 256             policyProvider.createPolicy("onap.policies.monitoring.cdap.tca.hi.lo.app", "1.0.0",
 257                     badPolicyServiceTemplate);
 258         }).hasMessage("policy type id does not match");
 259
 260         assertThatThrownBy(() -> {
 261             String badPolicyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE_WITH_BAD_POLICYTYPE_VERSION);
 262             ToscaServiceTemplate badPolicyServiceTemplate =
 263                     standardCoder.decode(badPolicyString, ToscaServiceTemplate.class);
 264             policyProvider.createPolicy("onap.policies.monitoring.cdap.tca.hi.lo.app", "1.0.0",
 265                     badPolicyServiceTemplate);
 266         }).hasMessage("policy type version does not match");
 267
 268         assertThatCode(() -> {
 269             String policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE);
 270             ToscaServiceTemplate policyServiceTemplate =
 271                     standardCoder.decode(policyString, ToscaServiceTemplate.class);
 272             ToscaServiceTemplate serviceTemplate = policyProvider
 273                     .createPolicy("onap.policies.monitoring.cdap.tca.hi.lo.app", "1.0.0", policyServiceTemplate);
 274             assertFalse(serviceTemplate.getToscaTopologyTemplate().getPolicies().get(0).isEmpty());
 275         }).doesNotThrowAnyException();
 276     }
 277
 278     @Test
 279     public void testDeletePolicy() {
 280
 281         assertThatThrownBy(() -> {
 282             policyProvider.deletePolicy("dummy", "1.0.0", "dummy", "1.0.0");
 283         }).hasMessage("policy with ID dummy:1.0.0 and type dummy:1.0.0 does not exist");
 284
 285         assertThatCode(() -> {
 286             String policyTypeString = ResourceUtils.getResourceAsString(POLICY_TYPE_RESOURCE);
 287             ToscaServiceTemplate policyTypeServiceTemplate =
 288                     standardCoder.decode(policyTypeString, ToscaServiceTemplate.class);
 289             policyTypeProvider.createPolicyType(policyTypeServiceTemplate);
 290         }).doesNotThrowAnyException();
 291
 292         assertThatCode(() -> {
 293             String policyString = ResourceUtils.getResourceAsString(POLICY_RESOURCE);
 294             ToscaServiceTemplate policyServiceTemplate =
 295                     standardCoder.decode(policyString, ToscaServiceTemplate.class);
 296             ToscaServiceTemplate serviceTemplate = policyProvider
 297                     .createPolicy("onap.policies.monitoring.cdap.tca.hi.lo.app", "1.0.0", policyServiceTemplate);
 298             assertFalse(serviceTemplate.getToscaTopologyTemplate().getPolicies().get(0).isEmpty());
 299         }).doesNotThrowAnyException();
 300
 301         assertThatCode(() -> {
 302             ToscaServiceTemplate serviceTemplate = policyProvider.deletePolicy(
 303                     "onap.policies.monitoring.cdap.tca.hi.lo.app", "1.0.0", "onap.restart.tca", "1.0.0");
 304             assertFalse(serviceTemplate.getToscaTopologyTemplate().getPolicies().get(0).isEmpty());
 305         }).doesNotThrowAnyException();
 306
 307         String exceptionMessage = "policy with ID onap.restart.tca:1.0.0 and type "
 308             + "onap.policies.monitoring.cdap.tca.hi.lo.app:1.0.0 does not exist";
 309         assertThatThrownBy(() -> {
 310             policyProvider.deletePolicy("onap.policies.monitoring.cdap.tca.hi.lo.app", "1.0.0",
 311                     "onap.restart.tca", "1.0.0");
 312         }).hasMessage(exceptionMessage);
 313     }
 314
 315 }