org.opendaylight.yangtools.yang2sources.plugin.YangToSourcesMojo 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 static org.opendaylight.yangtools.yang2sources.plugin.YangToSourcesProcessor.LOG_PREFIX;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableList;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.File;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import org.apache.maven.RepositoryUtils;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.collection.CollectRequest;
import org.eclipse.aether.resolution.ArtifactResult;
import org.eclipse.aether.resolution.DependencyRequest;
import org.eclipse.aether.resolution.DependencyResolutionException;
import org.eclipse.aether.resolution.DependencyResult;
import org.opendaylight.yangtools.plugin.generator.api.FileGenerator;
import org.opendaylight.yangtools.plugin.generator.api.ModuleResourceResolver;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonatype.plexus.build.incremental.BuildContext;
/**
* Generate sources from yang files using user provided set of
* {@link FileGeneratorArg}s. Steps of this process:
*
* - List yang files from {@link #yangFilesRootDir}
* - Process yang files using Yang Parser
* - For each {@link FileGeneratorArg} from {@link #fileGenerators}:
*
* - Instantiate using default constructor
* - Call {@link FileGenerator#generateFiles(EffectiveModelContext, Set, ModuleResourceResolver)}
*
*
*
*/
@Mojo(name = "generate-sources", defaultPhase = LifecyclePhase.GENERATE_SOURCES,
requiresDependencyResolution = ResolutionScope.COMPILE, requiresProject = true, threadSafe = true)
public final class YangToSourcesMojo extends AbstractMojo {
public static final String PLUGIN_NAME = "org.opendaylight.yangtools:yang-maven-plugin";
private static final Logger LOG = LoggerFactory.getLogger(YangToSourcesMojo.class);
/**
* {@link FileGenerator} instances resolved via ServiceLoader can hold additional configuration, which details
* how they are executed.
*/
@Parameter(required = false)
private FileGeneratorArg[] fileGenerators;
/**
* Source directory that will be recursively searched for yang files (ending
* with .yang suffix).
*/
@Parameter(required = false)
// defaults to ${basedir}/src/main/yang
private String yangFilesRootDir;
@Parameter(required = false)
private String[] excludeFiles;
@Parameter(property = "project", required = true, readonly = true)
private MavenProject project;
@Parameter(property = "inspectDependencies")
private boolean inspectDependencies;
// When set to "true", then the execution of the plugin is disabled
@Parameter(property = "yang.skip", defaultValue = "false")
private boolean yangSkip;
@Component
private BuildContext buildContext;
@Component
private RepositorySystem repoSystem;
@Parameter(readonly = true, defaultValue = "${repositorySystemSession}")
private RepositorySystemSession repoSession;
public YangToSourcesMojo() {
}
@Override
@SuppressFBWarnings(value = "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", justification = "yangFilesRootDir")
public void execute() throws MojoExecutionException, MojoFailureException {
if (yangSkip) {
LOG.info("{} Skipping YANG code generation because property yang.skip is true",
YangToSourcesProcessor.LOG_PREFIX);
return;
}
checkClasspath();
// defaults to ${basedir}/src/main/yang
File yangFilesRootFile = processYangFilesRootDir(yangFilesRootDir, project.getBasedir());
Collection excludedFiles = processExcludeFiles(excludeFiles, yangFilesRootFile);
new YangToSourcesProcessor(buildContext, yangFilesRootFile, excludedFiles, arrayToList(fileGenerators), project,
inspectDependencies).execute();
}
/**
* Read current project dependencies and check if it don't grab incorrect artifacts versions which could be in
* conflict with plugin dependencies.
*/
private void checkClasspath() {
final var plugin = project.getPlugin(YangToSourcesMojo.PLUGIN_NAME);
if (plugin == null) {
LOG.warn("{} {} not found, dependencies version check skipped", LOG_PREFIX, YangToSourcesMojo.PLUGIN_NAME);
return;
}
final var remoteRepos = RepositoryUtils.toRepos(project.getRemoteArtifactRepositories());
final var pluginDeps = new HashMap>();
for (var mavenDep : plugin.getDependencies()) {
final var aetherDep = RepositoryUtils.toDependency(mavenDep, repoSession.getArtifactTypeRegistry());
final var collectRequest = new CollectRequest();
collectRequest.setRoot(aetherDep);
collectRequest.setRepositories(remoteRepos);
final var request = new DependencyRequest(collectRequest, null);
final DependencyResult result;
try {
result = repoSystem.resolveDependencies(repoSession, request);
} catch (DependencyResolutionException e) {
throw new IllegalStateException(e);
}
pluginDeps.put(aetherDep.getArtifact(),
result.getArtifactResults().stream().map(ArtifactResult::getArtifact).collect(Collectors.toSet()));
}
final var projectDependencies = RepositoryUtils.toArtifacts(project.getDependencyArtifacts());
for (var entry : pluginDeps.entrySet()) {
checkArtifact(entry.getKey(), projectDependencies);
for (var dependency : entry.getValue()) {
checkArtifact(dependency, projectDependencies);
}
}
}
/**
* 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 (var dep : dependencies) {
if (artifact.getGroupId().equals(dep.getGroupId()) && artifact.getArtifactId().equals(dep.getArtifactId())
&& !artifact.getVersion().equals(dep.getVersion())) {
LOG.warn("{} Dependency resolution conflict:", 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.",
LOG_PREFIX, YangToSourcesMojo.PLUGIN_NAME, artifact, dep);
}
}
}
private static List arrayToList(final T[] array) {
return array == null ? ImmutableList.of() : Arrays.asList(array);
}
private static File processYangFilesRootDir(final String yangFilesRootDir, final File baseDir) {
File yangFilesRootFile;
if (yangFilesRootDir == null) {
yangFilesRootFile = new File(baseDir, "src" + File.separator + "main" + File.separator + "yang");
} else {
File file = new File(yangFilesRootDir);
if (file.isAbsolute()) {
yangFilesRootFile = file;
} else {
yangFilesRootFile = new File(baseDir, file.getPath());
}
}
return yangFilesRootFile;
}
private static Collection processExcludeFiles(final String[] excludeFiles, final File baseDir) {
if (excludeFiles == null) {
return ImmutableList.of();
}
return Collections2.transform(Arrays.asList(excludeFiles), f -> new File(baseDir, f));
}
}