cps-service/src/main/java/org/onap/cps/yang/YangTextSchemaSourceSetBuilder.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Pantheon.tech
   4  *  Modifications Copyright (C) 2022 Nordix Foundation.
   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  *
  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.yang;
  23
  24 import static com.google.common.base.Preconditions.checkNotNull;
  25
  26 import com.google.common.base.MoreObjects;
  27 import com.google.common.collect.ImmutableMap;
  28 import java.io.ByteArrayInputStream;
  29 import java.io.IOException;
  30 import java.io.InputStream;
  31 import java.nio.charset.StandardCharsets;
  32 import java.util.Collections;
  33 import java.util.List;
  34 import java.util.Map;
  35 import java.util.regex.Pattern;
  36 import java.util.stream.Collectors;
  37 import lombok.NoArgsConstructor;
  38 import org.onap.cps.spi.exceptions.CpsException;
  39 import org.onap.cps.spi.exceptions.ModelValidationException;
  40 import org.onap.cps.spi.model.ModuleReference;
  41 import org.opendaylight.yangtools.yang.common.Revision;
  42 import org.opendaylight.yangtools.yang.model.api.Module;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  44 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
  45 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  46 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  47 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
  48 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.YangStatementStreamSource;
  49 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  50 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  51
  52 @NoArgsConstructor
  53 public final class YangTextSchemaSourceSetBuilder {
  54
  55     private static final Pattern RFC6020_RECOMMENDED_FILENAME_PATTERN =
  56         Pattern.compile("([\\w-]+)@(\\d{4}-\\d{2}-\\d{2})(?:\\.yang)?", Pattern.CASE_INSENSITIVE);
  57
  58     private final ImmutableMap.Builder<String, String> yangModelMap = new ImmutableMap.Builder<>();
  59
  60     public YangTextSchemaSourceSetBuilder putAll(final Map<String, String> yangResourceNameToContent) {
  61         this.yangModelMap.putAll(yangResourceNameToContent);
  62         return this;
  63     }
  64
  65     public YangTextSchemaSourceSet build() {
  66         final var schemaContext = generateSchemaContext(yangModelMap.build());
  67         return new YangTextSchemaSourceSetImpl(schemaContext);
  68     }
  69
  70     public static YangTextSchemaSourceSet of(final Map<String, String> yangResourceNameToContent) {
  71         return new YangTextSchemaSourceSetBuilder().putAll(yangResourceNameToContent).build();
  72     }
  73
  74     /**
  75      * Validates if SchemaContext can be successfully built from given yang resources.
  76      *
  77      * @param yangResourceNameToContent the yang resources as map where key is name and value is content
  78      * @throws ModelValidationException if validation fails
  79      */
  80     public static void validate(final Map<String, String> yangResourceNameToContent) {
  81         generateSchemaContext(yangResourceNameToContent);
  82     }
  83
  84     private static class YangTextSchemaSourceSetImpl implements YangTextSchemaSourceSet {
  85
  86         private final SchemaContext schemaContext;
  87
  88         private YangTextSchemaSourceSetImpl(final SchemaContext schemaContext) {
  89             this.schemaContext = schemaContext;
  90         }
  91
  92         @Override
  93         public List<ModuleReference> getModuleReferences() {
  94             return schemaContext.getModules().stream()
  95                 .map(YangTextSchemaSourceSetImpl::toModuleReference)
  96                 .collect(Collectors.toList());
  97         }
  98
  99         private static ModuleReference toModuleReference(final Module module) {
 100             return ModuleReference.builder()
 101                 .moduleName(module.getName())
 102                 .namespace(module.getQNameModule().getNamespace().toString())
 103                 .revision(module.getRevision().map(Revision::toString).orElse(null))
 104                 .build();
 105         }
 106
 107         @Override
 108         public SchemaContext getSchemaContext() {
 109             return schemaContext;
 110         }
 111     }
 112
 113     /**
 114      * Parse and validate a string representing a yang model to generate a SchemaContext context.
 115      *
 116      * @param yangResourceNameToContent is a {@link Map} collection that contains the name of the model represented
 117      *                                  on yangModelContent as key and the yangModelContent as value.
 118      * @return the schema context
 119      */
 120     private static SchemaContext generateSchemaContext(final Map<String, String> yangResourceNameToContent) {
 121         final CrossSourceStatementReactor.BuildAction reactor = RFC7950Reactors.defaultReactor().newBuild();
 122         for (final YangTextSchemaSource yangTextSchemaSource : forResources(yangResourceNameToContent)) {
 123             final String resourceName = yangTextSchemaSource.getIdentifier().getName();
 124             try {
 125                 reactor.addSource(YangStatementStreamSource.create(yangTextSchemaSource));
 126             } catch (final IOException e) {
 127                 throw new CpsException("Failed to read yang resource.",
 128                     String.format("Exception occurred on reading resource %s.", resourceName), e);
 129             } catch (final YangSyntaxErrorException e) {
 130                 throw new ModelValidationException("Yang resource is invalid.",
 131                     String.format(
 132                             "Yang syntax validation failed for resource %s:%n%s", resourceName, e.getMessage()), e);
 133             }
 134         }
 135         try {
 136             return reactor.buildEffective();
 137         } catch (final ReactorException e) {
 138             final List<String> resourceNames = yangResourceNameToContent.keySet().stream().collect(Collectors.toList());
 139             Collections.sort(resourceNames);
 140             throw new ModelValidationException("Invalid schema set.",
 141                 String.format("Effective schema context build failed for resources %s.", resourceNames.toString()),
 142                 e);
 143         }
 144     }
 145
 146     private static List<YangTextSchemaSource> forResources(final Map<String, String> yangResourceNameToContent) {
 147         return yangResourceNameToContent.entrySet().stream()
 148             .map(entry -> toYangTextSchemaSource(entry.getKey(), entry.getValue()))
 149             .collect(Collectors.toList());
 150     }
 151
 152     private static YangTextSchemaSource toYangTextSchemaSource(final String sourceName, final String source) {
 153         final var revisionSourceIdentifier =
 154             createIdentifierFromSourceName(checkNotNull(sourceName));
 155
 156         return new YangTextSchemaSource(revisionSourceIdentifier) {
 157             @Override
 158             protected MoreObjects.ToStringHelper addToStringAttributes(
 159                 final MoreObjects.ToStringHelper toStringHelper) {
 160                 return toStringHelper;
 161             }
 162
 163             @Override
 164             public InputStream openStream() {
 165                 return new ByteArrayInputStream(source.getBytes(StandardCharsets.UTF_8));
 166             }
 167         };
 168     }
 169
 170     private static RevisionSourceIdentifier createIdentifierFromSourceName(final String sourceName) {
 171         final var matcher = RFC6020_RECOMMENDED_FILENAME_PATTERN.matcher(sourceName);
 172         if (matcher.matches()) {
 173             return RevisionSourceIdentifier.create(matcher.group(1), Revision.of(matcher.group(2)));
 174         }
 175         return RevisionSourceIdentifier.create(sourceName);
 176     }
 177 }