X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-service%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fcps%2Fncmp%2Fapi%2Finventory%2Fsync%2FSyncUtils.java;h=046a116efa99a1e42f48535f31ac453c078ffd19;hb=d797b35547c24f3ebd6bd5ad53eed1891d5783b3;hp=924546433eb7e04e2b362e2d9fd939b4c9bb9ae0;hpb=a0b8fb72f9ab872ec554b812db10758592b5a294;p=cps.git diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/SyncUtils.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/SyncUtils.java index 924546433..046a116ef 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/SyncUtils.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/SyncUtils.java @@ -1,6 +1,7 @@ /* - * ============LICENSE_START======================================================= + * ============LICENSE_START======================================================= * Copyright (C) 2022 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. @@ -20,37 +21,51 @@ package org.onap.cps.ncmp.api.inventory.sync; -import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DATASPACE_NAME; -import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_ANCHOR; -import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_PARENT; - +import com.fasterxml.jackson.databind.JsonNode; +import com.google.common.collect.ImmutableMap; import java.security.SecureRandom; +import java.time.Duration; import java.time.OffsetDateTime; +import java.time.format.DateTimeFormatter; +import java.util.Collections; +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 java.util.stream.Collectors; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; -import org.onap.cps.api.CpsDataService; -import org.onap.cps.ncmp.api.impl.operations.YangModelCmHandleRetriever; +import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations; +import org.onap.cps.ncmp.api.impl.operations.DmiOperations; +import org.onap.cps.ncmp.api.impl.utils.YangDataConverter; import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle; -import org.onap.cps.spi.CpsDataPersistenceService; +import org.onap.cps.ncmp.api.inventory.CmHandleState; +import org.onap.cps.ncmp.api.inventory.CompositeState; +import org.onap.cps.ncmp.api.inventory.DataStoreSyncState; +import org.onap.cps.ncmp.api.inventory.InventoryPersistence; +import org.onap.cps.ncmp.api.inventory.LockReasonCategory; import org.onap.cps.spi.FetchDescendantsOption; import org.onap.cps.spi.model.DataNode; import org.onap.cps.utils.JsonObjectMapper; -import org.springframework.stereotype.Component; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Service; @Slf4j -@Component +@Service @RequiredArgsConstructor public class SyncUtils { private static final SecureRandom secureRandom = new SecureRandom(); - private final CpsDataService cpsDataService; - private final CpsDataPersistenceService cpsDataPersistenceService; + private final InventoryPersistence inventoryPersistence; + + private final DmiDataOperations dmiDataOperations; private final JsonObjectMapper jsonObjectMapper; - private final YangModelCmHandleRetriever yangModelCmHandleRetriever; + private static final Pattern retryAttemptPattern = Pattern.compile("^Attempt #(\\d+) failed:"); /** * Query data nodes for cm handles with an "ADVISED" cm handle state, and select a random entry for processing. @@ -58,30 +73,123 @@ public class SyncUtils { * @return a random yang model cm handle with an ADVISED state, return null if not found */ public YangModelCmHandle getAnAdvisedCmHandle() { - final List advisedCmHandles = cpsDataPersistenceService.queryDataNodes("NCMP-Admin", - "ncmp-dmi-registry", "//cm-handles[@state=\"ADVISED\"]", - FetchDescendantsOption.OMIT_DESCENDANTS); + final List advisedCmHandles = inventoryPersistence.getCmHandlesByState(CmHandleState.ADVISED); if (advisedCmHandles.isEmpty()) { return null; } final int randomElementIndex = secureRandom.nextInt(advisedCmHandles.size()); final String cmHandleId = advisedCmHandles.get(randomElementIndex).getLeaves() .get("id").toString(); - return yangModelCmHandleRetriever.getYangModelCmHandle(cmHandleId); + return inventoryPersistence.getYangModelCmHandle(cmHandleId); + } + + /** + * 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 random yang model cm handle with State in READY and Operation Sync State in "UNSYNCHRONIZED", + * return null if not found + */ + public YangModelCmHandle getAnUnSynchronizedReadyCmHandle() { + final List unSynchronizedCmHandles = inventoryPersistence + .getCmHandlesByOperationalSyncState(DataStoreSyncState.UNSYNCHRONIZED); + if (unSynchronizedCmHandles.isEmpty()) { + return null; + } + Collections.shuffle(unSynchronizedCmHandles); + for (final DataNode cmHandle : unSynchronizedCmHandles) { + final String cmHandleId = cmHandle.getLeaves().get("id").toString(); + final List readyCmHandles = inventoryPersistence + .getCmHandlesByIdAndState(cmHandleId, CmHandleState.READY); + if (!readyCmHandles.isEmpty()) { + return inventoryPersistence.getYangModelCmHandle(cmHandleId); + } + } + return null; + } + + /** + * Query data nodes for cm handles with an "LOCKED" cm handle state with reason LOCKED_MODULE_SYNC_FAILED". + * + * @return a random LOCKED yang model cm handle, return null if not found + */ + public List getModuleSyncFailedCmHandles() { + final List lockedCmHandleAsDataNodeList = inventoryPersistence.getCmHandleDataNodesByCpsPath( + "//lock-reason[@reason=\"LOCKED_MODULE_SYNC_FAILED\"]/ancestor::cm-handles", + FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS); + return lockedCmHandleAsDataNodeList.stream() + .map(cmHandle -> YangDataConverter.convertCmHandleToYangModel(cmHandle, + cmHandle.getLeaves().get("id").toString())).collect(Collectors.toList()); } /** - * Update the Cm Handle state to "READY". + * Update Composite State attempts counter and set new lock reason and details. * - * @param yangModelCmHandle yang model cm handle - * @param state cm handle state + * @param lockReasonCategory lock reason category + * @param errorMessage error message */ - public void updateCmHandleState(final YangModelCmHandle yangModelCmHandle, final String state) { - yangModelCmHandle.setCmHandleState(state); - final String cmHandleJsonData = String.format("{\"cm-handles\":[%s]}", - jsonObjectMapper.asJsonString(yangModelCmHandle)); - cpsDataService.updateNodeLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT, - cmHandleJsonData, OffsetDateTime.now()); + public void updateLockReasonDetailsAndAttempts(final CompositeState compositeState, + final LockReasonCategory lockReasonCategory, + final String errorMessage) { + int attempt = 1; + if (compositeState.getLockReason() != null) { + final Matcher matcher = retryAttemptPattern.matcher(compositeState.getLockReason().getDetails()); + if (matcher.find()) { + attempt = 1 + Integer.parseInt(matcher.group(1)); + } + } + compositeState.setLockReason(CompositeState.LockReason.builder() + .details(String.format("Attempt #%d failed: %s", attempt, errorMessage)) + .lockReasonCategory(lockReasonCategory).build()); } + + /** + * Check if the retry mechanism should attempt to unlock the cm handle based on the last update time. + * + * @param compositeState the composite state currently in the locked state + * @return if the retry mechanism should be attempted + */ + public boolean isReadyForRetry(final CompositeState compositeState) { + int timeInMinutesUntilNextAttempt = 1; + final OffsetDateTime time = + OffsetDateTime.parse(compositeState.getLastUpdateTime(), + DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSZ")); + final Matcher matcher = retryAttemptPattern.matcher(compositeState.getLockReason().getDetails()); + if (matcher.find()) { + timeInMinutesUntilNextAttempt = (int) Math.pow(2, Integer.parseInt(matcher.group(1))); + } else { + log.debug("First Attempt: no current attempts found."); + } + final int timeSinceLastAttempt = (int) Duration.between(time, OffsetDateTime.now()).toMinutes(); + if (timeInMinutesUntilNextAttempt >= timeSinceLastAttempt) { + log.info("Time until next attempt is {} minutes: ", + timeInMinutesUntilNextAttempt - timeSinceLastAttempt); + } + return timeSinceLastAttempt > timeInMinutesUntilNextAttempt; + } + + /** + * Get the Resourece 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 resourceDataResponseEntity = dmiDataOperations.getResourceDataFromDmi( + cmHandleId, DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL, + UUID.randomUUID().toString()); + if (resourceDataResponseEntity.getStatusCode().is2xxSuccessful()) { + return getFirstResource(resourceDataResponseEntity.getBody()); + } + return null; + } + + private String getFirstResource(final Object responseBody) { + final String jsonObjectAsString = jsonObjectMapper.asJsonString(responseBody); + final JsonNode overallJsonNode = jsonObjectMapper.convertToJsonNode(jsonObjectAsString); + final Iterator> overallJsonTreeMap = overallJsonNode.fields(); + final Map.Entry firstElement = overallJsonTreeMap.next(); + return jsonObjectMapper.asJsonString(ImmutableMap.of(firstElement.getKey(), firstElement.getValue())); + } }