cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 highstreet technologies GmbH
   4  *  Modifications Copyright (C) 2021-2022 Nordix Foundation
   5  *  Modifications Copyright (C) 2021 Pantheon.tech
   6  *  Modifications Copyright (C) 2021 Bell Canada
   7  *  ================================================================================
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License.
  19  *
  20  *  SPDX-License-Identifier: Apache-2.0
  21  *  ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.cps.ncmp.api.impl;
  25
  26 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DATASPACE_NAME;
  27 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_ANCHOR;
  28 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_PARENT;
  29 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
  30 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP;
  31 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
  32 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
  33
  34 import com.fasterxml.jackson.core.JsonProcessingException;
  35 import java.util.Collection;
  36 import java.util.HashMap;
  37 import java.util.LinkedHashMap;
  38 import java.util.List;
  39 import java.util.Map;
  40 import java.util.UUID;
  41 import java.util.regex.Pattern;
  42 import java.util.stream.Collectors;
  43 import lombok.RequiredArgsConstructor;
  44 import lombok.extern.slf4j.Slf4j;
  45 import org.onap.cps.api.CpsAdminService;
  46 import org.onap.cps.api.CpsDataService;
  47 import org.onap.cps.api.CpsModuleService;
  48 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
  49 import org.onap.cps.ncmp.api.impl.exception.InvalidTopicException;
  50 import org.onap.cps.ncmp.api.impl.exception.ServerNcmpException;
  51 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
  52 import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations;
  53 import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
  54 import org.onap.cps.ncmp.api.impl.operations.YangModelCmHandleRetriever;
  55 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  56 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandlesList;
  57 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
  58 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  59 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  60 import org.onap.cps.spi.exceptions.DataValidationException;
  61 import org.onap.cps.spi.model.ModuleReference;
  62 import org.onap.cps.utils.JsonObjectMapper;
  63 import org.springframework.http.HttpStatus;
  64 import org.springframework.http.ResponseEntity;
  65 import org.springframework.stereotype.Service;
  66
  67 @Slf4j
  68 @Service
  69 @RequiredArgsConstructor
  70 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
  71
  72     private final CpsDataService cpsDataService;
  73
  74     private final JsonObjectMapper jsonObjectMapper;
  75
  76     private final DmiDataOperations dmiDataOperations;
  77
  78     private final DmiModelOperations dmiModelOperations;
  79
  80     private final CpsModuleService cpsModuleService;
  81
  82     private final CpsAdminService cpsAdminService;
  83
  84     private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
  85
  86     private final YangModelCmHandleRetriever yangModelCmHandleRetriever;
  87
  88     // valid kafka topic name regex
  89     private static final Pattern TOPIC_NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9]([._-](?![._-])|"
  90             + "[a-zA-Z0-9]){0,120}[a-zA-Z0-9]$");
  91     private static final String NO_REQUEST_ID = null;
  92     private static final String NO_TOPIC = null;
  93
  94     @Override
  95     public void updateDmiRegistrationAndSyncModule(final DmiPluginRegistration dmiPluginRegistration) {
  96         dmiPluginRegistration.validateDmiPluginRegistration();
  97         try {
  98             if (!dmiPluginRegistration.getCreatedCmHandles().isEmpty()) {
  99                 parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(dmiPluginRegistration);
 100             }
 101             if (!dmiPluginRegistration.getUpdatedCmHandles().isEmpty()) {
 102                 parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration);
 103             }
 104             parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration);
 105         } catch (final JsonProcessingException | DataNodeNotFoundException e) {
 106             final String errorMessage = String.format(
 107                     "Error occurred while processing the CM-handle registration request, caused by : [%s]",
 108                     e.getMessage());
 109             throw new DataValidationException(errorMessage, e.getMessage(), e);
 110         }
 111     }
 112
 113     @Override
 114     public Object getResourceDataOperationalForCmHandle(final String cmHandleId,
 115                                                         final String resourceIdentifier,
 116                                                         final String acceptParamInHeader,
 117                                                         final String optionsParamInQuery,
 118                                                         final String topicParamInQuery) {
 119
 120         return validateTopicNameAndGetResourceData(cmHandleId, resourceIdentifier, acceptParamInHeader,
 121                 DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL, optionsParamInQuery, topicParamInQuery);
 122     }
 123
 124     @Override
 125     public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 126                                                                final String resourceIdentifier,
 127                                                                final String acceptParamInHeader,
 128                                                                final String optionsParamInQuery,
 129                                                                final String topicParamInQuery) {
 130         return validateTopicNameAndGetResourceData(cmHandleId, resourceIdentifier, acceptParamInHeader,
 131                 DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING, optionsParamInQuery, topicParamInQuery);
 132     }
 133
 134     @Override
 135     public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 136                                                                final String resourceIdentifier,
 137                                                                final OperationEnum operation,
 138                                                                final String requestData,
 139                                                                final String dataType) {
 140         return handleResponse(
 141             dmiDataOperations.writeResourceDataPassThroughRunningFromDmi(
 142                 cmHandleId, resourceIdentifier, operation, requestData, dataType),
 143             "Not able to " + operation + " resource data.");
 144     }
 145
 146
 147     @Override
 148     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 149         return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 150     }
 151
 152     /**
 153      * Retrieve cm handle identifiers for the given list of module names.
 154      *
 155      * @param moduleNames module names.
 156      * @return a collection of anchor identifiers
 157      */
 158     @Override
 159     public Collection<String> executeCmHandleHasAllModulesSearch(final Collection<String> moduleNames) {
 160         return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNames);
 161     }
 162
 163     /**
 164      * Retrieve cm handle details for a given cm handle.
 165      * @param cmHandleId cm handle identifier
 166      * @return cm handle details
 167      */
 168     @Override
 169     public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
 170         final NcmpServiceCmHandle ncmpServiceCmHandle = new NcmpServiceCmHandle();
 171         final YangModelCmHandle yangModelCmHandle =
 172             yangModelCmHandleRetriever.getDmiServiceNamesAndProperties(cmHandleId);
 173         final List<YangModelCmHandle.Property> dmiProperties = yangModelCmHandle.getDmiProperties();
 174         final List<YangModelCmHandle.Property> publicProperties = yangModelCmHandle.getPublicProperties();
 175         ncmpServiceCmHandle.setCmHandleID(yangModelCmHandle.getId());
 176         setDmiProperties(dmiProperties, ncmpServiceCmHandle);
 177         setPublicProperties(publicProperties, ncmpServiceCmHandle);
 178         return ncmpServiceCmHandle;
 179     }
 180
 181     private void setDmiProperties(final List<YangModelCmHandle.Property> dmiProperties,
 182                                   final NcmpServiceCmHandle ncmpServiceCmHandle) {
 183         final Map<String, String> dmiPropertiesMap = new LinkedHashMap<>(dmiProperties.size());
 184         asPropertiesMap(dmiProperties, dmiPropertiesMap);
 185         ncmpServiceCmHandle.setDmiProperties(dmiPropertiesMap);
 186     }
 187
 188     private void setPublicProperties(final List<YangModelCmHandle.Property> publicProperties,
 189                                      final NcmpServiceCmHandle ncmpServiceCmHandle) {
 190         final Map<String, String> publicPropertiesMap = new LinkedHashMap<>();
 191         asPropertiesMap(publicProperties, publicPropertiesMap);
 192         ncmpServiceCmHandle.setPublicProperties(publicPropertiesMap);
 193     }
 194
 195     private void asPropertiesMap(final List<YangModelCmHandle.Property> properties,
 196                                  final Map<String, String> propertiesMap) {
 197         for (final YangModelCmHandle.Property property: properties) {
 198             propertiesMap.put(property.getName(), property.getValue());
 199         }
 200     }
 201
 202     /**
 203      * THis method registers a cm handle and initiates modules sync.
 204      *
 205      * @param dmiPluginRegistration dmi plugin registration information.
 206      * @throws JsonProcessingException thrown if json is malformed or missing.
 207      */
 208     public void parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
 209         final DmiPluginRegistration dmiPluginRegistration) throws JsonProcessingException {
 210         final YangModelCmHandlesList createdYangModelCmHandlesList =
 211             getUpdatedYangModelCmHandlesList(dmiPluginRegistration,
 212                 dmiPluginRegistration.getCreatedCmHandles());
 213         registerAndSyncNewCmHandles(createdYangModelCmHandlesList);
 214     }
 215
 216     private static Object handleResponse(final ResponseEntity<?> responseEntity,
 217                                          final String exceptionMessage) {
 218         if (responseEntity.getStatusCode().is2xxSuccessful()) {
 219             return responseEntity.getBody();
 220         } else {
 221             throw new ServerNcmpException(exceptionMessage,
 222                     "DMI status code: " + responseEntity.getStatusCodeValue()
 223                             + ", DMI response body: " + responseEntity.getBody());
 224         }
 225     }
 226
 227     private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
 228         networkCmProxyDataServicePropertyHandler.updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles());
 229     }
 230
 231     private YangModelCmHandlesList getUpdatedYangModelCmHandlesList(
 232         final DmiPluginRegistration dmiPluginRegistration,
 233         final List<NcmpServiceCmHandle> updatedCmHandles) {
 234         return YangModelCmHandlesList.toYangModelCmHandlesList(
 235             dmiPluginRegistration.getDmiPlugin(),
 236             dmiPluginRegistration.getDmiDataPlugin(),
 237             dmiPluginRegistration.getDmiModelPlugin(),
 238             updatedCmHandles);
 239     }
 240
 241     private void registerAndSyncNewCmHandles(final YangModelCmHandlesList yangModelCmHandlesList) {
 242         final String cmHandleJsonData = jsonObjectMapper.asJsonString(yangModelCmHandlesList);
 243         cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 244                 cmHandleJsonData, NO_TIMESTAMP);
 245
 246         for (final YangModelCmHandle yangModelCmHandle : yangModelCmHandlesList.getYangModelCmHandles()) {
 247             syncModulesAndCreateAnchor(yangModelCmHandle);
 248         }
 249     }
 250
 251     protected void syncModulesAndCreateAnchor(final YangModelCmHandle yangModelCmHandle) {
 252         syncAndCreateSchemaSet(yangModelCmHandle);
 253         createAnchor(yangModelCmHandle);
 254     }
 255
 256     private void parseAndRemoveCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
 257         for (final String cmHandle : dmiPluginRegistration.getRemovedCmHandles()) {
 258             try {
 259                 attemptToDeleteSchemaSetWithCascade(cmHandle);
 260                 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 261                     "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
 262             } catch (final DataNodeNotFoundException e) {
 263                 log.warn("Datanode {} not deleted message {}", cmHandle, e.getMessage());
 264             }
 265         }
 266     }
 267
 268     private void attemptToDeleteSchemaSetWithCascade(final String schemaSetName) {
 269         try {
 270             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 271                 CASCADE_DELETE_ALLOWED);
 272         } catch (final Exception e) {
 273             log.warn("Schema set {} delete failed, reason {}", schemaSetName, e.getMessage());
 274         }
 275     }
 276
 277     private void syncAndCreateSchemaSet(final YangModelCmHandle yangModelCmHandle) {
 278         final Collection<ModuleReference> moduleReferencesFromCmHandle =
 279             dmiModelOperations.getModuleReferences(yangModelCmHandle);
 280
 281         final Collection<ModuleReference> identifiedNewModuleReferencesFromCmHandle = cpsModuleService
 282             .identifyNewModuleReferences(moduleReferencesFromCmHandle);
 283
 284         final Collection<ModuleReference> existingModuleReferencesFromCmHandle =
 285             moduleReferencesFromCmHandle.stream().filter(moduleReferenceFromCmHandle ->
 286                 !identifiedNewModuleReferencesFromCmHandle.contains(moduleReferenceFromCmHandle)
 287             ).collect(Collectors.toList());
 288
 289         final Map<String, String> newModuleNameToContentMap;
 290         if (identifiedNewModuleReferencesFromCmHandle.isEmpty()) {
 291             newModuleNameToContentMap = new HashMap<>();
 292         } else {
 293             newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle,
 294                 identifiedNewModuleReferencesFromCmHandle);
 295         }
 296         cpsModuleService
 297             .createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 298                 newModuleNameToContentMap, existingModuleReferencesFromCmHandle);
 299     }
 300
 301     private void createAnchor(final YangModelCmHandle yangModelCmHandle) {
 302         cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 303             yangModelCmHandle.getId());
 304     }
 305
 306     private static boolean hasTopicParameter(final String topicName) {
 307         if (topicName == null) {
 308             return false;
 309         }
 310         if (TOPIC_NAME_PATTERN.matcher(topicName).matches()) {
 311             return true;
 312         }
 313         throw new InvalidTopicException("Topic name " + topicName + " is invalid", "invalid topic");
 314     }
 315
 316     private Map<String, Object> buildDmiResponse(final String requestId) {
 317         final Map<String, Object> dmiResponseMap = new HashMap<>();
 318         dmiResponseMap.put("requestId", requestId);
 319         return dmiResponseMap;
 320     }
 321
 322     private Object validateTopicNameAndGetResourceData(final String cmHandleId,
 323                                                        final String resourceIdentifier,
 324                                                        final String acceptParamInHeader,
 325                                                        final DmiOperations.DataStoreEnum dataStore,
 326                                                        final String optionsParamInQuery,
 327                                                        final String topicParamInQuery) {
 328         final boolean processAsynchronously = hasTopicParameter(topicParamInQuery);
 329         if (processAsynchronously) {
 330             final String resourceDataRequestId = UUID.randomUUID().toString();
 331             return ResponseEntity.status(HttpStatus.OK)
 332                     .body(buildDmiResponse(resourceDataRequestId));
 333         }
 334         final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(
 335                 cmHandleId, resourceIdentifier, optionsParamInQuery, acceptParamInHeader,
 336                 dataStore, NO_REQUEST_ID, NO_TOPIC);
 337         return handleResponse(responseEntity, "Not able to get resource data.");
 338     }
 339 }