/*
* ============LICENSE_START=======================================================
* Copyright (C) 2020 Pantheon.tech
+ * Modifications Copyright (C) 2022 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
package org.onap.cps.yang;
+import static com.google.common.base.Preconditions.checkNotNull;
+
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableMap;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Collections;
import java.util.List;
import java.util.Map;
+import java.util.regex.Pattern;
import java.util.stream.Collectors;
+import lombok.NoArgsConstructor;
+import org.onap.cps.spi.exceptions.CpsException;
+import org.onap.cps.spi.exceptions.ModelValidationException;
+import org.onap.cps.spi.model.ModuleReference;
import org.opendaylight.yangtools.yang.common.Revision;
-import org.opendaylight.yangtools.yang.common.YangNames;
+import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
+@NoArgsConstructor
public final class YangTextSchemaSourceSetBuilder {
- private final ImmutableMap.Builder<String, String> yangModelMap = new ImmutableMap.Builder<>();
-
- public YangTextSchemaSourceSetBuilder() {
- }
+ private static final Pattern RFC6020_RECOMMENDED_FILENAME_PATTERN =
+ Pattern.compile("([\\w-]+)@(\\d{4}-\\d{2}-\\d{2})(?:\\.yang)?", Pattern.CASE_INSENSITIVE);
- public YangTextSchemaSourceSetBuilder put(final String fileName, final String content) {
- this.yangModelMap.put(fileName, content);
- return this;
- }
+ private final ImmutableMap.Builder<String, String> yangModelMap = new ImmutableMap.Builder<>();
public YangTextSchemaSourceSetBuilder putAll(final Map<String, String> yangResourceNameToContent) {
this.yangModelMap.putAll(yangResourceNameToContent);
return this;
}
- public YangTextSchemaSourceSet build() throws ReactorException, IOException, YangSyntaxErrorException {
- final SchemaContext schemaContext = generateSchemaContext(yangModelMap.build());
+ public YangTextSchemaSourceSet build() {
+ final var schemaContext = generateSchemaContext(yangModelMap.build());
return new YangTextSchemaSourceSetImpl(schemaContext);
}
- public static YangTextSchemaSourceSet of(final Map<String, String> yangResourceNameToContent)
- throws ReactorException, IOException, YangSyntaxErrorException {
+ public static YangTextSchemaSourceSet of(final Map<String, String> yangResourceNameToContent) {
return new YangTextSchemaSourceSetBuilder().putAll(yangResourceNameToContent).build();
}
+ /**
+ * Validates if SchemaContext can be successfully built from given yang resources.
+ *
+ * @param yangResourceNameToContent the yang resources as map where key is name and value is content
+ * @throws ModelValidationException if validation fails
+ */
+ public static void validate(final Map<String, String> yangResourceNameToContent) {
+ generateSchemaContext(yangResourceNameToContent);
+ }
+
private static class YangTextSchemaSourceSetImpl implements YangTextSchemaSourceSet {
private final SchemaContext schemaContext;
- public YangTextSchemaSourceSetImpl(final SchemaContext schemaContext) {
+ private YangTextSchemaSourceSetImpl(final SchemaContext schemaContext) {
this.schemaContext = schemaContext;
}
+ @Override
+ public List<ModuleReference> getModuleReferences() {
+ return schemaContext.getModules().stream()
+ .map(YangTextSchemaSourceSetImpl::toModuleReference)
+ .collect(Collectors.toList());
+ }
+
+ private static ModuleReference toModuleReference(final Module module) {
+ return ModuleReference.builder()
+ .moduleName(module.getName())
+ .namespace(module.getQNameModule().getNamespace().toString())
+ .revision(module.getRevision().map(Revision::toString).orElse(null))
+ .build();
+ }
+
@Override
public SchemaContext getSchemaContext() {
return schemaContext;
* Parse and validate a string representing a yang model to generate a SchemaContext context.
*
* @param yangResourceNameToContent is a {@link Map} collection that contains the name of the model represented
- * on yangModelContent as key and the yangModelContent as value.
+ * on yangModelContent as key and the yangModelContent as value.
* @return the schema context
*/
- private SchemaContext generateSchemaContext(final Map<String, String> yangResourceNameToContent)
- throws IOException, ReactorException, YangSyntaxErrorException {
+ private static SchemaContext generateSchemaContext(final Map<String, String> yangResourceNameToContent) {
final CrossSourceStatementReactor.BuildAction reactor = RFC7950Reactors.defaultReactor().newBuild();
- final List<YangTextSchemaSource> yangTextSchemaSources = forResources(yangResourceNameToContent);
- for (final YangTextSchemaSource yangTextSchemaSource : yangTextSchemaSources) {
- reactor.addSource(YangStatementStreamSource.create(yangTextSchemaSource));
+ for (final YangTextSchemaSource yangTextSchemaSource : forResources(yangResourceNameToContent)) {
+ final String resourceName = yangTextSchemaSource.getIdentifier().getName();
+ try {
+ reactor.addSource(YangStatementStreamSource.create(yangTextSchemaSource));
+ } catch (final IOException e) {
+ throw new CpsException("Failed to read yang resource.",
+ String.format("Exception occurred on reading resource %s.", resourceName), e);
+ } catch (final YangSyntaxErrorException e) {
+ throw new ModelValidationException("Yang resource is invalid.",
+ String.format(
+ "Yang syntax validation failed for resource %s:%n%s", resourceName, e.getMessage()), e);
+ }
+ }
+ try {
+ return reactor.buildEffective();
+ } catch (final ReactorException e) {
+ final List<String> resourceNames = yangResourceNameToContent.keySet().stream().collect(Collectors.toList());
+ Collections.sort(resourceNames);
+ throw new ModelValidationException("Invalid schema set.",
+ String.format("Effective schema context build failed for resources %s.", resourceNames.toString()),
+ e);
}
- return reactor.buildEffective();
}
- private List<YangTextSchemaSource> forResources(final Map<String, String> yangResourceNameToContent) {
+ private static List<YangTextSchemaSource> forResources(final Map<String, String> yangResourceNameToContent) {
return yangResourceNameToContent.entrySet().stream()
- .map(entry -> toYangTextSchemaSource(entry.getKey(), entry.getValue()))
- .collect(Collectors.toList());
+ .map(entry -> toYangTextSchemaSource(entry.getKey(), entry.getValue()))
+ .collect(Collectors.toList());
}
- private YangTextSchemaSource toYangTextSchemaSource(final String sourceName, final String source) {
- final Map.Entry<String, String> sourceNameParsed = YangNames.parseFilename(sourceName);
- final RevisionSourceIdentifier revisionSourceIdentifier = RevisionSourceIdentifier
- .create(sourceNameParsed.getKey(), Revision.ofNullable(sourceNameParsed.getValue()));
+ private static YangTextSchemaSource toYangTextSchemaSource(final String sourceName, final String source) {
+ final var revisionSourceIdentifier =
+ createIdentifierFromSourceName(checkNotNull(sourceName));
+
return new YangTextSchemaSource(revisionSourceIdentifier) {
@Override
protected MoreObjects.ToStringHelper addToStringAttributes(
- final MoreObjects.ToStringHelper toStringHelper) {
+ final MoreObjects.ToStringHelper toStringHelper) {
return toStringHelper;
}
@Override
public InputStream openStream() {
- return new ByteArrayInputStream(source.getBytes());
+ return new ByteArrayInputStream(source.getBytes(StandardCharsets.UTF_8));
}
};
}
+
+ private static RevisionSourceIdentifier createIdentifierFromSourceName(final String sourceName) {
+ final var matcher = RFC6020_RECOMMENDED_FILENAME_PATTERN.matcher(sourceName);
+ if (matcher.matches()) {
+ return RevisionSourceIdentifier.create(matcher.group(1), Revision.of(matcher.group(2)));
+ }
+ return RevisionSourceIdentifier.create(sourceName);
+ }
}
Code Review / cps.git / blobdiff