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.HttpClientRequestException;
  50 import org.onap.cps.ncmp.api.impl.exception.InvalidTopicException;
  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(cmHandleId, resourceIdentifier, operation,
 149                         requestData, dataType), operation);
 150     }
 151
 152
 153     @Override
 154     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 155         CpsValidator.validateNameCharacters(cmHandleId);
 156         return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 157     }
 158
 159     /**
 160      * Retrieve cm handle identifiers for the given list of module names.
 161      *
 162      * @param moduleNames module names.
 163      * @return a collection of anchor identifiers
 164      */
 165     @Override
 166     public Collection<String> executeCmHandleHasAllModulesSearch(final Collection<String> moduleNames) {
 167         return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNames);
 168     }
 169
 170     /**
 171      * Retrieve cm handle details for a given cm handle.
 172      *
 173      * @param cmHandleId cm handle identifier
 174      * @return cm handle details
 175      */
 176     @Override
 177     public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
 178         CpsValidator.validateNameCharacters(cmHandleId);
 179         final NcmpServiceCmHandle ncmpServiceCmHandle = new NcmpServiceCmHandle();
 180         final YangModelCmHandle yangModelCmHandle =
 181             yangModelCmHandleRetriever.getDmiServiceNamesAndProperties(cmHandleId);
 182         final List<YangModelCmHandle.Property> dmiProperties = yangModelCmHandle.getDmiProperties();
 183         final List<YangModelCmHandle.Property> publicProperties = yangModelCmHandle.getPublicProperties();
 184         ncmpServiceCmHandle.setCmHandleID(yangModelCmHandle.getId());
 185         setDmiProperties(dmiProperties, ncmpServiceCmHandle);
 186         setPublicProperties(publicProperties, ncmpServiceCmHandle);
 187         return ncmpServiceCmHandle;
 188     }
 189
 190     private void setDmiProperties(final List<YangModelCmHandle.Property> dmiProperties,
 191                                   final NcmpServiceCmHandle ncmpServiceCmHandle) {
 192         final Map<String, String> dmiPropertiesMap = new LinkedHashMap<>(dmiProperties.size());
 193         asPropertiesMap(dmiProperties, dmiPropertiesMap);
 194         ncmpServiceCmHandle.setDmiProperties(dmiPropertiesMap);
 195     }
 196
 197     private void setPublicProperties(final List<YangModelCmHandle.Property> publicProperties,
 198                                      final NcmpServiceCmHandle ncmpServiceCmHandle) {
 199         final Map<String, String> publicPropertiesMap = new LinkedHashMap<>();
 200         asPropertiesMap(publicProperties, publicPropertiesMap);
 201         ncmpServiceCmHandle.setPublicProperties(publicPropertiesMap);
 202     }
 203
 204     private void asPropertiesMap(final List<YangModelCmHandle.Property> properties,
 205                                  final Map<String, String> propertiesMap) {
 206         for (final YangModelCmHandle.Property property: properties) {
 207             propertiesMap.put(property.getName(), property.getValue());
 208         }
 209     }
 210
 211     /**
 212      * THis method registers a cm handle and initiates modules sync.
 213      *
 214      * @param dmiPluginRegistration dmi plugin registration information.
 215      * @return cm-handle registration response for create cm-handle requests.
 216      */
 217     public List<CmHandleRegistrationResponse> parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
 218         final DmiPluginRegistration dmiPluginRegistration) {
 219         return dmiPluginRegistration.getCreatedCmHandles().stream()
 220             .map(cmHandle ->
 221                 YangModelCmHandle.toYangModelCmHandle(
 222                     dmiPluginRegistration.getDmiPlugin(),
 223                     dmiPluginRegistration.getDmiDataPlugin(),
 224                     dmiPluginRegistration.getDmiModelPlugin(), cmHandle)
 225             )
 226             .map(this::registerAndSyncNewCmHandle)
 227             .collect(Collectors.toList());
 228     }
 229
 230     private static Object handleResponse(final ResponseEntity<?> responseEntity, final OperationEnum operation) {
 231         if (responseEntity.getStatusCode().is2xxSuccessful()) {
 232             return responseEntity.getBody();
 233         } else {
 234             final String exceptionMessage = "Unable to " + operation.toString() + " resource data.";
 235             throw new HttpClientRequestException(exceptionMessage, (String) responseEntity.getBody(),
 236                     responseEntity.getStatusCodeValue());
 237         }
 238     }
 239
 240     private CmHandleRegistrationResponse registerAndSyncNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 241         try {
 242             CpsValidator.validateNameCharacters(yangModelCmHandle.getId());
 243             final String cmHandleJsonData = String.format("{\"cm-handles\":[%s]}",
 244                 jsonObjectMapper.asJsonString(yangModelCmHandle));
 245             cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 246                 cmHandleJsonData, NO_TIMESTAMP);
 247             syncModulesAndCreateAnchor(yangModelCmHandle);
 248             return CmHandleRegistrationResponse.createSuccessResponse(yangModelCmHandle.getId());
 249         } catch (final AlreadyDefinedException alreadyDefinedException) {
 250             return CmHandleRegistrationResponse.createFailureResponse(
 251                 yangModelCmHandle.getId(), RegistrationError.CM_HANDLE_ALREADY_EXIST);
 252         } catch (final DataValidationException dataValidationException) {
 253             return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(),
 254                 RegistrationError.CM_HANDLE_INVALID_ID);
 255         } catch (final Exception exception) {
 256             return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(), exception);
 257         }
 258     }
 259
 260     protected void syncModulesAndCreateAnchor(final YangModelCmHandle yangModelCmHandle) {
 261         syncAndCreateSchemaSet(yangModelCmHandle);
 262         createAnchor(yangModelCmHandle);
 263     }
 264
 265     protected List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
 266         final List<String> tobeRemovedCmHandles) {
 267         final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
 268             new ArrayList<>(tobeRemovedCmHandles.size());
 269         for (final String cmHandle : tobeRemovedCmHandles) {
 270             try {
 271                 CpsValidator.validateNameCharacters(cmHandle);
 272                 deleteSchemaSetWithCascade(cmHandle);
 273                 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 274                     "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
 275                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandle));
 276             } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
 277                 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
 278                     cmHandle, dataNodeNotFoundException.getMessage());
 279                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 280                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
 281             } catch (final DataValidationException dataValidationException) {
 282                 log.error("Unable to de-register cm-handle id: {}, caused by: {}",
 283                     cmHandle, dataValidationException.getMessage());
 284                 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
 285                     .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_INVALID_ID));
 286             } catch (final Exception exception) {
 287                 log.error("Unable to de-register cm-handle id : {} , caused by : {}",
 288                     cmHandle, exception.getMessage());
 289                 cmHandleRegistrationResponses.add(
 290                     CmHandleRegistrationResponse.createFailureResponse(cmHandle, exception));
 291             }
 292         }
 293         return cmHandleRegistrationResponses;
 294     }
 295
 296     private void deleteSchemaSetWithCascade(final String schemaSetName) {
 297         try {
 298             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 299                 CASCADE_DELETE_ALLOWED);
 300         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 301             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 302         }
 303     }
 304
 305     private void syncAndCreateSchemaSet(final YangModelCmHandle yangModelCmHandle) {
 306         final Collection<ModuleReference> moduleReferencesFromCmHandle =
 307             dmiModelOperations.getModuleReferences(yangModelCmHandle);
 308
 309         final Collection<ModuleReference> identifiedNewModuleReferencesFromCmHandle = cpsModuleService
 310             .identifyNewModuleReferences(moduleReferencesFromCmHandle);
 311
 312         final Collection<ModuleReference> existingModuleReferencesFromCmHandle =
 313             moduleReferencesFromCmHandle.stream().filter(moduleReferenceFromCmHandle ->
 314                 !identifiedNewModuleReferencesFromCmHandle.contains(moduleReferenceFromCmHandle)
 315             ).collect(Collectors.toList());
 316
 317         final Map<String, String> newModuleNameToContentMap;
 318         if (identifiedNewModuleReferencesFromCmHandle.isEmpty()) {
 319             newModuleNameToContentMap = new HashMap<>();
 320         } else {
 321             newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle,
 322                 identifiedNewModuleReferencesFromCmHandle);
 323         }
 324         cpsModuleService
 325             .createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 326                 newModuleNameToContentMap, existingModuleReferencesFromCmHandle);
 327     }
 328
 329     private void createAnchor(final YangModelCmHandle yangModelCmHandle) {
 330         cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
 331             yangModelCmHandle.getId());
 332     }
 333
 334     private static boolean hasTopicParameter(final String topicName) {
 335         if (topicName == null) {
 336             return false;
 337         }
 338         if (TOPIC_NAME_PATTERN.matcher(topicName).matches()) {
 339             return true;
 340         }
 341         throw new InvalidTopicException("Topic name " + topicName + " is invalid", "invalid topic");
 342     }
 343
 344     private Map<String, Object> buildDmiResponse(final String requestId) {
 345         final Map<String, Object> dmiResponseMap = new HashMap<>();
 346         dmiResponseMap.put("requestId", requestId);
 347         return dmiResponseMap;
 348     }
 349
 350     private Object validateTopicNameAndGetResourceData(final String cmHandleId,
 351                                                        final String resourceIdentifier,
 352                                                        final String acceptParamInHeader,
 353                                                        final DmiOperations.DataStoreEnum dataStore,
 354                                                        final String optionsParamInQuery,
 355                                                        final String topicParamInQuery) {
 356         final boolean processAsynchronously = hasTopicParameter(topicParamInQuery);
 357         if (processAsynchronously) {
 358             final String resourceDataRequestId = UUID.randomUUID().toString();
 359             return ResponseEntity.status(HttpStatus.OK)
 360                     .body(buildDmiResponse(resourceDataRequestId));
 361         }
 362         final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(
 363                 cmHandleId, resourceIdentifier, optionsParamInQuery, acceptParamInHeader,
 364                 dataStore, NO_REQUEST_ID, NO_TOPIC);
 365         return handleResponse(responseEntity, OperationEnum.READ);
 366     }
 367 }