gerrit.onap Code Review - cps.git/blob

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022-2024 Nordix Foundation
   4  *  Modifications Copyright (C) 2022 Bell Canada
   5  *  Modifications Copyright (C) 2024 TechMahindra Ltd.
   6  *  ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *  You may obtain a copy of the License at
  10  *
  11  *        http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  *
  19  *  SPDX-License-Identifier: Apache-2.0
  20  *  ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.cps.ncmp.api.impl;
  24
  25 import static org.onap.cps.ncmp.api.NcmpResponseStatus.ALTERNATE_ID_ALREADY_ASSOCIATED;
  26 import static org.onap.cps.ncmp.api.NcmpResponseStatus.CM_HANDLES_NOT_FOUND;
  27 import static org.onap.cps.ncmp.api.NcmpResponseStatus.CM_HANDLE_INVALID_ID;
  28 import static org.onap.cps.ncmp.api.impl.CmHandleRegistrationServicePropertyHandler.PropertyType.DMI_PROPERTY;
  29 import static org.onap.cps.ncmp.api.impl.CmHandleRegistrationServicePropertyHandler.PropertyType.PUBLIC_PROPERTY;
  30 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DATASPACE_NAME;
  31 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_ANCHOR;
  32 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_PARENT;
  33
  34 import com.google.common.collect.ImmutableMap;
  35 import java.time.OffsetDateTime;
  36 import java.util.ArrayList;
  37 import java.util.Collection;
  38 import java.util.HashMap;
  39 import java.util.HashSet;
  40 import java.util.LinkedHashMap;
  41 import java.util.List;
  42 import java.util.Map;
  43 import java.util.regex.Matcher;
  44 import java.util.regex.Pattern;
  45 import lombok.RequiredArgsConstructor;
  46 import lombok.extern.slf4j.Slf4j;
  47 import org.onap.cps.api.CpsDataService;
  48 import org.onap.cps.ncmp.api.impl.inventory.InventoryPersistence;
  49 import org.onap.cps.ncmp.api.impl.utils.AlternateIdChecker;
  50 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  51 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  52 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse;
  53 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  54 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  55 import org.onap.cps.spi.exceptions.DataValidationException;
  56 import org.onap.cps.spi.model.DataNode;
  57 import org.onap.cps.spi.model.DataNodeBuilder;
  58 import org.onap.cps.utils.ContentType;
  59 import org.onap.cps.utils.JsonObjectMapper;
  60 import org.springframework.stereotype.Service;
  61 import org.springframework.util.StringUtils;
  62
  63 @Slf4j
  64 @Service
  65 @RequiredArgsConstructor
  66 //Accepting the security hotspot as the string checked is generated from inside code and not user input.
  67 @SuppressWarnings("squid:S5852")
  68 public class CmHandleRegistrationServicePropertyHandler {
  69
  70     private final InventoryPersistence inventoryPersistence;
  71     private final CpsDataService cpsDataService;
  72     private final JsonObjectMapper jsonObjectMapper;
  73     private final AlternateIdChecker alternateIdChecker;
  74
  75     /**
  76      * Iterates over incoming updatedNcmpServiceCmHandles and update the dataNodes based on the updated attributes.
  77      * The attributes which are not passed will remain as is.
  78      *
  79      * @param updatedNcmpServiceCmHandles collection of CmHandles
  80      */
  81     public List<CmHandleRegistrationResponse> updateCmHandleProperties(
  82             final Collection<NcmpServiceCmHandle> updatedNcmpServiceCmHandles) {
  83         final Collection<String> rejectedCmHandleIds = alternateIdChecker
  84             .getIdsOfCmHandlesWithRejectedAlternateId(updatedNcmpServiceCmHandles, AlternateIdChecker.Operation.UPDATE);
  85         final List<CmHandleRegistrationResponse> failureResponses =
  86             CmHandleRegistrationResponse.createFailureResponses(rejectedCmHandleIds, ALTERNATE_ID_ALREADY_ASSOCIATED);
  87         final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses = new ArrayList<>(failureResponses);
  88         for (final NcmpServiceCmHandle updatedNcmpServiceCmHandle : updatedNcmpServiceCmHandles) {
  89             final String cmHandleId = updatedNcmpServiceCmHandle.getCmHandleId();
  90             if (!rejectedCmHandleIds.contains(cmHandleId)) {
  91                 try {
  92                     final DataNode existingCmHandleDataNode = inventoryPersistence
  93                             .getCmHandleDataNodeByCmHandleId(cmHandleId).iterator().next();
  94                     processUpdates(existingCmHandleDataNode, updatedNcmpServiceCmHandle);
  95                     cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandleId));
  96                 } catch (final DataNodeNotFoundException e) {
  97                     log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}", cmHandleId,
  98                             e.getMessage());
  99                     cmHandleRegistrationResponses.add(
 100                             CmHandleRegistrationResponse.createFailureResponse(cmHandleId, CM_HANDLES_NOT_FOUND));
 101                 } catch (final DataValidationException e) {
 102                     log.error("Unable to update cm handle : {}, caused by : {}", cmHandleId, e.getMessage());
 103                     cmHandleRegistrationResponses.add(
 104                             CmHandleRegistrationResponse.createFailureResponse(cmHandleId, CM_HANDLE_INVALID_ID));
 105                 } catch (final Exception exception) {
 106                     log.error("Unable to update cmHandle : {} , caused by : {}", cmHandleId, exception.getMessage());
 107                     cmHandleRegistrationResponses.add(
 108                             CmHandleRegistrationResponse.createFailureResponse(cmHandleId, exception));
 109                 }
 110             }
 111         }
 112         return cmHandleRegistrationResponses;
 113     }
 114
 115     private void processUpdates(final DataNode existingCmHandleDataNode,
 116                                 final NcmpServiceCmHandle updatedNcmpServiceCmHandle) {
 117         setAndUpdateCmHandleField(
 118             updatedNcmpServiceCmHandle.getCmHandleId(), "alternate-id", updatedNcmpServiceCmHandle.getAlternateId());
 119         updateDataProducerIdentifier(existingCmHandleDataNode, updatedNcmpServiceCmHandle);
 120         if (!updatedNcmpServiceCmHandle.getPublicProperties().isEmpty()) {
 121             updateProperties(existingCmHandleDataNode, PUBLIC_PROPERTY,
 122                 updatedNcmpServiceCmHandle.getPublicProperties());
 123         }
 124         if (!updatedNcmpServiceCmHandle.getDmiProperties().isEmpty()) {
 125             updateProperties(existingCmHandleDataNode, DMI_PROPERTY, updatedNcmpServiceCmHandle.getDmiProperties());
 126         }
 127     }
 128
 129     private void updateDataProducerIdentifier(final DataNode cmHandleDataNode,
 130                                               final NcmpServiceCmHandle ncmpServiceCmHandle) {
 131         final String newDataProducerIdentifier = ncmpServiceCmHandle.getDataProducerIdentifier();
 132         if (StringUtils.hasText(newDataProducerIdentifier)) {
 133             final YangModelCmHandle yangModelCmHandle =
 134                 YangDataConverter.convertCmHandleToYangModel(cmHandleDataNode);
 135             final String existingDataProducerIdentifier = yangModelCmHandle.getDataProducerIdentifier();
 136             if (StringUtils.hasText(existingDataProducerIdentifier)) {
 137                 if (!existingDataProducerIdentifier.equals(newDataProducerIdentifier)) {
 138                     log.warn("Unable to update dataProducerIdentifier for cmHandle {}. "
 139                             + "Value for dataProducerIdentifier has been set previously.",
 140                         ncmpServiceCmHandle.getCmHandleId());
 141                 } else {
 142                     log.debug("dataProducerIdentifier for cmHandle {} is already set to {}.",
 143                         ncmpServiceCmHandle.getCmHandleId(), newDataProducerIdentifier);
 144                 }
 145             } else {
 146                 setAndUpdateCmHandleField(
 147                     yangModelCmHandle.getId(), "data-producer-identifier", newDataProducerIdentifier);
 148             }
 149         }
 150     }
 151
 152     private void updateProperties(final DataNode existingCmHandleDataNode, final PropertyType propertyType,
 153                                   final Map<String, String> updatedProperties) {
 154         final Collection<DataNode> replacementPropertyDataNodes =
 155                 getReplacementDataNodes(existingCmHandleDataNode, propertyType, updatedProperties);
 156         replacementPropertyDataNodes.addAll(
 157                 getUnchangedPropertyDataNodes(existingCmHandleDataNode, propertyType, updatedProperties));
 158         if (replacementPropertyDataNodes.isEmpty()) {
 159             removeAllProperties(existingCmHandleDataNode, propertyType);
 160         } else {
 161             inventoryPersistence.replaceListContent(existingCmHandleDataNode.getXpath(), replacementPropertyDataNodes);
 162         }
 163     }
 164
 165     private void removeAllProperties(final DataNode existingCmHandleDataNode, final PropertyType propertyType) {
 166         existingCmHandleDataNode.getChildDataNodes().forEach(dataNode -> {
 167             final Matcher matcher = propertyType.propertyXpathPattern.matcher(dataNode.getXpath());
 168             if (matcher.find()) {
 169                 log.info("Deleting dataNode with xpath : [{}]", dataNode.getXpath());
 170                 inventoryPersistence.deleteDataNode(dataNode.getXpath());
 171             }
 172         });
 173     }
 174
 175     private Collection<DataNode> getUnchangedPropertyDataNodes(final DataNode existingCmHandleDataNode,
 176                                                                final PropertyType propertyType,
 177                                                                final Map<String, String> updatedProperties) {
 178         final Collection<DataNode> unchangedPropertyDataNodes = new HashSet<>();
 179         for (final DataNode existingPropertyDataNode : existingCmHandleDataNode.getChildDataNodes()) {
 180             final Matcher matcher = propertyType.propertyXpathPattern.matcher(existingPropertyDataNode.getXpath());
 181             if (matcher.find()) {
 182                 final String keyName = matcher.group(2);
 183                 if (!updatedProperties.containsKey(keyName)) {
 184                     unchangedPropertyDataNodes.add(existingPropertyDataNode);
 185                 }
 186             }
 187         }
 188         return unchangedPropertyDataNodes;
 189     }
 190
 191     private Collection<DataNode> getReplacementDataNodes(final DataNode existingCmHandleDataNode,
 192                                                          final PropertyType propertyType,
 193                                                          final Map<String, String> updatedProperties) {
 194         final Collection<DataNode> replacementPropertyDataNodes = new HashSet<>();
 195         updatedProperties.forEach((updatedAttributeKey, updatedAttributeValue) -> {
 196             final String propertyXpath = getAttributeXpath(existingCmHandleDataNode, propertyType, updatedAttributeKey);
 197             if (updatedAttributeValue != null) {
 198                 log.info("Creating a new DataNode with xpath {} , key : {} and value : {}", propertyXpath,
 199                         updatedAttributeKey, updatedAttributeValue);
 200                 replacementPropertyDataNodes.add(
 201                         buildDataNode(propertyXpath, updatedAttributeKey, updatedAttributeValue));
 202             }
 203         });
 204         return replacementPropertyDataNodes;
 205     }
 206
 207     private String getAttributeXpath(final DataNode cmHandle, final PropertyType propertyType,
 208                                      final String attributeKey) {
 209         return cmHandle.getXpath() + "/" + propertyType.xpathPrefix + String.format("[@name='%s']", attributeKey);
 210     }
 211
 212     private DataNode buildDataNode(final String xpath, final String attributeKey, final String attributeValue) {
 213         final Map<String, String> updatedLeaves = new LinkedHashMap<>(1);
 214         updatedLeaves.put("name", attributeKey);
 215         updatedLeaves.put("value", attributeValue);
 216         log.debug("Building a new node with xpath {} with leaves (name : {} , value : {})", xpath, attributeKey,
 217                 attributeValue);
 218         return new DataNodeBuilder().withXpath(xpath).withLeaves(ImmutableMap.copyOf(updatedLeaves)).build();
 219     }
 220
 221     private void setAndUpdateCmHandleField(final String cmHandleIdToUpdate, final String fieldName,
 222                                            final String newFieldValue) {
 223         final Map<String, Map<String, String>> dmiRegistryData = new HashMap<>(1);
 224         final Map<String, String> cmHandleData = new HashMap<>(2);
 225         cmHandleData.put("id", cmHandleIdToUpdate);
 226         cmHandleData.put(fieldName, newFieldValue);
 227         dmiRegistryData.put("cm-handles", cmHandleData);
 228         cpsDataService.updateNodeLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 229                 jsonObjectMapper.asJsonString(dmiRegistryData), OffsetDateTime.now(), ContentType.JSON);
 230         log.debug("Updating {} for cmHandle {} with value : {})", fieldName, cmHandleIdToUpdate, newFieldValue);
 231     }
 232
 233     enum PropertyType {
 234         DMI_PROPERTY("additional-properties"), PUBLIC_PROPERTY("public-properties");
 235
 236         private static final String LIST_INDEX_PATTERN = "\\[@(\\w+)[^\\/]'([^']+)']";
 237
 238         final String xpathPrefix;
 239         final Pattern propertyXpathPattern;
 240
 241         PropertyType(final String xpathPrefix) {
 242             this.xpathPrefix = xpathPrefix;
 243             this.propertyXpathPattern = Pattern.compile(xpathPrefix + LIST_INDEX_PATTERN);
 244         }
 245     }
 246 }