cps-service/src/main/java/org/onap/cps/utils/YangUtils.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020-2021 Nordix Foundation
   4  *  Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
   5  *  Modifications Copyright (C) 2021 Pantheon.tech
   6  *  ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *  You may obtain a copy of the License at
  10  *
  11  *        http://www.apache.org/licenses/LICENSE-2.0
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.utils;
  23
  24 import com.google.gson.JsonSyntaxException;
  25 import com.google.gson.stream.JsonReader;
  26 import java.io.IOException;
  27 import java.io.StringReader;
  28 import java.util.Arrays;
  29 import java.util.Collection;
  30 import java.util.Collections;
  31 import java.util.List;
  32 import java.util.Optional;
  33 import java.util.stream.Collectors;
  34 import lombok.AccessLevel;
  35 import lombok.NoArgsConstructor;
  36 import lombok.extern.slf4j.Slf4j;
  37 import org.onap.cps.spi.exceptions.DataValidationException;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  41 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
  42 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  43 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  46 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  47 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  49
  50 @Slf4j
  51 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  52 public class YangUtils {
  53
  54     private static final String XPATH_DELIMITER_REGEX = "\\/";
  55     private static final String XPATH_NODE_KEY_ATTRIBUTES_REGEX = "\\[.+";
  56
  57     /**
  58      * Parses jsonData into NormalizedNode according to given schema context.
  59      *
  60      * @param jsonData      json data as string
  61      * @param schemaContext schema context describing associated data model
  62      * @return the NormalizedNode object
  63      */
  64     @SuppressWarnings("squid:S1452")  // Generic type <? ,?> is returned by external librray, opendaylight.yangtools
  65     public static NormalizedNode<?, ?> parseJsonData(final String jsonData, final SchemaContext schemaContext) {
  66         return parseJsonData(jsonData, schemaContext, Optional.empty());
  67     }
  68
  69     /**
  70      * Parses jsonData into NormalizedNode according to given schema context.
  71      *
  72      * @param jsonData        json data fragment as string
  73      * @param schemaContext   schema context describing associated data model
  74      * @param parentNodeXpath the xpath referencing the parent node current data fragment belong to
  75      * @return the NormalizedNode object
  76      */
  77     @SuppressWarnings("squid:S1452")  // Generic type <? ,?> is returned by external librray, opendaylight.yangtools
  78     public static NormalizedNode<?, ?> parseJsonData(final String jsonData, final SchemaContext schemaContext,
  79         final String parentNodeXpath) {
  80         final DataSchemaNode parentSchemaNode = getDataSchemaNodeByXpath(parentNodeXpath, schemaContext);
  81         return parseJsonData(jsonData, schemaContext, Optional.of(parentSchemaNode));
  82     }
  83
  84     private static NormalizedNode<?, ?> parseJsonData(final String jsonData, final SchemaContext schemaContext,
  85         final Optional<DataSchemaNode> optionalParentSchemaNode) {
  86         final JSONCodecFactory jsonCodecFactory = JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02
  87             .getShared(schemaContext);
  88         final NormalizedNodeResult normalizedNodeResult = new NormalizedNodeResult();
  89         final NormalizedNodeStreamWriter normalizedNodeStreamWriter = ImmutableNormalizedNodeStreamWriter
  90             .from(normalizedNodeResult);
  91
  92         try (final JsonParserStream jsonParserStream = optionalParentSchemaNode.isPresent()
  93             ? JsonParserStream.create(normalizedNodeStreamWriter, jsonCodecFactory, optionalParentSchemaNode.get())
  94             : JsonParserStream.create(normalizedNodeStreamWriter, jsonCodecFactory)
  95         ) {
  96             final JsonReader jsonReader = new JsonReader(new StringReader(jsonData));
  97             jsonParserStream.parse(jsonReader);
  98
  99         } catch (final IOException | IllegalStateException | JsonSyntaxException exception) {
 100             throw new DataValidationException(
 101                     "Failed to parse json data: " + jsonData,  exception.getMessage(), exception);
 102         }
 103         return normalizedNodeResult.getResult();
 104     }
 105
 106     /**
 107      * Create an xpath form a Yang Tools NodeIdentifier (i.e. PathArgument).
 108      *
 109      * @param nodeIdentifier the NodeIdentifier
 110      * @return an xpath
 111      */
 112     public static String buildXpath(final YangInstanceIdentifier.PathArgument nodeIdentifier) {
 113         final StringBuilder xpathBuilder = new StringBuilder();
 114         xpathBuilder.append("/").append(nodeIdentifier.getNodeType().getLocalName());
 115
 116         if (nodeIdentifier instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates) {
 117             xpathBuilder.append(getKeyAttributesStatement(
 118                 (YangInstanceIdentifier.NodeIdentifierWithPredicates) nodeIdentifier));
 119         }
 120         return xpathBuilder.toString();
 121     }
 122
 123     private static String getKeyAttributesStatement(
 124         final YangInstanceIdentifier.NodeIdentifierWithPredicates nodeIdentifier) {
 125         final List<String> keyAttributes = nodeIdentifier.entrySet().stream().map(
 126             entry -> {
 127                 final String name = entry.getKey().getLocalName();
 128                 final String value = String.valueOf(entry.getValue()).replace("'", "\\'");
 129                 return String.format("@%s='%s'", name, value);
 130             }
 131         ).collect(Collectors.toList());
 132
 133         if (keyAttributes.isEmpty()) {
 134             return "";
 135         } else {
 136             Collections.sort(keyAttributes);
 137             return "[" + String.join(" and ", keyAttributes) + "]";
 138         }
 139     }
 140
 141     private static DataSchemaNode getDataSchemaNodeByXpath(final String parentNodeXpath,
 142         final SchemaContext schemaContext) {
 143         final String[] xpathNodeIdSequence = xpathToNodeIdSequence(parentNodeXpath);
 144         return findDataSchemaNodeByXpathNodeIdSequence(xpathNodeIdSequence, schemaContext.getChildNodes());
 145     }
 146
 147     private static String[] xpathToNodeIdSequence(final String xpath) {
 148         final String[] xpathNodeIdSequence = Arrays.stream(xpath.split(XPATH_DELIMITER_REGEX))
 149             .map(identifier -> identifier.replaceFirst(XPATH_NODE_KEY_ATTRIBUTES_REGEX, ""))
 150             .filter(identifier -> !identifier.isEmpty())
 151             .toArray(String[]::new);
 152         if (xpathNodeIdSequence.length < 1) {
 153             throw new DataValidationException("Invalid xpath.", "Xpath contains no node identifiers.");
 154         }
 155         return xpathNodeIdSequence;
 156     }
 157
 158     private static DataSchemaNode findDataSchemaNodeByXpathNodeIdSequence(final String[] xpathNodeIdSequence,
 159         final Collection<? extends DataSchemaNode> dataSchemaNodes) {
 160         final String currentXpathNodeId = xpathNodeIdSequence[0];
 161         final DataSchemaNode currentDataSchemaNode = dataSchemaNodes.stream()
 162             .filter(dataSchemaNode -> currentXpathNodeId.equals(dataSchemaNode.getQName().getLocalName()))
 163             .findFirst().orElseThrow(() -> schemaNodeNotFoundException(currentXpathNodeId));
 164         if (xpathNodeIdSequence.length <= 1) {
 165             return currentDataSchemaNode;
 166         }
 167         if (currentDataSchemaNode instanceof DataNodeContainer) {
 168             return findDataSchemaNodeByXpathNodeIdSequence(
 169                 getNextLevelXpathNodeIdSequence(xpathNodeIdSequence),
 170                 ((DataNodeContainer) currentDataSchemaNode).getChildNodes());
 171         }
 172         throw schemaNodeNotFoundException(xpathNodeIdSequence[1]);
 173     }
 174
 175     private static String[] getNextLevelXpathNodeIdSequence(final String[] xpathNodeIdSequence) {
 176         final String[] nextXpathNodeIdSequence = new String[xpathNodeIdSequence.length - 1];
 177         System.arraycopy(xpathNodeIdSequence, 1, nextXpathNodeIdSequence, 0, nextXpathNodeIdSequence.length);
 178         return nextXpathNodeIdSequence;
 179     }
 180
 181     private static DataValidationException schemaNodeNotFoundException(final String schemaNodeIdentifier) {
 182         return new DataValidationException("Invalid xpath.",
 183             String.format("No schema node was found for xpath identifier '%s'.", schemaNodeIdentifier));
 184     }
 185 }