1 files changed, 262 insertions, 0 deletions
diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/ModuleOperationsUtils.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/ModuleOperationsUtils.java
new file mode 100644
index 000000000..69fb7f59f
--- /dev/null
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/ModuleOperationsUtils.java
@@ -0,0 +1,262 @@
+/*
+ *  ============LICENSE_START=======================================================
+ *  Copyright (C) 2022-2024 Nordix Foundation
+ *  Modifications Copyright (C) 2022 Bell Canada
+ *  ================================================================================
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *  ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.impl.inventory.sync;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import java.time.Duration;
+import java.time.OffsetDateTime;
+import java.time.format.DateTimeFormatter;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.onap.cps.ncmp.api.inventory.models.CompositeState;
+import org.onap.cps.ncmp.impl.data.DmiDataOperations;
+import org.onap.cps.ncmp.impl.inventory.CmHandleQueryService;
+import org.onap.cps.ncmp.impl.inventory.DataStoreSyncState;
+import org.onap.cps.ncmp.impl.inventory.models.CmHandleState;
+import org.onap.cps.ncmp.impl.inventory.models.LockReasonCategory;
+import org.onap.cps.ncmp.impl.inventory.models.YangModelCmHandle;
+import org.onap.cps.ncmp.impl.utils.YangDataConverter;
+import org.onap.cps.spi.FetchDescendantsOption;
+import org.onap.cps.spi.model.DataNode;
+import org.onap.cps.utils.JsonObjectMapper;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Service;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class ModuleOperationsUtils {
+
+    private final CmHandleQueryService cmHandleQueryService;
+    private final DmiDataOperations dmiDataOperations;
+    private final JsonObjectMapper jsonObjectMapper;
+    private static final String RETRY_ATTEMPT_KEY = "attempt";
+    private static final String MODULE_SET_TAG_KEY = "moduleSetTag";
+    public static final String MODULE_SET_TAG_MESSAGE_FORMAT = "Upgrade to ModuleSetTag: %s";
+    private static final String LOCK_REASON_DETAILS_MSG_FORMAT =
+            MODULE_SET_TAG_MESSAGE_FORMAT + " Attempt #%d failed: %s";
+    private static final Pattern retryAttemptPattern = Pattern.compile("Attempt #(\\d+) failed:.+");
+    private static final Pattern moduleSetTagPattern = Pattern.compile("Upgrade to ModuleSetTag: (\\S+)");
+    private static final String CPS_PATH_CM_HANDLES_MODEL_SYNC_FAILED_OR_UPGRADE = """
+            //lock-reason[@reason="MODULE_SYNC_FAILED"
+            or @reason="MODULE_UPGRADE"
+            or @reason="MODULE_UPGRADE_FAILED"]""";
+
+    /**
+     * Query data nodes for cm handles with an "ADVISED" cm handle state.
+     *
+     * @return cm handles (data nodes) in ADVISED state (empty list if none found)
+     */
+    public List<DataNode> getAdvisedCmHandles() {
+        final List<DataNode> advisedCmHandlesAsDataNodes =
+            cmHandleQueryService.queryCmHandlesByState(CmHandleState.ADVISED);
+        log.debug("Total number of fetched advised cm handle(s) is (are) {}", advisedCmHandlesAsDataNodes.size());
+        return advisedCmHandlesAsDataNodes;
+    }
+
+    /**
+     * First query data nodes for cm handles with CM Handle Operational Sync State in "UNSYNCHRONIZED" and
+     * randomly select a CM Handle and query the data nodes for CM Handle State in "READY".
+     *
+     * @return a randomized yang model cm handle list with State in READY and Operation Sync State in "UNSYNCHRONIZED",
+     *         return empty list if not found
+     */
+    public List<YangModelCmHandle> getUnsynchronizedReadyCmHandles() {
+        final List<DataNode> unsynchronizedCmHandles = cmHandleQueryService
+                .queryCmHandlesByOperationalSyncState(DataStoreSyncState.UNSYNCHRONIZED);
+
+        final List<YangModelCmHandle> yangModelCmHandles = new ArrayList<>();
+        for (final DataNode unsynchronizedCmHandle : unsynchronizedCmHandles) {
+            final String cmHandleId = unsynchronizedCmHandle.getLeaves().get("id").toString();
+            if (cmHandleQueryService.cmHandleHasState(cmHandleId, CmHandleState.READY)) {
+                yangModelCmHandles.addAll(convertCmHandlesDataNodesToYangModelCmHandles(
+                                Collections.singletonList(unsynchronizedCmHandle)));
+            }
+        }
+        Collections.shuffle(yangModelCmHandles);
+        return yangModelCmHandles;
+    }
+
+    /**
+     * Query data nodes for cm handles with an "LOCKED" cm handle state with reason.
+     *
+     * @return a random LOCKED yang model cm handle, return null if not found
+     */
+    public List<YangModelCmHandle> getCmHandlesThatFailedModelSyncOrUpgrade() {
+        final List<DataNode> lockedCmHandlesAsDataNodeList
+                = cmHandleQueryService.queryCmHandleAncestorsByCpsPath(CPS_PATH_CM_HANDLES_MODEL_SYNC_FAILED_OR_UPGRADE,
+                FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
+        return convertCmHandlesDataNodesToYangModelCmHandles(lockedCmHandlesAsDataNodeList);
+    }
+
+    /**
+     * Update Composite State attempts counter and set new lock reason and details.
+     *
+     * @param lockReasonCategory lock reason category
+     * @param errorMessage       error message
+     */
+    public void updateLockReasonDetailsAndAttempts(final CompositeState compositeState,
+                                                   final LockReasonCategory lockReasonCategory,
+                                                   final String errorMessage) {
+        int attempt = 1;
+        final Map<String, String> compositeStateDetails
+                = getLockedCompositeStateDetails(compositeState.getLockReason());
+        if (!compositeStateDetails.isEmpty() && compositeStateDetails.containsKey(RETRY_ATTEMPT_KEY)) {
+            attempt = 1 + Integer.parseInt(compositeStateDetails.get(RETRY_ATTEMPT_KEY));
+        }
+        final String moduleSetTag = compositeStateDetails.getOrDefault(MODULE_SET_TAG_KEY, "");
+        compositeState.setLockReason(CompositeState.LockReason.builder()
+                .details(String.format(LOCK_REASON_DETAILS_MSG_FORMAT, moduleSetTag, attempt, errorMessage))
+                .lockReasonCategory(lockReasonCategory)
+                .build());
+    }
+
+    /**
+     * Extract lock reason details as key-value pair.
+     *
+     * @param compositeStateLockReason lock reason having all the details
+     * @return a map of lock reason details
+     */
+    public static Map<String, String> getLockedCompositeStateDetails(final CompositeState.LockReason
+                                                                             compositeStateLockReason) {
+        if (compositeStateLockReason != null) {
+            final Map<String, String> compositeStateDetails = new HashMap<>(2);
+            final String lockedCompositeStateReasonDetails = compositeStateLockReason.getDetails();
+            final Matcher retryAttemptMatcher = retryAttemptPattern.matcher(lockedCompositeStateReasonDetails);
+            if (retryAttemptMatcher.find()) {
+                final int attemptsRegexGroupId = 1;
+                compositeStateDetails.put(RETRY_ATTEMPT_KEY, retryAttemptMatcher.group(attemptsRegexGroupId));
+            }
+            final Matcher moduleSetTagMatcher = moduleSetTagPattern.matcher(lockedCompositeStateReasonDetails);
+            if (moduleSetTagMatcher.find()) {
+                final int moduleSetTagRegexGroupId = 1;
+                compositeStateDetails.put(MODULE_SET_TAG_KEY, moduleSetTagMatcher.group(moduleSetTagRegexGroupId));
+            }
+            return compositeStateDetails;
+        }
+        return Collections.emptyMap();
+    }
+
+
+    /**
+     * Check if a module sync retry is needed.
+     *
+     * @param compositeState the composite state currently in the locked state
+     * @return if the retry mechanism should be attempted
+     */
+    public boolean needsModuleSyncRetryOrUpgrade(final CompositeState compositeState) {
+        final OffsetDateTime time = OffsetDateTime.parse(compositeState.getLastUpdateTime(),
+                DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSZ"));
+        final CompositeState.LockReason lockReason = compositeState.getLockReason();
+
+        final boolean moduleUpgrade = LockReasonCategory.MODULE_UPGRADE == lockReason.getLockReasonCategory();
+        if (moduleUpgrade) {
+            log.info("Locked for module upgrade");
+            return true;
+        }
+
+        final boolean failedDuringModuleSync = LockReasonCategory.MODULE_SYNC_FAILED
+                == lockReason.getLockReasonCategory();
+        final boolean failedDuringModuleUpgrade = LockReasonCategory.MODULE_UPGRADE_FAILED
+                == lockReason.getLockReasonCategory();
+
+        if (failedDuringModuleSync || failedDuringModuleUpgrade) {
+            log.info("Locked for module {} (last attempt failed).", failedDuringModuleSync ? "sync" : "upgrade");
+            return isRetryDue(lockReason, time);
+        }
+        log.info("Locked for other reason");
+        return false;
+    }
+
+    /**
+     * Get the Resource Data from Node through DMI Passthrough service.
+     *
+     * @param cmHandleId cm handle id
+     * @return optional string containing the resource data
+     */
+    public String getResourceData(final String cmHandleId) {
+        final ResponseEntity<Object> resourceDataResponseEntity = dmiDataOperations.getAllResourceDataFromDmi(
+                cmHandleId, UUID.randomUUID().toString());
+        if (resourceDataResponseEntity.getStatusCode().is2xxSuccessful()) {
+            return getFirstResource(resourceDataResponseEntity.getBody());
+        }
+        return null;
+    }
+
+    /**
+     * Checks if cm handle state module is in upgrade or upgrade failed.
+     *
+     * @param compositeState current lock reason of  cm handle
+     * @return true or false based on lock reason category
+     */
+    public static boolean inUpgradeOrUpgradeFailed(final CompositeState compositeState) {
+        return compositeState.getLockReason() != null
+                && (LockReasonCategory.MODULE_UPGRADE.equals(compositeState.getLockReason().getLockReasonCategory())
+                || LockReasonCategory.MODULE_UPGRADE_FAILED.equals(compositeState.getLockReason()
+                .getLockReasonCategory()));
+    }
+
+    public static String getUpgradedModuleSetTagFromLockReason(final CompositeState.LockReason lockReason) {
+        return getLockedCompositeStateDetails(lockReason).getOrDefault(MODULE_SET_TAG_KEY, "");
+    }
+
+    private String getFirstResource(final Object responseBody) {
+        final String jsonObjectAsString = jsonObjectMapper.asJsonString(responseBody);
+        final JsonNode overallJsonNode = jsonObjectMapper.convertToJsonNode(jsonObjectAsString);
+        final Iterator<Map.Entry<String, JsonNode>> overallJsonTreeMap = overallJsonNode.fields();
+        final Map.Entry<String, JsonNode> firstElement = overallJsonTreeMap.next();
+        return jsonObjectMapper.asJsonString(Map.of(firstElement.getKey(), firstElement.getValue()));
+    }
+
+    private List<YangModelCmHandle> convertCmHandlesDataNodesToYangModelCmHandles(
+            final List<DataNode> cmHandlesAsDataNodeList) {
+        return cmHandlesAsDataNodeList.stream().map(YangDataConverter::toYangModelCmHandle).toList();
+    }
+
+    private boolean isRetryDue(final CompositeState.LockReason compositeStateLockReason, final OffsetDateTime time) {
+        final int timeInMinutesUntilNextAttempt;
+        final Map<String, String> compositeStateDetails = getLockedCompositeStateDetails(compositeStateLockReason);
+        if (compositeStateDetails.isEmpty()) {
+            timeInMinutesUntilNextAttempt = 1;
+            log.info("First Attempt: no current attempts found.");
+        } else {
+            timeInMinutesUntilNextAttempt = (int) Math.pow(2, Integer.parseInt(compositeStateDetails
+                    .get(RETRY_ATTEMPT_KEY)));
+        }
+        final int timeSinceLastAttempt = (int) Duration.between(time, OffsetDateTime.now()).toMinutes();
+        if (timeInMinutesUntilNextAttempt >= timeSinceLastAttempt) {
+            log.info("Time until next attempt is {} minutes: ", timeInMinutesUntilNextAttempt - timeSinceLastAttempt);
+            return false;
+        }
+        log.info("Retry due now");
+        return true;
+    }
+}