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