/* * ============LICENSE_START======================================================= * Copyright (C) 2022-2023 Nordix Foundation * ================================================================================ * 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.api.impl.inventory.sync; import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DATASPACE_NAME; import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_ANCHOR; import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_PARENT; import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME; import java.time.OffsetDateTime; import java.util.Collection; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Optional; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.onap.cps.api.CpsAdminService; import org.onap.cps.api.CpsDataService; import org.onap.cps.api.CpsModuleService; import org.onap.cps.ncmp.api.impl.inventory.CmHandleQueries; import org.onap.cps.ncmp.api.impl.inventory.CmHandleState; import org.onap.cps.ncmp.api.impl.inventory.CompositeState; import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations; import org.onap.cps.ncmp.api.impl.utils.YangDataConverter; import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle; import org.onap.cps.spi.CascadeDeleteAllowed; import org.onap.cps.spi.FetchDescendantsOption; import org.onap.cps.spi.exceptions.SchemaSetNotFoundException; import org.onap.cps.spi.model.DataNode; import org.onap.cps.spi.model.ModuleReference; import org.onap.cps.utils.JsonObjectMapper; import org.springframework.stereotype.Service; @Slf4j @Service @RequiredArgsConstructor public class ModuleSyncService { private final DmiModelOperations dmiModelOperations; private final CpsModuleService cpsModuleService; private final CpsAdminService cpsAdminService; private final CmHandleQueries cmHandleQueries; private final CpsDataService cpsDataService; private final JsonObjectMapper jsonObjectMapper; private final Map> moduleSetTagCache; private static final Map NO_NEW_MODULES = Collections.emptyMap(); /** * This method registers a cm handle and initiates modules sync. * * @param yangModelCmHandle the yang model of cm handle. */ public void syncAndCreateOrUpgradeSchemaSetAndAnchor(final YangModelCmHandle yangModelCmHandle) { final String moduleSetTag; final String cmHandleId = yangModelCmHandle.getId(); final CompositeState compositeState = yangModelCmHandle.getCompositeState(); final boolean inUpgrade = ModuleOperationsUtils.isInUpgradeOrUpgradeFailed(compositeState); if (inUpgrade) { moduleSetTag = ModuleOperationsUtils.getLockedCompositeStateDetails(compositeState.getLockReason()) .get(ModuleOperationsUtils.MODULE_SET_TAG_KEY); } else { moduleSetTag = yangModelCmHandle.getModuleSetTag(); } final Collection moduleReferencesFromCache = moduleSetTagCache.get(moduleSetTag); if (moduleReferencesFromCache == null) { final Optional optionalExistingCmHandleWithSameModuleSetTag = getFirstReadyDataNodeWithModuleSetTag(moduleSetTag); if (optionalExistingCmHandleWithSameModuleSetTag.isPresent()) { final String existingCmHandleAnchorName = optionalExistingCmHandleWithSameModuleSetTag.get().getAnchorName(); createOrUpgradeSchemaSetUsingModuleSetTag(cmHandleId, moduleSetTag, existingCmHandleAnchorName); } else { syncAndCreateSchemaSet(yangModelCmHandle, moduleSetTag); } } else { cpsModuleService.createOrUpgradeSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId, NO_NEW_MODULES, moduleReferencesFromCache); } if (!inUpgrade) { cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId, cmHandleId); } setCmHandleModuleSetTag(yangModelCmHandle, moduleSetTag); } private void syncAndCreateSchemaSet(final YangModelCmHandle yangModelCmHandle, final String moduleSetTag) { final Collection allModuleReferencesFromCmHandle = dmiModelOperations.getModuleReferences(yangModelCmHandle); final Collection identifiedNewModuleReferencesFromCmHandle = cpsModuleService .identifyNewModuleReferences(allModuleReferencesFromCmHandle); final Map newModuleNameToContentMap; if (identifiedNewModuleReferencesFromCmHandle.isEmpty()) { newModuleNameToContentMap = NO_NEW_MODULES; } else { newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle, identifiedNewModuleReferencesFromCmHandle); } cpsModuleService.createOrUpgradeSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(), newModuleNameToContentMap, allModuleReferencesFromCmHandle); if (StringUtils.isNotBlank(moduleSetTag)) { moduleSetTagCache.put(moduleSetTag, allModuleReferencesFromCmHandle); } } /** * Deletes the SchemaSet for schema set id if the SchemaSet Exists. * * @param schemaSetId the schema set id to be deleted */ public void deleteSchemaSetIfExists(final String schemaSetId) { try { cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetId, CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED); log.debug("SchemaSet for {} has been deleted. Ready to be recreated.", schemaSetId); } catch (final SchemaSetNotFoundException e) { log.debug("No SchemaSet for {}. Assuming CmHandle has not been previously Module Synced.", schemaSetId); } } private Optional getFirstReadyDataNodeWithModuleSetTag(final String moduleSetTag) { final List dataNodes = StringUtils.isNotBlank(moduleSetTag) ? cmHandleQueries .queryNcmpRegistryByCpsPath("//cm-handles[@module-set-tag='" + moduleSetTag + "']", FetchDescendantsOption.OMIT_DESCENDANTS) : Collections.emptyList(); return dataNodes.stream().filter(dataNode -> { final String cmHandleId = YangDataConverter.extractCmHandleIdFromXpath(dataNode.getXpath()); return cmHandleQueries.cmHandleHasState(cmHandleId, CmHandleState.READY); }).findFirst(); } private void setCmHandleModuleSetTag(final YangModelCmHandle upgradedCmHandle, final String moduleSetTag) { final Map> dmiRegistryProperties = new HashMap<>(1); final Map cmHandleProperties = new HashMap<>(2); cmHandleProperties.put("id", upgradedCmHandle.getId()); cmHandleProperties.put("module-set-tag", moduleSetTag); dmiRegistryProperties.put("cm-handles", cmHandleProperties); cpsDataService.updateNodeLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT, jsonObjectMapper.asJsonString(dmiRegistryProperties), OffsetDateTime.now()); } private void createOrUpgradeSchemaSetUsingModuleSetTag(final String schemaSetName, final String moduleSetTag, final String existingCmHandleAnchorName) { log.info("Found cm handle having module set tag: {}", moduleSetTag); final Collection moduleReferencesFromExistingCmHandle = cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, existingCmHandleAnchorName); cpsModuleService.createOrUpgradeSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName, NO_NEW_MODULES, moduleReferencesFromExistingCmHandle); moduleSetTagCache.put(moduleSetTag, moduleReferencesFromExistingCmHandle); } }