*/
package org.opendaylight.yangtools.yang2sources.plugin;
+import com.google.common.base.Preconditions;
+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 {
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
return yangFiles;
}
- static Collection<File> listFiles(File root, File[] excludedFiles, Log log) throws FileNotFoundException {
+ static Collection<File> listFiles(File root, File[] 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<File> result = new ArrayList<>();
Collection<File> yangFiles = FileUtils.listFiles(root, new String[] { YANG_SUFFIX }, true);
}
}
if (excluded) {
- if (log != null) {
- log.info(Util.message("%s file excluded %s", YangToSourcesProcessor.LOG_PREFIX,
- Util.YANG_SUFFIX.toUpperCase(), f));
- }
+ LOG.info("{} {} file excluded {}", YangToSourcesProcessor.LOG_PREFIX, Util.YANG_SUFFIX.toUpperCase(),
+ f);
} else {
result.add(f);
}
return result;
}
- 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<File> yangFiles) {
cache.put(rootDir, yangFiles);
}
private static Class<?> resolveClass(String codeGeneratorClass, Class<?> baseType) throws ClassNotFoundException {
Class<?> clazz = Class.forName(codeGeneratorClass);
- if (!isImplemented(baseType, clazz)) {
+ if (!baseType.isAssignableFrom(clazz)) {
throw new IllegalArgumentException("Code generator " + clazz + " has to implement " + baseType);
}
return clazz;
}
- private static boolean isImplemented(Class<?> expectedIface, Class<?> byClazz) {
- for (Class<?> iface : byClazz.getInterfaces()) {
- if (iface.equals(expectedIface)) {
- return true;
- }
- }
- return false;
- }
-
- static String message(String message, String logPrefix, Object... args) {
- String innerMessage = String.format(message, args);
- return String.format("%s %s", logPrefix, innerMessage);
- }
-
static List<File> getClassPath(MavenProject project) {
List<File> dependencies = Lists.newArrayList();
for (Artifact element : project.getArtifacts()) {
return dependencies;
}
+ /**
+ * 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(MavenProject project, RepositorySystem repoSystem, ArtifactRepository localRepo,
+ List<ArtifactRepository> 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<Artifact, Collection<Artifact>> pluginDependencies = new HashMap<>();
+ getPluginTransitiveDependencies(plugin, pluginDependencies, repoSystem, localRepo, remoteRepos);
+
+ Set<Artifact> projectDependencies = project.getDependencyArtifacts();
+ for (Map.Entry<Artifact, Collection<Artifact>> entry : pluginDependencies.entrySet()) {
+ checkArtifact(entry.getKey(), projectDependencies);
+ for (Artifact dependency : entry.getValue()) {
+ checkArtifact(dependency, projectDependencies);
+ }
+ }
+ }
+ }
+
+ /**
+ * 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(Plugin plugin, Map<Artifact, Collection<Artifact>> map,
+ RepositorySystem repoSystem, ArtifactRepository localRepository, List<ArtifactRepository> remoteRepos) {
+
+ List<Dependency> 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<Artifact> pluginDependencyDependencies = result.getArtifacts();
+ map.put(artifact, pluginDependencyDependencies);
+ }
+ }
+
+ /**
+ * 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(Artifact artifact, Collection<Artifact> 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);
+ }
+ }
+ }
+ }
+
private static final String JAR_SUFFIX = ".jar";
private static boolean isJar(File element) {
- return (element.isFile() && element.getName().endsWith(JAR_SUFFIX)) ? true : false;
+ return (element.isFile() && element.getName().endsWith(JAR_SUFFIX));
}
static <T> T checkNotNull(T obj, String paramName) {
}
static final class YangsInZipsResult implements Closeable {
- private final List<InputStream> yangStreams;
+ private final List<YangSourceFromDependency> yangStreams;
private final List<Closeable> zipInputStreams;
- private YangsInZipsResult(List<InputStream> yangStreams, List<Closeable> zipInputStreams) {
+ private YangsInZipsResult(List<YangSourceFromDependency> yangStreams, List<Closeable> 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<InputStream> getYangStreams() {
+ public List<YangSourceFromDependency> getYangStreams() {
return this.yangStreams;
}
}
- static YangsInZipsResult findYangFilesInDependenciesAsStream(Log log, MavenProject project)
+ static YangsInZipsResult findYangFilesInDependenciesAsStream(MavenProject project)
throws MojoFailureException {
- List<InputStream> yangsFromDependencies = new ArrayList<>();
+ List<YangSourceFromDependency> yangsFromDependencies = new ArrayList<>();
List<Closeable> zips = new ArrayList<>();
try {
List<File> 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<String> 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));
}
}
if (entryName.startsWith(YangToSourcesProcessor.META_INF_YANG_STRING_JAR)
&& !entry.isDirectory() && entryName.endsWith(".yang")) {
foundFilesForReporting.add(entryName);
- // This will be closed after all streams 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);
}
}
return new YangsInZipsResult(yangsFromDependencies, zips);
}
- static Collection<File> findYangFilesInDependencies(Log log, MavenProject project) throws MojoFailureException {
+ /**
+ * 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<File> findYangFilesInDependencies(MavenProject project) throws MojoFailureException {
final List<File> yangsFilesFromDependencies = new ArrayList<>();
+ List<File> filesOnCp;
try {
- List<File> filesOnCp = Util.getClassPath(project);
- log.info(Util.message("Searching for yang files in following dependencies: %s",
- YangToSourcesProcessor.LOG_PREFIX, filesOnCp));
+ 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) {
+ 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(new FilenameFilter() {
- @Override
- public boolean accept(File dir, String name) {
- return name.endsWith(".yang") && new File(dir, name).isFile();
- }
- });
+ File[] yangFiles = yangDir.listFiles(
+ (dir, name) -> name.endsWith(".yang") && new File(dir, name).isFile());
yangsFilesFromDependencies.addAll(Arrays.asList(yangFiles));
}
if (entryName.startsWith(YangToSourcesProcessor.META_INF_YANG_STRING_JAR)
&& !entry.isDirectory() && entryName.endsWith(".yang")) {
- log.debug(Util.message("Found a YANG file in %s: %s", YangToSourcesProcessor.LOG_PREFIX,
- file, entryName));
+ 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);
}
- } catch (Exception e) {
- throw new MojoFailureException("Failed to scan for YANG files in depedencies", e);
}
return yangsFilesFromDependencies;
}
Code Review / yangtools.git / blobdiff