cps-ri/src/main/java/org/onap/cps/spi/query/CpsPathQuery.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation
   4  *  Modifications Copyright (C) 2021 Bell Canada.
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  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.spi.query;
  22
  23 import java.util.HashMap;
  24 import java.util.Map;
  25 import java.util.regex.Matcher;
  26 import java.util.regex.Pattern;
  27 import lombok.AccessLevel;
  28 import lombok.Getter;
  29 import lombok.Setter;
  30 import org.onap.cps.spi.exceptions.CpsPathException;
  31
  32 @Getter
  33 @Setter(AccessLevel.PRIVATE)
  34 public class CpsPathQuery {
  35
  36     private CpsPathQueryType cpsPathQueryType;
  37     private String xpathPrefix;
  38     private String leafName;
  39     private Object leafValue;
  40     private String descendantName;
  41     private Map<String, Object> leavesData;
  42
  43     private static final String NON_CAPTURING_GROUP_1_TO_99_YANG_CONTAINERS = "((?:\\/[^\\/]+){1,99})";
  44
  45     private static final String YANG_LEAF_VALUE_EQUALS_CONDITION =
  46         "\\[\\s{0,9}@(\\S+?)\\s{0,9}=\\s{0,9}(.*?)\\s{0,9}\\]";
  47
  48     private static final Pattern QUERY_CPS_PATH_WITH_SINGLE_LEAF_PATTERN =
  49         Pattern.compile(NON_CAPTURING_GROUP_1_TO_99_YANG_CONTAINERS + YANG_LEAF_VALUE_EQUALS_CONDITION);
  50
  51     private static final Pattern DESCENDANT_ANYWHERE_PATTERN = Pattern.compile("\\/\\/([^\\/].+)");
  52
  53     private static final Pattern LEAF_INTEGER_VALUE_PATTERN = Pattern.compile("[-+]?\\d+");
  54
  55     private static final Pattern LEAF_STRING_VALUE_IN_SINGLE_QUOTES_PATTERN = Pattern.compile("'(.*)'");
  56     private static final Pattern LEAF_STRING_VALUE_IN_DOUBLE_QUOTES_PATTERN = Pattern.compile("\"(.*)\"");
  57
  58     private static final String YANG_MULTIPLE_LEAF_VALUE_EQUALS_CONDITION =  "\\[(.*?)\\s{0,9}]";
  59
  60     private static final Pattern DESCENDANT_ANYWHERE_PATTERN_WITH_MULTIPLE_LEAF_PATTERN =
  61         Pattern.compile(DESCENDANT_ANYWHERE_PATTERN + YANG_MULTIPLE_LEAF_VALUE_EQUALS_CONDITION);
  62
  63     private static final String INDIVIDUAL_LEAF_DETAIL_PATTERN = ("\\s{0,9}and\\s{0,9}");
  64
  65     private static final Pattern LEAF_VALUE_PATTERN = Pattern.compile("@(\\S+?)=(.*)");
  66
  67     /**
  68      * Returns a cps path query.
  69      *
  70      * @param cpsPath cps path
  71      * @return a CpsPath object.
  72      */
  73     public static CpsPathQuery createFrom(final String cpsPath) {
  74         var matcher = QUERY_CPS_PATH_WITH_SINGLE_LEAF_PATTERN.matcher(cpsPath);
  75         final var cpsPathQuery = new CpsPathQuery();
  76         if (matcher.matches()) {
  77             return buildCpsPathQueryWithSingleLeafPattern(cpsPath, matcher, cpsPathQuery);
  78         }
  79         matcher = DESCENDANT_ANYWHERE_PATTERN_WITH_MULTIPLE_LEAF_PATTERN.matcher(cpsPath);
  80         if (matcher.matches()) {
  81             return buildCpsQueryForDescendentWithLeafPattern(cpsPath, matcher, cpsPathQuery);
  82         }
  83         matcher = DESCENDANT_ANYWHERE_PATTERN.matcher(cpsPath);
  84         if (matcher.matches()) {
  85             cpsPathQuery.setCpsPathQueryType(CpsPathQueryType.XPATH_HAS_DESCENDANT_ANYWHERE);
  86             cpsPathQuery.setDescendantName(matcher.group(1));
  87             return cpsPathQuery;
  88         }
  89         throw new CpsPathException("Invalid cps path.",
  90             String.format("Cannot interpret or parse cps path '%s'.", cpsPath));
  91     }
  92
  93     private static CpsPathQuery buildCpsPathQueryWithSingleLeafPattern(final String cpsPath, final Matcher matcher,
  94         final CpsPathQuery cpsPathQuery) {
  95         cpsPathQuery.setCpsPathQueryType(CpsPathQueryType.XPATH_LEAF_VALUE);
  96         cpsPathQuery.setXpathPrefix(matcher.group(1));
  97         cpsPathQuery.setLeafName(matcher.group(2));
  98         cpsPathQuery.setLeafValue(convertLeafValueToCorrectType(matcher.group(3), cpsPath));
  99         return cpsPathQuery;
 100     }
 101
 102     private static CpsPathQuery buildCpsQueryForDescendentWithLeafPattern(final String cpsPath, final Matcher matcher,
 103         final CpsPathQuery cpsPathQuery) {
 104         cpsPathQuery.setCpsPathQueryType(CpsPathQueryType.XPATH_HAS_DESCENDANT_WITH_LEAF_VALUES);
 105         cpsPathQuery.setDescendantName(matcher.group(1));
 106         final Map<String, Object> leafData = new HashMap<>();
 107         for (final String leafValuePair : matcher.group(2).split(INDIVIDUAL_LEAF_DETAIL_PATTERN)) {
 108             final var descendentMatcher = LEAF_VALUE_PATTERN.matcher(leafValuePair);
 109             if (descendentMatcher.matches()) {
 110                 leafData.put(descendentMatcher.group(1),
 111                     convertLeafValueToCorrectType(descendentMatcher.group(2), cpsPath));
 112             } else {
 113                 throw new CpsPathException("Invalid cps path.",
 114                     String.format("Cannot interpret or parse attributes in cps path '%s'.", cpsPath));
 115             }
 116         }
 117         cpsPathQuery.setLeavesData(leafData);
 118         return cpsPathQuery;
 119     }
 120
 121     private static Object convertLeafValueToCorrectType(final String leafValueString, final String cpsPath) {
 122         final var stringValueWithSingleQuotesMatcher =
 123                 LEAF_STRING_VALUE_IN_SINGLE_QUOTES_PATTERN.matcher(leafValueString);
 124         if (stringValueWithSingleQuotesMatcher.matches()) {
 125             return stringValueWithSingleQuotesMatcher.group(1);
 126         }
 127         final var stringValueWithDoubleQuotesMatcher =
 128                 LEAF_STRING_VALUE_IN_DOUBLE_QUOTES_PATTERN.matcher(leafValueString);
 129         if (stringValueWithDoubleQuotesMatcher.matches()) {
 130             return stringValueWithDoubleQuotesMatcher.group(1);
 131         }
 132         final var integerValueMatcher = LEAF_INTEGER_VALUE_PATTERN.matcher(leafValueString);
 133         if (integerValueMatcher.matches()) {
 134             return Integer.valueOf(leafValueString);
 135         }
 136         throw new CpsPathException("Unsupported leaf value.",
 137             String.format("Unsupported leaf value '%s' in cps path '%s'.", leafValueString, cpsPath));
 138     }
 139 }