X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-maven-plugin%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang2sources%2Fplugin%2FUtil.java;h=d13f577f8c5c927a45ce07b30964a4f4c657e482;hb=8dacdc2b6097844d54f85f300fd96e8f0c79cc8e;hp=d5c53338a4b64e3c85d69d7a03abe1324cd3cf0a;hpb=71796f7bd699504e4de34d1e4d8d30b73f230bf5;p=yangtools.git diff --git a/yang/yang-maven-plugin/src/main/java/org/opendaylight/yangtools/yang2sources/plugin/Util.java b/yang/yang-maven-plugin/src/main/java/org/opendaylight/yangtools/yang2sources/plugin/Util.java index d5c53338a4..d13f577f8c 100644 --- a/yang/yang-maven-plugin/src/main/java/org/opendaylight/yangtools/yang2sources/plugin/Util.java +++ b/yang/yang-maven-plugin/src/main/java/org/opendaylight/yangtools/yang2sources/plugin/Util.java @@ -7,33 +7,37 @@ */ package org.opendaylight.yangtools.yang2sources.plugin; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; import java.io.Closeable; import java.io.File; -import java.io.FileInputStream; import java.io.FileNotFoundException; -import java.io.FilenameFilter; import java.io.IOException; -import java.io.InputStream; import java.util.ArrayList; +import java.util.Arrays; import java.util.Collection; +import java.util.Collections; import java.util.Enumeration; +import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; import java.util.zip.ZipEntry; import java.util.zip.ZipFile; - import org.apache.commons.io.FileUtils; import org.apache.maven.artifact.Artifact; +import org.apache.maven.artifact.repository.ArtifactRepository; +import org.apache.maven.artifact.resolver.ArtifactResolutionRequest; +import org.apache.maven.artifact.resolver.ArtifactResolutionResult; +import org.apache.maven.model.Dependency; +import org.apache.maven.model.Plugin; import org.apache.maven.plugin.MojoFailureException; -import org.apache.maven.plugin.logging.Log; import org.apache.maven.project.MavenProject; +import org.apache.maven.repository.RepositorySystem; import org.opendaylight.yangtools.yang.model.api.Module; import org.opendaylight.yangtools.yang.model.api.SchemaContext; - -import com.google.common.base.Preconditions; -import com.google.common.collect.Lists; -import com.google.common.collect.Maps; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; final class Util { @@ -45,6 +49,7 @@ final class Util { static final String YANG_SUFFIX = "yang"; + private static final Logger LOG = LoggerFactory.getLogger(Util.class); private static final int CACHE_SIZE = 10; // Cache for listed directories and found yang files. Typically yang files // are utilized twice. First: code is generated during generate-sources @@ -57,7 +62,7 @@ final class Util { * List files recursively and return as array of String paths. Use cache of * size 1. */ - static Collection listFiles(File root) throws FileNotFoundException { + static Collection listFiles(final File root) throws FileNotFoundException { if (cache.get(root) != null) { return cache.get(root); } @@ -72,25 +77,19 @@ final class Util { return yangFiles; } - static Collection listFiles(File root, File[] excludedFiles, Log log) throws FileNotFoundException { + static Collection listFiles(final File root, final Collection excludedFiles) throws FileNotFoundException { if (!root.exists()) { - throw new FileNotFoundException(root.toString()); + LOG.warn("{} YANG source directory {} not found. No code will be generated.", YangToSourcesProcessor + .LOG_PREFIX, root.toString()); + + return Collections.emptyList(); } Collection result = new ArrayList<>(); Collection yangFiles = FileUtils.listFiles(root, new String[] { YANG_SUFFIX }, true); for (File f : yangFiles) { - boolean excluded = false; - for (File ex : excludedFiles) { - if (ex.equals(f)) { - excluded = true; - break; - } - } - if (excluded) { - if (log != null) { - log.info(Util.message("%s file excluded %s", YangToSourcesProcessor.LOG_PREFIX, - Util.YANG_SUFFIX.toUpperCase(), f)); - } + if (excludedFiles.contains(f)) { + LOG.info("{} {} file excluded {}", YangToSourcesProcessor.LOG_PREFIX, Util.YANG_SUFFIX.toUpperCase(), + f); } else { result.add(f); } @@ -99,135 +98,159 @@ final class Util { return result; } - static List listFilesAsStream(File rootDir, File[] excludedFiles, Log log) - throws FileNotFoundException { - List is = new ArrayList(); - - Collection files = listFiles(rootDir, excludedFiles, log); - for (File f : files) { - is.add(new NamedFileInputStream(f)); - } - - return is; - } - - static class NamedFileInputStream extends FileInputStream { - private final File file; - - NamedFileInputStream(File file) throws FileNotFoundException { - super(file); - this.file = file; - } - - @Override - public String toString() { - return getClass().getSimpleName() + "{" + file + "}"; - } - } - private static void toCache(final File rootDir, final Collection yangFiles) { cache.put(rootDir, yangFiles); } - /** - * Instantiate object from fully qualified class name - */ - static T getInstance(String codeGeneratorClass, Class baseType) throws ClassNotFoundException, - InstantiationException, IllegalAccessException { - return baseType.cast(resolveClass(codeGeneratorClass, baseType).newInstance()); - } - - private static Class resolveClass(String codeGeneratorClass, Class baseType) throws ClassNotFoundException { - Class clazz = Class.forName(codeGeneratorClass); - - if (!isImplemented(baseType, clazz)) { - throw new IllegalArgumentException("Code generator " + clazz + " has to implement " + baseType); + static List getClassPath(final MavenProject project) { + List dependencies = Lists.newArrayList(); + for (Artifact element : project.getArtifacts()) { + File asFile = element.getFile(); + if (isJar(asFile) || asFile.isDirectory()) { + dependencies.add(asFile); + } } - return clazz; + return dependencies; } - private static boolean isImplemented(Class expectedIface, Class byClazz) { - for (Class iface : byClazz.getInterfaces()) { - if (iface.equals(expectedIface)) { - return true; + /** + * Read current project dependencies and check if it don't grab incorrect + * artifacts versions which could be in conflict with plugin dependencies. + * + * @param project + * current project + * @param repoSystem + * repository system + * @param localRepo + * local repository + * @param remoteRepos + * remote repositories + */ + static void checkClasspath(final MavenProject project, final RepositorySystem repoSystem, + final ArtifactRepository localRepo, final List remoteRepos) { + Plugin plugin = project.getPlugin(YangToSourcesMojo.PLUGIN_NAME); + if (plugin == null) { + LOG.warn("{} {} not found, dependencies version check skipped", YangToSourcesProcessor.LOG_PREFIX, + YangToSourcesMojo.PLUGIN_NAME); + } else { + Map> pluginDependencies = new HashMap<>(); + getPluginTransitiveDependencies(plugin, pluginDependencies, repoSystem, localRepo, remoteRepos); + + Set projectDependencies = project.getDependencyArtifacts(); + for (Map.Entry> entry : pluginDependencies.entrySet()) { + checkArtifact(entry.getKey(), projectDependencies); + for (Artifact dependency : entry.getValue()) { + checkArtifact(dependency, projectDependencies); + } } } - return false; } - static String message(String message, String logPrefix, Object... args) { - String innerMessage = String.format(message, args); - return String.format("%s %s", logPrefix, innerMessage); + /** + * Read transitive dependencies of given plugin and store them in map. + * + * @param plugin + * plugin to read + * @param map + * map, where founded transitive dependencies will be stored + * @param repoSystem + * repository system + * @param localRepository + * local repository + * @param remoteRepos + * list of remote repositories + */ + private static void getPluginTransitiveDependencies(final Plugin plugin, + final Map> map, final RepositorySystem repoSystem, + final ArtifactRepository localRepository, final List remoteRepos) { + + List pluginDependencies = plugin.getDependencies(); + for (Dependency dep : pluginDependencies) { + Artifact artifact = repoSystem.createDependencyArtifact(dep); + + ArtifactResolutionRequest request = new ArtifactResolutionRequest(); + request.setArtifact(artifact); + request.setResolveTransitively(true); + request.setLocalRepository(localRepository); + request.setRemoteRepositories(remoteRepos); + + ArtifactResolutionResult result = repoSystem.resolve(request); + Set pluginDependencyDependencies = result.getArtifacts(); + map.put(artifact, pluginDependencyDependencies); + } } - static List getClassPath(MavenProject project) { - List dependencies = Lists.newArrayList(); - for (Artifact element : project.getArtifacts()) { - File asFile = element.getFile(); - if (isJar(asFile) || asFile.isDirectory()) { - dependencies.add(asFile); + /** + * Check artifact against collection of dependencies. If collection contains + * artifact with same groupId and artifactId, but different version, logs a + * warning. + * + * @param artifact + * artifact to check + * @param dependencies + * collection of dependencies + */ + private static void checkArtifact(final Artifact artifact, final Collection dependencies) { + for (org.apache.maven.artifact.Artifact d : dependencies) { + if (artifact.getGroupId().equals(d.getGroupId()) && artifact.getArtifactId().equals(d.getArtifactId())) { + if (!(artifact.getVersion().equals(d.getVersion()))) { + LOG.warn("{} Dependency resolution conflict:", YangToSourcesProcessor.LOG_PREFIX); + LOG.warn("{} '{}' dependency [{}] has different version than one declared in current project [{}]" + + ". It is recommended to fix this problem because it may cause compilation errors.", + YangToSourcesProcessor.LOG_PREFIX, YangToSourcesMojo.PLUGIN_NAME, artifact, d); + } } } - return dependencies; } private static final String JAR_SUFFIX = ".jar"; - private static boolean isJar(File element) { - return (element.isFile() && element.getName().endsWith(JAR_SUFFIX)) ? true : false; - } - - static T checkNotNull(T obj, String paramName) { - return Preconditions.checkNotNull(obj, "Parameter " + paramName + " is null"); + private static boolean isJar(final File element) { + return (element.isFile() && element.getName().endsWith(JAR_SUFFIX)); } static final class YangsInZipsResult implements Closeable { - private final List yangStreams; + private final List yangStreams; private final List zipInputStreams; - private YangsInZipsResult(List yangStreams, List zipInputStreams) { + private YangsInZipsResult(final List yangStreams, + final List zipInputStreams) { this.yangStreams = yangStreams; this.zipInputStreams = zipInputStreams; } @Override public void close() throws IOException { - for (InputStream is : yangStreams) { - is.close(); - } for (Closeable is : zipInputStreams) { is.close(); } } - public List getYangStreams() { + public List getYangStreams() { return this.yangStreams; } } - static YangsInZipsResult findYangFilesInDependenciesAsStream(Log log, MavenProject project) + static YangsInZipsResult findYangFilesInDependenciesAsStream(final MavenProject project) throws MojoFailureException { - List yangsFromDependencies = new ArrayList<>(); + List yangsFromDependencies = new ArrayList<>(); List zips = new ArrayList<>(); try { List filesOnCp = Util.getClassPath(project); - log.info(Util.message("Searching for yang files in following dependencies: %s", - YangToSourcesProcessor.LOG_PREFIX, filesOnCp)); + LOG.info("{} Searching for yang files in following dependencies: {}", YangToSourcesProcessor.LOG_PREFIX, + filesOnCp); for (File file : filesOnCp) { List foundFilesForReporting = new ArrayList<>(); // is it jar file or directory? if (file.isDirectory()) { + //FIXME: code duplicate File yangDir = new File(file, YangToSourcesProcessor.META_INF_YANG_STRING); if (yangDir.exists() && yangDir.isDirectory()) { - File[] yangFiles = yangDir.listFiles(new FilenameFilter() { - @Override - public boolean accept(File dir, String name) { - return name.endsWith(".yang") && new File(dir, name).isFile(); - } - }); - for (File yangFile : yangFiles) { - yangsFromDependencies.add(new NamedFileInputStream(yangFile)); + File[] yangFiles = yangDir.listFiles( + (dir, name) -> name.endsWith(".yang") && new File(dir, name).isFile()); + for (final File yangFile : yangFiles) { + yangsFromDependencies.add(new YangSourceFromFile(yangFile)); } } @@ -243,16 +266,13 @@ final class Util { if (entryName.startsWith(YangToSourcesProcessor.META_INF_YANG_STRING_JAR) && !entry.isDirectory() && entryName.endsWith(".yang")) { foundFilesForReporting.add(entryName); - // This will be closed after all strams are - // parsed. - InputStream entryStream = zip.getInputStream(entry); - yangsFromDependencies.add(entryStream); + yangsFromDependencies.add(new YangSourceInZipFile(zip, entry)); } } } if (foundFilesForReporting.size() > 0) { - log.info(Util.message("Found %d yang files in %s: %s", YangToSourcesProcessor.LOG_PREFIX, - foundFilesForReporting.size(), file, foundFilesForReporting)); + LOG.info("{} Found {} yang files in {}: {}", YangToSourcesProcessor.LOG_PREFIX, + foundFilesForReporting.size(), file, foundFilesForReporting); } } @@ -262,11 +282,71 @@ final class Util { return new YangsInZipsResult(yangsFromDependencies, zips); } + /** + * Find all dependencies which contains yang sources + * + * Returns collection of YANG files and Zip files which contains YANG files. + * + * FIXME: Rename to what class is actually doing. + * + * @param project + * @return + * @throws MojoFailureException + */ + static Collection findYangFilesInDependencies(final MavenProject project) throws MojoFailureException { + final List yangsFilesFromDependencies = new ArrayList<>(); + + List filesOnCp; + try { + filesOnCp = Util.getClassPath(project); + } catch (Exception e) { + throw new MojoFailureException("Failed to scan for YANG files in dependencies", e); + } + LOG.info("{} Searching for yang files in following dependencies: {}", YangToSourcesProcessor.LOG_PREFIX, + filesOnCp); + + for (File file : filesOnCp) { + try { + // is it jar file or directory? + if (file.isDirectory()) { + //FIXME: code duplicate + File yangDir = new File(file, YangToSourcesProcessor.META_INF_YANG_STRING); + if (yangDir.exists() && yangDir.isDirectory()) { + File[] yangFiles = yangDir.listFiles( + (dir, name) -> name.endsWith(".yang") && new File(dir, name).isFile()); + + yangsFilesFromDependencies.addAll(Arrays.asList(yangFiles)); + } + } else { + try (ZipFile zip = new ZipFile(file)) { + + final Enumeration entries = zip.entries(); + while (entries.hasMoreElements()) { + ZipEntry entry = entries.nextElement(); + String entryName = entry.getName(); + + if (entryName.startsWith(YangToSourcesProcessor.META_INF_YANG_STRING_JAR) + && !entry.isDirectory() && entryName.endsWith(".yang")) { + LOG.debug("{} Found a YANG file in {}: {}", YangToSourcesProcessor.LOG_PREFIX, file, + entryName); + yangsFilesFromDependencies.add(file); + break; + } + } + } + } + } catch (Exception e) { + throw new MojoFailureException("Failed to scan for YANG files in dependency: " + file.toString(), e); + } + } + return yangsFilesFromDependencies; + } + static final class ContextHolder { private final SchemaContext context; private final Set yangModules; - ContextHolder(SchemaContext context, Set yangModules) { + ContextHolder(final SchemaContext context, final Set yangModules) { this.context = context; this.yangModules = yangModules; }