gerrit.onap Code Review - cps.git/blob

   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.impl.inventory;
  22
  23 import static org.onap.cps.ncmp.impl.inventory.CmHandleQueryParametersValidator.validateCpsPathConditionProperties;
  24 import static org.onap.cps.ncmp.impl.inventory.CmHandleQueryParametersValidator.validateModuleNameConditionProperties;
  25 import static org.onap.cps.ncmp.impl.inventory.NcmpPersistence.NCMP_DMI_REGISTRY_PARENT;
  26 import static org.onap.cps.ncmp.impl.inventory.models.CmHandleQueryConditions.HAS_ALL_MODULES;
  27 import static org.onap.cps.ncmp.impl.inventory.models.CmHandleQueryConditions.HAS_ALL_PROPERTIES;
  28 import static org.onap.cps.ncmp.impl.inventory.models.CmHandleQueryConditions.WITH_CPS_PATH;
  29 import static org.onap.cps.ncmp.impl.inventory.models.CmHandleQueryConditions.WITH_TRUST_LEVEL;
  30 import static org.onap.cps.spi.FetchDescendantsOption.DIRECT_CHILDREN_ONLY;
  31 import static org.onap.cps.spi.FetchDescendantsOption.OMIT_DESCENDANTS;
  32
  33 import java.util.ArrayList;
  34 import java.util.Collection;
  35 import java.util.Collections;
  36 import java.util.HashMap;
  37 import java.util.List;
  38 import java.util.Map;
  39 import java.util.function.Function;
  40 import java.util.stream.Collectors;
  41 import lombok.RequiredArgsConstructor;
  42 import org.onap.cps.cpspath.parser.PathParsingException;
  43 import org.onap.cps.ncmp.api.inventory.models.CmHandleQueryServiceParameters;
  44 import org.onap.cps.ncmp.impl.inventory.models.InventoryQueryConditions;
  45 import org.onap.cps.ncmp.impl.inventory.models.PropertyType;
  46 import org.onap.cps.ncmp.impl.inventory.models.YangModelCmHandle;
  47 import org.onap.cps.ncmp.impl.utils.YangDataConverter;
  48 import org.onap.cps.spi.exceptions.DataValidationException;
  49 import org.onap.cps.spi.model.ConditionProperties;
  50 import org.onap.cps.spi.model.DataNode;
  51 import org.springframework.stereotype.Service;
  52
  53 @Service
  54 @RequiredArgsConstructor
  55 public class ParameterizedCmHandleQueryServiceImpl implements ParameterizedCmHandleQueryService {
  56
  57     private static final Collection<String> NO_QUERY_TO_EXECUTE = null;
  58     private final CmHandleQueryService cmHandleQueryService;
  59     private final InventoryPersistence inventoryPersistence;
  60
  61     @Override
  62     public Collection<String> queryCmHandleIds(
  63             final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
  64         return executeQueries(cmHandleQueryServiceParameters,
  65                 this::executeCpsPathQuery,
  66                 this::queryCmHandlesByPublicProperties,
  67                 this::executeModuleNameQuery,
  68                 this::queryCmHandlesByTrustLevel);
  69     }
  70
  71     @Override
  72     public Collection<String> queryCmHandleIdsForInventory(
  73             final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
  74         return executeQueries(cmHandleQueryServiceParameters,
  75                 this::executeCpsPathQuery,
  76                 this::queryCmHandlesByPublicProperties,
  77                 this::queryCmHandlesByPrivateProperties,
  78                 this::queryCmHandlesByDmiPlugin);
  79     }
  80
  81     @Override
  82     public Collection<YangModelCmHandle> queryCmHandles(
  83             final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
  84         if (cmHandleQueryServiceParameters.getCmHandleQueryParameters().isEmpty()) {
  85             return getAllCmHandles();
  86         }
  87         final Collection<String> cmHandleIds = queryCmHandleIds(cmHandleQueryServiceParameters);
  88         return inventoryPersistence.getYangModelCmHandles(cmHandleIds);
  89     }
  90
  91     private Collection<YangModelCmHandle> getAllCmHandles() {
  92         final DataNode dataNode = inventoryPersistence.getDataNode(NCMP_DMI_REGISTRY_PARENT).iterator().next();
  93         return dataNode.getChildDataNodes().stream().map(YangDataConverter::toYangModelCmHandle).toList();
  94     }
  95
  96     private Collection<String> queryCmHandlesByDmiPlugin(
  97             final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
  98         final Map<String, String> dmiPropertyQueryPairs =
  99                 getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
 100                         InventoryQueryConditions.CM_HANDLE_WITH_DMI_PLUGIN.getName());
 101         if (dmiPropertyQueryPairs.isEmpty()) {
 102             return NO_QUERY_TO_EXECUTE;
 103         }
 104
 105         final String dmiPluginIdentifierValue = dmiPropertyQueryPairs
 106             .get(PropertyType.DMI_PLUGIN.getYangContainerName());
 107
 108         return cmHandleQueryService.getCmHandleIdsByDmiPluginIdentifier(dmiPluginIdentifierValue);
 109     }
 110
 111     private Collection<String> queryCmHandlesByPrivateProperties(
 112             final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
 113
 114         final Map<String, String> privatePropertyQueryPairs =
 115                 getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
 116                         InventoryQueryConditions.HAS_ALL_ADDITIONAL_PROPERTIES.getName());
 117
 118         if (privatePropertyQueryPairs.isEmpty()) {
 119             return NO_QUERY_TO_EXECUTE;
 120         }
 121         return cmHandleQueryService.queryCmHandleAdditionalProperties(privatePropertyQueryPairs);
 122     }
 123
 124     private Collection<String> queryCmHandlesByPublicProperties(
 125             final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
 126
 127         final Map<String, String> publicPropertyQueryPairs =
 128                 getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
 129                         HAS_ALL_PROPERTIES.getConditionName());
 130
 131         if (publicPropertyQueryPairs.isEmpty()) {
 132             return NO_QUERY_TO_EXECUTE;
 133         }
 134         return cmHandleQueryService.queryCmHandlePublicProperties(publicPropertyQueryPairs);
 135     }
 136
 137     private Collection<String> queryCmHandlesByTrustLevel(final CmHandleQueryServiceParameters
 138                                                                   cmHandleQueryServiceParameters) {
 139
 140         final Map<String, String> trustLevelPropertyQueryPairs =
 141                 getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
 142                         WITH_TRUST_LEVEL.getConditionName());
 143
 144         if (trustLevelPropertyQueryPairs.isEmpty()) {
 145             return NO_QUERY_TO_EXECUTE;
 146         }
 147         return cmHandleQueryService.queryCmHandlesByTrustLevel(trustLevelPropertyQueryPairs);
 148     }
 149
 150     private Collection<String> executeModuleNameQuery(
 151             final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
 152         final Collection<String> moduleNamesForQuery =
 153                 getModuleNamesForQuery(cmHandleQueryServiceParameters.getCmHandleQueryParameters());
 154         if (moduleNamesForQuery.isEmpty()) {
 155             return NO_QUERY_TO_EXECUTE;
 156         }
 157         return inventoryPersistence.getCmHandleIdsWithGivenModules(moduleNamesForQuery);
 158     }
 159
 160     private Collection<String> executeCpsPathQuery(
 161             final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
 162         final Map<String, String> cpsPathCondition
 163             = getCpsPathCondition(cmHandleQueryServiceParameters.getCmHandleQueryParameters());
 164         if (!validateCpsPathConditionProperties(cpsPathCondition)) {
 165             return Collections.emptySet();
 166         }
 167         final Collection<String> cpsPathQueryResult;
 168         if (cpsPathCondition.isEmpty()) {
 169             return NO_QUERY_TO_EXECUTE;
 170         }
 171         try {
 172             cpsPathQueryResult = collectCmHandleIdsFromDataNodes(
 173                 cmHandleQueryService.queryCmHandleAncestorsByCpsPath(
 174                         cpsPathCondition.get("cpsPath"), OMIT_DESCENDANTS));
 175         } catch (final PathParsingException pathParsingException) {
 176             throw new DataValidationException(pathParsingException.getMessage(), pathParsingException.getDetails(),
 177                     pathParsingException);
 178         }
 179         return cpsPathQueryResult;
 180     }
 181
 182     private Collection<String> getModuleNamesForQuery(final List<ConditionProperties> conditionProperties) {
 183         final List<String> result = new ArrayList<>();
 184         getConditions(conditionProperties, HAS_ALL_MODULES.getConditionName()).forEach(
 185                 conditionProperty -> {
 186                     validateModuleNameConditionProperties(conditionProperty);
 187                     result.add(conditionProperty.get("moduleName"));
 188                 });
 189         return result;
 190     }
 191
 192     private Map<String, String> getCpsPathCondition(final List<ConditionProperties> conditionProperties) {
 193         final Map<String, String> result = new HashMap<>();
 194         getConditions(conditionProperties, WITH_CPS_PATH.getConditionName()).forEach(result::putAll);
 195         return result;
 196     }
 197
 198     private Map<String, String> getPropertyPairs(final List<ConditionProperties> conditionProperties,
 199                                                        final String queryProperty) {
 200         final Map<String, String> result = new HashMap<>();
 201         getConditions(conditionProperties, queryProperty).forEach(result::putAll);
 202         return result;
 203     }
 204
 205     private List<Map<String, String>> getConditions(final List<ConditionProperties> conditionProperties,
 206                                                     final String name) {
 207         for (final ConditionProperties conditionProperty : conditionProperties) {
 208             if (conditionProperty.getConditionName().equals(name)) {
 209                 return conditionProperty.getConditionParameters();
 210             }
 211         }
 212         return Collections.emptyList();
 213     }
 214
 215     private Collection<String> getAllCmHandleIds() {
 216         final DataNode dataNode = inventoryPersistence.getDataNode(NCMP_DMI_REGISTRY_PARENT, DIRECT_CHILDREN_ONLY)
 217                 .iterator().next();
 218         return collectCmHandleIdsFromDataNodes(dataNode.getChildDataNodes());
 219     }
 220
 221     private Collection<String> executeQueries(final CmHandleQueryServiceParameters cmHandleQueryServiceParameters,
 222                                               final Function<CmHandleQueryServiceParameters, Collection<String>>...
 223                                                   queryFunctions) {
 224         if (cmHandleQueryServiceParameters.getCmHandleQueryParameters().isEmpty()) {
 225             return getAllCmHandleIds();
 226         }
 227         Collection<String> combinedQueryResult = NO_QUERY_TO_EXECUTE;
 228         for (final Function<CmHandleQueryServiceParameters, Collection<String>> queryFunction : queryFunctions) {
 229             final Collection<String> queryResult = queryFunction.apply(cmHandleQueryServiceParameters);
 230             if (noEntriesFoundCanStopQuerying(queryResult)) {
 231                 return Collections.emptySet();
 232             }
 233             combinedQueryResult = combineCmHandleQueryResults(combinedQueryResult, queryResult);
 234         }
 235         return combinedQueryResult;
 236     }
 237
 238     private boolean noEntriesFoundCanStopQuerying(final Collection<String> queryResult) {
 239         return queryResult != NO_QUERY_TO_EXECUTE && queryResult.isEmpty();
 240     }
 241
 242     private Collection<String> combineCmHandleQueryResults(final Collection<String> firstQuery,
 243                                                            final Collection<String> secondQuery) {
 244         if (firstQuery == NO_QUERY_TO_EXECUTE && secondQuery == NO_QUERY_TO_EXECUTE) {
 245             return NO_QUERY_TO_EXECUTE;
 246         } else if (firstQuery == NO_QUERY_TO_EXECUTE) {
 247             return secondQuery;
 248         } else if (secondQuery == NO_QUERY_TO_EXECUTE) {
 249             return firstQuery;
 250         } else {
 251             firstQuery.retainAll(secondQuery);
 252             return firstQuery;
 253         }
 254     }
 255
 256     private Collection<String> collectCmHandleIdsFromDataNodes(final Collection<DataNode> dataNodes) {
 257         return dataNodes.stream().map(dataNode -> (String) dataNode.getLeaves().get("id")).collect(Collectors.toSet());
 258     }
 259
 260 }