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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022-2024 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.api.impl.inventory.sync;
  22
  23 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DATASPACE_NAME;
  24 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_ANCHOR;
  25 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_PARENT;
  26 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
  27
  28 import java.time.OffsetDateTime;
  29 import java.util.Collection;
  30 import java.util.Collections;
  31 import java.util.HashMap;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.Optional;
  35 import lombok.RequiredArgsConstructor;
  36 import lombok.extern.slf4j.Slf4j;
  37 import org.apache.commons.lang3.StringUtils;
  38 import org.apache.commons.lang3.tuple.ImmutableTriple;
  39 import org.onap.cps.api.CpsAnchorService;
  40 import org.onap.cps.api.CpsDataService;
  41 import org.onap.cps.api.CpsModuleService;
  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.operations.DmiModelOperations;
  45 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  46 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  47 import org.onap.cps.spi.CascadeDeleteAllowed;
  48 import org.onap.cps.spi.FetchDescendantsOption;
  49 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
  50 import org.onap.cps.spi.model.DataNode;
  51 import org.onap.cps.spi.model.ModuleReference;
  52 import org.onap.cps.utils.JsonObjectMapper;
  53 import org.springframework.stereotype.Service;
  54
  55 @Slf4j
  56 @Service
  57 @RequiredArgsConstructor
  58 public class ModuleSyncService {
  59
  60     private final DmiModelOperations dmiModelOperations;
  61     private final CpsModuleService cpsModuleService;
  62     private final CmHandleQueries cmHandleQueries;
  63     private final CpsDataService cpsDataService;
  64     private final CpsAnchorService cpsAnchorService;
  65     private final JsonObjectMapper jsonObjectMapper;
  66     private static final Map<String, String> NO_NEW_MODULES = Collections.emptyMap();
  67
  68     /**
  69      * This method registers a cm handle and initiates modules sync.
  70      *
  71      * @param yangModelCmHandle the yang model of cm handle.
  72      */
  73     public void syncAndCreateOrUpgradeSchemaSetAndAnchor(final YangModelCmHandle yangModelCmHandle) {
  74
  75         final boolean inUpgrade = ModuleOperationsUtils.inUpgradeOrUpgradeFailed(yangModelCmHandle.getCompositeState());
  76
  77         final ImmutableTriple<String, Map<String, String>, Collection<ModuleReference>>
  78                 allModuleReferencesAndNewModuleNameByModuleSetTag
  79                 = getAllModuleReferencesAndNewYangResourcesByModuleSetTag(yangModelCmHandle, inUpgrade);
  80
  81         final String moduleSetTag = allModuleReferencesAndNewModuleNameByModuleSetTag.getLeft();
  82         final Map<String, String> newYangResources = allModuleReferencesAndNewModuleNameByModuleSetTag.getMiddle();
  83         final Collection<ModuleReference> allModuleReferences
  84                 = allModuleReferencesAndNewModuleNameByModuleSetTag.getRight();
  85         final String cmHandleId = yangModelCmHandle.getId();
  86
  87         if (inUpgrade) {
  88             cpsModuleService.upgradeSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId,
  89                     newYangResources, allModuleReferences);
  90             setCmHandleModuleSetTag(yangModelCmHandle, moduleSetTag);
  91         } else {
  92             cpsModuleService.createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId,
  93                     newYangResources, allModuleReferences);
  94             cpsAnchorService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId, cmHandleId);
  95         }
  96     }
  97
  98     /**
  99      * Deletes the SchemaSet for schema set id if the SchemaSet Exists.
 100      *
 101      * @param schemaSetId the schema set id to be deleted
 102      */
 103     public void deleteSchemaSetIfExists(final String schemaSetId) {
 104         try {
 105             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetId,
 106                 CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED);
 107             log.debug("SchemaSet for {} has been deleted. Ready to be recreated.", schemaSetId);
 108         } catch (final SchemaSetNotFoundException e) {
 109             log.debug("No SchemaSet for {}. Assuming CmHandle has not been previously Module Synced.", schemaSetId);
 110         }
 111     }
 112
 113     private ImmutableTriple<String, Map<String, String>, Collection<ModuleReference>>
 114         getAllModuleReferencesAndNewYangResourcesByModuleSetTag(final YangModelCmHandle yangModelCmHandle,
 115                                                                 final boolean inUpgrade) {
 116
 117         final String moduleSetTag = getModuleSetTag(yangModelCmHandle, inUpgrade);
 118         final Collection<ModuleReference> allModuleReferences;
 119         Map<String, String> newYangResources = Collections.emptyMap();
 120
 121         final Optional<DataNode> optionalDataNode = getFirstReadyDataNodeByModuleSetTagProvidedInDb(moduleSetTag);
 122
 123         if (optionalDataNode.isPresent()) {
 124             log.info("Found other cm handle having same module set tag: {}", moduleSetTag);
 125             final String otherAnchorWithSameModuleSetTag
 126                     = YangDataConverter.extractCmHandleIdFromXpath(optionalDataNode.get().getXpath());
 127             allModuleReferences = cpsModuleService.getYangResourcesModuleReferences(
 128                     NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, otherAnchorWithSameModuleSetTag);
 129         } else {
 130             allModuleReferences = dmiModelOperations.getModuleReferences(yangModelCmHandle);
 131             newYangResources = getNewModuleNameToContentMap(yangModelCmHandle, allModuleReferences);
 132         }
 133         return ImmutableTriple.of(moduleSetTag, newYangResources, allModuleReferences);
 134     }
 135
 136     private Optional<DataNode> getFirstReadyDataNodeByModuleSetTagProvidedInDb(final String moduleSetTag) {
 137         final List<DataNode> dataNodes = StringUtils.isNotBlank(moduleSetTag) ? cmHandleQueries
 138                 .queryNcmpRegistryByCpsPath("//cm-handles[@module-set-tag='" + moduleSetTag + "']",
 139                         FetchDescendantsOption.OMIT_DESCENDANTS) : Collections.emptyList();
 140         return dataNodes.stream().filter(dataNode -> {
 141             final String cmHandleId = YangDataConverter.extractCmHandleIdFromXpath(dataNode.getXpath());
 142             return cmHandleQueries.cmHandleHasState(cmHandleId, CmHandleState.READY);
 143         }).findFirst();
 144     }
 145
 146     private void setCmHandleModuleSetTag(final YangModelCmHandle upgradedCmHandle, final String moduleSetTag) {
 147         final Map<String, Map<String, String>> dmiRegistryProperties = new HashMap<>(1);
 148         final Map<String, String> cmHandleProperties = new HashMap<>(2);
 149         cmHandleProperties.put("id", upgradedCmHandle.getId());
 150         cmHandleProperties.put("module-set-tag", moduleSetTag);
 151         dmiRegistryProperties.put("cm-handles", cmHandleProperties);
 152         cpsDataService.updateNodeLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 153                 jsonObjectMapper.asJsonString(dmiRegistryProperties), OffsetDateTime.now());
 154     }
 155
 156     private Map<String, String> getNewModuleNameToContentMap(final YangModelCmHandle yangModelCmHandle,
 157                                                              final Collection<ModuleReference> moduleReferences) {
 158         final Collection<ModuleReference> identifiedNewModuleReferences = cpsModuleService
 159                 .identifyNewModuleReferences(moduleReferences);
 160         final Map<String, String> newModuleNameToContentMap;
 161         if (identifiedNewModuleReferences.isEmpty()) {
 162             newModuleNameToContentMap = NO_NEW_MODULES;
 163         } else {
 164             newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle,
 165                     identifiedNewModuleReferences);
 166         }
 167         return newModuleNameToContentMap;
 168     }
 169
 170     private String getModuleSetTag(final YangModelCmHandle yangModelCmHandle, final boolean inUpgrade) {
 171         if (inUpgrade) {
 172             return ModuleOperationsUtils.getUpgradedModuleSetTagFromLockReason(
 173                     yangModelCmHandle.getCompositeState().getLockReason());
 174         }
 175         return yangModelCmHandle.getModuleSetTag();
 176     }
 177
 178 }