main/src/main/java/org/onap/policy/pap/main/comm/PdpStatusMessageHandler.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019-2021 AT&T Intellectual Property.
   5  *  Modifications Copyright (C) 2021 Bell Canada. 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.pap.main.comm;
  24
  25 import java.sql.SQLIntegrityConstraintViolationException;
  26 import java.time.Instant;
  27 import java.util.Arrays;
  28 import java.util.Collections;
  29 import java.util.HashMap;
  30 import java.util.LinkedList;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Optional;
  34 import java.util.concurrent.TimeUnit;
  35 import java.util.stream.Collectors;
  36 import org.apache.commons.lang3.builder.EqualsBuilder;
  37 import org.eclipse.persistence.exceptions.EclipseLinkException;
  38 import org.onap.policy.models.base.PfModelException;
  39 import org.onap.policy.models.pdp.concepts.Pdp;
  40 import org.onap.policy.models.pdp.concepts.PdpGroup;
  41 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
  42 import org.onap.policy.models.pdp.concepts.PdpStatistics;
  43 import org.onap.policy.models.pdp.concepts.PdpStatus;
  44 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
  45 import org.onap.policy.models.pdp.enums.PdpState;
  46 import org.onap.policy.models.provider.PolicyModelsProvider;
  47 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  49 import org.onap.policy.pap.main.PolicyPapException;
  50 import org.onap.policy.pap.main.parameters.PdpParameters;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54
  55 /**
  56  * Handler for PDP Status messages which either represent registration or heart beat.
  57  *
  58  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  59  */
  60 public class PdpStatusMessageHandler extends PdpMessageGenerator {
  61     private static final Logger LOGGER = LoggerFactory.getLogger(PdpStatusMessageHandler.class);
  62
  63     private final PdpParameters params;
  64
  65     private final boolean savePdpStatistics;
  66
  67     /**
  68      * List to store policies present in db.
  69      */
  70     List<ToscaPolicy> policies = new LinkedList<>();
  71
  72     /**
  73      * List to store policies to be deployed (heartbeat).
  74      */
  75     Map<ToscaConceptIdentifier, ToscaPolicy> policiesToBeDeployed = new HashMap<>();
  76
  77     /**
  78      * List to store policies to be undeployed (heartbeat).
  79      */
  80     List<ToscaConceptIdentifier> policiesToBeUndeployed = new LinkedList<>();
  81
  82     /**
  83      * Constructs the object.
  84      *
  85      * @param params PDP parameters
  86      */
  87     public PdpStatusMessageHandler(PdpParameters params, boolean savePdpStatistics) {
  88         super(true);
  89         this.params = params;
  90         this.savePdpStatistics = savePdpStatistics;
  91     }
  92
  93     /**
  94      * Handles the PdpStatus message coming from various PDP's.
  95      *
  96      * @param message the PdpStatus message
  97      */
  98     public void handlePdpStatus(final PdpStatus message) {
  99         if (message.getPolicies() == null) {
 100             message.setPolicies(Collections.emptyList());
 101         }
 102
 103         long diffms = System.currentTimeMillis() - message.getTimestampMs();
 104         if (diffms > params.getMaxMessageAgeMs()) {
 105             long diffsec = TimeUnit.SECONDS.convert(diffms, TimeUnit.MILLISECONDS);
 106             LOGGER.info("discarding status message from {} age {}s", message.getName(), diffsec);
 107             return;
 108         }
 109
 110         synchronized (updateLock) {
 111             try (PolicyModelsProvider databaseProvider = modelProviderWrapper.create()) {
 112                 if (message.getPdpSubgroup() == null) {
 113                     handlePdpRegistration(message, databaseProvider);
 114                 } else {
 115                     handlePdpHeartbeat(message, databaseProvider);
 116                 }
 117             } catch (final PolicyPapException exp) {
 118                 LOGGER.error("Operation Failed", exp);
 119             } catch (final Exception exp) {
 120                 if (isDuplicateKeyException(exp)) {
 121                     /*
 122                      * this is to be expected, if multiple PAPs are processing the same
 123                      * heartbeat at a time, thus we log the exception at a trace level
 124                      * instead of an error level.
 125                      */
 126                     LOGGER.info("Failed updating PDP information for {} - may have been added by another PAP",
 127                                     message.getName());
 128                     LOGGER.trace("Failed updating PDP information for {}", message.getName(), exp);
 129                 } else {
 130                     LOGGER.error("Failed connecting to database provider", exp);
 131                 }
 132             }
 133         }
 134     }
 135
 136     /**
 137      * Determines if the exception indicates a duplicate key.
 138      *
 139      * @param thrown exception to check
 140      * @return {@code true} if the exception occurred due to a duplicate key
 141      */
 142     protected static boolean isDuplicateKeyException(Throwable thrown) {
 143         while (thrown != null) {
 144             if (thrown instanceof SQLIntegrityConstraintViolationException) {
 145                 return true;
 146             }
 147
 148             if (thrown instanceof EclipseLinkException) {
 149                 EclipseLinkException ele = (EclipseLinkException) thrown;
 150                 if (isDuplicateKeyException(ele.getInternalException())) {
 151                     return true;
 152                 }
 153             }
 154
 155             thrown = thrown.getCause();
 156         }
 157
 158         return false;
 159     }
 160
 161     private void handlePdpRegistration(final PdpStatus message, final PolicyModelsProvider databaseProvider)
 162             throws PfModelException, PolicyPapException {
 163         if (!findAndUpdatePdpGroup(message, databaseProvider)) {
 164             final var errorMessage = "Failed to register PDP. No matching PdpGroup/SubGroup Found - ";
 165             LOGGER.debug("{}{}", errorMessage, message);
 166             throw new PolicyPapException(errorMessage + message);
 167         }
 168     }
 169
 170     private boolean findAndUpdatePdpGroup(final PdpStatus message, final PolicyModelsProvider databaseProvider)
 171             throws PfModelException {
 172         var pdpGroupFound = false;
 173         final PdpGroupFilter filter =
 174                 PdpGroupFilter.builder().name(message.getPdpGroup()).groupState(PdpState.ACTIVE).build();
 175
 176         final List<PdpGroup> pdpGroups = databaseProvider.getFilteredPdpGroups(filter);
 177         if (!pdpGroups.isEmpty()) {
 178             pdpGroupFound = registerPdp(message, databaseProvider, pdpGroups.get(0));
 179         }
 180         return pdpGroupFound;
 181     }
 182
 183     private boolean registerPdp(final PdpStatus message, final PolicyModelsProvider databaseProvider,
 184             final PdpGroup finalizedPdpGroup) throws PfModelException {
 185         Optional<PdpSubGroup> subGroup;
 186         var pdpGroupFound = false;
 187         subGroup = findPdpSubGroup(message, finalizedPdpGroup);
 188
 189         if (subGroup.isPresent()) {
 190             policies = getToscaPolicies(subGroup.get(), databaseProvider);
 191             policiesToBeDeployed = policies.stream().collect(Collectors
 192                     .toMap(ToscaPolicy::getIdentifier, policy -> policy));
 193             policiesToBeUndeployed = null;
 194
 195             LOGGER.debug("Found pdpGroup - {}, going for registration of PDP - {}", finalizedPdpGroup, message);
 196             Optional<Pdp> pdp = findPdpInstance(message, subGroup.get());
 197             if (pdp.isPresent()) {
 198                 updatePdpHealthStatus(message, subGroup.get(), pdp.get(), finalizedPdpGroup, databaseProvider);
 199             } else {
 200                 updatePdpSubGroup(finalizedPdpGroup, subGroup.get(), message, databaseProvider);
 201             }
 202             sendPdpMessage(finalizedPdpGroup.getName(), subGroup.get(), message.getName(), null, databaseProvider);
 203             pdpGroupFound = true;
 204         }
 205         return pdpGroupFound;
 206     }
 207
 208     private void updatePdpSubGroup(final PdpGroup pdpGroup, final PdpSubGroup pdpSubGroup, final PdpStatus message,
 209             final PolicyModelsProvider databaseProvider) throws PfModelException {
 210
 211         final var pdpInstance = new Pdp();
 212         pdpInstance.setInstanceId(message.getName());
 213         pdpInstance.setPdpState(PdpState.ACTIVE);
 214         pdpInstance.setHealthy(message.getHealthy());
 215         pdpInstance.setMessage(message.getDescription());
 216         pdpInstance.setLastUpdate(Instant.now());
 217         pdpSubGroup.getPdpInstances().add(pdpInstance);
 218
 219         pdpSubGroup.setCurrentInstanceCount(pdpSubGroup.getCurrentInstanceCount() + 1);
 220
 221         databaseProvider.updatePdpSubGroup(pdpGroup.getName(), pdpSubGroup);
 222
 223         LOGGER.debug("Updated PdpSubGroup in DB - {} belonging to PdpGroup - {}", pdpSubGroup, pdpGroup.getName());
 224     }
 225
 226     private void handlePdpHeartbeat(final PdpStatus message, final PolicyModelsProvider databaseProvider)
 227             throws PfModelException {
 228
 229         final PdpGroupFilter filter =
 230                 PdpGroupFilter.builder().name(message.getPdpGroup()).groupState(PdpState.ACTIVE).build();
 231         final List<PdpGroup> pdpGroups = databaseProvider.getFilteredPdpGroups(filter);
 232         if (!pdpGroups.isEmpty()) {
 233             var pdpGroup = pdpGroups.get(0);
 234             Optional<PdpSubGroup> pdpSubgroup = findPdpSubGroup(message, pdpGroup);
 235             if (pdpSubgroup.isPresent()) {
 236                 Optional<Pdp> pdpInstance = findPdpInstance(message, pdpSubgroup.get());
 237                 if (pdpInstance.isPresent()) {
 238                     processPdpDetails(message, pdpSubgroup.get(), pdpInstance.get(), pdpGroup, databaseProvider);
 239                 } else {
 240                     LOGGER.debug("PdpInstance not Found in DB. Sending Pdp for registration - {}", message);
 241                     registerPdp(message, databaseProvider, pdpGroup);
 242                 }
 243             }
 244         }
 245     }
 246
 247     private Optional<PdpSubGroup> findPdpSubGroup(final PdpStatus message, final PdpGroup pdpGroup) {
 248         PdpSubGroup pdpSubgroup = null;
 249         for (final PdpSubGroup subGroup : pdpGroup.getPdpSubgroups()) {
 250             if (message.getPdpType().equals(subGroup.getPdpType())) {
 251                 pdpSubgroup = subGroup;
 252                 break;
 253             }
 254         }
 255         return Optional.ofNullable(pdpSubgroup);
 256     }
 257
 258     private Optional<Pdp> findPdpInstance(final PdpStatus message, final PdpSubGroup subGroup) {
 259         Pdp pdpInstance = null;
 260         for (final Pdp pdpInstanceDetails : subGroup.getPdpInstances()) {
 261             if (pdpInstanceDetails.getInstanceId().equals(message.getName())) {
 262                 pdpInstance = pdpInstanceDetails;
 263                 break;
 264             }
 265         }
 266         return Optional.ofNullable(pdpInstance);
 267     }
 268
 269     private void processPdpDetails(final PdpStatus message, final PdpSubGroup pdpSubGroup, final Pdp pdpInstance,
 270             final PdpGroup pdpGroup, final PolicyModelsProvider databaseProvider)
 271                     throws PfModelException {
 272         // all policies
 273         policies = getToscaPolicies(pdpSubGroup, databaseProvider);
 274
 275         Map<ToscaConceptIdentifier, ToscaPolicy> policyMap =
 276                         policies.stream().collect(Collectors.toMap(ToscaPolicy::getIdentifier, policy -> policy));
 277
 278         // policies that the PDP already has (-) all
 279         policiesToBeUndeployed = message.getPolicies().stream().filter(policyId -> !policyMap.containsKey(policyId))
 280                         .collect(Collectors.toList());
 281
 282         // all (-) policies that the PDP already has
 283         policiesToBeDeployed = policyMap;
 284         policiesToBeDeployed.keySet().removeAll(message.getPolicies());
 285
 286         if (PdpState.TERMINATED.equals(message.getState())) {
 287             processPdpTermination(pdpSubGroup, pdpInstance, pdpGroup, databaseProvider);
 288         } else if (validatePdpDetails(message, pdpGroup, pdpSubGroup, pdpInstance)) {
 289             LOGGER.debug("PdpInstance details are correct. Saving current state in DB - {}", pdpInstance);
 290             updatePdpHealthStatus(message, pdpSubGroup, pdpInstance, pdpGroup, databaseProvider);
 291
 292             if (savePdpStatistics) {
 293                 processPdpStatistics(message, pdpSubGroup, pdpInstance, pdpGroup, databaseProvider);
 294             } else {
 295                 LOGGER.debug("Not processing PdpStatistics - {}", message.getStatistics());
 296             }
 297         } else {
 298             LOGGER.debug("PdpInstance details are not correct. Sending PdpUpdate message - {}", pdpInstance);
 299             LOGGER.debug("Policy list in DB - {}. Policy list in heartbeat - {}", pdpSubGroup.getPolicies(),
 300                 message.getPolicies());
 301             updatePdpHealthStatus(message, pdpSubGroup, pdpInstance, pdpGroup, databaseProvider);
 302             sendPdpMessage(pdpGroup.getName(), pdpSubGroup, pdpInstance.getInstanceId(), pdpInstance.getPdpState(),
 303                 databaseProvider);
 304         }
 305     }
 306
 307     private void processPdpStatistics(final PdpStatus message, final PdpSubGroup pdpSubGroup, final Pdp pdpInstance,
 308                     final PdpGroup pdpGroup, final PolicyModelsProvider databaseProvider) throws PfModelException {
 309         if (validatePdpStatisticsDetails(message, pdpInstance, pdpGroup, pdpSubGroup)) {
 310             LOGGER.debug("PdpStatistics details are correct. Saving current statistics in DB - {}",
 311                     message.getStatistics());
 312             createPdpStatistics(message.getStatistics(), databaseProvider);
 313         } else {
 314             LOGGER.debug("PdpStatistics details are not correct - {}", message.getStatistics());
 315         }
 316     }
 317
 318     private void processPdpTermination(final PdpSubGroup pdpSubGroup, final Pdp pdpInstance, final PdpGroup pdpGroup,
 319             final PolicyModelsProvider databaseProvider) throws PfModelException {
 320         pdpSubGroup.getPdpInstances().remove(pdpInstance);
 321         pdpSubGroup.setCurrentInstanceCount(pdpSubGroup.getCurrentInstanceCount() - 1);
 322         databaseProvider.updatePdpSubGroup(pdpGroup.getName(), pdpSubGroup);
 323
 324         LOGGER.debug("Deleted PdpInstance - {} belonging to PdpSubGroup - {} and PdpGroup - {}", pdpInstance,
 325                 pdpSubGroup, pdpGroup);
 326     }
 327
 328     private boolean validatePdpDetails(final PdpStatus message, final PdpGroup pdpGroup, final PdpSubGroup subGroup,
 329             final Pdp pdpInstanceDetails) {
 330         /*
 331          * "EqualsBuilder" is a bit of a misnomer, as it uses containsAll() to check policies. Nevertheless, it does the
 332          * job and provides a convenient way to build a bunch of comparisons.
 333          */
 334         return new EqualsBuilder().append(message.getPdpGroup(), pdpGroup.getName())
 335                 .append(message.getPdpSubgroup(), subGroup.getPdpType())
 336                 .append(message.getPdpType(), subGroup.getPdpType())
 337                 .append(message.getState(), pdpInstanceDetails.getPdpState())
 338                 .append(message.getPolicies().containsAll(subGroup.getPolicies()), true)
 339                 .append(subGroup.getPolicies().containsAll(message.getPolicies()), true).build();
 340     }
 341
 342     private boolean validatePdpStatisticsDetails(final PdpStatus message, final Pdp pdpInstanceDetails,
 343             final PdpGroup pdpGroup, final PdpSubGroup pdpSubGroup) {
 344         if (message.getStatistics() != null) {
 345             return new EqualsBuilder()
 346                     .append(message.getStatistics().getPdpInstanceId(), pdpInstanceDetails.getInstanceId())
 347                     .append(message.getStatistics().getPdpGroupName(), pdpGroup.getName())
 348                     .append(message.getStatistics().getPdpSubGroupName(), pdpSubGroup.getPdpType())
 349                     .append(message.getStatistics().getPolicyDeployCount() < 0, false)
 350                     .append(message.getStatistics().getPolicyDeployFailCount() < 0, false)
 351                     .append(message.getStatistics().getPolicyDeploySuccessCount() < 0, false)
 352                     .append(message.getStatistics().getPolicyExecutedCount() < 0, false)
 353                     .append(message.getStatistics().getPolicyExecutedFailCount() < 0, false)
 354                     .append(message.getStatistics().getPolicyExecutedSuccessCount() < 0, false).build();
 355         } else {
 356             LOGGER.debug("PdpStatistics is null");
 357             return false;
 358         }
 359     }
 360
 361     private void updatePdpHealthStatus(final PdpStatus message, final PdpSubGroup pdpSubgroup, final Pdp pdpInstance,
 362             final PdpGroup pdpGroup, final PolicyModelsProvider databaseProvider) throws PfModelException {
 363         pdpInstance.setHealthy(message.getHealthy());
 364         pdpInstance.setMessage(message.getDescription());
 365         pdpInstance.setLastUpdate(Instant.now());
 366         databaseProvider.updatePdp(pdpGroup.getName(), pdpSubgroup.getPdpType(), pdpInstance);
 367
 368         LOGGER.debug("Updated Pdp in DB - {}", pdpInstance);
 369     }
 370
 371     private void createPdpStatistics(final PdpStatistics pdpStatistics, final PolicyModelsProvider databaseProvider)
 372             throws PfModelException {
 373         databaseProvider.createPdpStatistics(Arrays.asList(pdpStatistics));
 374         LOGGER.debug("Created PdpStatistics in DB - {}", pdpStatistics);
 375     }
 376
 377     private void sendPdpMessage(final String pdpGroupName, final PdpSubGroup subGroup, final String pdpInstanceId,
 378             final PdpState pdpState, final PolicyModelsProvider databaseProvider)
 379                     throws PfModelException {
 380         final List<ToscaPolicy> polsToBeDeployed = new LinkedList<>(policiesToBeDeployed.values());
 381         final var pdpUpdatemessage =
 382             createPdpUpdateMessage(pdpGroupName, subGroup, pdpInstanceId,
 383                         polsToBeDeployed, policiesToBeUndeployed);
 384         final var pdpStateChangeMessage =
 385             createPdpStateChangeMessage(pdpGroupName, subGroup, pdpInstanceId, pdpState);
 386         updateDeploymentStatus(pdpGroupName, subGroup.getPdpType(), pdpInstanceId, pdpStateChangeMessage.getState(),
 387             databaseProvider, pdpUpdatemessage.getPoliciesToBeDeployed());
 388
 389         requestMap.addRequest(pdpUpdatemessage, pdpStateChangeMessage);
 390         LOGGER.debug("Sent PdpUpdate message - {}", pdpUpdatemessage);
 391         LOGGER.debug("Sent PdpStateChange message - {}", pdpStateChangeMessage);
 392     }
 393 }