org.opendaylight.yangtools.yang2sources.plugin.Util Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of yang-maven-plugin Show documentation
Show all versions of yang-maven-plugin Show documentation
This plugin is a wrapper for "yang to source code" generation.
It can be configured by a set of third-party code generators and resource providers.
For further info see available goals.
Sample usage:
TODO: add sample usage when finished
/*
* Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
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.FileNotFoundException;
import java.io.FilenameFilter;
import java.io.IOException;
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.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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;
final class Util {
/**
* It isn't desirable to create instances of this class
*/
private 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
// phase Second: yang files are copied as resources during
// generate-resources phase. This cache ensures that yang files are listed
// only once.
private static Map> cache = Maps.newHashMapWithExpectedSize(CACHE_SIZE);
/**
* List files recursively and return as array of String paths. Use cache of
* size 1.
*/
static Collection listFiles(File root) throws FileNotFoundException {
if (cache.get(root) != null) {
return cache.get(root);
}
if (!root.exists()) {
throw new FileNotFoundException(root.toString());
}
Collection yangFiles = FileUtils.listFiles(root, new String[] { YANG_SUFFIX }, true);
toCache(root, yangFiles);
return yangFiles;
}
static Collection listFiles(File root, File[] excludedFiles) throws FileNotFoundException {
if (!root.exists()) {
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) {
LOG.info("{} {} file excluded {}", YangToSourcesProcessor.LOG_PREFIX, Util.YANG_SUFFIX.toUpperCase(),
f);
} else {
result.add(f);
}
}
return result;
}
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 (!baseType.isAssignableFrom(clazz)) {
throw new IllegalArgumentException("Code generator " + clazz + " has to implement " + baseType);
}
return clazz;
}
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);
}
}
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 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);
}
}
}
}
/**
* 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> map,
RepositorySystem repoSystem, ArtifactRepository localRepository, 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);
}
}
/**
* 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 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));
}
static T checkNotNull(T obj, String paramName) {
return Preconditions.checkNotNull(obj, "Parameter " + paramName + " is null");
}
static final class YangsInZipsResult implements Closeable {
private final List yangStreams;
private final List zipInputStreams;
private YangsInZipsResult(List yangStreams, List zipInputStreams) {
this.yangStreams = yangStreams;
this.zipInputStreams = zipInputStreams;
}
@Override
public void close() throws IOException {
for (Closeable is : zipInputStreams) {
is.close();
}
}
public List getYangStreams() {
return this.yangStreams;
}
}
static YangsInZipsResult findYangFilesInDependenciesAsStream(MavenProject project)
throws MojoFailureException {
List yangsFromDependencies = new ArrayList<>();
List zips = new ArrayList<>();
try {
List filesOnCp = Util.getClassPath(project);
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 (final File yangFile : yangFiles) {
yangsFromDependencies.add(new YangSourceFromFile(yangFile));
}
}
} else {
ZipFile zip = new ZipFile(file);
zips.add(zip);
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")) {
foundFilesForReporting.add(entryName);
yangsFromDependencies.add(new YangSourceInZipFile(zip, entry));
}
}
}
if (foundFilesForReporting.size() > 0) {
LOG.info("{} Found {} yang files in {}: {}", YangToSourcesProcessor.LOG_PREFIX,
foundFilesForReporting.size(), file, foundFilesForReporting);
}
}
} catch (Exception e) {
throw new MojoFailureException(e.getMessage(), e);
}
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(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(new FilenameFilter() {
@Override
public boolean accept(File dir, String name) {
return 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) {
this.context = context;
this.yangModules = yangModules;
}
SchemaContext getContext() {
return context;
}
Set getYangModules() {
return yangModules;
}
}
}