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

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