2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.validator;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
13 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
15 import java.io.FileFilter;
16 import java.io.FileNotFoundException;
17 import java.io.IOException;
18 import java.nio.charset.StandardCharsets;
19 import java.nio.file.Files;
20 import java.nio.file.Paths;
21 import java.util.ArrayList;
22 import java.util.Arrays;
23 import java.util.Collection;
24 import java.util.Iterator;
25 import java.util.List;
26 import java.util.Locale;
27 import java.util.ServiceLoader;
29 import java.util.regex.Matcher;
30 import java.util.regex.Pattern;
31 import org.eclipse.jdt.annotation.NonNull;
32 import org.opendaylight.yangtools.yang.common.QName;
33 import org.opendaylight.yangtools.yang.common.YangConstants;
34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
35 import org.opendaylight.yangtools.yang.model.parser.api.YangParser;
36 import org.opendaylight.yangtools.yang.model.parser.api.YangParserException;
37 import org.opendaylight.yangtools.yang.model.parser.api.YangParserFactory;
38 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
40 final class SystemTestUtils {
42 private static final Pattern MODULE_PATTERN = Pattern.compile("module(.*?)\\{");
43 private static final Pattern WHITESPACES = Pattern.compile("\\s+");
44 private static final @NonNull YangParserFactory PARSER_FACTORY;
47 final Iterator<@NonNull YangParserFactory> it = ServiceLoader.load(YangParserFactory.class).iterator();
49 throw new IllegalStateException("No YangParserFactory found");
51 PARSER_FACTORY = it.next();
54 private SystemTestUtils() {
58 static final FileFilter YANG_FILE_FILTER = file -> {
59 final String name = file.getName().toLowerCase(Locale.ENGLISH);
60 return name.endsWith(YangConstants.RFC6020_YANG_FILE_EXTENSION) && file.isFile();
63 static SchemaContext parseYangSources(final List<String> yangLibDirs, final List<String> yangTestFiles,
64 final Set<QName> supportedFeatures, final boolean recursiveSearch) throws IOException, YangParserException {
66 * Current dir "." should be always present implicitly in the list of
67 * directories where dependencies are searched for
69 if (!yangLibDirs.contains(".")) {
73 final List<File> libFiles = new ArrayList<>();
74 for (final String yangLibDir : yangLibDirs) {
75 libFiles.addAll(getYangFiles(yangLibDir, recursiveSearch));
78 final List<File> testFiles = new ArrayList<>();
79 for (final String yangTestFile : yangTestFiles) {
80 if (!yangTestFile.endsWith(YangConstants.RFC6020_YANG_FILE_EXTENSION)) {
81 testFiles.add(findInFiles(libFiles, yangTestFile));
83 testFiles.add(new File(yangTestFile));
87 return parseYangSources(supportedFeatures, testFiles, libFiles);
90 static SchemaContext parseYangSources(final Set<QName> supportedFeatures, final List<File> testFiles,
91 final List<File> libFiles) throws IOException, YangParserException {
92 checkArgument(!testFiles.isEmpty(), "No yang sources");
94 final YangParser parser = PARSER_FACTORY.createParser();
95 if (supportedFeatures != null) {
96 parser.setSupportedFeatures(supportedFeatures);
99 for (File file : testFiles) {
100 parser.addSource(YangTextSchemaSource.forFile(file));
102 for (File file : libFiles) {
103 parser.addLibSource(YangTextSchemaSource.forFile(file));
106 return parser.buildSchemaContext();
109 private static File findInFiles(final List<File> libFiles, final String yangTestFile) throws IOException {
110 for (final File file : libFiles) {
111 if (WHITESPACES.matcher(getModelNameFromFile(file)).replaceAll("").equals(yangTestFile)) {
115 throw new FileNotFoundException("Model with specific module-name does not exist : " + yangTestFile);
118 private static String getModelNameFromFile(final File file) throws IOException {
119 final String fileAsString = readFile(file.getAbsolutePath());
120 final Matcher matcher = MODULE_PATTERN.matcher(fileAsString);
121 return matcher.find() ? matcher.group(1) : "";
124 private static String readFile(final String path) throws IOException {
125 return new String(Files.readAllBytes(Paths.get(path)), StandardCharsets.UTF_8);
128 @SuppressFBWarnings("NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE")
129 private static Collection<File> getYangFiles(final String yangSourcesDirectoryPath, final boolean recursiveSearch)
130 throws FileNotFoundException {
131 final File testSourcesDir = new File(yangSourcesDirectoryPath);
132 if (!testSourcesDir.isDirectory()) {
133 throw new FileNotFoundException(String.format("%s no such directory", yangSourcesDirectoryPath));
136 return recursiveSearch ? searchYangFiles(testSourcesDir)
137 : Arrays.asList(testSourcesDir.listFiles(YANG_FILE_FILTER));
140 @SuppressFBWarnings("NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE")
141 private static List<File> searchYangFiles(final File dir) {
143 checkArgument(dir.isDirectory(), "File %s is not a directory", dir.getPath());
145 final List<File> yangFiles = new ArrayList<>();
146 for (final File file : dir.listFiles()) {
147 if (file.isDirectory()) {
148 yangFiles.addAll(searchYangFiles(file));
149 } else if (file.isFile()
150 && file.getName().toLowerCase(Locale.ENGLISH).endsWith(YangConstants.RFC6020_YANG_FILE_EXTENSION)) {