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 lombok.RequiredArgsConstructor;
  35 import lombok.extern.slf4j.Slf4j;
  36 import org.apache.commons.lang3.StringUtils;
  37 import org.apache.commons.lang3.tuple.ImmutableTriple;
  38 import org.onap.cps.api.CpsAnchorService;
  39 import org.onap.cps.api.CpsDataService;
  40 import org.onap.cps.api.CpsModuleService;
  41 import org.onap.cps.ncmp.api.impl.inventory.CmHandleQueries;
  42 import org.onap.cps.ncmp.api.impl.inventory.CmHandleState;
  43 import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations;
  44 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  45 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  46 import org.onap.cps.spi.CascadeDeleteAllowed;
  47 import org.onap.cps.spi.FetchDescendantsOption;
  48 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
  49 import org.onap.cps.spi.model.DataNode;
  50 import org.onap.cps.spi.model.ModuleReference;
  51 import org.onap.cps.utils.JsonObjectMapper;
  52 import org.springframework.stereotype.Service;
  53
  54 @Slf4j
  55 @Service
  56 @RequiredArgsConstructor
  57 public class ModuleSyncService {
  58
  59     private final DmiModelOperations dmiModelOperations;
  60     private final CpsModuleService cpsModuleService;
  61     private final CmHandleQueries cmHandleQueries;
  62     private final CpsDataService cpsDataService;
  63     private final CpsAnchorService cpsAnchorService;
  64     private final JsonObjectMapper jsonObjectMapper;
  65     private static final Map<String, String> NO_NEW_MODULES = Collections.emptyMap();
  66
  67     /**
  68      * This method registers a cm handle and initiates modules sync.
  69      *
  70      * @param yangModelCmHandle the yang model of cm handle.
  71      */
  72     public void syncAndCreateOrUpgradeSchemaSetAndAnchor(final YangModelCmHandle yangModelCmHandle) {
  73
  74         final boolean inUpgrade = ModuleOperationsUtils.inUpgradeOrUpgradeFailed(yangModelCmHandle.getCompositeState());
  75
  76         final ImmutableTriple<String, Map<String, String>, Collection<ModuleReference>>
  77                 allModuleReferencesAndNewModuleNameByModuleSetTag
  78                 = getAllModuleReferencesAndNewYangResourcesByModuleSetTag(yangModelCmHandle, inUpgrade);
  79
  80         final String moduleSetTag = allModuleReferencesAndNewModuleNameByModuleSetTag.getLeft();
  81         final Map<String, String> newYangResources = allModuleReferencesAndNewModuleNameByModuleSetTag.getMiddle();
  82         final Collection<ModuleReference> allModuleReferences
  83                 = allModuleReferencesAndNewModuleNameByModuleSetTag.getRight();
  84         final String cmHandleId = yangModelCmHandle.getId();
  85
  86         if (inUpgrade) {
  87             cpsModuleService.upgradeSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId,
  88                     newYangResources, allModuleReferences);
  89             setCmHandleModuleSetTag(yangModelCmHandle, moduleSetTag);
  90         } else {
  91             cpsModuleService.createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId,
  92                     newYangResources, allModuleReferences);
  93             cpsAnchorService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId, cmHandleId);
  94         }
  95     }
  96
  97     /**
  98      * Deletes the SchemaSet for schema set id if the SchemaSet Exists.
  99      *
 100      * @param schemaSetId the schema set id to be deleted
 101      */
 102     public void deleteSchemaSetIfExists(final String schemaSetId) {
 103         try {
 104             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetId,
 105                 CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED);
 106             log.debug("SchemaSet for {} has been deleted. Ready to be recreated.", schemaSetId);
 107         } catch (final SchemaSetNotFoundException e) {
 108             log.debug("No SchemaSet for {}. Assuming CmHandle has not been previously Module Synced.", schemaSetId);
 109         }
 110     }
 111
 112     private ImmutableTriple<String, Map<String, String>, Collection<ModuleReference>>
 113         getAllModuleReferencesAndNewYangResourcesByModuleSetTag(final YangModelCmHandle yangModelCmHandle,
 114                                                                 final boolean inUpgrade) {
 115         final String moduleSetTag = getModuleSetTag(yangModelCmHandle, inUpgrade);
 116         final Collection<ModuleReference> allModuleReferences;
 117         final Map<String, String> newYangResources;
 118
 119         final YangModelCmHandle cmHandleWithSameModuleSetTag = getAnyReadyCmHandleByModuleSetTag(moduleSetTag);
 120         if (cmHandleWithSameModuleSetTag == null) {
 121             allModuleReferences = dmiModelOperations.getModuleReferences(yangModelCmHandle);
 122             newYangResources = getNewModuleNameToContentMap(yangModelCmHandle, allModuleReferences);
 123         } else {
 124             log.info("Found other cm handle having same module set tag: {}", moduleSetTag);
 125             allModuleReferences = cpsModuleService.getYangResourcesModuleReferences(
 126                     NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleWithSameModuleSetTag.getId());
 127             newYangResources = NO_NEW_MODULES;
 128         }
 129         return ImmutableTriple.of(moduleSetTag, newYangResources, allModuleReferences);
 130     }
 131
 132     private YangModelCmHandle getAnyReadyCmHandleByModuleSetTag(final String moduleSetTag) {
 133         if (StringUtils.isBlank(moduleSetTag)) {
 134             return null;
 135         }
 136         final String escapedModuleSetTag = moduleSetTag.replace("'", "''");
 137         final List<DataNode> dataNodes = cmHandleQueries.queryNcmpRegistryByCpsPath(
 138                 NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@module-set-tag='" + escapedModuleSetTag + "']",
 139                 FetchDescendantsOption.DIRECT_CHILDREN_ONLY);
 140         return dataNodes.stream().map(YangDataConverter::convertCmHandleToYangModel)
 141                 .filter(cmHandle -> cmHandle.getCompositeState().getCmHandleState() == CmHandleState.READY)
 142                 .findFirst().orElse(null);
 143     }
 144
 145     private void setCmHandleModuleSetTag(final YangModelCmHandle upgradedCmHandle, final String moduleSetTag) {
 146         final Map<String, Map<String, String>> dmiRegistryProperties = new HashMap<>(1);
 147         final Map<String, String> cmHandleProperties = new HashMap<>(2);
 148         cmHandleProperties.put("id", upgradedCmHandle.getId());
 149         cmHandleProperties.put("module-set-tag", moduleSetTag);
 150         dmiRegistryProperties.put("cm-handles", cmHandleProperties);
 151         cpsDataService.updateNodeLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 152                 jsonObjectMapper.asJsonString(dmiRegistryProperties), OffsetDateTime.now());
 153     }
 154
 155     private Map<String, String> getNewModuleNameToContentMap(final YangModelCmHandle yangModelCmHandle,
 156                                                              final Collection<ModuleReference> moduleReferences) {
 157         final Collection<ModuleReference> identifiedNewModuleReferences = cpsModuleService
 158                 .identifyNewModuleReferences(moduleReferences);
 159         return dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle, identifiedNewModuleReferences);
 160     }
 161
 162     private String getModuleSetTag(final YangModelCmHandle yangModelCmHandle, final boolean inUpgrade) {
 163         if (inUpgrade) {
 164             return ModuleOperationsUtils.getUpgradedModuleSetTagFromLockReason(
 165                     yangModelCmHandle.getCompositeState().getLockReason());
 166         }
 167         return yangModelCmHandle.getModuleSetTag();
 168     }
 169
 170 }