cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/inventory/sync/ModuleOperationsUtils.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022-2023 Nordix Foundation
   4  *  Modifications Copyright (C) 2022 Bell Canada
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.ncmp.api.impl.inventory.sync;
  23
  24 import static org.onap.cps.ncmp.api.impl.operations.DatastoreType.PASSTHROUGH_OPERATIONAL;
  25
  26 import com.fasterxml.jackson.databind.JsonNode;
  27 import java.time.Duration;
  28 import java.time.OffsetDateTime;
  29 import java.time.format.DateTimeFormatter;
  30 import java.util.ArrayList;
  31 import java.util.Collections;
  32 import java.util.HashMap;
  33 import java.util.Iterator;
  34 import java.util.List;
  35 import java.util.Map;
  36 import java.util.UUID;
  37 import java.util.regex.Matcher;
  38 import java.util.regex.Pattern;
  39 import lombok.RequiredArgsConstructor;
  40 import lombok.extern.slf4j.Slf4j;
  41 import org.apache.commons.lang3.StringUtils;
  42 import org.onap.cps.ncmp.api.impl.inventory.CmHandleQueries;
  43 import org.onap.cps.ncmp.api.impl.inventory.CmHandleState;
  44 import org.onap.cps.ncmp.api.impl.inventory.CompositeState;
  45 import org.onap.cps.ncmp.api.impl.inventory.DataStoreSyncState;
  46 import org.onap.cps.ncmp.api.impl.inventory.LockReasonCategory;
  47 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
  48 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  49 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  50 import org.onap.cps.spi.FetchDescendantsOption;
  51 import org.onap.cps.spi.model.DataNode;
  52 import org.onap.cps.utils.JsonObjectMapper;
  53 import org.springframework.http.ResponseEntity;
  54 import org.springframework.stereotype.Service;
  55
  56 @Slf4j
  57 @Service
  58 @RequiredArgsConstructor
  59 public class ModuleOperationsUtils {
  60
  61     private final CmHandleQueries cmHandleQueries;
  62     private final DmiDataOperations dmiDataOperations;
  63     private final JsonObjectMapper jsonObjectMapper;
  64     private static final String RETRY_ATTEMPT_KEY = "attempt";
  65     public static final String MODULE_SET_TAG_KEY = "moduleSetTag";
  66     public static final String MODULE_SET_TAG_MESSAGE_FORMAT = "Upgrade to ModuleSetTag: {0}";
  67     private static final String UPGRADE_FORMAT = "Upgrade to ModuleSetTag: %s";
  68     private static final String LOCK_REASON_DETAILS_MSG_FORMAT = UPGRADE_FORMAT + " Attempt #%d failed: %s";
  69     private static final Pattern retryAttemptPattern = Pattern.compile("Attempt #(\\d+) failed:.+");
  70     private static final Pattern moduleSetTagPattern = Pattern.compile("Upgrade to ModuleSetTag: (\\S+)");
  71
  72     /**
  73      * Query data nodes for cm handles with an "ADVISED" cm handle state.
  74      *
  75      * @return cm handles (data nodes) in ADVISED state (empty list if none found)
  76      */
  77     public List<DataNode> getAdvisedCmHandles() {
  78         final List<DataNode> advisedCmHandlesAsDataNodes = cmHandleQueries.queryCmHandlesByState(CmHandleState.ADVISED);
  79         log.debug("Total number of fetched advised cm handle(s) is (are) {}", advisedCmHandlesAsDataNodes.size());
  80         return advisedCmHandlesAsDataNodes;
  81     }
  82
  83     /**
  84      * First query data nodes for cm handles with CM Handle Operational Sync State in "UNSYNCHRONIZED" and
  85      * randomly select a CM Handle and query the data nodes for CM Handle State in "READY".
  86      *
  87      * @return a randomized yang model cm handle list with State in READY and Operation Sync State in "UNSYNCHRONIZED",
  88      *         return empty list if not found
  89      */
  90     public List<YangModelCmHandle> getUnsynchronizedReadyCmHandles() {
  91         final List<DataNode> unsynchronizedCmHandles = cmHandleQueries
  92                 .queryCmHandlesByOperationalSyncState(DataStoreSyncState.UNSYNCHRONIZED);
  93
  94         final List<YangModelCmHandle> yangModelCmHandles = new ArrayList<>();
  95         for (final DataNode unsynchronizedCmHandle : unsynchronizedCmHandles) {
  96             final String cmHandleId = unsynchronizedCmHandle.getLeaves().get("id").toString();
  97             if (cmHandleQueries.cmHandleHasState(cmHandleId, CmHandleState.READY)) {
  98                 yangModelCmHandles.addAll(convertCmHandlesDataNodesToYangModelCmHandles(
  99                                 Collections.singletonList(unsynchronizedCmHandle)));
 100             }
 101         }
 102         Collections.shuffle(yangModelCmHandles);
 103         return yangModelCmHandles;
 104     }
 105
 106     /**
 107      * Query data nodes for cm handles with an "LOCKED" cm handle state with reason.
 108      *
 109      * @return a random LOCKED yang model cm handle, return null if not found
 110      */
 111     public List<YangModelCmHandle> getCmHandlesThatFailedModelSyncOrUpgrade() {
 112         final List<DataNode> lockedCmHandlesAsDataNodeList
 113                 = cmHandleQueries.queryCmHandleAncestorsByCpsPath(
 114                 "//lock-reason[@reason=\"MODULE_SYNC_FAILED\" or @reason=\"MODULE_UPGRADE\"]",
 115                 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
 116         return convertCmHandlesDataNodesToYangModelCmHandles(lockedCmHandlesAsDataNodeList);
 117     }
 118
 119     /**
 120      * Update Composite State attempts counter and set new lock reason and details.
 121      *
 122      * @param lockReasonCategory lock reason category
 123      * @param errorMessage       error message
 124      */
 125     public void updateLockReasonDetailsAndAttempts(final CompositeState compositeState,
 126                                                    final LockReasonCategory lockReasonCategory,
 127                                                    final String errorMessage) {
 128         int attempt = 1;
 129         final Map<String, String> compositeStateDetails
 130                 = getLockedCompositeStateDetails(compositeState.getLockReason());
 131         if (!compositeStateDetails.isEmpty() && compositeStateDetails.containsKey(RETRY_ATTEMPT_KEY)) {
 132             attempt = 1 + Integer.parseInt(compositeStateDetails.get(RETRY_ATTEMPT_KEY));
 133         }
 134         final String moduleSetTag = compositeStateDetails.get(MODULE_SET_TAG_KEY);
 135         compositeState.setLockReason(CompositeState.LockReason.builder()
 136                 .details(String.format(LOCK_REASON_DETAILS_MSG_FORMAT, StringUtils.isNotBlank(moduleSetTag)
 137                         ? moduleSetTag : "not-specified", attempt, errorMessage)).lockReasonCategory(lockReasonCategory)
 138                 .build());
 139     }
 140
 141     /**
 142      * Extract lock reason details as key-value pair.
 143      *
 144      * @param compositeStateLockReason lock reason having all the details
 145      * @return a map of lock reason details
 146      */
 147     public static Map<String, String> getLockedCompositeStateDetails(final CompositeState.LockReason
 148                                                                              compositeStateLockReason) {
 149         if (compositeStateLockReason != null) {
 150             final Map<String, String> compositeStateDetails = new HashMap<>(2);
 151             final String lockedCompositeStateReasonDetails = compositeStateLockReason.getDetails();
 152             final Matcher retryAttemptMatcher = retryAttemptPattern.matcher(lockedCompositeStateReasonDetails);
 153             if (retryAttemptMatcher.find()) {
 154                 final int attemptsRegexGroupId = 1;
 155                 compositeStateDetails.put(RETRY_ATTEMPT_KEY, retryAttemptMatcher.group(attemptsRegexGroupId));
 156             }
 157             final Matcher moduleSetTagMatcher = moduleSetTagPattern.matcher(lockedCompositeStateReasonDetails);
 158             if (moduleSetTagMatcher.find()) {
 159                 final int moduleSetTagRegexGroupId = 1;
 160                 compositeStateDetails.put(MODULE_SET_TAG_KEY, moduleSetTagMatcher.group(moduleSetTagRegexGroupId));
 161             }
 162             return compositeStateDetails;
 163         }
 164         return Collections.emptyMap();
 165     }
 166
 167
 168     /**
 169      * Check if a module sync retry is needed.
 170      *
 171      * @param compositeState the composite state currently in the locked state
 172      * @return if the retry mechanism should be attempted
 173      */
 174     public boolean needsModuleSyncRetryOrUpgrade(final CompositeState compositeState) {
 175         final OffsetDateTime time = OffsetDateTime.parse(compositeState.getLastUpdateTime(),
 176                 DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSZ"));
 177         final CompositeState.LockReason lockReason = compositeState.getLockReason();
 178
 179         final boolean moduleUpgrade = LockReasonCategory.MODULE_UPGRADE == lockReason.getLockReasonCategory();
 180         if (moduleUpgrade) {
 181             log.info("Locked for module upgrade");
 182             return true;
 183         }
 184
 185         final boolean failedDuringModuleSync = LockReasonCategory.MODULE_SYNC_FAILED
 186                 == lockReason.getLockReasonCategory();
 187         final boolean failedDuringModuleUpgrade = LockReasonCategory.MODULE_UPGRADE_FAILED
 188                 == lockReason.getLockReasonCategory();
 189
 190         if (failedDuringModuleSync || failedDuringModuleUpgrade) {
 191             log.info("Locked for module {} (last attempt failed).", failedDuringModuleSync ? "sync" : "upgrade");
 192             return isRetryDue(lockReason, time);
 193         }
 194         log.info("Locked for other reason");
 195         return false;
 196     }
 197
 198     /**
 199      * Get the Resourece Data from Node through DMI Passthrough service.
 200      *
 201      * @param cmHandleId cm handle id
 202      * @return optional string containing the resource data
 203      */
 204     public String getResourceData(final String cmHandleId) {
 205         final ResponseEntity<Object> resourceDataResponseEntity = dmiDataOperations.getResourceDataFromDmi(
 206                 PASSTHROUGH_OPERATIONAL.getDatastoreName(),
 207                 cmHandleId,
 208                 UUID.randomUUID().toString());
 209         if (resourceDataResponseEntity.getStatusCode().is2xxSuccessful()) {
 210             return getFirstResource(resourceDataResponseEntity.getBody());
 211         }
 212         return null;
 213     }
 214
 215     /**
 216      * Checks if cm handle state module is in upgrade or upgrade failed.
 217      *
 218      * @param compositeState current lock reason of  cm handle
 219      * @return true or false based on lock reason category
 220      */
 221     public static boolean isInUpgradeOrUpgradeFailed(final CompositeState compositeState) {
 222         return compositeState.getLockReason() != null
 223                 && (LockReasonCategory.MODULE_UPGRADE.equals(compositeState.getLockReason().getLockReasonCategory())
 224                 || LockReasonCategory.MODULE_UPGRADE_FAILED.equals(compositeState.getLockReason()
 225                 .getLockReasonCategory()));
 226     }
 227
 228     private String getFirstResource(final Object responseBody) {
 229         final String jsonObjectAsString = jsonObjectMapper.asJsonString(responseBody);
 230         final JsonNode overallJsonNode = jsonObjectMapper.convertToJsonNode(jsonObjectAsString);
 231         final Iterator<Map.Entry<String, JsonNode>> overallJsonTreeMap = overallJsonNode.fields();
 232         final Map.Entry<String, JsonNode> firstElement = overallJsonTreeMap.next();
 233         return jsonObjectMapper.asJsonString(Map.of(firstElement.getKey(), firstElement.getValue()));
 234     }
 235
 236     private List<YangModelCmHandle> convertCmHandlesDataNodesToYangModelCmHandles(
 237             final List<DataNode> cmHandlesAsDataNodeList) {
 238         return cmHandlesAsDataNodeList.stream()
 239                 .map(cmHandle -> YangDataConverter.convertCmHandleToYangModel(cmHandle,
 240                         cmHandle.getLeaves().get("id").toString())).toList();
 241     }
 242
 243     private boolean isRetryDue(final CompositeState.LockReason compositeStateLockReason, final OffsetDateTime time) {
 244         final int timeInMinutesUntilNextAttempt;
 245         final Map<String, String> compositeStateDetails = getLockedCompositeStateDetails(compositeStateLockReason);
 246         if (compositeStateDetails.isEmpty()) {
 247             timeInMinutesUntilNextAttempt = 1;
 248             log.info("First Attempt: no current attempts found.");
 249         } else {
 250             timeInMinutesUntilNextAttempt = (int) Math.pow(2, Integer.parseInt(compositeStateDetails
 251                     .get(RETRY_ATTEMPT_KEY)));
 252         }
 253         final int timeSinceLastAttempt = (int) Duration.between(time, OffsetDateTime.now()).toMinutes();
 254         if (timeInMinutesUntilNextAttempt >= timeSinceLastAttempt) {
 255             log.info("Time until next attempt is {} minutes: ", timeInMinutesUntilNextAttempt - timeSinceLastAttempt);
 256             return false;
 257         }
 258         log.info("Retry due now");
 259         return true;
 260     }
 261 }