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-2022 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 java.util.ArrayList;
  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.models.CmHandleRegistrationResponse;
  57 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.RegistrationError;
  58 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
  59 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
  60 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  61 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
  62 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  63 import org.onap.cps.spi.exceptions.DataValidationException;
  64 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
  65 import org.onap.cps.spi.model.ModuleReference;
  66 import org.onap.cps.utils.CpsValidator;
  67 import org.onap.cps.utils.JsonObjectMapper;
  68 import org.springframework.http.HttpStatus;
  69 import org.springframework.http.ResponseEntity;
  70 import org.springframework.stereotype.Service;
  71
  72 @Slf4j
  73 @Service
  74 @RequiredArgsConstructor
  75 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
  76
  77     private final CpsDataService cpsDataService;
  78
  79     private final JsonObjectMapper jsonObjectMapper;
  80
  81     private final DmiDataOperations dmiDataOperations;
  82
  83     private final DmiModelOperations dmiModelOperations;
  84
  85     private final CpsModuleService cpsModuleService;
  86
  87     private final CpsAdminService cpsAdminService;
  88
  89     private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
  90
  91     private final YangModelCmHandleRetriever yangModelCmHandleRetriever;
  92
  93     // valid kafka topic name regex
  94     private static final Pattern TOPIC_NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9]([._-](?![._-])|"
  95             + "[a-zA-Z0-9]){0,120}[a-zA-Z0-9]$");
  96     private static final String NO_REQUEST_ID = null;
  97     private static final String NO_TOPIC = null;
  98
  99     @Override
 100     public DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(
 101         final DmiPluginRegistration dmiPluginRegistration) {
 102         dmiPluginRegistration.validateDmiPluginRegistration();
 103         final var dmiPluginRegistrationResponse = new DmiPluginRegistrationResponse();
 104         dmiPluginRegistrationResponse.setRemovedCmHandles(
 105             parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration.getRemovedCmHandles()));
 106         if (!dmiPluginRegistration.getCreatedCmHandles().isEmpty()) {
 107             dmiPluginRegistrationResponse.setCreatedCmHandles(
 108                 parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(dmiPluginRegistration));
 109         }
 110         if (!dmiPluginRegistration.getUpdatedCmHandles().isEmpty()) {
 111             dmiPluginRegistrationResponse.setUpdatedCmHandles(
 112                 networkCmProxyDataServicePropertyHandler
 113                     .updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles()));
 114         }
 115         return dmiPluginRegistrationResponse;
 116     }
 117
 118     @Override
 119     public Object getResourceDataOperationalForCmHandle(final String cmHandleId,
 120                                                         final String resourceIdentifier,
 121                                                         final String acceptParamInHeader,
 122                                                         final String optionsParamInQuery,
 123                                                         final String topicParamInQuery) {
 124         CpsValidator.validateNameCharacters(cmHandleId);
 125         return validateTopicNameAndGetResourceData(cmHandleId, resourceIdentifier, acceptParamInHeader,
 126                 DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL, optionsParamInQuery, topicParamInQuery);
 127     }
 128
 129     @Override
 130     public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 131                                                                final String resourceIdentifier,
 132                                                                final String acceptParamInHeader,
 133                                                                final String optionsParamInQuery,
 134                                                                final String topicParamInQuery) {
 135         CpsValidator.validateNameCharacters(cmHandleId);
 136         return validateTopicNameAndGetResourceData(cmHandleId, resourceIdentifier, acceptParamInHeader,
 137                 DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING, optionsParamInQuery, topicParamInQuery);
 138     }
 139
 140     @Override
 141     public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
 142                                                                final String resourceIdentifier,
 143                                                                final OperationEnum operation,
 144                                                                final String requestData,
 145                                                                final String dataType) {
 146         CpsValidator.validateNameCharacters(cmHandleId);
 147         return handleResponse(
 148             dmiDataOperations.writeResourceDataPassThroughRunningFromDmi(
 149                 cmHandleId, resourceIdentifier, operation, requestData, dataType),
 150             "Not able to " + operation + " resource data.");
 151     }
 152
 153
 154     @Override
 155     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 156         CpsValidator.validateNameCharacters(cmHandleId);
 157         return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 158     }
 159
 160     /**
 161      * Retrieve cm handle identifiers for the given list of module names.
 162      *
 163      * @param moduleNames module names.
 164      * @return a collection of anchor identifiers
 165      */
 166     @Override
 167     public Collection<String> executeCmHandleHasAllModulesSearch(final Collection<String> moduleNames) {
 168         return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNames);
 169     }
 170
 171     /**
 172      * Retrieve cm handle details for a given cm handle.
 173      *
 174      * @param cmHandleId cm handle identifier
 175      * @return cm handle details
 176      */
 177     @Override
 178     public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
 179         CpsValidator.validateNameCharacters(cmHandleId);
 180         final NcmpServiceCmHandle ncmpServiceCmHandle = new NcmpServiceCmHandle();
 181         final YangModelCmHandle yangModelCmHandle =
 182             yangModelCmHandleRetriever.getDmiServiceNamesAndProperties(cmHandleId);
 183         final List<YangModelCmHandle.Property> dmiProperties = yangModelCmHandle.getDmiProperties();
 184         final List<YangModelCmHandle.Property> publicProperties = yangModelCmHandle.getPublicProperties();
 185         ncmpServiceCmHandle.setCmHandleID(yangModelCmHandle.getId());
 186         setDmiProperties(dmiProperties, ncmpServiceCmHandle);
 187         setPublicProperties(publicProperties, ncmpServiceCmHandle);
 188         return ncmpServiceCmHandle;
 189     }
 190
 191     private void setDmiProperties(final List<YangModelCmHandle.Property> dmiProperties,
 192                                   final NcmpServiceCmHandle ncmpServiceCmHandle) {
 193         final Map<String, String> dmiPropertiesMap = new LinkedHashMap<>(dmiProperties.size());
 194         asPropertiesMap(dmiProperties, dmiPropertiesMap);
 195         ncmpServiceCmHandle.setDmiProperties(dmiPropertiesMap);
 196     }
 197
 198     private void setPublicProperties(final List<YangModelCmHandle.Property> publicProperties,
 199                                      final NcmpServiceCmHandle ncmpServiceCmHandle) {
 200         final Map<String, String> publicPropertiesMap = new LinkedHashMap<>();
 201         asPropertiesMap(publicProperties, publicPropertiesMap);
 202         ncmpServiceCmHandle.setPublicProperties(publicPropertiesMap);
 203     }
 204
 205     private void asPropertiesMap(final List<YangModelCmHandle.Property> properties,
 206                                  final Map<String, String> propertiesMap) {
 207         for (final YangModelCmHandle.Property property: properties) {
 208             propertiesMap.put(property.getName(), property.getValue());
 209         }
 210     }
 211
 212     /**
 213      * THis method registers a cm handle and initiates modules sync.
 214      *
 215      * @param dmiPluginRegistration dmi plugin registration information.
 216      * @return cm-handle registration response for create cm-handle requests.
 217      */
 218     public List<CmHandleRegistrationResponse> parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
 219         final DmiPluginRegistration dmiPluginRegistration) {
 220         return dmiPluginRegistration.getCreatedCmHandles().stream()
 221             .map(cmHandle ->
 222                 YangModelCmHandle.toYangModelCmHandle(
 223                     dmiPluginRegistration.getDmiPlugin(),
 224                     dmiPluginRegistration.getDmiDataPlugin(),
 225                     dmiPluginRegistration.getDmiModelPlugin(), cmHandle)
 226             )
 227             .map(this::registerAndSyncNewCmHandle)
 228             .collect(Collectors.toList());
 229     }
 230
 231     private static Object handleResponse(final ResponseEntity<?> responseEntity,
 232                                          final String exceptionMessage) {
 233         if (responseEntity.getStatusCode().is2xxSuccessful()) {
 234             return responseEntity.getBody();
 235         } else {
 236             throw new ServerNcmpException(exceptionMessage,
 237                     "DMI status code: " + responseEntity.getStatusCodeValue()
 238                             + ", DMI response body: " + responseEntity.getBody());
 239         }
 240     }
 241
 242     private CmHandleRegistrationResponse registerAndSyncNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 243         try {
 244             CpsValidator.validateNameCharacters(yangModelCmHandle.getId());
 245             final String cmHandleJsonData = String.format("{\"cm-handles\":[%s]}",
 246                 jsonObjectMapper.asJsonString(yangModelCmHandle));
 247             cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 248                 cmHandleJsonData, NO_TIMESTAMP);
 249             syncModulesAndCreateAnchor(yangModelCmHandle);
 250             return CmHandleRegistrationResponse.createSuccessResponse(yangModelCmHandle.getId());
 251         } catch (final AlreadyDefinedException alreadyDefinedException) {
 252             return CmHandleRegistrationResponse.createFailureResponse(
 253                 yangModelCmHandle.getId(), RegistrationError.CM_HANDLE_ALREADY_EXIST);
 254         } catch (final DataValidationException dataValidationException) {
 255             return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(),
 256                 RegistrationError.CM_HANDLE_INVALID_ID);
 257         } catch (final Exception exception) {
 258             return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(), exception);
 259         }
 260     }
 261
 262     protected void syncModulesAndCreateAnchor(final YangModelCmHandle yangModelCmHandle) {
 263         syncAndCreateSchemaSet(yangModelCmHandle);
 264         createAnchor(yangModelCmHandle);
 265     }
 266
 267     protected List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
 268         final List<String> tobeRemovedCmHandles) {
 269         final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
 270             new ArrayList<>(tobeRemovedCmHandles.size());
 271         for (final String cmHandle : tobeRemovedCmHandles) {
 272             try {
 273                 CpsValidator.validateNameCharacters(cmHandle);
 274                 deleteSchemaSetWithCascade(cmHandle);
 275                 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 276                     "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
 277                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandle));
 278             } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
 279                 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
 280                     cmHandle, dataNodeNotFoundException.getMessage());
 281                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 282                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
 283             } catch (final DataValidationException dataValidationException) {
 284                 log.error("Unable to de-register cm-handle id: {}, caused by: {}",
 285                     cmHandle, dataValidationException.getMessage());
 286                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 287                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_INVALID_ID));
 288             } catch (final Exception exception) {
 289                 log.error("Unable to de-register cm-handle id : {} , caused by : {}",
 290                     cmHandle, exception.getMessage());
 291                 cmHandleRegistrationResponses.add(
 292                     CmHandleRegistrationResponse.createFailureResponse(cmHandle, exception));
 293             }
 294         }
 295         return cmHandleRegistrationResponses;
 296     }
 297
 298     private void deleteSchemaSetWithCascade(final String schemaSetName) {
 299         try {
 300             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 301                 CASCADE_DELETE_ALLOWED);
 302         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 303             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 304         }
 305     }
 306
 307     private void syncAndCreateSchemaSet(final YangModelCmHandle yangModelCmHandle) {
 308         final Collection<ModuleReference> moduleReferencesFromCmHandle =
 309             dmiModelOperations.getModuleReferences(yangModelCmHandle);
 310
 311         final Collection<ModuleReference> identifiedNewModuleReferencesFromCmHandle = cpsModuleService
 312             .identifyNewModuleReferences(moduleReferencesFromCmHandle);
 313
 314         final Collection<ModuleReference> existingModuleReferencesFromCmHandle =
 315             moduleReferencesFromCmHandle.stream().filter(moduleReferenceFromCmHandle ->
 316                 !identifiedNewModuleReferencesFromCmHandle.contains(moduleReferenceFromCmHandle)
 317             ).collect(Collectors.toList());
 318
 319         final Map<String, String> newModuleNameToContentMap;
 320         if (identifiedNewModuleReferencesFromCmHandle.isEmpty()) {
 321             newModuleNameToContentMap = new HashMap<>();
 322         } else {
 323             newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle,
 324                 identifiedNewModuleReferencesFromCmHandle);
 325         }
 326         cpsModuleService
 327             .createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 328                 newModuleNameToContentMap, existingModuleReferencesFromCmHandle);
 329     }
 330
 331     private void createAnchor(final YangModelCmHandle yangModelCmHandle) {
 332         cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 333             yangModelCmHandle.getId());
 334     }
 335
 336     private static boolean hasTopicParameter(final String topicName) {
 337         if (topicName == null) {
 338             return false;
 339         }
 340         if (TOPIC_NAME_PATTERN.matcher(topicName).matches()) {
 341             return true;
 342         }
 343         throw new InvalidTopicException("Topic name " + topicName + " is invalid", "invalid topic");
 344     }
 345
 346     private Map<String, Object> buildDmiResponse(final String requestId) {
 347         final Map<String, Object> dmiResponseMap = new HashMap<>();
 348         dmiResponseMap.put("requestId", requestId);
 349         return dmiResponseMap;
 350     }
 351
 352     private Object validateTopicNameAndGetResourceData(final String cmHandleId,
 353                                                        final String resourceIdentifier,
 354                                                        final String acceptParamInHeader,
 355                                                        final DmiOperations.DataStoreEnum dataStore,
 356                                                        final String optionsParamInQuery,
 357                                                        final String topicParamInQuery) {
 358         final boolean processAsynchronously = hasTopicParameter(topicParamInQuery);
 359         if (processAsynchronously) {
 360             final String resourceDataRequestId = UUID.randomUUID().toString();
 361             return ResponseEntity.status(HttpStatus.OK)
 362                     .body(buildDmiResponse(resourceDataRequestId));
 363         }
 364         final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(
 365                 cmHandleId, resourceIdentifier, optionsParamInQuery, acceptParamInHeader,
 366                 dataStore, NO_REQUEST_ID, NO_TOPIC);
 367         return handleResponse(responseEntity, "Not able to get resource data.");
 368     }
 369 }